Milestone - November (十一月) - 2022

[Bistard]

OverView

mark	Description
bullet	not started
checkmark	completed
⭐	important
🐄	on-going (Chris)
🐳	on-going (Jerry)
🚳	not for now
...	lots of unfinished

Folder Structure (2022.10.30)

├─base     # 基础代码
│  ├─browser       # 通用UI元件
│  │  ├─basic          # 基础UI元件
│  │  └─secondary      # 复合UI元件
│  ├─common        # 公用接口
│  ├─electron      # 主进程相关接口
│  └─node          # nodeJS相关接口
├─code     # 主入口
│  ├─browser       # 渲染进程主入口
│  ├─electron      # 主进程主入口
│  ├─platform      # 基于平台相关的微服务
│  └─styles        # css文件
├─editor   # 编辑器代码
│  ├─common
│  ├─styles        # css文件
│  ├─model
│  ├─view
│  └─viewModel
└─styles   # css文件

Iteration Plan

Generals

Common Codes

• hash - String hashable and object hashable.
• event - New type of emitter: PriorityEmitter that only fires event to the listeners who has the highest priority.
• 🚳event - Emitter memory leak optimization.
• uri - refactor - Simplifies the existed uri.ts.

User interface (UI)

• ContextMenu - Refactors all the existed codes relates to ContextMenu.
• milkdown - Trys out how milkdown lib works.

Services (common)

Services (main process)

Services (renderer process)

Main Process

• 🐄Node.JS - Remove all the Node.JS code from the renderer process.
• 🐄DevEnviro - Move all the testing code from electron-quick-playground in a brand new branch named test.

Renderer Process

Editor

• PieceTableModel - wrapper class.
• EditorModel - tokenization process.
• EditorViewEventHandler -
• EditorViewModelEventEmitter -

Issues

• Sash - Fix When draging the scrollbar of the explorer view, the hover effect on the sash will be activated, which is not what we expected. #100

Unit Tests

• 🚳shortcutService - shortcutService.test.ts. (currently disabled)
• PieceTableModel - unit tests.

Benchmark & Optimization

• 🐄markdown-tokenizer - marked, markdown-it, and our own tokenizer.
• PieceTable - Reading chunks in 128KB or 64KB instead of 256KB. We need a fully test here.
• range - perf optimization.
• ListView - perf optimization.
• event - perf optimization.
• general - avoid using forEach / map / reduce etc functions. Use vanilla coding style.

Code Review

• vscode - Read codes about CompressedObjectTreeModel.
• vscode - Read codes about FuzzyScore.
• vscode - Read codes about CompressibleAsyncDataTree.
• vscode - Learn how ThemeService works.
• vscode - Learn how StorageService works.
• marked - Source code reading (tokenizer & lexer).
• vscode - TokenizationTextModelPart
• vscode - TextModelTokenization
• vscode - TokenizationStateStore - Stores the states at the start of each line and keeps track of which lines must be retokenized.
• vscode - ContiguousTokensStore - Represents contiguous tokens in a text model.
• vscode - SparseTokensStore - Represents sparse tokens in a text model.
• 🐄vscode - How vscode renders lines (How vscode get LineTokens given a line number) (low-level)
• 🐳vscode - Action and Action2
• 🐄vscode - Create a pr on PieceTable optimization.

Documentation

Others

• try out TiddlyWiki
• MVVM
• Gap Buffer
• Context Pattern