Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 630 Bytes

File metadata and controls

41 lines (28 loc) · 630 Bytes

comment-word-blacklist

Specify a blacklist of disallowed words within comments.

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

Options

array|string: ["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 warnings:

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

The following patterns are not considered warnings:

/* comment */