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