eslint-plugin-todo-plz
v1.3.1
Published
Enforce consistent and maintainable TODO comments
Downloads
91,560
Maintainers
Readme
eslint-plugin-todo-plz
Enforce consistent and maintainable TODO comments.
Installation
You'll first need to install ESLint:
$ npm i eslint --save-dev
Next, install eslint-plugin-todo-plz
:
$ npm install eslint-plugin-todo-plz --save-dev
Usage
Add todo-plz
to the plugins section of your .eslintrc
configuration file. You can omit the eslint-plugin-
prefix:
{
"plugins": ["todo-plz"]
}
Then configure the rules you want to use under the rules section.
{
"rules": {
"todo-plz/ticket-ref": ["error", { "pattern": "PROJ-[0-9]+" }]
}
}
Supported Rules
Inspiration
- Shoutout
expiring-todo-comments
for showing me how to build my first ESLint rule.