https://github.com/sawyerh/eslint-plugin-todo-plz

Enforce consistent and maintainable TODO comments
https://github.com/sawyerh/eslint-plugin-todo-plz

eslint npm-package

Last synced: 4 days ago
JSON representation

Enforce consistent and maintainable TODO comments

• Host: GitHub
• URL: https://github.com/sawyerh/eslint-plugin-todo-plz
• Owner: sawyerh
• Created: 2020-07-17T01:35:41.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-07-18T18:44:55.000Z (6 months ago)
• Last Synced: 2025-01-13T05:06:07.034Z (11 days ago)
• Topics: eslint, npm-package
• Language: JavaScript
• Homepage: https://npmjs.com/package/eslint-plugin-todo-plz
• Size: 226 KB
• Stars: 27
• Watchers: 3
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# eslint-plugin-todo-plz

Enforce consistent and maintainable TODO comments.

![Screenshot](.github/assets/screenshot.png)

## Installation

You'll first need to install [ESLint](http://eslint.org):

```

$ 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:

```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]+" }]

  }

}

```

## Supported Rules

- [`ticket-ref`](docs/rules/ticket-ref.md)

## Inspiration

- Shoutout [`expiring-todo-comments`](https://github.com/sindresorhus/eslint-plugin-unicorn/blob/master/docs/rules/expiring-todo-comments.md) for showing me how to build my first ESLint rule.