An extension for Visual Studio Code that helps you find and manage TODOs in your codebase. This extension provides a sidebar view and a status bar item to display the number of TODOs, and it allows you to configure custom tags and file patterns for inclusion and exclusion in the search.
- Display the total number of TODOs in your project.
- Sidebar view with a list of files containing TODOs.
- Configure custom tags for filtering TODOs.
- Configure file inclusion and exclusion patterns for the search.
- Ignore specific TODOs with an
//ignore-todo
comment.
- Open Visual Studio Code.
- Go to the Extensions view by clicking the square icon in the sidebar or pressing
Ctrl+Shift+X
. - Search for
TODOs Finder
. - Click
Install
.
- Open the TODOs view from the activity bar to see the list of files containing TODOs.
- Click on a file to navigate to it.
- The status bar shows the total number of TODOs in the project.
- It updates automatically when you save a file or switch active editors.
- Add
//ignore-todo
on the line before a TODO to exclude it from the count.
- Tag:
""
(empty string). - Files to Include:
**/*
- Files to Exclude:
**/node_modules/**
You can configure the extension settings through the VSCode settings UI or by editing your settings.json
file:
{
"todosfinder.tag": "BUG",
"todosfinder.filesToInclude": "**/*.js",
"todosfinder.filesToExclude": "**/node_modules/**"
}
- Tag: Custom tag to search for TODOs. Example:
BUG
.- By default the extension will search for the keyword TODO. If you add a custom value, for example BUG, the extension will search for TODO[BUG].
- Files to Include: Global pattern of files to include in the search. Example:
**/*.js
- Files to Exclude: Global pattern of files to exclude from the search. Example:
**/node_modules/**