Skip to content

sapegin/vscode-todo-tomorrow

Repository files navigation

Todo Tomorrow Visual Studio Code extension ✅

Visual Studio Code extension for highlighting TODO, HACK, FIXME, etc. comments.

Install from Visual Studio Marketplace

Todo Tomorrow Visual Studio Code extension

Features

  • Very minimal and fast
  • Useful defaults to cover most use cases
  • Supports Bash, CSS, HTML, JavaScript, Lua, Markdown, Perl, PHP, Python, R, Ruby, SQL, TypeScript, and any other language with C-style comments (// or /* */)
  • Supports light and dark modes out of the box

Settings

By default the extension highlights the most popular comment tags:

  • Warning comments, bold and darker color: BODGE, BUG, HACK, KLUDGE, UGLY, XXX, @bodge, @bug, @hack, @kludge, @ugly, and @xxx.
  • Informational comments, just bold: DEBUG, FIX, FIXME, NOTE, TODO, UNDONE, @debug, @fix, @fixme, @note, @todo, and @undone.

Supported types of comments

You can override the these keywords and their styles.

You can change the following options in the Visual Studio Code setting:

Description Setting Default
Groups of patterns to highlight todoTomorrow.patterns See below

All keywords are case insensitive. See all supported decoration options.

The colon (:) after the keyword is optional (@todo or @todo:) for all languages except Markdown (to avoid false-positives).

Here’s how a config file would look like with default options:

{
  "todoTomorrow.patterns": [
    {
      "keywords": [
        "@debug",
        "@fixme",
        "@fix",
        "@note",
        "@todo",
        "@undone",
        "debug",
        "fixme",
        "fix",
        "note",
        "todo",
        "undone"
      ],
      "fontWeight": "bold"
    },
    {
      "keywords": [
        "@bodge",
        "@bug",
        "@hack",
        "@kludge",
        "@ugly",
        "@xxx",
        "bodge",
        "bug",
        "hack",
        "kludge",
        "ugly",
        "xxx"
      ],
      "fontWeight": "bold",
      "light": {
        "color": "#4c4b4e"
      },
      "dark": {
        "color": "#dcd5c0"
      }
    }
  ]
}

Changelog

The changelog can be found on the Changelog.md file.

You may also like

Check out my other Visual Studio Code extensions:

Sponsoring

This software has been developed with lots of coffee, buy me one more cup to keep it going.

Buy Me A Coffee

Contributing

Bug fixes are welcome, but not new features. Please take a moment to review the contributing guidelines.

Authors and license

Artem Sapegin, and contributors.

MIT License, see the included License.md file.