mirror of
https://github.com/CharaChorder/DeviceManager.git
synced 2026-01-20 08:52:59 +00:00
41 lines
703 B
Markdown
41 lines
703 B
Markdown
# comment-pattern
|
||
|
||
Specify a pattern for comments.
|
||
|
||
<!-- prettier-ignore -->
|
||
```css
|
||
/* comment */
|
||
/** ↑
|
||
* The pattern of this */
|
||
```
|
||
|
||
The [`message` secondary option](../../../docs/user-guide/configure.md#message) can accept the arguments of this rule.
|
||
|
||
## Options
|
||
|
||
`regex|string`
|
||
|
||
A string will be translated into a RegExp like so `new RegExp(yourString)` — so be sure to escape properly.
|
||
|
||
Given the string:
|
||
|
||
```json
|
||
"foo .+"
|
||
```
|
||
|
||
The following patterns are considered problems:
|
||
|
||
<!-- prettier-ignore -->
|
||
```css
|
||
/*not starting with foo*/
|
||
a { color: red; }
|
||
```
|
||
|
||
The following patterns are _not_ considered problems:
|
||
|
||
<!-- prettier-ignore -->
|
||
```css
|
||
/*foo at the beginning*/
|
||
a { color: red; }
|
||
```
|