0.0.2 • Published 1 month ago

eslint-plugin-avoid-comments v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
1 month ago

✨ 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