TODO NUKEM

Working Draft

A VSCode extension for creating and managing structured TODO comments with emojis following the TODO NUKEM Convention. Features interactive comment generation, TODO overview with filtering, and quick snippets for maximum productivity.

📰 Installation

Install this extension from the VSCode Marketplace

🚀 Usage

This extension offers two ways to create TODO NUKEM comments:

1. 🎯 Interactive Command (Recommended)

Open the Command Palette (Cmd+Shift+P or Ctrl+Shift+P) and search for:

TODO NUKEM Comment

Follow the guided prompts:

1. Priority: 🟩 Low / 🔶 Medium / 🔴 High
2. Type: ✨ Feature / 🐛 Fix
3. Context: 🎨 Design / 📚 Doc / 🧪 Test / ⚡ Perf / etc.
4. Message: Your TODO description
5. Meta Blocks (optional): 💬 TBD / 🎯 Scope / 🎫 Ticket / 📅 Until / etc.

Example in source code:

// TODO: [high] [feature] [design] Refactor button component [ticket: JIRA-123] [until: 2025-12-31]

Visual display (with decorations):

The extension decorates the keys with emojis in the editor:

// TODO: 🔴 ✨ 🎨 Refactor button component 🎫 JIRA-123 📅 2025-12-31

Note: You can customize the display mode in todonukem.json (emoji, text, or emoji-text combination). Alternatively, click the eye icon (👁️) in the status bar to quickly toggle between display modes.

2. ⚡ Quick Snippets

In supported languages, type todo or fixme and press Tab to activate snippet templates:

todo ⇥ fixme ⇥

This provides pre-defined templates for quick TODO insertion.

✨ Supported Languages

Defined in the package.json file, the following languages are supported with either line or block comments:

Line Comment

TypeScript, JavaScript

Block Comment

CSS, PostCSS, SCSS, Less, HTML, Python, Java, C#, C++, Ruby, Swift, PHP, Go, Rust, Dart, Perl, Lua, Shell Script

For example, CSS uses block comments like /* ... */.

And TypeScript could use line comments like // ....

If a language you need is missing, feel free to open a PR and contribute!

❓FAQ

"editor.quickSuggestions": {
    "comments": true,
    "strings": true
}

{
  "emojis": {
    "priority": {
      "low": "🔵"
    }
  }
}

{
  "displayMode": "emoji"
}

{
  "displayMode": "text"
}

{
  "displayMode": "emoji-text"
}

{
  "ticketBaseUrl": "https://jira.example.com/browse"
}

// TODO: [high] [feature] Fix login bug [ticket: JIRA-123]

For more questions and answers, please visit our Q&A Discussions.

🔗 Related Tools

ESLint Plugin

For best results, combine this extension with the TODO NUKEM ESLint plugin to enforce the convention in your codebase:

The ESLint plugin validates that your TODO comments follow the TODO NUKEM Convention and can auto-fix formatting issues.

npm install --save-dev @jolution/eslint-plugin-todo-nukem

Learn more:
GitHub Repository
npm Package

❤️ Support

If you find this project helpful, please consider giving it the Convention Repo a star on GitHub.

We do not currently offer direct support for this project.

💎 Sponsor

Atos

We appreciate the support from Atos, helping us continue our open source work.

✍️ Authors (in alphabetical order)

• @juliankasimir
• @pimmok

⚖️ License

See the LICENSE file for details.

ℹ️ Disclaimer

Please note that this project, TODO NUKEM, is not officially associated with or endorsed by the Duke Nukem franchise or its creators. It is an independent project developed by the open-source community and does not claim any rights to the Duke Nukem trademark or any related materials.

✨ Contributors

Thanks goes to these wonderful people (emoji key):

Jochen Simon 🎨

Julian Kasimir 🤔 💻

This project follows the all-contributors specification. Contributions of any kind welcome!