ESLint plugin to enforce the TODO NUKEM convention for code comments.
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
npm install --save-dev @jolution/eslint-plugin-todo-nukemAdd 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'
}
}
];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.
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 componentVisual display (with VSCode extension decorations):
// TODO: 🟩 ✨ 🎨 Refactor this componentFor the complete specification and all available tags, see the TODO NUKEM documentation.
If you find this project helpful, please consider giving it a star on GitHub.
We do not currently offer direct support for this project.
We appreciate the support from Atos, helping us continue our open source work.
See the LICENSE file for details.
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.