Skip to content

Commit 3df7f4a

Browse files
authored
docs(linter): Regenerate docs for rules to update the CLI/config block at the bottom. (#687)
Ths updates every rule in the codebase, I made sure to generate this commit after regenerating the site with all other recent changes, so it should only include the changes for the bottom block.
1 parent 928b905 commit 3df7f4a

File tree

615 files changed

+3075
-3075
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

615 files changed

+3075
-3075
lines changed

src/docs/guide/usage/linter/rules/eslint/array-callback-return.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,10 @@ When set to true, rule will also report forEach callbacks that return a value.
6565

6666
## How to use
6767

68-
To **enable** this rule in the CLI or using the config file, you can use:
68+
To **enable** this rule using the config file or in the CLI, you can use:
6969

7070
::: code-group
7171

72-
```bash [CLI]
73-
oxlint --deny array-callback-return
74-
```
75-
7672
```json [Config (.oxlintrc.json)]
7773
{
7874
"rules": {
@@ -81,6 +77,10 @@ oxlint --deny array-callback-return
8177
}
8278
```
8379

80+
```bash [CLI]
81+
oxlint --deny array-callback-return
82+
```
83+
8484
:::
8585

8686
## References

src/docs/guide/usage/linter/rules/eslint/arrow-body-style.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -160,14 +160,10 @@ const bar = () => {
160160

161161
## How to use
162162

163-
To **enable** this rule in the CLI or using the config file, you can use:
163+
To **enable** this rule using the config file or in the CLI, you can use:
164164

165165
::: code-group
166166

167-
```bash [CLI]
168-
oxlint --deny arrow-body-style
169-
```
170-
171167
```json [Config (.oxlintrc.json)]
172168
{
173169
"rules": {
@@ -176,6 +172,10 @@ oxlint --deny arrow-body-style
176172
}
177173
```
178174

175+
```bash [CLI]
176+
oxlint --deny arrow-body-style
177+
```
178+
179179
:::
180180

181181
## References

src/docs/guide/usage/linter/rules/eslint/block-scoped-var.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,10 @@ function doTry() {
107107

108108
## How to use
109109

110-
To **enable** this rule in the CLI or using the config file, you can use:
110+
To **enable** this rule using the config file or in the CLI, you can use:
111111

112112
::: code-group
113113

114-
```bash [CLI]
115-
oxlint --deny block-scoped-var
116-
```
117-
118114
```json [Config (.oxlintrc.json)]
119115
{
120116
"rules": {
@@ -123,6 +119,10 @@ oxlint --deny block-scoped-var
123119
}
124120
```
125121

122+
```bash [CLI]
123+
oxlint --deny block-scoped-var
124+
```
125+
126126
:::
127127

128128
## References

src/docs/guide/usage/linter/rules/eslint/class-methods-use-this.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,14 +98,10 @@ Whether to ignore methods that are overridden.
9898

9999
## How to use
100100

101-
To **enable** this rule in the CLI or using the config file, you can use:
101+
To **enable** this rule using the config file or in the CLI, you can use:
102102

103103
::: code-group
104104

105-
```bash [CLI]
106-
oxlint --deny class-methods-use-this
107-
```
108-
109105
```json [Config (.oxlintrc.json)]
110106
{
111107
"rules": {
@@ -114,6 +110,10 @@ oxlint --deny class-methods-use-this
114110
}
115111
```
116112

113+
```bash [CLI]
114+
oxlint --deny class-methods-use-this
115+
```
116+
117117
:::
118118

119119
## References

src/docs/guide/usage/linter/rules/eslint/constructor-super.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,10 @@ class C extends D {
7777

7878
## How to use
7979

80-
To **enable** this rule in the CLI or using the config file, you can use:
80+
To **enable** this rule using the config file or in the CLI, you can use:
8181

8282
::: code-group
8383

84-
```bash [CLI]
85-
oxlint --deny constructor-super
86-
```
87-
8884
```json [Config (.oxlintrc.json)]
8985
{
9086
"rules": {
@@ -93,6 +89,10 @@ oxlint --deny constructor-super
9389
}
9490
```
9591

92+
```bash [CLI]
93+
oxlint --deny constructor-super
94+
```
95+
9696
:::
9797

9898
## References

src/docs/guide/usage/linter/rules/eslint/curly.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -256,14 +256,10 @@ Which type of curly brace enforcement to use.
256256

257257
## How to use
258258

259-
To **enable** this rule in the CLI or using the config file, you can use:
259+
To **enable** this rule using the config file or in the CLI, you can use:
260260

261261
::: code-group
262262

263-
```bash [CLI]
264-
oxlint --deny curly
265-
```
266-
267263
```json [Config (.oxlintrc.json)]
268264
{
269265
"rules": {
@@ -272,6 +268,10 @@ oxlint --deny curly
272268
}
273269
```
274270

271+
```bash [CLI]
272+
oxlint --deny curly
273+
```
274+
275275
:::
276276

277277
## References

src/docs/guide/usage/linter/rules/eslint/default-case-last.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,10 @@ switch (foo) {
8383

8484
## How to use
8585

86-
To **enable** this rule in the CLI or using the config file, you can use:
86+
To **enable** this rule using the config file or in the CLI, you can use:
8787

8888
::: code-group
8989

90-
```bash [CLI]
91-
oxlint --deny default-case-last
92-
```
93-
9490
```json [Config (.oxlintrc.json)]
9591
{
9692
"rules": {
@@ -99,6 +95,10 @@ oxlint --deny default-case-last
9995
}
10096
```
10197

98+
```bash [CLI]
99+
oxlint --deny default-case-last
100+
```
101+
102102
:::
103103

104104
## References

src/docs/guide/usage/linter/rules/eslint/default-case.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,10 @@ switch (a) {
101101

102102
## How to use
103103

104-
To **enable** this rule in the CLI or using the config file, you can use:
104+
To **enable** this rule using the config file or in the CLI, you can use:
105105

106106
::: code-group
107107

108-
```bash [CLI]
109-
oxlint --deny default-case
110-
```
111-
112108
```json [Config (.oxlintrc.json)]
113109
{
114110
"rules": {
@@ -117,6 +113,10 @@ oxlint --deny default-case
117113
}
118114
```
119115

116+
```bash [CLI]
117+
oxlint --deny default-case
118+
```
119+
120120
:::
121121

122122
## References

src/docs/guide/usage/linter/rules/eslint/default-param-last.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,10 @@ function combine(a: number, b?: number, c: number = 3) {}
7171

7272
## How to use
7373

74-
To **enable** this rule in the CLI or using the config file, you can use:
74+
To **enable** this rule using the config file or in the CLI, you can use:
7575

7676
::: code-group
7777

78-
```bash [CLI]
79-
oxlint --deny default-param-last
80-
```
81-
8278
```json [Config (.oxlintrc.json)]
8379
{
8480
"rules": {
@@ -87,6 +83,10 @@ oxlint --deny default-param-last
8783
}
8884
```
8985

86+
```bash [CLI]
87+
oxlint --deny default-param-last
88+
```
89+
9090
:::
9191

9292
## References

src/docs/guide/usage/linter/rules/eslint/eqeqeq.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -174,14 +174,10 @@ type: `"always" | "never" | "ignore"`
174174

175175
## How to use
176176

177-
To **enable** this rule in the CLI or using the config file, you can use:
177+
To **enable** this rule using the config file or in the CLI, you can use:
178178

179179
::: code-group
180180

181-
```bash [CLI]
182-
oxlint --deny eqeqeq
183-
```
184-
185181
```json [Config (.oxlintrc.json)]
186182
{
187183
"rules": {
@@ -190,6 +186,10 @@ oxlint --deny eqeqeq
190186
}
191187
```
192188

189+
```bash [CLI]
190+
oxlint --deny eqeqeq
191+
```
192+
193193
:::
194194

195195
## References

0 commit comments

Comments
 (0)