Milestone - May (五月) - 2022

[Bistard]

OverView

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

Folder Structure (2022.05.24)

├─base   # 基础代码
│  ├─browser       # 通用元件
│  │  ├─basic          # 基础元件
│  │  ├─icon           # 图标文件
│  │  └─secondary      # 复合元件
│  ├─common        # 公用接口
│  ├─electron      # electron相关接口
│  └─node          # nodeJS相关接口
├─code   # 主入口
│  ├─common        # 公用ts文件
│  │  ├─model          # model类
│  │  ├─service        # 公用服务类
│  │  └─viewModel      # viewModel类
│  ├─platform      # 平台相关功能
│  ├─electron-main # electron主入口
│  ├─browser       # 渲染模块主入口
│  │  ├─service       # 渲染进程服务类
│  │  └─workbench     # 工作区
│  └styles         # css文件
└─test   # 测试文件

Iteration Plan

Common Codes

• 🐄memoization - memoize decorator for speeding up functions or getters by storing the result in the cache.
• 🐄array - Array namespace that contains a series of array related helper functions.
• 🐄iterable - Iterable namespace that contains a series of Iterable related helper functions.
• 🐄event - RelayEmitter - new type of emitter works like a relay.
• 🐄dom - FocusTracker - browser utility.
• dom - FastElement - browser utility.

User interface (UI)

• 🐄ListView - Refactor splice() method.
• 🐄__ListWidgetTrait - refactor.
• 🐄ListWidgetMouseController - Manages mouse support in ListWidget.
• 🐄__ListWidgetKeyboardController - Manages keyboard support in ListWidget.
• 🐄__ListWidgetDragAndDropController - Manages drag and drop support in ListWidget.
• 🐄tree - IndexTreeModel - basic functionalities.
• 🐄tree - AbstractTree - basic functionalities.
• 🐄tree - MultiTreeModel - basic functionalities.
• 🐄tree - TreeRenderer - a series of renderers for rendering in a tree model.
• 🐄tree - MultiTree - basic functionalities.
• 🐄tree - AsyncMultiTree - basic functionalities.
• 🐄tree - AsyncMultiTreeModel - basic functionalities.

Workbench

• notebookManager - Refactor the old codes.
• 🐄Component - refactor.
• 🐄ActionBar - refactor (better coding style).
• 🐄ActionView - refactor (better coding style).
• 🐄explorer - refactor old codes.
• 🐄UserConfigService - has ability to validate .nota directory.
• 🐄notebookManager - refactor.
• 🐄notebook - refactor.
• 🐄ExplorerItem - data type represents each item in the tree-like structure in explorer.
• 🐄ExplorerRenderer - renderer for explorer view.
• 🐄ListView - optimization (fixing some of the weird behaviours and bugs).

Issues

• 🐄🐳SplitView - missing sash.
• 🐄fileService - some tests are instable on MacOS / Windows / Ubuntu.

Unit Tests

• iterable.test.ts
• string.test.ts
• 🐄indexTreeModel - basic tests.
• 🐄multiTreeModel - basic tests.
• 🐄asyncMultiTree - basic tests.

Code Review

• 🐄vscode - Read codes about IndexTreeModel.
• 🐄vscode - Read codes about ObjectTreeModel.
• 🐄vscode - Read codes about AbstractTree.
• 🐄vscode - Read codes about ObjectTree.
• 🐄vscode - Read codes about AsyncDataTree.

Documentation

• 🐄README - more detailed README.md
• Blueprint - Design blueprint for nota.
• ListView - detailed documentation
• ListWidget - detailed documentation

Others

• 🐄UI / UX designer
• 🐄 Add new Action: CodeQL
• try out Obsidian

[Bistard]

vscode - ExplorerView Architecture

• ExplorerView
  • field - WorkbenchCompressibleAsyncDataTree
    • inherit - CompressibleAsyncDataTree
      • field - CompressibleAsyncDataTreeNodeMapper
      • inherit - AsyncDataTree
        • field - map()
        • field - ObjectTree
          • inherit (abstract) - AbstractTree
            • field - ITreeModel
          • field (override) - ObjectTreeModel
            • field - map()
            • field - IndexTreeModel
      • field - CompressibleObjectTree
        • field - CompressibleObjectTreeModel
          • field - CompressedNodeWeakMapper
          • field - CompressedObjectTreeModel
            • field- map()
            • field - ObjectTreeModel
        • inherit - ObjectTree

[Bistard]

AsyncDataTree Related Qs:

• Why do they need a template named TInput?
• Considering AsyncDataTree already wraps an ObjectTree, which already contains a Map and a root. Why do they still need Map and a new root with the type IAsyncDataTreeNode.

  • The inner Map in ObjectTreeModel is mapping from type IAsyncDataTreeNode<TInput | T> | null to ITreeNode<IAsyncDataTreeNode<TInput | T> | null, TFilterData>. Which is not what we are looking for TInput | T to IAsyncDataTreeNode<TInput | T>. Thats why they set a outer Map for such usage.

• subTreeRefreshPromises field - whats for?

  • Similar to refreshPromise field, but this one is for storing the Promise when trying to refresh the given node and all its children.

• refreshPromises field - whats for?

  • For storing the Promise when fetching the stats of the children on an async tree node.

• nodeMapper field - whats for? Why do we need such a thing that cost extra RAM.

  • One-time converting the node with type ITreeNode<IAsyncDataTreeNode<TInput, T> | null, TFilterData> to ITreeNode<TInput | T, TFilterData>.