Skip to main content

comment-word-blacklist

Deprecated: Instead use the comment-word-disallowed-list rule.

Specify a list of disallowed words within comments.

/* words within comments */
/** โ†‘ โ†‘ โ†‘
* These three words */

Caveat: Comments within selector and value lists are currently ignored.

Options#

array|string|regexp: ["array", "of", "words", /or/, "/regex/"]|"word"|"/regex/"

If a string is surrounded with "/" (e.g. "/^TODO:/"), it is interpreted as a regular expression.

Given:

["/^TODO:/", "badword"]

The following patterns are considered violations:

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

The following patterns are not considered violations:

/* comment */