Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 903 Bytes

File metadata and controls

50 lines (35 loc) · 903 Bytes

comment-word-disallowed-list

Specify a list of disallowed words within comments.

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

This rule was previously called comment-word-blacklist.

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 */