Skip to main content

comment-word-disallowed-list

Specify a list of disallowed words within comments.

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

Comments within selector and value lists are currently ignored.

The message secondary option can accept the arguments of this rule.

Options​

array|string|regexp: ["array", "of", "words", /or/, "/regex/"]|"word"|"/regex/"|/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 problems:

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

The following patterns are not considered problems:

/* comment */