eslint-plugin-todo-plz

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": "ABC-[0-9]+" }]
  }
}

Supported Rules

• ticket-ref

Inspiration

• Shoutout expiring-todo-comments for showing me how to build my first ESLint rule.