.config/coc/extensions/node_modules/coc-prettier/node_modules/stylelint/lib/rules/comment-word-blacklist/README.md

   1 # comment-word-blacklist
   2
   3 Specify a blacklist of disallowed words within comments.
   4
   5 ```css
   6  /* words within comments */
   7 /** ↑     ↑      ↑
   8  * These three words */
   9 ```
  10
  11 **Caveat:** Comments within *selector and value lists* are currently ignored.
  12
  13 ## Options
  14
  15 `array|string`: `["array", "of", "words", "or", "/regex/"]|"word"|"/regex/"`
  16
  17 If a string is surrounded with `"/"` (e.g. `"/^TODO:/"`), it is interpreted as a regular expression.
  18
  19 Given:
  20
  21 ```js
  22 ["/^TODO:/", "badword"]
  23 ```
  24
  25 The following patterns are considered violations:
  26
  27 ```css
  28 /* TODO: */
  29 ```
  30
  31 ```css
  32 /* TODO: add fallback */
  33 ```
  34
  35 ```css
  36 /* some badword */
  37 ```
  38
  39 The following patterns are *not* considered violations:
  40
  41 ```css
  42 /* comment */
  43 ```