README.md

December 1, 2025 · View on GitHub

Shows the banner of TODO NUKEM, with its logo

ESLint plugin to enforce the TODO NUKEM convention for code comments.

About TODO NUKEM

In a nutshell: TODO NUKEM is a convention for classifying TODO comments in your code with text-based tags for priority, type, and context. This makes it easier to track and manage technical debt.

Learn more:
GitHub Repository
npm Package

Installation

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

Usage

Add to your Eslint-Config File (e.g eslint.config.js):

import todoNukem from '@jolution/eslint-plugin-todo-nukem';

export default [
  {
    plugins: {
      'todo-nukem': todoNukem
    },
    rules: {
      'todo-nukem/todo-nukem-convention': 'error'
    }
  }
];

Best Practice: Use with VSCode Generator

For the best experience, we recommend using this ESLint plugin together with the TODO NUKEM VSCode Generator. The generator provides:

Quick TODO creation
Automatic formatting to match the convention
Seamless integration with this ESLint plugin for validation

This combination ensures your TODOs are always correctly formatted from the start, while the ESLint plugin catches any manual edits that don't follow the convention.

Classification Format

The plugin enforces the TODO NUKEM format:

// TODO: [priority] [type] [context] <description> [optional meta]
// TODO: [low] [feature] [design] Refactor this component [scope: Header] [until: 2025-Q1]

In source code:

// TODO: [low] [feature] [design] Refactor this component

Visual display (with VSCode extension decorations):

// TODO: 🟩 ✨ 🎨 Refactor this component

For the complete specification and all available tags, see the TODO NUKEM documentation.

❤️ Support

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

We do not currently offer direct support for this project.

✍️ Authors (in alphabetical order)

Atos

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

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.