mirror of https://github.com/thangisme/notes.git synced 2024-11-01 03:17:30 -04:00

History

Patrick Marsceill b7b0d0d7bf Initial commit		2017-03-09 13:16:08 -05:00
..
index.js	Initial commit	2017-03-09 13:16:08 -05:00
README.md	Initial commit	2017-03-09 13:16:08 -05:00

comment-word-blacklist

Specify a blacklist of disallowed words within comments.

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

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

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