Skip to content

franciscobressa/eslint-plugin-avoid-comments

Repository files navigation

✨ 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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •