TODO Summary Panel - VS Code Extension
A powerful VS Code extension that scans your workspace for TODO, FIXME, and HACK comments and displays them in an organized tree view panel.
Features
- 🔍 Automatic Scanning: Scans all supported files in your workspace for TODO, FIXME, and HACK comments
- 📊 Organized View: Groups comments by type with color-coded icons
- 🎯 Click to Navigate: Click any item to jump directly to the comment location in your code
- 🔄 Auto-Refresh: Automatically updates when files change
- 🎨 Visual Indicators: Different icons and colors for each comment type:
- 📝 TODO (Blue) - Tasks to be done
- 🐛 FIXME (Red) - Issues that need fixing
- 🔧 HACK (Yellow) - Temporary workarounds
The extension recognizes various comment formats across different programming languages:
// TODO: This is a task
// FIXME: This needs to be fixed
// HACK: Temporary workaround
/* TODO: Block comment */
/* FIXME - With dash separator */
/**
* TODO: JSDoc comment
*/
Supported File Types
The extension scans the following file types:
- JavaScript/TypeScript:
.js, .jsx, .ts, .tsx, .mjs, .cjs
- Web:
.html, .css, .scss, .less, .json, .jsonc
- Documentation:
.md, .mdx, .txt
- Configuration:
.yml, .yaml, .xml, .toml, .ini, .cfg, .conf, .env, .properties
- Python:
.py
- Java/Kotlin:
.java, .kt, .kts, .gradle, .groovy
- Go:
.go
- Rust:
.rs
- Ruby:
.rb
- PHP:
.php
- C/C++:
.c, .cpp, .h, .hpp
- C#:
.cs
- Swift:
.swift
- SQL:
.sql
- Shell:
.sh, .bash, .zsh, .ps1
- And more...
Usage
- Open the TODO Summary Panel: Click on the checklist icon in the Activity Bar
- View Comments: The panel shows all TODO, FIXME, and HACK comments grouped by type
- Navigate to Code: Click on any item to open the file and jump to that line
- Refresh: Click the refresh icon in the panel title to manually rescan
Commands
Sample: Refresh TODO Summary - Manually refresh the TODO list
Sample: Open TODO Item - Open a specific TODO item (used internally)
Installation
- Clone this repository
- Run
npm install to install dependencies
- Run
npm run compile to build the extension
- Press F5 to open a new VS Code window with the extension loaded
Development
# Install dependencies
npm install
# Compile the extension
npm run compile
# Watch for changes
npm run watch
# Run tests
npm test
License
Read the license file
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
| |