Skip to main content

comment-word-disallowed-list

Specify a list of disallowed words within comments.

 /* words within comments */
/** ↑     ↑      ↑
 * These three words */

Use this rule to enforce a convention. For example, disallow:

  • /^TODO:/ and /^FIXME:/ to avoid merging unfinished work
  • /^!/, which minifiers keep in production bundles
warning

Comments within selector and value lists are currently ignored.

This rule supports 1 message argument: the disallowed word.

Options​

Array<string>​

["array", "of", "words", "/regex/"]

Given:

{
  "comment-word-disallowed-list": ["/^TODO:/", "badword"]
}

The following patterns are considered problems:

/* TODO: */
/* TODO: add fallback */
/* some badword */

The following patterns are not considered problems:

/* comment */