Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: add syntax highlighting and format arrays in doc #3463

Merged
merged 1 commit into from Dec 26, 2022
Merged

chore: add syntax highlighting and format arrays in doc #3463

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
92 changes: 46 additions & 46 deletions docs/reference-rules.md
View file
Open in desktop
Expand Up @@ -10,31 +10,31 @@ Rule configurations are either of type `array` residing on a key with the rule's

**Plain array**

```
```js
"rules": {
"header-max-length": [0, "always", 72],
}
```

**Function returning array**

```
```js
"rules": {
"header-max-length": () => [0, "always", 72],
}
```

**Async function returning array**

```
```js
"rules": {
"header-max-length": async () => [0, "always", 72],
}
```

**Function returning a promise resolving to array**

```
```js
"rules": {
"header-max-length": () => Promise.resolve([0, "always", 72]),
}
Expand Down Expand Up @@ -104,16 +104,16 @@ Infinity

- **possible values**

```
```js
[
'lower-case', // default
'upper-case', // UPPERCASE
'camel-case', // camelCase
'kebab-case', // kebab-case
'pascal-case', // PascalCase
'lower-case', // default
'upper-case', // UPPERCASE
'camel-case', // camelCase
'kebab-case', // kebab-case
'pascal-case', // PascalCase
'sentence-case', // Sentence case
'snake-case', // snake_case
'start-case' // Start Case
'snake-case', // snake_case
'start-case' // Start Case
]
```

Expand Down Expand Up @@ -169,16 +169,16 @@ Infinity

- **possible values**

```
```js
[
'lower-case', // default
'upper-case', // UPPERCASE
'camel-case', // camelCase
'kebab-case', // kebab-case
'pascal-case', // PascalCase
'lower-case', // default
'upper-case', // UPPERCASE
'camel-case', // camelCase
'kebab-case', // kebab-case
'pascal-case', // PascalCase
'sentence-case', // Sentence case
'snake-case', // snake_case
'start-case' // Start Case
'snake-case', // snake_case
'start-case' // Start Case
]
```

Expand Down Expand Up @@ -238,16 +238,16 @@ Infinity

- **possible values**

```
```js
[
'lower-case', // default
'upper-case', // UPPERCASE
'camel-case', // camelCase
'kebab-case', // kebab-case
'pascal-case', // PascalCase
'lower-case', // default
'upper-case', // UPPERCASE
'camel-case', // camelCase
'kebab-case', // kebab-case
'pascal-case', // PascalCase
'sentence-case', // Sentence case
'snake-case', // snake_case
'start-case' // Start Case
'snake-case', // snake_case
'start-case' // Start Case
]
```

Expand Down Expand Up @@ -282,22 +282,22 @@ Infinity
- **rule**: `always`
- **value**

```
```js
['sentence-case', 'start-case', 'pascal-case', 'upper-case']
```

- **possible values**

```
```js
[
'lower-case', // default
'upper-case', // UPPERCASE
'camel-case', // camelCase
'kebab-case', // kebab-case
'pascal-case', // PascalCase
'lower-case', // default
'upper-case', // UPPERCASE
'camel-case', // camelCase
'kebab-case', // kebab-case
'pascal-case', // PascalCase
'sentence-case', // Sentence case
'snake-case', // snake_case
'start-case' // Start Case
'snake-case', // snake_case
'start-case'. // Start Case
]
```

Expand Down Expand Up @@ -346,7 +346,7 @@ Infinity
- **condition**: `type` is found in value
- **rule**: `always`
- **value**
```
```js
['feat', 'fix', 'docs', 'style', 'refactor', 'test', 'revert']
```

Expand All @@ -360,16 +360,16 @@ Infinity
```
- **possible values**

```
```js
[
'lower-case', // default
'upper-case', // UPPERCASE
'camel-case', // camelCase
'kebab-case', // kebab-case
'pascal-case', // PascalCase
'lower-case', // default
'upper-case', // UPPERCASE
'camel-case', // camelCase
'kebab-case', // kebab-case
'pascal-case', // PascalCase
'sentence-case', // Sentence case
'snake-case', // snake_case
'start-case' // Start Case
'snake-case', // snake_case
'start-case' // Start Case
];
```

Expand Down