TODO Highlight v2 installs statistics

TODO Highlight v2

Highlight TODO:, FIXME: and any other annotations you wish within your code in VSCode.

Sometimes you forget to review the TODOs and NOTEs you've added while coding before you publish the code to production. This extension highlights them, making them harder to forget. They're shown in the file, in the output channel, and optionally as decorations in the 'overview ruler' too.

They can also be set on a per-language basis.

NB: This extension was started and maintained by wayou until 2018, when it appears to have been abandoned. I, (jgclark) then picked it up in mid-2020, using the significant PR from vonEdfa to add regexes, and also dealt with some other issues in the original repository. See CHANGELOG.md for more details.

Preview

• with material night color theme: • with material night eighties color theme:

Commands

This extension contributes the following commands to the Command palette.

• Toggle highlight : turn on/off the highlight • List highlighted annotations : list annotations to the Output tab (when you have a folder and/or workspace open; when you are working on individual files in one or more editors, the command returns 0 results). Keywords are coloured to match your configured highlight styles.

Installing

You can install the latest version of the extension from the Visual Studio Marketplace.

The source code is available on GitHub.

Top-level Configuration

TODO: and FIXME: are built-in keywords. To add or change keywords and other settings, command + , (or on Windows / Linux: File -> Preferences -> User Settings) to open the VSCode file settings.json.

Alternatively, you can keep settings in a workspace config file at the project root. The extension auto-detects .todohighlight.json or .todohighlight.jsonc, or you can point to a custom file with todohighlight.configFile. Keys in the config file override the same keys in settings.json; both sources work together. Example .todohighlight.json:

For .js config files, export a plain object: module.exports = { keywords: [...] }.

| | type | default | description |

| todohighlight.configFile | string | (empty) | Path to a workspace config file (relative to the workspace root). When empty, auto-detects .todohighlight.json, or .todohighlight.jsonc. File values override matching keys in settings.json. | | todohighlight.enableDiagnostics | boolean | false | Enable creating diagnostic entries for open files in the problems view. Default is false. | | todohighlight.isEnable | boolean | true | Toggle the highlight, default is true. | | todohighlight.isCaseSensitive | boolean | true | Whether the keywords are case sensitive or not. | | todohighlight.wholeWordMatch | boolean | false | When enabled, plain-text keywords are only highlighted when they appear as whole words (e.g. BUG: no longer matches the BUG: inside DEBUG:). Can be overridden per keyword with the wholeWord property. Keywords using a custom regex are not affected. | | todohighlight.keywords | array | N/A | An array of keywords that will be highlighted. You can also specify the style for each keyword here, and a more advanced regex to detect the item to highlight. See section and examples below for details | | todohighlight.keywordsPattern | string | N/A | Specify keywords via regex instead of todohighlight.keywords one by one. NB: if this is present, todohighlight.keywords will be ignored. Remember to escape the backslash if there's any in your regex (using \\ (double backslash) instead of single backslash). | | todohighlight.defaultStyle | object | N/A | Specify the default style for custom keywords, if not specified, build in default style will be applied. See all available properties on VSCode doc DecorationRenderOptions section | | todohighlight.include | array | [ "/*.js", "/*.jsx", "/*.ts", "/*.tsx", "/*.html", "/*.php", "/*.css", "/*.scss" ] | Glob patterns that defines the files to search for. Please add other file types you need, but for performance reasons and to avoid binary files do not use {**/*.*}. Note that explicitly specifying include patterns will override the default settings, so if you want to add new patterns, and also use the defaults, you will need to include the default patterns as well. | | todohighlight.exclude | array | [ "/node_modules/", "/dist/", "/bower_components/", "/build/", "/.vscode/", "/.github/", "/_output/", "/*.min.*", "/*.map" ] | Glob pattern that defines files and folders to exclude while listing annotations. Note that explicitly specifying exclude patterns will override the default settings, so if you want to add new patterns, and also use the defaults, you will need to include the default patterns as well. | | todohighlight.maxFilesForSearch | number | 5120 | Max files for searching, mostly you don't need to configure this. | | todohighlight.toggleURI | boolean | false | If the file path within the output channel is not clickable, set this to true to toggle the path pattern between # and ::. |

Configuration for each Keyword…

Description from the VS Code Marketplace listing.