Sha256: 7b55190107858cba6e497dd6dabe3500895f7f44040a2c7046d9700290e8eeb5

Contents?: true

Size: 843 Bytes

Versions: 23

Compression:

Stored size: 843 Bytes

Contents

# comment-word-blacklist

Specify a blacklist of disallowed words within comments.

<!-- prettier-ignore -->
```css
 /* words within comments */
/** ↑     ↑      ↑
 * These three words */
```

**Caveat:** Comments within _selector and value lists_ are currently ignored.

## Options

`array|string|regexp`: `["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 violations:

<!-- prettier-ignore -->
```css
/* TODO: */
```

<!-- prettier-ignore -->
```css
/* TODO: add fallback */
```

<!-- prettier-ignore -->
```css
/* some badword */
```

The following patterns are _not_ considered violations:

<!-- prettier-ignore -->
```css
/* comment */
```

Version data entries

23 entries across 23 versions & 1 rubygems

Version Path
trusty-cms-5.0.7 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-5.0.6 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-5.0.5 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-5.0.4 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-5.0.3 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-5.0.2 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-5.0.1 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-4.3.5 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-5.0.0 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-4.3.4 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-4.3.3 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-4.3.2 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-4.3.1 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-4.3 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-4.2.3 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-4.2.2 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-4.2.1 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-4.2 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-4.1.9 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md
trusty-cms-4.1.8 node_modules/stylelint/lib/rules/comment-word-blacklist/README.md