1
0
mirror of https://github.com/thangisme/notes.git synced 2024-11-01 06:27:23 -04:00
notes/node_modules/stylelint/lib/rules/comment-whitespace-inside/README.md

85 lines
1.1 KiB
Markdown
Raw Normal View History

2017-03-09 13:16:08 -05:00
# comment-whitespace-inside
Require or disallow whitespace on the inside of comment markers.
```css
/* comment */
/** ↑ ↑
* The space inside these two markers */
```
Any number of asterisks are allowed at the beginning or end of the comment. So `/** comment **/` is treated the same way as `/* comment */`.
**Caveat:** Comments within *selector and value lists* are currently ignored.
## Options
`string`: `"always"|"never"`
### `"always"`
There *must always* be whitespace inside the markers.
The following patterns are considered warnings:
```css
/*comment*/
```
```css
/*comment */
```
```css
/** comment**/
```
The following patterns are *not* considered warnings:
```css
/* comment */
```
```css
/** comment **/
```
```css
/**
* comment
*/
```
```css
/* comment
*/
```
### `"never"`
There *must never* be whitespace on the inside the markers.
The following patterns are considered warnings:
```css
/* comment */
```
```css
/*comment */
```
```css
/** comment**/
```
The following patterns are *not* considered warnings:
```css
/*comment*/
```
```css
/****comment****/
```