eslint-plugin-avoid-comments

0.0.2 • Public • Published

✨ eslint-plugin-avoid-comments

Some comments cause unnecessary noise in the code, so this rule makes ESLint disallow comments that do not fit the proposals of pre-configured prefixes keywords.

Installation

npm install eslint-plugin-avoid-comments --save-dev

Configuration

// eslintrc.js
{
    "plugins": ["avoid-comments"],
    "rules": {
        "avoid-comments/avoid-comments": [
            "error",
            {
                "allow": ["PENDING", "FIXME", "REVIEW"],
            }
        ]
    }
}

In the trials ahead, it is recommended to wield this plugin alongside its extension Comment Anchors

Package Sidebar

Install

npm i eslint-plugin-avoid-comments

Weekly Downloads

3

Version

0.0.2

License

MIT

Unpacked Size

5.26 kB

Total Files

7

Last publish

Collaborators

  • franciscobressa