Skip to content

@kazupon/no-tag-comments

disallow tag comments

Rule Details

This rule reports comments where tag are used.

Comments with tags such as FIXME, BUG and ISSUE should generally be fixed before shipping to production.

Tags only detect the start of comments.

Fail

Some examples of incorrect code for this rule:

Pass

Some examples of correct code for this rule:

Options

json
{
  "@kazupon/no-tag-comments": [
    "error",
    {
      "tags": ["FIXME", "BUG"]
    }
  ]
}
  • tags: specify the tags to be able to lint. If you don't set any options, it set to ["FIXME", "BUG"] as default.

Nothing.

Version

This rule was introduced in @kazupon/eslint-plugin v0.2.0

Implementation