Enforce consistent and maintainable TODO comments
npm install eslint-plugin-todo-plzEnforce consistent and maintainable TODO comments.
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
Add todo-plz to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:
`json`
{
"plugins": ["todo-plz"]
}
Then configure the rules you want to use under the rules section.
`json`
{
"rules": {
"todo-plz/ticket-ref": ["error", { "pattern": "PROJ-[0-9]+" }]
}
}
- Shoutout expiring-todo-comments` for showing me how to build my first ESLint rule.