eslint-plugin-todo-comment

This is a rules to encourage the entry of ticket URLs in TODO comments.

Rule Details

This rule reports invalid TODO comment.

✗ BAD: No ticket url

// TODO: refactor
const x = () => 1

✓ GOOD:: With ticket url

// TODO: refactor
// https://ticket.com/1,
const x = () => 1

Installation

Add package

# npm
npm i -D eslint-plugin-todo-comment

# yarn
yarn add -D eslint-plugin-todo-comment

Update your eslint config

{
  "plugins": [
    "todo-comment"
  ],
  "rules": {
    "todo-comment/ticket-url": "error"
  }
}