VSCODE-TODO-HIGHLIGHT

Highlight TODO,FIXME or any other annotations within your code.

Sometimes you will forget to review the TODOs added while coding till publish the code to production. So I've been long for an extension to highlight them and remind me know there're notes or things not done.

Hope this extension helps you as well.

Preview

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

Config

TODO:,FIXME: are built in keywords. You can override the look by customizing the setting.

To custom the keywords and other stuff, command + , (Windows / Linux: File -> Preferences -> User Settings) open vscode settings.json file.

following is an example of configuration:

{
    "todohighlight.isEnable": true, //toggle the highlight, default is true
    "todohighlight.isCaseSensitive": false, //whether the keywords are case sensitive or not
    "todohighlight.keywords": [
        "BUG:", // adding custom keywords without specifying the look, default color will be applied
        "REVIEW:", //another custom keyword
        {  //adding custom keywords with custom look
            "text": "NOTE:", // custom text to be highlighted
            "color": "#ff0000", // the text color, any css color identifier is valid
            "backgroundColor": "yellow", // the text background color
            "overviewRulerColor": "grey" //the color of the ruler mark on the scroll bar. use rgba() and define transparent colors to play well with other decorations.
        },
        {
            "text": "HACK:",
            "color": "#000"
        }
        ...
    ],
    "todohighlight.defaultStyle": { //specify the default style for custom keywords, if not specified, build in default style will be applied
        "color": "#0000ff",
        "backgroundColor": "yellow",
        "overviewRulerColor": "grey"
    }
}