Skip to content

Commit f0308e6

Browse files
authored
chore: add syntax highlighting and format arrays (#3463)
1 parent 9b32742 commit f0308e6

File tree

1 file changed

+46
-46
lines changed

1 file changed

+46
-46
lines changed

docs/reference-rules.md

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -10,31 +10,31 @@ Rule configurations are either of type `array` residing on a key with the rule's
1010

1111
**Plain array**
1212

13-
```
13+
```js
1414
"rules": {
1515
"header-max-length": [0, "always", 72],
1616
}
1717
```
1818

1919
**Function returning array**
2020

21-
```
21+
```js
2222
"rules": {
2323
"header-max-length": () => [0, "always", 72],
2424
}
2525
```
2626

2727
**Async function returning array**
2828

29-
```
29+
```js
3030
"rules": {
3131
"header-max-length": async () => [0, "always", 72],
3232
}
3333
```
3434

3535
**Function returning a promise resolving to array**
3636

37-
```
37+
```js
3838
"rules": {
3939
"header-max-length": () => Promise.resolve([0, "always", 72]),
4040
}
@@ -104,16 +104,16 @@ Infinity
104104

105105
- **possible values**
106106

107-
```
107+
```js
108108
[
109-
'lower-case', // default
110-
'upper-case', // UPPERCASE
111-
'camel-case', // camelCase
112-
'kebab-case', // kebab-case
113-
'pascal-case', // PascalCase
109+
'lower-case', // default
110+
'upper-case', // UPPERCASE
111+
'camel-case', // camelCase
112+
'kebab-case', // kebab-case
113+
'pascal-case', // PascalCase
114114
'sentence-case', // Sentence case
115-
'snake-case', // snake_case
116-
'start-case' // Start Case
115+
'snake-case', // snake_case
116+
'start-case' // Start Case
117117
]
118118
```
119119

@@ -169,16 +169,16 @@ Infinity
169169

170170
- **possible values**
171171

172-
```
172+
```js
173173
[
174-
'lower-case', // default
175-
'upper-case', // UPPERCASE
176-
'camel-case', // camelCase
177-
'kebab-case', // kebab-case
178-
'pascal-case', // PascalCase
174+
'lower-case', // default
175+
'upper-case', // UPPERCASE
176+
'camel-case', // camelCase
177+
'kebab-case', // kebab-case
178+
'pascal-case', // PascalCase
179179
'sentence-case', // Sentence case
180-
'snake-case', // snake_case
181-
'start-case' // Start Case
180+
'snake-case', // snake_case
181+
'start-case' // Start Case
182182
]
183183
```
184184

@@ -238,16 +238,16 @@ Infinity
238238

239239
- **possible values**
240240

241-
```
241+
```js
242242
[
243-
'lower-case', // default
244-
'upper-case', // UPPERCASE
245-
'camel-case', // camelCase
246-
'kebab-case', // kebab-case
247-
'pascal-case', // PascalCase
243+
'lower-case', // default
244+
'upper-case', // UPPERCASE
245+
'camel-case', // camelCase
246+
'kebab-case', // kebab-case
247+
'pascal-case', // PascalCase
248248
'sentence-case', // Sentence case
249-
'snake-case', // snake_case
250-
'start-case' // Start Case
249+
'snake-case', // snake_case
250+
'start-case' // Start Case
251251
]
252252
```
253253

@@ -282,22 +282,22 @@ Infinity
282282
- **rule**: `always`
283283
- **value**
284284

285-
```
285+
```js
286286
['sentence-case', 'start-case', 'pascal-case', 'upper-case']
287287
```
288288

289289
- **possible values**
290290

291-
```
291+
```js
292292
[
293-
'lower-case', // default
294-
'upper-case', // UPPERCASE
295-
'camel-case', // camelCase
296-
'kebab-case', // kebab-case
297-
'pascal-case', // PascalCase
293+
'lower-case', // default
294+
'upper-case', // UPPERCASE
295+
'camel-case', // camelCase
296+
'kebab-case', // kebab-case
297+
'pascal-case', // PascalCase
298298
'sentence-case', // Sentence case
299-
'snake-case', // snake_case
300-
'start-case' // Start Case
299+
'snake-case', // snake_case
300+
'start-case'. // Start Case
301301
]
302302
```
303303

@@ -346,7 +346,7 @@ Infinity
346346
- **condition**: `type` is found in value
347347
- **rule**: `always`
348348
- **value**
349-
```
349+
```js
350350
['feat', 'fix', 'docs', 'style', 'refactor', 'test', 'revert']
351351
```
352352

@@ -360,16 +360,16 @@ Infinity
360360
```
361361
- **possible values**
362362

363-
```
363+
```js
364364
[
365-
'lower-case', // default
366-
'upper-case', // UPPERCASE
367-
'camel-case', // camelCase
368-
'kebab-case', // kebab-case
369-
'pascal-case', // PascalCase
365+
'lower-case', // default
366+
'upper-case', // UPPERCASE
367+
'camel-case', // camelCase
368+
'kebab-case', // kebab-case
369+
'pascal-case', // PascalCase
370370
'sentence-case', // Sentence case
371-
'snake-case', // snake_case
372-
'start-case' // Start Case
371+
'snake-case', // snake_case
372+
'start-case' // Start Case
373373
];
374374
```
375375

0 commit comments

Comments
 (0)