How gruntfuggly/todo-tree works
Todo Tree is a VS Code extension for finding comment tags in a workspace, presenting matches in a configurable tree, and highlighting them in open files. The principal workflow is workspace scan → ripgrep matches → tree results → open the tagged location; editor highlighting is a parallel capability. Configuration, tag attributes, colour handling, and icon selection support these features. The README documents the user-facing flow; source excerpts and the SOURCE INDEX show module dependencies, but several implementation details are unsampled, so those relationships are not expanded.
Main entry points: extension.js Extension runtime · tree.js Results tree · icons.js Tag icons · utils.js Search utilities
Components 16
Search
- Extension runtime
src/extension.js - Ripgrep search
src/ripgrep.js - Search results
src/searchResults.js - Workspace files
Results and navigation
- Results tree
src/tree.js
Highlights and icons
- Editor highlights
src/highlights.js - Tag icons
src/icons.js - Colour handling
src/colours.js - Colour names
src/colourNames.js - Codicon names
src/codiconNames.js - Product icon names
src/productIconNames.js - Theme colour names
src/themeColourNames.js
Configuration and utilities
- Tag attributes
src/attributes.js - Configuration
src/config.js - Search utilities
src/utils.js
Other components
- VS Code user
Connections 27
- VS Code user → Extension runtime: starts extension
- Extension runtime → Ripgrep search: searches with
README.md - Ripgrep search → Workspace files: scans files
README.md - Extension runtime → Search results: collects matches
src/extension.js - Extension runtime → Results tree: shows matches
README.md - VS Code user → Results tree: selects match
README.md - Results tree → Workspace files: opens location
README.md - VS Code user → Editor highlights: views open files
README.md - Editor highlights → Tag attributes: reads styling
src/highlights.js - Editor highlights → Tag icons: uses icons
src/highlights.js - Tag icons → Tag attributes: reads icon settings
src/icons.js - Tag icons → Codicon names: validates names
src/icons.js - Tag icons → Product icon names: validates names
src/icons.js - Tag icons → Theme colour names: checks theme colours
src/icons.js - Tag attributes → Configuration: reads settings
src/attributes.js - Configuration → Tag attributes: queries attributes
src/config.js - Search utilities → Colour names: checks colour names
src/utils.js - Search utilities → Theme colour names: checks theme colours
src/utils.js - Colour handling → Search utilities: uses helpers
src/colours.js - Results tree → Search utilities: uses helpers
src/tree.js - Results tree → Tag icons: uses icons
src/tree.js - Results tree → Configuration: reads settings
src/tree.js - Ripgrep search → Search utilities: uses helpers
src/ripgrep.js - Extension runtime → Configuration: uses settings
src/extension.js - Extension runtime → Editor highlights: uses highlighting
src/extension.js - Extension runtime → Results tree: uses tree
src/extension.js - Extension runtime → Ripgrep search: uses search
src/extension.js