🔨 ESLint plugin supports TODO comments with a label in parentheses
Give a ⭐️ if this project helped you!
When working with code, many times there will be a situation of creating a TODO in the code to indicate that you need to perform some action here, such as writing an error handler. In such situations, the creation of a TODO is understandable. On the other hand, it often happens that such a comment in the code is for a long time. Then people reading such code, who would like to solve the TODO comment, lack information about the author, so that they can turn to him for more details.
If we use this plugin, we will force everyone creating a TODO comment to define the author in parentheses. This way, we will always have a point of contact for the person we can ask for help.
- ✅ Validate format of TODOs in comments (default valid format is
TODO(label): any text here) - ✅ Supports passing a custom pattern
- ✅ Supports 8 comment types:
TODO,NOTE,COMMENT,FIXME,BUG,HACK,INFO,XXX
You'll first need to install ESLint:
npm install -D eslintNext, install eslint-plugin-todo-with-label:
npm install -D eslint-plugin-todo-with-labelAdd todo-with-label to the plugins section of your .eslintrc configuration file.
You can omit the eslint-plugin- prefix:
module.exports = {
// ...
plugins: ['todo-with-label'],
rules: {
'todo-with-label/has-valid-pattern': 'error',
}
};The optional configuration for rule todo-with-label/has-valid-pattern:
-
patternexamples:^TODO: (.*)$- valid:
TODO: any text here
- valid:
^TODO\\((\\w+)\\)$- valid:
TODO(label)
- valid:
^TODO\\((author:@\\w+)\\)\\: (.*)$- valid:
TODO(author:@login): any text here
- valid:
Default
patternlooks as follows:^TODO\\((\\w+)\\)\\: (.*)$- valid:
TODO(label): any text here
- valid:
Example:
module.exports = {
// ...
plugins: ['todo-with-label'],
rules: {
"todo-with-label/has-valid-pattern": [
"error",
{ pattern: "^TODO\\((author:@\\w+)\\)\\: (.*)$" },
],
},
};The MIT License @ 2023