Skip to content

Commit afaa5a4

Browse files
authored
Release 1.34.0 (#713)
Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
1 parent 4ca355d commit afaa5a4

35 files changed

+648
-45
lines changed

โ€Žsrc/docs/guide/usage/formatter/generated-config.mdโ€Ž

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ search: false
66

77
Most options are the same as Prettier's options.
88
See also <https://prettier.io/docs/options>
9-
But some options are our own extensions.
9+
10+
In addition, some options are our own extensions.
1011

1112
## arrowParens
1213

@@ -59,41 +60,45 @@ type: `string[]`
5960

6061
### experimentalSortImports.ignoreCase
6162

62-
type: `boolean`
63+
type: `boolean | null`
6364

64-
default: `true`
65+
Ignore case when sorting. (Default: `true`)
6566

6667
### experimentalSortImports.internalPattern
6768

6869
type: `string[]`
6970

71+
Glob patterns to identify internal imports.
72+
7073
### experimentalSortImports.newlinesBetween
7174

72-
type: `boolean`
75+
type: `boolean | null`
7376

74-
default: `true`
77+
Add newlines between import groups. (Default: `true`)
7578

7679
### experimentalSortImports.order
7780

7881
type: `string | null`
7982

83+
Sort order. (Default: `"asc"`)
84+
8085
### experimentalSortImports.partitionByComment
8186

82-
type: `boolean`
87+
type: `boolean | null`
8388

84-
default: `false`
89+
Partition imports by comments. (Default: `false`)
8590

8691
### experimentalSortImports.partitionByNewline
8792

88-
type: `boolean`
93+
type: `boolean | null`
8994

90-
default: `false`
95+
Partition imports by newlines. (Default: `false`)
9196

9297
### experimentalSortImports.sortSideEffects
9398

94-
type: `boolean`
99+
type: `boolean | null`
95100

96-
default: `false`
101+
Sort side-effect imports. (Default: `false`)
97102

98103
## experimentalSortPackageJson
99104

โ€Žsrc/docs/guide/usage/linter/generated-config.mdโ€Ž

Lines changed: 83 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,12 @@ Example
5050
}
5151
```
5252

53+
## $schema
54+
55+
type: `string | null`
56+
57+
Schema URI for editor tooling.
58+
5359
## categories
5460

5561
type: `object`
@@ -143,13 +149,50 @@ Globs to ignore during linting. These are resolved from the configuration file p
143149

144150
## jsPlugins
145151

146-
type: `string[]`
152+
type: `array | null`
147153

148154
JS plugins.
149155

150156
Note: JS plugins are experimental and not subject to semver.
151157
They are not supported in language server at present.
152158

159+
### jsPlugins[n]
160+
161+
type: `object | string`
162+
163+
#### jsPlugins[n].name
164+
165+
type: `string`
166+
167+
Custom name/alias for the plugin.
168+
169+
Note: The following plugin names are reserved because they are implemented natively in Rust within oxlint and cannot be used for JS plugins:
170+
171+
- react (includes react-hooks)
172+
- unicorn
173+
- typescript
174+
- oxc
175+
- import (includes import-x)
176+
- jsdoc
177+
- jest
178+
- vitest
179+
- jsx-a11y
180+
- nextjs
181+
- react-perf
182+
- promise
183+
- node
184+
- regex
185+
- vue
186+
- eslint
187+
188+
If you need to use the JavaScript version of any of these plugins, provide a custom alias to avoid conflicts.
189+
190+
#### jsPlugins[n].specifier
191+
192+
type: `string`
193+
194+
Path or package name of the plugin
195+
153196
## overrides
154197

155198
type: `array`
@@ -178,13 +221,50 @@ Enabled or disabled specific global variables.
178221

179222
#### overrides[n].jsPlugins
180223

181-
type: `string[]`
224+
type: `array | null`
182225

183226
JS plugins for this override.
184227

185228
Note: JS plugins are experimental and not subject to semver.
186229
They are not supported in language server at present.
187230

231+
##### overrides[n].jsPlugins[n]
232+
233+
type: `object | string`
234+
235+
###### overrides[n].jsPlugins[n].name
236+
237+
type: `string`
238+
239+
Custom name/alias for the plugin.
240+
241+
Note: The following plugin names are reserved because they are implemented natively in Rust within oxlint and cannot be used for JS plugins:
242+
243+
- react (includes react-hooks)
244+
- unicorn
245+
- typescript
246+
- oxc
247+
- import (includes import-x)
248+
- jsdoc
249+
- jest
250+
- vitest
251+
- jsx-a11y
252+
- nextjs
253+
- react-perf
254+
- promise
255+
- node
256+
- regex
257+
- vue
258+
- eslint
259+
260+
If you need to use the JavaScript version of any of these plugins, provide a custom alias to avoid conflicts.
261+
262+
###### overrides[n].jsPlugins[n].specifier
263+
264+
type: `string`
265+
266+
Path or package name of the plugin
267+
188268
#### overrides[n].plugins
189269

190270
type: `array | null`
@@ -504,7 +584,7 @@ type: `object`
504584

505585
Configure Vitest plugin rules.
506586

507-
See [eslint-plugin-vitest](https://github.com/veritem/eslint-plugin-vitest)'s
587+
See [eslint-plugin-vitest](https://github.com/vitest-dev/eslint-plugin-vitest)'s
508588
configuration for a full reference.
509589

510590
#### settings.vitest.typecheck

โ€Žsrc/docs/guide/usage/linter/generated-rules.mdโ€Ž

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ search: false
66

77
The progress of all rule implementations is tracked [here](https://github.com/oxc-project/oxc/issues/481).
88

9-
- Total number of rules: 630
9+
- Total number of rules: 634
1010
- Rules turned on by default: 104
1111

1212
**Legend for 'Fixable?' column:**
@@ -277,7 +277,7 @@ Lints which prevent the use of language and library features. Must not be enable
277277
| [anchor-ambiguous-text](/docs/guide/usage/linter/rules/jsx_a11y/anchor-ambiguous-text.html) | jsx_a11y | | |
278278
| [no-new-require](/docs/guide/usage/linter/rules/node/no-new-require.html) | node | | |
279279
| [no-process-env](/docs/guide/usage/linter/rules/node/no-process-env.html) | node | | |
280-
| [bad-bitwise-operator](/docs/guide/usage/linter/rules/oxc/bad-bitwise-operator.html) | oxc | | ๐Ÿšง |
280+
| [bad-bitwise-operator](/docs/guide/usage/linter/rules/oxc/bad-bitwise-operator.html) | oxc | | ๐Ÿ’ก |
281281
| [no-async-await](/docs/guide/usage/linter/rules/oxc/no-async-await.html) | oxc | | |
282282
| [no-barrel-file](/docs/guide/usage/linter/rules/oxc/no-barrel-file.html) | oxc | | |
283283
| [no-const-enum](/docs/guide/usage/linter/rules/oxc/no-const-enum.html) | oxc | | ๐Ÿ› ๏ธ |
@@ -346,7 +346,7 @@ code that is most likely wrong or useless.
346346
| [no-unassigned-import](/docs/guide/usage/linter/rules/import/no-unassigned-import.html) | import | | |
347347
| [no-commented-out-tests](/docs/guide/usage/linter/rules/jest/no-commented-out-tests.html) | jest | | |
348348
| [approx-constant](/docs/guide/usage/linter/rules/oxc/approx-constant.html) | oxc | | ๐Ÿ’ก |
349-
| [misrefactored-assign-op](/docs/guide/usage/linter/rules/oxc/misrefactored-assign-op.html) | oxc | | ๐Ÿšง |
349+
| [misrefactored-assign-op](/docs/guide/usage/linter/rules/oxc/misrefactored-assign-op.html) | oxc | | ๐Ÿ’ก |
350350
| [no-async-endpoint-handlers](/docs/guide/usage/linter/rules/oxc/no-async-endpoint-handlers.html) | oxc | | |
351351
| [no-this-in-exported-function](/docs/guide/usage/linter/rules/oxc/no-this-in-exported-function.html) | oxc | | |
352352
| [always-return](/docs/guide/usage/linter/rules/promise/always-return.html) | promise | | |
@@ -378,7 +378,7 @@ code that is most likely wrong or useless.
378378
| [no-required-prop-with-default](/docs/guide/usage/linter/rules/vue/no-required-prop-with-default.html) | vue | | ๐Ÿšง |
379379
| [require-default-export](/docs/guide/usage/linter/rules/vue/require-default-export.html) | vue | | |
380380

381-
## Pedantic (111):
381+
## Pedantic (112):
382382

383383
Lints which are rather strict or have occasional false positives.
384384
| Rule name | Source | Default | Fixable? |
@@ -396,6 +396,7 @@ Lints which are rather strict or have occasional false positives.
396396
| [no-constructor-return](/docs/guide/usage/linter/rules/eslint/no-constructor-return.html) | eslint | | |
397397
| [no-else-return](/docs/guide/usage/linter/rules/eslint/no-else-return.html) | eslint | | ๐Ÿ› ๏ธ |
398398
| [no-fallthrough](/docs/guide/usage/linter/rules/eslint/no-fallthrough.html) | eslint | | ๐Ÿšง |
399+
| [no-inline-comments](/docs/guide/usage/linter/rules/eslint/no-inline-comments.html) | eslint | | |
399400
| [no-inner-declarations](/docs/guide/usage/linter/rules/eslint/no-inner-declarations.html) | eslint | | |
400401
| [no-lonely-if](/docs/guide/usage/linter/rules/eslint/no-lonely-if.html) | eslint | | ๐Ÿšง |
401402
| [no-loop-func](/docs/guide/usage/linter/rules/eslint/no-loop-func.html) | eslint | | |
@@ -440,7 +441,7 @@ Lints which are rather strict or have occasional false positives.
440441
| [no-unsafe-member-access](/docs/guide/usage/linter/rules/typescript/no-unsafe-member-access.html) | typescript | | ๐Ÿšง |
441442
| [no-unsafe-return](/docs/guide/usage/linter/rules/typescript/no-unsafe-return.html) | typescript | | ๐Ÿšง |
442443
| [only-throw-error](/docs/guide/usage/linter/rules/typescript/only-throw-error.html) | typescript | | ๐Ÿšง |
443-
| [prefer-enum-initializers](/docs/guide/usage/linter/rules/typescript/prefer-enum-initializers.html) | typescript | | ๐Ÿšง |
444+
| [prefer-enum-initializers](/docs/guide/usage/linter/rules/typescript/prefer-enum-initializers.html) | typescript | | ๐Ÿ’ก |
444445
| [prefer-includes](/docs/guide/usage/linter/rules/typescript/prefer-includes.html) | typescript | | ๐Ÿšง |
445446
| [prefer-nullish-coalescing](/docs/guide/usage/linter/rules/typescript/prefer-nullish-coalescing.html) | typescript | | ๐Ÿšง |
446447
| [prefer-promise-reject-errors](/docs/guide/usage/linter/rules/typescript/prefer-promise-reject-errors.html) | typescript | | ๐Ÿšง |
@@ -460,13 +461,13 @@ Lints which are rather strict or have occasional false positives.
460461
| [no-hex-escape](/docs/guide/usage/linter/rules/unicorn/no-hex-escape.html) | unicorn | | ๐Ÿ› ๏ธ |
461462
| [no-instanceof-array](/docs/guide/usage/linter/rules/unicorn/no-instanceof-array.html) | unicorn | | ๐Ÿ› ๏ธ |
462463
| [no-lonely-if](/docs/guide/usage/linter/rules/unicorn/no-lonely-if.html) | unicorn | | |
463-
| [no-negation-in-equality-check](/docs/guide/usage/linter/rules/unicorn/no-negation-in-equality-check.html) | unicorn | | ๐Ÿšง |
464+
| [no-negation-in-equality-check](/docs/guide/usage/linter/rules/unicorn/no-negation-in-equality-check.html) | unicorn | | ๐Ÿ’ก |
464465
| [no-new-buffer](/docs/guide/usage/linter/rules/unicorn/no-new-buffer.html) | unicorn | | ๐Ÿšง |
465466
| [no-object-as-default-parameter](/docs/guide/usage/linter/rules/unicorn/no-object-as-default-parameter.html) | unicorn | | |
466467
| [no-static-only-class](/docs/guide/usage/linter/rules/unicorn/no-static-only-class.html) | unicorn | | โš ๏ธ๐Ÿ› ๏ธ๏ธ |
467468
| [no-this-assignment](/docs/guide/usage/linter/rules/unicorn/no-this-assignment.html) | unicorn | | |
468469
| [no-typeof-undefined](/docs/guide/usage/linter/rules/unicorn/no-typeof-undefined.html) | unicorn | | ๐Ÿšง |
469-
| [no-unnecessary-array-flat-depth](/docs/guide/usage/linter/rules/unicorn/no-unnecessary-array-flat-depth.html) | unicorn | | ๐Ÿšง |
470+
| [no-unnecessary-array-flat-depth](/docs/guide/usage/linter/rules/unicorn/no-unnecessary-array-flat-depth.html) | unicorn | | ๐Ÿ’ก |
470471
| [no-unnecessary-array-splice-count](/docs/guide/usage/linter/rules/unicorn/no-unnecessary-array-splice-count.html) | unicorn | | ๐Ÿ› ๏ธ |
471472
| [no-unnecessary-slice-end](/docs/guide/usage/linter/rules/unicorn/no-unnecessary-slice-end.html) | unicorn | | ๐Ÿ› ๏ธ |
472473
| [no-unreadable-iife](/docs/guide/usage/linter/rules/unicorn/no-unreadable-iife.html) | unicorn | | |
@@ -495,12 +496,13 @@ Lints which are rather strict or have occasional false positives.
495496
| [prefer-type-error](/docs/guide/usage/linter/rules/unicorn/prefer-type-error.html) | unicorn | | ๐Ÿ› ๏ธ |
496497
| [require-number-to-fixed-digits-argument](/docs/guide/usage/linter/rules/unicorn/require-number-to-fixed-digits-argument.html) | unicorn | | ๐Ÿ› ๏ธ |
497498

498-
## Style (173):
499+
## Style (176):
499500

500501
Code that should be written in a more idiomatic way.
501502
| Rule name | Source | Default | Fixable? |
502503
| ------------------------------------ | ---------- | ------- | -------- |
503504
| [arrow-body-style](/docs/guide/usage/linter/rules/eslint/arrow-body-style.html) | eslint | | ๐Ÿ› ๏ธ |
505+
| [capitalized-comments](/docs/guide/usage/linter/rules/eslint/capitalized-comments.html) | eslint | | ๐Ÿ› ๏ธ |
504506
| [curly](/docs/guide/usage/linter/rules/eslint/curly.html) | eslint | | ๐Ÿ› ๏ธ |
505507
| [default-case-last](/docs/guide/usage/linter/rules/eslint/default-case-last.html) | eslint | | |
506508
| [default-param-last](/docs/guide/usage/linter/rules/eslint/default-param-last.html) | eslint | | |
@@ -574,7 +576,7 @@ Code that should be written in a more idiomatic way.
574576
| [no-test-return-statement](/docs/guide/usage/linter/rules/jest/no-test-return-statement.html) | jest | | |
575577
| [no-untyped-mock-factory](/docs/guide/usage/linter/rules/jest/no-untyped-mock-factory.html) | jest | | ๐Ÿ› ๏ธ |
576578
| [padding-around-test-blocks](/docs/guide/usage/linter/rules/jest/padding-around-test-blocks.html) | jest | | ๐Ÿ› ๏ธ |
577-
| [prefer-called-with](/docs/guide/usage/linter/rules/jest/prefer-called-with.html) | jest | | |
579+
| [prefer-called-with](/docs/guide/usage/linter/rules/jest/prefer-called-with.html) | jest | | ๐Ÿ› ๏ธ |
578580
| [prefer-comparison-matcher](/docs/guide/usage/linter/rules/jest/prefer-comparison-matcher.html) | jest | | ๐Ÿ› ๏ธ |
579581
| [prefer-each](/docs/guide/usage/linter/rules/jest/prefer-each.html) | jest | | |
580582
| [prefer-equality-matcher](/docs/guide/usage/linter/rules/jest/prefer-equality-matcher.html) | jest | | |
@@ -588,6 +590,8 @@ Code that should be written in a more idiomatic way.
588590
| [prefer-strict-equal](/docs/guide/usage/linter/rules/jest/prefer-strict-equal.html) | jest | | ๐Ÿ› ๏ธ |
589591
| [prefer-to-be](/docs/guide/usage/linter/rules/jest/prefer-to-be.html) | jest | | ๐Ÿ› ๏ธ |
590592
| [prefer-to-contain](/docs/guide/usage/linter/rules/jest/prefer-to-contain.html) | jest | | ๐Ÿ› ๏ธ |
593+
| [prefer-to-have-been-called](/docs/guide/usage/linter/rules/jest/prefer-to-have-been-called.html) | jest | | ๐Ÿ› ๏ธ |
594+
| [prefer-to-have-been-called-times](/docs/guide/usage/linter/rules/jest/prefer-to-have-been-called-times.html) | jest | | ๐Ÿ› ๏ธ |
591595
| [prefer-to-have-length](/docs/guide/usage/linter/rules/jest/prefer-to-have-length.html) | jest | | ๐Ÿ› ๏ธ |
592596
| [prefer-todo](/docs/guide/usage/linter/rules/jest/prefer-todo.html) | jest | | ๐Ÿ› ๏ธ |
593597
| [require-hook](/docs/guide/usage/linter/rules/jest/require-hook.html) | jest | | |
@@ -619,7 +623,7 @@ Code that should be written in a more idiomatic way.
619623
| [consistent-type-definitions](/docs/guide/usage/linter/rules/typescript/consistent-type-definitions.html) | typescript | | โš ๏ธ๐Ÿ› ๏ธ๏ธ |
620624
| [consistent-type-imports](/docs/guide/usage/linter/rules/typescript/consistent-type-imports.html) | typescript | | ๐Ÿ› ๏ธ |
621625
| [no-empty-interface](/docs/guide/usage/linter/rules/typescript/no-empty-interface.html) | typescript | | |
622-
| [no-inferrable-types](/docs/guide/usage/linter/rules/typescript/no-inferrable-types.html) | typescript | | ๐Ÿšง |
626+
| [no-inferrable-types](/docs/guide/usage/linter/rules/typescript/no-inferrable-types.html) | typescript | | ๐Ÿ’ก |
623627
| [prefer-for-of](/docs/guide/usage/linter/rules/typescript/prefer-for-of.html) | typescript | | ๐Ÿšง |
624628
| [prefer-function-type](/docs/guide/usage/linter/rules/typescript/prefer-function-type.html) | typescript | | ๐Ÿ› ๏ธ |
625629
| [prefer-namespace-keyword](/docs/guide/usage/linter/rules/typescript/prefer-namespace-keyword.html) | typescript | | ๐Ÿ› ๏ธ |

0 commit comments

Comments
ย (0)