mirror of
https://github.com/snachodog/just-the-docs.git
synced 2025-04-12 22:52:21 -06: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 */