diff --git a/.vitepress/data/rules.json b/.vitepress/data/rules.json index e04eedb0ec7..a9eda307591 100644 --- a/.vitepress/data/rules.json +++ b/.vitepress/data/rules.json @@ -4922,6 +4922,15 @@ "default": false, "docs_url": "https://oxc.rs/docs/guide/usage/linter/rules/unicorn/consistent-function-scoping.html" }, + { + "scope": "unicorn", + "value": "custom-error-definition", + "category": "style", + "type_aware": false, + "fix": "pending", + "default": false, + "docs_url": "https://oxc.rs/docs/guide/usage/linter/rules/unicorn/custom-error-definition.html" + }, { "scope": "unicorn", "value": "empty-brace-spaces", @@ -6092,6 +6101,15 @@ "default": false, "docs_url": "https://oxc.rs/docs/guide/usage/linter/rules/vitest/prefer-import-in-mock.html" }, + { + "scope": "vitest", + "value": "prefer-strict-boolean-matchers", + "category": "style", + "type_aware": false, + "fix": "fixable_fix", + "default": false, + "docs_url": "https://oxc.rs/docs/guide/usage/linter/rules/vitest/prefer-strict-boolean-matchers.html" + }, { "scope": "vitest", "value": "prefer-to-be-falsy", diff --git a/src/docs/guide/usage/formatter/generated-config.md b/src/docs/guide/usage/formatter/generated-config.md index 227249cfff5..6d328e3d4ef 100644 --- a/src/docs/guide/usage/formatter/generated-config.md +++ b/src/docs/guide/usage/formatter/generated-config.md @@ -79,6 +79,115 @@ Whether to insert a final newline at the end of the file. - Default: `true` - Overrides `.editorconfig.insert_final_newline` +## jsdoc + +type: `object` + +Enable JSDoc comment formatting. + +When enabled, JSDoc comments are normalized and reformatted: +tag aliases are canonicalized, descriptions are capitalized, +long lines are wrapped, and short comments are collapsed to single-line. + +Pass an object (`jsdoc: {}`) to enable with defaults, or omit to disable. + +- Default: Disabled + +### jsdoc.addDefaultToDescription + +type: `boolean` + +Append default values to `@param` descriptions (e.g. "Default is `value`"). + +- Default: `true` + +### jsdoc.bracketSpacing + +type: `boolean` + +Add spaces inside JSDoc type braces: `{string}` → `{ string }`. + +- Default: `false` + +### jsdoc.capitalizeDescriptions + +type: `boolean` + +Capitalize the first letter of tag descriptions. + +- Default: `true` + +### jsdoc.commentLineStrategy + +type: `string` + +How to format comment blocks. + +- `"singleLine"` — Convert to single-line `/** content */` when possible. +- `"multiline"` — Always use multi-line format. +- `"keep"` — Preserve original formatting. + +- Default: `"singleLine"` + +### jsdoc.descriptionTag + +type: `boolean` + +Emit `@description` tag instead of inline description. + +- Default: `false` + +### jsdoc.descriptionWithDot + +type: `boolean` + +Add a trailing dot to the end of descriptions. + +- Default: `false` + +### jsdoc.keepUnparsableExampleIndent + +type: `boolean` + +Preserve indentation in unparsable `@example` code. + +- Default: `false` + +### jsdoc.lineWrappingStyle + +type: `string` + +Strategy for wrapping description lines at print width. + +- `"greedy"` — Always re-wrap text to fit within print width. +- `"balance"` — Preserve original line breaks if all lines fit within print width. + +- Default: `"greedy"` + +### jsdoc.preferCodeFences + +type: `boolean` + +Use fenced code blocks (` ``` `) instead of 4-space indentation for code without a language tag. + +- Default: `false` + +### jsdoc.separateReturnsFromParam + +type: `boolean` + +Add a blank line between the last `@param` and `@returns`. + +- Default: `false` + +### jsdoc.separateTagGroups + +type: `boolean` + +Add blank lines between different tag groups (e.g. between `@param` and `@returns`). + +- Default: `false` + ## jsxSingleQuote type: `boolean` @@ -191,6 +300,115 @@ Whether to insert a final newline at the end of the file. - Default: `true` - Overrides `.editorconfig.insert_final_newline` +##### overrides[n].options.jsdoc + +type: `object` + +Enable JSDoc comment formatting. + +When enabled, JSDoc comments are normalized and reformatted: +tag aliases are canonicalized, descriptions are capitalized, +long lines are wrapped, and short comments are collapsed to single-line. + +Pass an object (`jsdoc: {}`) to enable with defaults, or omit to disable. + +- Default: Disabled + +###### overrides[n].options.jsdoc.addDefaultToDescription + +type: `boolean` + +Append default values to `@param` descriptions (e.g. "Default is `value`"). + +- Default: `true` + +###### overrides[n].options.jsdoc.bracketSpacing + +type: `boolean` + +Add spaces inside JSDoc type braces: `{string}` → `{ string }`. + +- Default: `false` + +###### overrides[n].options.jsdoc.capitalizeDescriptions + +type: `boolean` + +Capitalize the first letter of tag descriptions. + +- Default: `true` + +###### overrides[n].options.jsdoc.commentLineStrategy + +type: `string` + +How to format comment blocks. + +- `"singleLine"` — Convert to single-line `/** content */` when possible. +- `"multiline"` — Always use multi-line format. +- `"keep"` — Preserve original formatting. + +- Default: `"singleLine"` + +###### overrides[n].options.jsdoc.descriptionTag + +type: `boolean` + +Emit `@description` tag instead of inline description. + +- Default: `false` + +###### overrides[n].options.jsdoc.descriptionWithDot + +type: `boolean` + +Add a trailing dot to the end of descriptions. + +- Default: `false` + +###### overrides[n].options.jsdoc.keepUnparsableExampleIndent + +type: `boolean` + +Preserve indentation in unparsable `@example` code. + +- Default: `false` + +###### overrides[n].options.jsdoc.lineWrappingStyle + +type: `string` + +Strategy for wrapping description lines at print width. + +- `"greedy"` — Always re-wrap text to fit within print width. +- `"balance"` — Preserve original line breaks if all lines fit within print width. + +- Default: `"greedy"` + +###### overrides[n].options.jsdoc.preferCodeFences + +type: `boolean` + +Use fenced code blocks (` ``` `) instead of 4-space indentation for code without a language tag. + +- Default: `false` + +###### overrides[n].options.jsdoc.separateReturnsFromParam + +type: `boolean` + +Add a blank line between the last `@param` and `@returns`. + +- Default: `false` + +###### overrides[n].options.jsdoc.separateTagGroups + +type: `boolean` + +Add blank lines between different tag groups (e.g. between `@param` and `@returns`). + +- Default: `false` + ##### overrides[n].options.jsxSingleQuote type: `boolean` diff --git a/src/docs/guide/usage/linter/rules/eslint/accessor-pairs.md b/src/docs/guide/usage/linter/rules/eslint/accessor-pairs.md index 134023dc495..70471e66822 100644 --- a/src/docs/guide/usage/linter/rules/eslint/accessor-pairs.md +++ b/src/docs/guide/usage/linter/rules/eslint/accessor-pairs.md @@ -103,24 +103,8 @@ Report a setter without a getter. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "accessor-pairs": "error" - } -} -``` - -```bash [CLI] -oxlint --deny accessor-pairs -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/array-callback-return.md b/src/docs/guide/usage/linter/rules/eslint/array-callback-return.md index 41c0f9e76dc..f659991fd8c 100644 --- a/src/docs/guide/usage/linter/rules/eslint/array-callback-return.md +++ b/src/docs/guide/usage/linter/rules/eslint/array-callback-return.md @@ -79,24 +79,8 @@ When set to true, rule will also report forEach callbacks that return a value. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "array-callback-return": "error" - } -} -``` - -```bash [CLI] -oxlint --deny array-callback-return -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/arrow-body-style.md b/src/docs/guide/usage/linter/rules/eslint/arrow-body-style.md index 20b3a53dfd3..60cc2be94c4 100644 --- a/src/docs/guide/usage/linter/rules/eslint/arrow-body-style.md +++ b/src/docs/guide/usage/linter/rules/eslint/arrow-body-style.md @@ -178,24 +178,8 @@ default: `false` ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "arrow-body-style": "error" - } -} -``` - -```bash [CLI] -oxlint --deny arrow-body-style -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/block-scoped-var.md b/src/docs/guide/usage/linter/rules/eslint/block-scoped-var.md index 8c77d63acc4..5af748b3f57 100644 --- a/src/docs/guide/usage/linter/rules/eslint/block-scoped-var.md +++ b/src/docs/guide/usage/linter/rules/eslint/block-scoped-var.md @@ -108,24 +108,8 @@ function doTry() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "block-scoped-var": "error" - } -} -``` - -```bash [CLI] -oxlint --deny block-scoped-var -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/capitalized-comments.md b/src/docs/guide/usage/linter/rules/eslint/capitalized-comments.md index aa4b5121634..61056d44d19 100644 --- a/src/docs/guide/usage/linter/rules/eslint/capitalized-comments.md +++ b/src/docs/guide/usage/linter/rules/eslint/capitalized-comments.md @@ -125,24 +125,8 @@ A regex pattern. Comments that match the pattern will not cause violations. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "capitalized-comments": "error" - } -} -``` - -```bash [CLI] -oxlint --deny capitalized-comments -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/class-methods-use-this.md b/src/docs/guide/usage/linter/rules/eslint/class-methods-use-this.md index 4d7af40ec7a..cdf863b3125 100644 --- a/src/docs/guide/usage/linter/rules/eslint/class-methods-use-this.md +++ b/src/docs/guide/usage/linter/rules/eslint/class-methods-use-this.md @@ -113,24 +113,8 @@ Whether to ignore methods that are overridden. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "class-methods-use-this": "error" - } -} -``` - -```bash [CLI] -oxlint --deny class-methods-use-this -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/complexity.md b/src/docs/guide/usage/linter/rules/eslint/complexity.md index 21785b02101..2bd70d56cfd 100644 --- a/src/docs/guide/usage/linter/rules/eslint/complexity.md +++ b/src/docs/guide/usage/linter/rules/eslint/complexity.md @@ -118,24 +118,8 @@ complexity by 1 irrespective of the number of `case` statements ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "complexity": "error" - } -} -``` - -```bash [CLI] -oxlint --deny complexity -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/constructor-super.md b/src/docs/guide/usage/linter/rules/eslint/constructor-super.md index 000c29d0430..d960a61f605 100644 --- a/src/docs/guide/usage/linter/rules/eslint/constructor-super.md +++ b/src/docs/guide/usage/linter/rules/eslint/constructor-super.md @@ -85,24 +85,8 @@ class C extends D { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "constructor-super": "error" - } -} -``` - -```bash [CLI] -oxlint --deny constructor-super -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/curly.md b/src/docs/guide/usage/linter/rules/eslint/curly.md index 7dbe84637ca..c888fa91ad9 100644 --- a/src/docs/guide/usage/linter/rules/eslint/curly.md +++ b/src/docs/guide/usage/linter/rules/eslint/curly.md @@ -65,10 +65,13 @@ Examples of **incorrect** code for this rule with the `"multi"` option: ```js /* curly: ["error", "multi"] */ -if (foo) foo(); +if (foo) { + foo(); +} + +if (foo) bar(); else { - bar(); - baz(); + foo(); } ``` @@ -91,7 +94,7 @@ Examples of **incorrect** code for this rule with the `"multi-line"` option: if (foo) foo(); else bar(); -while (foo) foo(); +if (foo) foo(bar, baz); ``` Examples of **correct** code for this rule with the `"multi-line"` option: @@ -117,9 +120,13 @@ Examples of **incorrect** code for this rule with the `"multi-or-nest"` option: ```js /* curly: ["error", "multi-or-nest"] */ -if (foo) if (bar) bar(); +while (true) + if (foo) foo(); + else bar(); -while (foo) while (bar) bar(); +if (foo) { + foo++; +} ``` Examples of **correct** code for this rule with the `"multi-or-nest"` option: @@ -260,24 +267,8 @@ Require braces when the block is nested or spans multiple lines ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "curly": "error" - } -} -``` - -```bash [CLI] -oxlint --deny curly -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/default-case-last.md b/src/docs/guide/usage/linter/rules/eslint/default-case-last.md index 8b4bdbaace9..26d5baf8014 100644 --- a/src/docs/guide/usage/linter/rules/eslint/default-case-last.md +++ b/src/docs/guide/usage/linter/rules/eslint/default-case-last.md @@ -84,24 +84,8 @@ switch (foo) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "default-case-last": "error" - } -} -``` - -```bash [CLI] -oxlint --deny default-case-last -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/default-case.md b/src/docs/guide/usage/linter/rules/eslint/default-case.md index b78495977f7..9a18716bd78 100644 --- a/src/docs/guide/usage/linter/rules/eslint/default-case.md +++ b/src/docs/guide/usage/linter/rules/eslint/default-case.md @@ -100,24 +100,8 @@ switch (a) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "default-case": "error" - } -} -``` - -```bash [CLI] -oxlint --deny default-case -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/default-param-last.md b/src/docs/guide/usage/linter/rules/eslint/default-param-last.md index d7d872e7616..d4d82e5fc01 100644 --- a/src/docs/guide/usage/linter/rules/eslint/default-param-last.md +++ b/src/docs/guide/usage/linter/rules/eslint/default-param-last.md @@ -72,24 +72,8 @@ function combine(a: number, b?: number, c: number = 3) {} ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "default-param-last": "error" - } -} -``` - -```bash [CLI] -oxlint --deny default-param-last -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/eqeqeq.md b/src/docs/guide/usage/linter/rules/eslint/eqeqeq.md index 5d617b7e1aa..80445b6fb51 100644 --- a/src/docs/guide/usage/linter/rules/eslint/eqeqeq.md +++ b/src/docs/guide/usage/linter/rules/eslint/eqeqeq.md @@ -203,24 +203,8 @@ Ignore null comparisons, allow either `== null`/`!= null` or `=== null`/`!== nul ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "eqeqeq": "error" - } -} -``` - -```bash [CLI] -oxlint --deny eqeqeq -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/for-direction.md b/src/docs/guide/usage/linter/rules/eslint/for-direction.md index 62303eb976e..2ca22b883b4 100644 --- a/src/docs/guide/usage/linter/rules/eslint/for-direction.md +++ b/src/docs/guide/usage/linter/rules/eslint/for-direction.md @@ -67,24 +67,8 @@ for (let i = MIN; i <= MAX; i -= 0) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "for-direction": "error" - } -} -``` - -```bash [CLI] -oxlint --deny for-direction -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/func-names.md b/src/docs/guide/usage/linter/rules/eslint/func-names.md index 9728dcad8a9..c5f0812f652 100644 --- a/src/docs/guide/usage/linter/rules/eslint/func-names.md +++ b/src/docs/guide/usage/linter/rules/eslint/func-names.md @@ -226,24 +226,8 @@ function* foobar(i) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "func-names": "error" - } -} -``` - -```bash [CLI] -oxlint --deny func-names -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/func-style.md b/src/docs/guide/usage/linter/rules/eslint/func-style.md index 6155ff0da86..5ba47539410 100644 --- a/src/docs/guide/usage/linter/rules/eslint/func-style.md +++ b/src/docs/guide/usage/linter/rules/eslint/func-style.md @@ -184,24 +184,8 @@ default: `null` ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "func-style": "error" - } -} -``` - -```bash [CLI] -oxlint --deny func-style -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/getter-return.md b/src/docs/guide/usage/linter/rules/eslint/getter-return.md index 46cf2212629..a19bd89f734 100644 --- a/src/docs/guide/usage/linter/rules/eslint/getter-return.md +++ b/src/docs/guide/usage/linter/rules/eslint/getter-return.md @@ -68,24 +68,8 @@ When set to `true`, allows getters to implicitly return `undefined` with a `retu ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "getter-return": "error" - } -} -``` - -```bash [CLI] -oxlint --deny getter-return -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/grouped-accessor-pairs.md b/src/docs/guide/usage/linter/rules/eslint/grouped-accessor-pairs.md index 7fbeb90a200..584b5ca54d5 100644 --- a/src/docs/guide/usage/linter/rules/eslint/grouped-accessor-pairs.md +++ b/src/docs/guide/usage/linter/rules/eslint/grouped-accessor-pairs.md @@ -171,24 +171,8 @@ type Bar = { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "grouped-accessor-pairs": "error" - } -} -``` - -```bash [CLI] -oxlint --deny grouped-accessor-pairs -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/guard-for-in.md b/src/docs/guide/usage/linter/rules/eslint/guard-for-in.md index 8ff0558ace4..5aa324cb154 100644 --- a/src/docs/guide/usage/linter/rules/eslint/guard-for-in.md +++ b/src/docs/guide/usage/linter/rules/eslint/guard-for-in.md @@ -63,24 +63,8 @@ for (key in foo) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "guard-for-in": "error" - } -} -``` - -```bash [CLI] -oxlint --deny guard-for-in -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/id-length.md b/src/docs/guide/usage/linter/rules/eslint/id-length.md index 11384a78b9a..0399c277817 100644 --- a/src/docs/guide/usage/linter/rules/eslint/id-length.md +++ b/src/docs/guide/usage/linter/rules/eslint/id-length.md @@ -181,24 +181,8 @@ When set to `"always"` (default), property names are checked just like other ide ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "id-length": "error" - } -} -``` - -```bash [CLI] -oxlint --deny id-length -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/init-declarations.md b/src/docs/guide/usage/linter/rules/eslint/init-declarations.md index be813eff759..a5fe78d84a2 100644 --- a/src/docs/guide/usage/linter/rules/eslint/init-declarations.md +++ b/src/docs/guide/usage/linter/rules/eslint/init-declarations.md @@ -117,24 +117,8 @@ Only applies when mode is set to `"never"`. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "init-declarations": "error" - } -} -``` - -```bash [CLI] -oxlint --deny init-declarations -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/max-classes-per-file.md b/src/docs/guide/usage/linter/rules/eslint/max-classes-per-file.md index 374fd8a56ce..a93ee89896d 100644 --- a/src/docs/guide/usage/linter/rules/eslint/max-classes-per-file.md +++ b/src/docs/guide/usage/linter/rules/eslint/max-classes-per-file.md @@ -65,24 +65,8 @@ The maximum number of classes allowed per file. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "max-classes-per-file": "error" - } -} -``` - -```bash [CLI] -oxlint --deny max-classes-per-file -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/max-depth.md b/src/docs/guide/usage/linter/rules/eslint/max-depth.md index 4be685d5338..643f2d8a35b 100644 --- a/src/docs/guide/usage/linter/rules/eslint/max-depth.md +++ b/src/docs/guide/usage/linter/rules/eslint/max-depth.md @@ -89,24 +89,8 @@ The `max` enforces a maximum depth that blocks can be nested ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "max-depth": "error" - } -} -``` - -```bash [CLI] -oxlint --deny max-depth -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/max-lines-per-function.md b/src/docs/guide/usage/linter/rules/eslint/max-lines-per-function.md index e61a4689c61..8c30a847734 100644 --- a/src/docs/guide/usage/linter/rules/eslint/max-lines-per-function.md +++ b/src/docs/guide/usage/linter/rules/eslint/max-lines-per-function.md @@ -102,24 +102,8 @@ Skip lines containing just comments. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "max-lines-per-function": "error" - } -} -``` - -```bash [CLI] -oxlint --deny max-lines-per-function -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/max-lines.md b/src/docs/guide/usage/linter/rules/eslint/max-lines.md index 5d1d03630cc..2e61df1dae6 100644 --- a/src/docs/guide/usage/linter/rules/eslint/max-lines.md +++ b/src/docs/guide/usage/linter/rules/eslint/max-lines.md @@ -57,24 +57,8 @@ Whether to ignore comments when counting. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "max-lines": "error" - } -} -``` - -```bash [CLI] -oxlint --deny max-lines -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/max-nested-callbacks.md b/src/docs/guide/usage/linter/rules/eslint/max-nested-callbacks.md index 2cefabbb993..ad80ca1947e 100644 --- a/src/docs/guide/usage/linter/rules/eslint/max-nested-callbacks.md +++ b/src/docs/guide/usage/linter/rules/eslint/max-nested-callbacks.md @@ -80,24 +80,8 @@ The `max` enforces a maximum depth that callbacks can be nested. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "max-nested-callbacks": "error" - } -} -``` - -```bash [CLI] -oxlint --deny max-nested-callbacks -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/max-params.md b/src/docs/guide/usage/linter/rules/eslint/max-params.md index b838ce37be0..1064650bfb2 100644 --- a/src/docs/guide/usage/linter/rules/eslint/max-params.md +++ b/src/docs/guide/usage/linter/rules/eslint/max-params.md @@ -91,24 +91,8 @@ Maximum number of parameters allowed in function definitions. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "max-params": "error" - } -} -``` - -```bash [CLI] -oxlint --deny max-params -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/max-statements.md b/src/docs/guide/usage/linter/rules/eslint/max-statements.md index 939383edece..3e8a4a62ecf 100644 --- a/src/docs/guide/usage/linter/rules/eslint/max-statements.md +++ b/src/docs/guide/usage/linter/rules/eslint/max-statements.md @@ -175,24 +175,8 @@ Maximum number of statements allowed per function. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "max-statements": "error" - } -} -``` - -```bash [CLI] -oxlint --deny max-statements -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/new-cap.md b/src/docs/guide/usage/linter/rules/eslint/new-cap.md index 717453cbf1e..5e286254437 100644 --- a/src/docs/guide/usage/linter/rules/eslint/new-cap.md +++ b/src/docs/guide/usage/linter/rules/eslint/new-cap.md @@ -385,24 +385,8 @@ default: `true` ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "new-cap": "error" - } -} -``` - -```bash [CLI] -oxlint --deny new-cap -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-alert.md b/src/docs/guide/usage/linter/rules/eslint/no-alert.md index ce7cff341fc..c7578059428 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-alert.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-alert.md @@ -53,24 +53,8 @@ function foo() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-alert": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-alert -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-array-constructor.md b/src/docs/guide/usage/linter/rules/eslint/no-array-constructor.md index 1651a3e1619..9b0fa827daa 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-array-constructor.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-array-constructor.md @@ -46,24 +46,8 @@ let arr3 = new Array(9); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-array-constructor": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-array-constructor -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-async-promise-executor.md b/src/docs/guide/usage/linter/rules/eslint/no-async-promise-executor.md index ad164d78d23..da8034f24af 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-async-promise-executor.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-async-promise-executor.md @@ -83,24 +83,8 @@ const result = Promise.resolve(foo); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-async-promise-executor": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-async-promise-executor -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-await-in-loop.md b/src/docs/guide/usage/linter/rules/eslint/no-await-in-loop.md index fb06cd31a2f..eef1b26ad88 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-await-in-loop.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-await-in-loop.md @@ -46,24 +46,8 @@ async function good() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-await-in-loop": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-await-in-loop -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-bitwise.md b/src/docs/guide/usage/linter/rules/eslint/no-bitwise.md index f3e75aa7280..122c6a378df 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-bitwise.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-bitwise.md @@ -91,24 +91,8 @@ const b = a | 0; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-bitwise": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-bitwise -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-caller.md b/src/docs/guide/usage/linter/rules/eslint/no-caller.md index 58c1cfe9ecb..39b93342f7e 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-caller.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-caller.md @@ -74,24 +74,8 @@ function foo(n) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-caller": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-caller -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-case-declarations.md b/src/docs/guide/usage/linter/rules/eslint/no-case-declarations.md index 272da70a8d5..7923717e9c1 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-case-declarations.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-case-declarations.md @@ -69,24 +69,8 @@ switch (foo) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-case-declarations": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-case-declarations -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-class-assign.md b/src/docs/guide/usage/linter/rules/eslint/no-class-assign.md index b2815ceb293..760af13fcc8 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-class-assign.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-class-assign.md @@ -83,24 +83,8 @@ class A { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-class-assign": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-class-assign -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-compare-neg-zero.md b/src/docs/guide/usage/linter/rules/eslint/no-compare-neg-zero.md index c7580d1fe2b..bc79a2b19ed 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-compare-neg-zero.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-compare-neg-zero.md @@ -63,24 +63,8 @@ if (0 > x) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-compare-neg-zero": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-compare-neg-zero -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-cond-assign.md b/src/docs/guide/usage/linter/rules/eslint/no-cond-assign.md index 916e7b64ead..fab154541b1 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-cond-assign.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-cond-assign.md @@ -63,24 +63,8 @@ Disallow all assignments in conditional expressions. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-cond-assign": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-cond-assign -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-console.md b/src/docs/guide/usage/linter/rules/eslint/no-console.md index cac22d8d9b4..f457eaed559 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-console.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-console.md @@ -74,24 +74,8 @@ console.info("foo"); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-console": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-console -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-const-assign.md b/src/docs/guide/usage/linter/rules/eslint/no-const-assign.md index 17313f40af4..442a671cbf8 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-const-assign.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-const-assign.md @@ -51,24 +51,8 @@ b += 1; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-const-assign": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-const-assign -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-constant-binary-expression.md b/src/docs/guide/usage/linter/rules/eslint/no-constant-binary-expression.md index e4bc441f240..4fbd948f958 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-constant-binary-expression.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-constant-binary-expression.md @@ -57,24 +57,8 @@ const isEmpty = x.length === 0; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-constant-binary-expression": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-constant-binary-expression -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-constant-condition.md b/src/docs/guide/usage/linter/rules/eslint/no-constant-condition.md index 8c6ecce0c90..df7aeb61e48 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-constant-condition.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-constant-condition.md @@ -80,24 +80,8 @@ Configuration option to specify whether to check for constant conditions in loop ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-constant-condition": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-constant-condition -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-constructor-return.md b/src/docs/guide/usage/linter/rules/eslint/no-constructor-return.md index 96614d2fbf4..97487efc60e 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-constructor-return.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-constructor-return.md @@ -48,24 +48,8 @@ class C { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-constructor-return": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-constructor-return -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-continue.md b/src/docs/guide/usage/linter/rules/eslint/no-continue.md index 202c20114d6..f712af7840f 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-continue.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-continue.md @@ -54,24 +54,8 @@ for (i = 0; i < 10; i++) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-continue": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-continue -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-control-regex.md b/src/docs/guide/usage/linter/rules/eslint/no-control-regex.md index 0b9794a473e..0fbce36aba7 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-control-regex.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-control-regex.md @@ -56,24 +56,8 @@ var pattern8 = new RegExp("\\n"); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-control-regex": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-control-regex -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-debugger.md b/src/docs/guide/usage/linter/rules/eslint/no-debugger.md index efb4684cb21..34fa982bdf6 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-debugger.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-debugger.md @@ -47,24 +47,8 @@ async function main() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-debugger": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-debugger -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-delete-var.md b/src/docs/guide/usage/linter/rules/eslint/no-delete-var.md index 7c399721ef8..28227b53370 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-delete-var.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-delete-var.md @@ -45,24 +45,8 @@ delete y.prop; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-delete-var": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-delete-var -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-div-regex.md b/src/docs/guide/usage/linter/rules/eslint/no-div-regex.md index 929c1fb5e30..b397ceed8d9 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-div-regex.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-div-regex.md @@ -44,24 +44,8 @@ function bar() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-div-regex": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-div-regex -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-dupe-class-members.md b/src/docs/guide/usage/linter/rules/eslint/no-dupe-class-members.md index 6abb84612ba..709a2671227 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-dupe-class-members.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-dupe-class-members.md @@ -56,24 +56,8 @@ a.foo(); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-dupe-class-members": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-dupe-class-members -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-dupe-else-if.md b/src/docs/guide/usage/linter/rules/eslint/no-dupe-else-if.md index e9d6522617b..4c7621deab8 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-dupe-else-if.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-dupe-else-if.md @@ -97,24 +97,8 @@ if (n === 1) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-dupe-else-if": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-dupe-else-if -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-dupe-keys.md b/src/docs/guide/usage/linter/rules/eslint/no-dupe-keys.md index 85e798b73b3..9d6ed6581f4 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-dupe-keys.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-dupe-keys.md @@ -59,24 +59,8 @@ var foo = { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-dupe-keys": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-dupe-keys -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-duplicate-case.md b/src/docs/guide/usage/linter/rules/eslint/no-duplicate-case.md index 69d88e14bca..c9ef564587f 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-duplicate-case.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-duplicate-case.md @@ -80,24 +80,8 @@ switch (a) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-duplicate-case": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-duplicate-case -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-duplicate-imports.md b/src/docs/guide/usage/linter/rules/eslint/no-duplicate-imports.md index 7cd42b8ac47..5826ae3f84a 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-duplicate-imports.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-duplicate-imports.md @@ -111,24 +111,8 @@ export * from "module"; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-duplicate-imports": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-duplicate-imports -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-else-return.md b/src/docs/guide/usage/linter/rules/eslint/no-else-return.md index c0e81a26c21..9c896f3c31f 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-else-return.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-else-return.md @@ -178,24 +178,8 @@ function foo() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-else-return": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-else-return -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-empty-character-class.md b/src/docs/guide/usage/linter/rules/eslint/no-empty-character-class.md index 1ceed1914fa..723857262bc 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-empty-character-class.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-empty-character-class.md @@ -40,24 +40,8 @@ var foo2 = /^abc[123]/; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-empty-character-class": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-empty-character-class -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-empty-function.md b/src/docs/guide/usage/linter/rules/eslint/no-empty-function.md index ceb93824754..ef5edde767f 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-empty-function.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-empty-function.md @@ -225,24 +225,8 @@ class Foo extends Base { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-empty-function": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-empty-function -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-empty-pattern.md b/src/docs/guide/usage/linter/rules/eslint/no-empty-pattern.md index b7b521c253b..ff57aa92260 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-empty-pattern.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-empty-pattern.md @@ -73,24 +73,8 @@ function foo({a = []}) {} ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-empty-pattern": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-empty-pattern -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-empty-static-block.md b/src/docs/guide/usage/linter/rules/eslint/no-empty-static-block.md index 1493b0f22ef..7d9af82dd31 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-empty-static-block.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-empty-static-block.md @@ -52,24 +52,8 @@ class Bar { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-empty-static-block": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-empty-static-block -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-empty.md b/src/docs/guide/usage/linter/rules/eslint/no-empty.md index d2385a3fabf..6f312736753 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-empty.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-empty.md @@ -55,24 +55,8 @@ If set to `true`, allows an empty `catch` block without triggering the linter. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-empty": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-empty -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-eq-null.md b/src/docs/guide/usage/linter/rules/eslint/no-eq-null.md index 468b1f2febd..998fe24d68f 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-eq-null.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-eq-null.md @@ -56,24 +56,8 @@ if (bang === undefined) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-eq-null": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-eq-null -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-eval.md b/src/docs/guide/usage/linter/rules/eslint/no-eval.md index 01038064db5..cc84cbf83c8 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-eval.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-eval.md @@ -87,24 +87,8 @@ compared to direct calls, as they do not invoke JavaScript's scope chain. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-eval": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-eval -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-ex-assign.md b/src/docs/guide/usage/linter/rules/eslint/no-ex-assign.md index 2ed7a3ed441..c66667a9648 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-ex-assign.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-ex-assign.md @@ -51,24 +51,8 @@ try { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-ex-assign": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-ex-assign -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-extend-native.md b/src/docs/guide/usage/linter/rules/eslint/no-extend-native.md index 0be47323e18..a33bc7c7a24 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-extend-native.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-extend-native.md @@ -72,24 +72,8 @@ A list of objects which are allowed to be exceptions to the rule. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-extend-native": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-extend-native -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-extra-bind.md b/src/docs/guide/usage/linter/rules/eslint/no-extra-bind.md index 3b64a9e01b8..1a6a456c5b1 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-extra-bind.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-extra-bind.md @@ -53,24 +53,8 @@ const y = function (a) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-extra-bind": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-extra-bind -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-extra-boolean-cast.md b/src/docs/guide/usage/linter/rules/eslint/no-extra-boolean-cast.md index cce19230e30..13ad3d0c9cd 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-extra-boolean-cast.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-extra-boolean-cast.md @@ -76,24 +76,8 @@ cast inside inner expressions. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-extra-boolean-cast": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-extra-boolean-cast -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-extra-label.md b/src/docs/guide/usage/linter/rules/eslint/no-extra-label.md index f06fc5f0397..637b92842a0 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-extra-label.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-extra-label.md @@ -88,24 +88,8 @@ C: switch (a) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-extra-label": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-extra-label -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-fallthrough.md b/src/docs/guide/usage/linter/rules/eslint/no-fallthrough.md index b3000b3f37a..c9ad168628e 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-fallthrough.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-fallthrough.md @@ -214,24 +214,8 @@ Whether to report unused fallthrough comments. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-fallthrough": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-fallthrough -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-func-assign.md b/src/docs/guide/usage/linter/rules/eslint/no-func-assign.md index aa36bad68ea..b3c86f02b79 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-func-assign.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-func-assign.md @@ -70,24 +70,8 @@ function qux() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-func-assign": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-func-assign -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-global-assign.md b/src/docs/guide/usage/linter/rules/eslint/no-global-assign.md index 0fd5edf2f11..a43ba2c7db2 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-global-assign.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-global-assign.md @@ -46,24 +46,8 @@ Globals listed here can be assigned to without triggering warnings. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-global-assign": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-global-assign -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-implicit-coercion.md b/src/docs/guide/usage/linter/rules/eslint/no-implicit-coercion.md index 26dc745f9c8..3dff5d9d47c 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-implicit-coercion.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-implicit-coercion.md @@ -87,24 +87,8 @@ When `true`, warns on implicit string coercion (e.g., `"" + foo`). ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-implicit-coercion": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-implicit-coercion -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-import-assign.md b/src/docs/guide/usage/linter/rules/eslint/no-import-assign.md index 2fe63bfbe72..f47dcc98c21 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-import-assign.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-import-assign.md @@ -46,24 +46,8 @@ Object.assign(mod_ns, { foo: "foo" }); // ERROR: The members of 'mod_ns' are rea ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-import-assign": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-import-assign -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-inline-comments.md b/src/docs/guide/usage/linter/rules/eslint/no-inline-comments.md index bcda7da07d0..99e50216e69 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-inline-comments.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-inline-comments.md @@ -66,24 +66,8 @@ Example configuration: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-inline-comments": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-inline-comments -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-inner-declarations.md b/src/docs/guide/usage/linter/rules/eslint/no-inner-declarations.md index 19add0b1834..de4c2e21988 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-inner-declarations.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-inner-declarations.md @@ -78,24 +78,8 @@ Disallow function declarations in nested blocks regardless of strict mode. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-inner-declarations": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-inner-declarations -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-invalid-regexp.md b/src/docs/guide/usage/linter/rules/eslint/no-invalid-regexp.md index 3d03d140980..e194a754f2f 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-invalid-regexp.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-invalid-regexp.md @@ -56,24 +56,8 @@ Case-sensitive array of flags that will be allowed. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-invalid-regexp": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-invalid-regexp -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-irregular-whitespace.md b/src/docs/guide/usage/linter/rules/eslint/no-irregular-whitespace.md index dc342fb3ed5..0bce8313081 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-irregular-whitespace.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-irregular-whitespace.md @@ -46,24 +46,8 @@ function example() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-irregular-whitespace": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-irregular-whitespace -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-iterator.md b/src/docs/guide/usage/linter/rules/eslint/no-iterator.md index 0c178851411..419fbcb0663 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-iterator.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-iterator.md @@ -59,24 +59,8 @@ Foo.prototype[Symbol.iterator] = function () { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-iterator": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-iterator -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-label-var.md b/src/docs/guide/usage/linter/rules/eslint/no-label-var.md index c38fe705bf2..5d6daf95152 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-label-var.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-label-var.md @@ -55,24 +55,8 @@ function bar() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-label-var": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-label-var -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-labels.md b/src/docs/guide/usage/linter/rules/eslint/no-labels.md index 51780031754..ef6dc44109c 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-labels.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-labels.md @@ -118,24 +118,8 @@ label: switch (a) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-labels": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-labels -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-lone-blocks.md b/src/docs/guide/usage/linter/rules/eslint/no-lone-blocks.md index ef65219ccba..07f678c1dd8 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-lone-blocks.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-lone-blocks.md @@ -48,24 +48,8 @@ if (condition) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-lone-blocks": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-lone-blocks -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-lonely-if.md b/src/docs/guide/usage/linter/rules/eslint/no-lonely-if.md index 288220bc84e..c08996dc314 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-lonely-if.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-lonely-if.md @@ -83,24 +83,8 @@ if (condition) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-lonely-if": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-lonely-if -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-loop-func.md b/src/docs/guide/usage/linter/rules/eslint/no-loop-func.md index cb4d95245b9..bceb2909dde 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-loop-func.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-loop-func.md @@ -52,24 +52,8 @@ for (let i = 0; i < 10; i++) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-loop-func": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-loop-func -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-loss-of-precision.md b/src/docs/guide/usage/linter/rules/eslint/no-loss-of-precision.md index d353ffae23a..938f1f19f2d 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-loss-of-precision.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-loss-of-precision.md @@ -78,24 +78,8 @@ var x = 0x1fff_ffff_fff_fff; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-loss-of-precision": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-loss-of-precision -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-magic-numbers.md b/src/docs/guide/usage/linter/rules/eslint/no-magic-numbers.md index ea5215e63dd..e359f66fc92 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-magic-numbers.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-magic-numbers.md @@ -227,24 +227,8 @@ When true, numeric literals used to index TypeScript types are ignored. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-magic-numbers": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-magic-numbers -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-misleading-character-class.md b/src/docs/guide/usage/linter/rules/eslint/no-misleading-character-class.md index f63072918cf..8ec6f6e878a 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-misleading-character-class.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-misleading-character-class.md @@ -94,24 +94,8 @@ new RegExp("[\\u{1F1EF}\\u{1F1F5}]", "u"); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-misleading-character-class": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-misleading-character-class -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-multi-assign.md b/src/docs/guide/usage/linter/rules/eslint/no-multi-assign.md index 26b33c8f313..c98356b7362 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-multi-assign.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-multi-assign.md @@ -109,24 +109,8 @@ class Foo { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-multi-assign": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-multi-assign -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-multi-str.md b/src/docs/guide/usage/linter/rules/eslint/no-multi-str.md index 9422325f12b..9dc2863af15 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-multi-str.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-multi-str.md @@ -36,24 +36,8 @@ var x = ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-multi-str": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-multi-str -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-negated-condition.md b/src/docs/guide/usage/linter/rules/eslint/no-negated-condition.md index eec545f21fe..13f4650941b 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-negated-condition.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-negated-condition.md @@ -51,24 +51,8 @@ a ? doSomethingB() : doSomethingC(); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-negated-condition": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-negated-condition -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-nested-ternary.md b/src/docs/guide/usage/linter/rules/eslint/no-nested-ternary.md index 682a90ee661..3505d0849d8 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-nested-ternary.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-nested-ternary.md @@ -44,24 +44,8 @@ if (condition1) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-nested-ternary": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-nested-ternary -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-new-func.md b/src/docs/guide/usage/linter/rules/eslint/no-new-func.md index 53a04365d89..ead5731b2d9 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-new-func.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-new-func.md @@ -46,24 +46,8 @@ let x = function (a, b) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-new-func": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-new-func -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-new-native-nonconstructor.md b/src/docs/guide/usage/linter/rules/eslint/no-new-native-nonconstructor.md index 2c39a722572..2ef0661bc40 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-new-native-nonconstructor.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-new-native-nonconstructor.md @@ -50,24 +50,8 @@ let result = BigInt(9007199254740991); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-new-native-nonconstructor": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-new-native-nonconstructor -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-new-wrappers.md b/src/docs/guide/usage/linter/rules/eslint/no-new-wrappers.md index 2f55b53993d..871183c79e6 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-new-wrappers.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-new-wrappers.md @@ -52,24 +52,8 @@ var symbolObject = Symbol("foo"); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-new-wrappers": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-new-wrappers -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-new.md b/src/docs/guide/usage/linter/rules/eslint/no-new.md index 63794b50ca8..3398404c3bb 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-new.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-new.md @@ -44,24 +44,8 @@ var a = new Date()(() => new Date()); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-new": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-new -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-nonoctal-decimal-escape.md b/src/docs/guide/usage/linter/rules/eslint/no-nonoctal-decimal-escape.md index 92a32a5d7d5..24e8ecbde22 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-nonoctal-decimal-escape.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-nonoctal-decimal-escape.md @@ -41,24 +41,8 @@ let y = "\\9"; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-nonoctal-decimal-escape": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-nonoctal-decimal-escape -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-obj-calls.md b/src/docs/guide/usage/linter/rules/eslint/no-obj-calls.md index 32533ba3244..17fde9c9d23 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-obj-calls.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-obj-calls.md @@ -59,24 +59,8 @@ let segmenterFrom = Intl.Segmenter("fr", { granularity: "word" }); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-obj-calls": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-obj-calls -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-object-constructor.md b/src/docs/guide/usage/linter/rules/eslint/no-object-constructor.md index 4e68b419cca..225cf67911e 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-object-constructor.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-object-constructor.md @@ -43,24 +43,8 @@ const createObject = (Object) => new Object(); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-object-constructor": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-object-constructor -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-param-reassign.md b/src/docs/guide/usage/linter/rules/eslint/no-param-reassign.md index 054c6460166..c4a690c93c6 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-param-reassign.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-param-reassign.md @@ -67,24 +67,8 @@ When true, also check for modifications to properties of parameters. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-param-reassign": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-param-reassign -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-plusplus.md b/src/docs/guide/usage/linter/rules/eslint/no-plusplus.md index 1229c48ae13..e79907d2db2 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-plusplus.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-plusplus.md @@ -82,24 +82,8 @@ Whether to allow `++` and `--` in for loop afterthoughts. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-plusplus": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-plusplus -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-promise-executor-return.md b/src/docs/guide/usage/linter/rules/eslint/no-promise-executor-return.md index 19187a24702..6a64e8a4fd0 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-promise-executor-return.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-promise-executor-return.md @@ -108,24 +108,8 @@ If `true`, allows returning `void` expressions (e.g., `return void resolve()`). ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-promise-executor-return": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-promise-executor-return -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-proto.md b/src/docs/guide/usage/linter/rules/eslint/no-proto.md index e91c28ac8d6..001c7ace00a 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-proto.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-proto.md @@ -44,24 +44,8 @@ obj["__proto__"] = b; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-proto": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-proto -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-prototype-builtins.md b/src/docs/guide/usage/linter/rules/eslint/no-prototype-builtins.md index 67ec0f0e3e4..bb83d2ac0f0 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-prototype-builtins.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-prototype-builtins.md @@ -41,24 +41,8 @@ var barIsEnumerable = foo.propertyIsEnumerable("bar"); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-prototype-builtins": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-prototype-builtins -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-redeclare.md b/src/docs/guide/usage/linter/rules/eslint/no-redeclare.md index d7f365d5426..4e59b30a06f 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-redeclare.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-redeclare.md @@ -55,24 +55,8 @@ When set `true`, it flags redeclaring built-in globals (e.g., `let Object = 1;`) ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-redeclare": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-redeclare -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-regex-spaces.md b/src/docs/guide/usage/linter/rules/eslint/no-regex-spaces.md index 0ae6b8e4332..a109b503bd4 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-regex-spaces.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-regex-spaces.md @@ -39,24 +39,8 @@ var re = /foo bar/; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-regex-spaces": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-regex-spaces -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-restricted-globals.md b/src/docs/guide/usage/linter/rules/eslint/no-restricted-globals.md index 19afcfaf779..c45e164acab 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-restricted-globals.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-restricted-globals.md @@ -60,24 +60,8 @@ are restricted from use. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-restricted-globals": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-restricted-globals -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-restricted-imports.md b/src/docs/guide/usage/linter/rules/eslint/no-restricted-imports.md index 8b05150cafa..b7d5541fede 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-restricted-imports.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-restricted-imports.md @@ -343,24 +343,8 @@ import { isEmpty } from "utils/collection-utils"; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-restricted-imports": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-restricted-imports -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-return-assign.md b/src/docs/guide/usage/linter/rules/eslint/no-return-assign.md index 2290b5b7616..c94accd3050 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-return-assign.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-return-assign.md @@ -61,24 +61,8 @@ This is the default mode. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-return-assign": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-return-assign -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-script-url.md b/src/docs/guide/usage/linter/rules/eslint/no-script-url.md index 219f81da872..d5a436ccd14 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-script-url.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-script-url.md @@ -38,24 +38,8 @@ location.href = `javascript:void(0)`; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-script-url": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-script-url -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-self-assign.md b/src/docs/guide/usage/linter/rules/eslint/no-self-assign.md index 8878fb3dfec..21fa81d0522 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-self-assign.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-self-assign.md @@ -92,24 +92,8 @@ obj[a] = obj[a]; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-self-assign": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-self-assign -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-self-compare.md b/src/docs/guide/usage/linter/rules/eslint/no-self-compare.md index fe2e97284a5..83a94e06b2e 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-self-compare.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-self-compare.md @@ -37,24 +37,8 @@ if (x === x) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-self-compare": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-self-compare -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-sequences.md b/src/docs/guide/usage/linter/rules/eslint/no-sequences.md index aaed383cf72..f8af81d050e 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-sequences.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-sequences.md @@ -78,24 +78,8 @@ Default is `true`. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-sequences": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-sequences -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-setter-return.md b/src/docs/guide/usage/linter/rules/eslint/no-setter-return.md index ba76fb60ab7..0d876bcec6b 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-setter-return.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-setter-return.md @@ -42,24 +42,8 @@ class URL { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-setter-return": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-setter-return -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-shadow-restricted-names.md b/src/docs/guide/usage/linter/rules/eslint/no-shadow-restricted-names.md index 842f92c4b41..b75e291dbb1 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-shadow-restricted-names.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-shadow-restricted-names.md @@ -89,24 +89,8 @@ If true, also report shadowing of `globalThis`. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-shadow-restricted-names": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-shadow-restricted-names -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-shadow.md b/src/docs/guide/usage/linter/rules/eslint/no-shadow.md index 64f2e75d5be..cdfae0bde0f 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-shadow.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-shadow.md @@ -121,24 +121,8 @@ This is common in TypeScript: `type Foo = ...; const Foo = ...;` ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-shadow": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-shadow -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-sparse-arrays.md b/src/docs/guide/usage/linter/rules/eslint/no-sparse-arrays.md index ab3953b9ecd..c864f653b0f 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-sparse-arrays.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-sparse-arrays.md @@ -63,24 +63,8 @@ var colors = ["red", "blue"]; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-sparse-arrays": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-sparse-arrays -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-template-curly-in-string.md b/src/docs/guide/usage/linter/rules/eslint/no-template-curly-in-string.md index 143163ca4ab..4522d4801d0 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-template-curly-in-string.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-template-curly-in-string.md @@ -49,24 +49,8 @@ templateFunction`Hello ${name}`; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-template-curly-in-string": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-template-curly-in-string -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-ternary.md b/src/docs/guide/usage/linter/rules/eslint/no-ternary.md index 96aa69c25a0..aae97523ba3 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-ternary.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-ternary.md @@ -63,24 +63,8 @@ function quux() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-ternary": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-ternary -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-this-before-super.md b/src/docs/guide/usage/linter/rules/eslint/no-this-before-super.md index a730194b70a..bc4ffefc524 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-this-before-super.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-this-before-super.md @@ -43,24 +43,8 @@ class A1 extends B { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-this-before-super": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-this-before-super -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-throw-literal.md b/src/docs/guide/usage/linter/rules/eslint/no-throw-literal.md index 3ec12f8c4b5..cd8a849cb9e 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-throw-literal.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-throw-literal.md @@ -70,24 +70,8 @@ try { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-throw-literal": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-throw-literal -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-unassigned-vars.md b/src/docs/guide/usage/linter/rules/eslint/no-unassigned-vars.md index a2ef0d6a031..a89b0ce0d62 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-unassigned-vars.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-unassigned-vars.md @@ -48,24 +48,8 @@ console.log(user.name); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-unassigned-vars": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-unassigned-vars -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-undef.md b/src/docs/guide/usage/linter/rules/eslint/no-undef.md index 5a98461f166..8a52cadafc4 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-undef.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-undef.md @@ -50,24 +50,8 @@ When set to `true`, warns on undefined variables used in a `typeof` expression. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-undef": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-undef -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-undefined.md b/src/docs/guide/usage/linter/rules/eslint/no-undefined.md index bb00af289e5..e3e087b7df8 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-undefined.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-undefined.md @@ -62,24 +62,8 @@ bar(void 0, "lorem"); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-undefined": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-undefined -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-unexpected-multiline.md b/src/docs/guide/usage/linter/rules/eslint/no-unexpected-multiline.md index 6f3ee3b62b0..2bf4dfe60c4 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-unexpected-multiline.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-unexpected-multiline.md @@ -59,24 +59,8 @@ foo; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-unexpected-multiline": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-unexpected-multiline -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-unmodified-loop-condition.md b/src/docs/guide/usage/linter/rules/eslint/no-unmodified-loop-condition.md index 8d9cd7ff437..276f8d2c292 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-unmodified-loop-condition.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-unmodified-loop-condition.md @@ -46,24 +46,8 @@ while (!done) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-unmodified-loop-condition": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-unmodified-loop-condition -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-unneeded-ternary.md b/src/docs/guide/usage/linter/rules/eslint/no-unneeded-ternary.md index 598f767b411..0ed77bec540 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-unneeded-ternary.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-unneeded-ternary.md @@ -65,24 +65,8 @@ are allowed and not reported. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-unneeded-ternary": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-unneeded-ternary -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-unreachable.md b/src/docs/guide/usage/linter/rules/eslint/no-unreachable.md index d019dce9067..4fba20f9432 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-unreachable.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-unreachable.md @@ -48,24 +48,8 @@ function foo() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-unreachable": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-unreachable -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-unsafe-finally.md b/src/docs/guide/usage/linter/rules/eslint/no-unsafe-finally.md index 45a73cf8eba..110cad56ba6 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-unsafe-finally.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-unsafe-finally.md @@ -49,24 +49,8 @@ Examples of **incorrect** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-unsafe-finally": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-unsafe-finally -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-unsafe-negation.md b/src/docs/guide/usage/linter/rules/eslint/no-unsafe-negation.md index cc288163d2c..3bd9a80691a 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-unsafe-negation.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-unsafe-negation.md @@ -66,24 +66,8 @@ when what is really intended is `!(a < b)`. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-unsafe-negation": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-unsafe-negation -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-unsafe-optional-chaining.md b/src/docs/guide/usage/linter/rules/eslint/no-unsafe-optional-chaining.md index 4acddba38d4..e81566b4305 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-unsafe-optional-chaining.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-unsafe-optional-chaining.md @@ -53,24 +53,8 @@ If this is true, this rule warns arithmetic operations on optional chaining expr ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-unsafe-optional-chaining": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-unsafe-optional-chaining -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-unused-expressions.md b/src/docs/guide/usage/linter/rules/eslint/no-unused-expressions.md index 10d0240992c..03fde07cad0 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-unused-expressions.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-unused-expressions.md @@ -77,24 +77,8 @@ When set to `true`, enforces the rule for unused JSX expressions also. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-unused-expressions": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-unused-expressions -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-unused-labels.md b/src/docs/guide/usage/linter/rules/eslint/no-unused-labels.md index 731dd92bc5c..124dbd14f53 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-unused-labels.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-unused-labels.md @@ -49,24 +49,8 @@ for (const student of students) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-unused-labels": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-unused-labels -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-unused-private-class-members.md b/src/docs/guide/usage/linter/rules/eslint/no-unused-private-class-members.md index 4465cfa0ef6..8b9c5a87749 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-unused-private-class-members.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-unused-private-class-members.md @@ -87,24 +87,8 @@ class C { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-unused-private-class-members": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-unused-private-class-members -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-unused-vars.md b/src/docs/guide/usage/linter/rules/eslint/no-unused-vars.md index 2168e00df44..466b061cb83 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-unused-vars.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-unused-vars.md @@ -530,24 +530,8 @@ console.log(b); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-unused-vars": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-unused-vars -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-use-before-define.md b/src/docs/guide/usage/linter/rules/eslint/no-use-before-define.md index 7036a5e7be9..11c3203699e 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-use-before-define.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-use-before-define.md @@ -102,24 +102,8 @@ Check variable declarations. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-use-before-define": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-use-before-define -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-useless-backreference.md b/src/docs/guide/usage/linter/rules/eslint/no-useless-backreference.md index 1100e393fd0..b712f5c874c 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-useless-backreference.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-useless-backreference.md @@ -52,24 +52,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-useless-backreference": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-useless-backreference -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-useless-call.md b/src/docs/guide/usage/linter/rules/eslint/no-useless-call.md index 464492b7fa2..8e241a52f57 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-useless-call.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-useless-call.md @@ -62,24 +62,8 @@ obj.foo.apply(obj, args); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-useless-call": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-useless-call -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-useless-catch.md b/src/docs/guide/usage/linter/rules/eslint/no-useless-catch.md index 802e6d68d9e..48c74983d82 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-useless-catch.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-useless-catch.md @@ -46,24 +46,8 @@ doSomethingThatMightThrow(); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-useless-catch": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-useless-catch -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-useless-computed-key.md b/src/docs/guide/usage/linter/rules/eslint/no-useless-computed-key.md index 8451ced21d3..418794c309f 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-useless-computed-key.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-useless-computed-key.md @@ -110,24 +110,8 @@ class SomeClass { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-useless-computed-key": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-useless-computed-key -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-useless-concat.md b/src/docs/guide/usage/linter/rules/eslint/no-useless-concat.md index 1ecdd27e5a5..0a13bee19b5 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-useless-concat.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-useless-concat.md @@ -47,24 +47,8 @@ var foo = "a" + "b" + "c"; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-useless-concat": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-useless-concat -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-useless-constructor.md b/src/docs/guide/usage/linter/rules/eslint/no-useless-constructor.md index d27a71ba447..cf3fb22b42c 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-useless-constructor.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-useless-constructor.md @@ -76,24 +76,8 @@ class D extends A { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-useless-constructor": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-useless-constructor -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-useless-escape.md b/src/docs/guide/usage/linter/rules/eslint/no-useless-escape.md index 7412992c5a7..1b0b4e72e6c 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-useless-escape.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-useless-escape.md @@ -80,24 +80,8 @@ Each string in this array must be a single character. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-useless-escape": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-useless-escape -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-useless-rename.md b/src/docs/guide/usage/linter/rules/eslint/no-useless-rename.md index 35ed0097c05..e756685155a 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-useless-rename.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-useless-rename.md @@ -71,24 +71,8 @@ When set to `true`, allows renaming imports to the same name. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-useless-rename": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-useless-rename -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-useless-return.md b/src/docs/guide/usage/linter/rules/eslint/no-useless-return.md index 0779bf45e35..8e1383ffada 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-useless-return.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-useless-return.md @@ -68,24 +68,8 @@ function baz() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-useless-return": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-useless-return -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-var.md b/src/docs/guide/usage/linter/rules/eslint/no-var.md index b45682b047d..1b5fdb4e544 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-var.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-var.md @@ -44,24 +44,8 @@ const CONFIG = {}; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-var": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-var -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-void.md b/src/docs/guide/usage/linter/rules/eslint/no-void.md index 5246af50904..56a14e54939 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-void.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-void.md @@ -55,24 +55,8 @@ If set to `true`, using `void` as a standalone statement is allowed. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-void": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-void -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-warning-comments.md b/src/docs/guide/usage/linter/rules/eslint/no-warning-comments.md index 659089e7195..532ced71c82 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-warning-comments.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-warning-comments.md @@ -81,24 +81,8 @@ Useful for ignoring common comment decorations like `*` in JSDoc-style comments. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-warning-comments": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-warning-comments -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/no-with.md b/src/docs/guide/usage/linter/rules/eslint/no-with.md index 719fb37d2bc..02785055df4 100644 --- a/src/docs/guide/usage/linter/rules/eslint/no-with.md +++ b/src/docs/guide/usage/linter/rules/eslint/no-with.md @@ -41,24 +41,8 @@ with (point) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "no-with": "error" - } -} -``` - -```bash [CLI] -oxlint --deny no-with -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/operator-assignment.md b/src/docs/guide/usage/linter/rules/eslint/operator-assignment.md index 07066ecae66..3f559810d1a 100644 --- a/src/docs/guide/usage/linter/rules/eslint/operator-assignment.md +++ b/src/docs/guide/usage/linter/rules/eslint/operator-assignment.md @@ -78,24 +78,8 @@ Disallows assignment operator shorthand. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "operator-assignment": "error" - } -} -``` - -```bash [CLI] -oxlint --deny operator-assignment -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/prefer-const.md b/src/docs/guide/usage/linter/rules/eslint/prefer-const.md index 523e6bb8025..b38b6ac0e7b 100644 --- a/src/docs/guide/usage/linter/rules/eslint/prefer-const.md +++ b/src/docs/guide/usage/linter/rules/eslint/prefer-const.md @@ -86,24 +86,8 @@ This is mainly useful for preventing conflicts with the `typescript/no-use-befor ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "prefer-const": "error" - } -} -``` - -```bash [CLI] -oxlint --deny prefer-const -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/prefer-destructuring.md b/src/docs/guide/usage/linter/rules/eslint/prefer-destructuring.md index 54b9f9153d9..acbc7d09f40 100644 --- a/src/docs/guide/usage/linter/rules/eslint/prefer-destructuring.md +++ b/src/docs/guide/usage/linter/rules/eslint/prefer-destructuring.md @@ -105,24 +105,8 @@ Determines whether the object destructuring rule applies to renamed variables. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "prefer-destructuring": "error" - } -} -``` - -```bash [CLI] -oxlint --deny prefer-destructuring -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/prefer-exponentiation-operator.md b/src/docs/guide/usage/linter/rules/eslint/prefer-exponentiation-operator.md index 64c3f0021ce..8546b402ce4 100644 --- a/src/docs/guide/usage/linter/rules/eslint/prefer-exponentiation-operator.md +++ b/src/docs/guide/usage/linter/rules/eslint/prefer-exponentiation-operator.md @@ -41,24 +41,8 @@ a ** b; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "prefer-exponentiation-operator": "error" - } -} -``` - -```bash [CLI] -oxlint --deny prefer-exponentiation-operator -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/prefer-numeric-literals.md b/src/docs/guide/usage/linter/rules/eslint/prefer-numeric-literals.md index 48d4143bb69..de9d8103c42 100644 --- a/src/docs/guide/usage/linter/rules/eslint/prefer-numeric-literals.md +++ b/src/docs/guide/usage/linter/rules/eslint/prefer-numeric-literals.md @@ -43,24 +43,8 @@ Number.parseInt("1F7", 16) === 503; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "prefer-numeric-literals": "error" - } -} -``` - -```bash [CLI] -oxlint --deny prefer-numeric-literals -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/prefer-object-has-own.md b/src/docs/guide/usage/linter/rules/eslint/prefer-object-has-own.md index b8187197cdc..09b013126a2 100644 --- a/src/docs/guide/usage/linter/rules/eslint/prefer-object-has-own.md +++ b/src/docs/guide/usage/linter/rules/eslint/prefer-object-has-own.md @@ -58,24 +58,8 @@ const hasProperty = Object.hasOwn(object, property); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "prefer-object-has-own": "error" - } -} -``` - -```bash [CLI] -oxlint --deny prefer-object-has-own -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/prefer-object-spread.md b/src/docs/guide/usage/linter/rules/eslint/prefer-object-spread.md index 2b17101a134..b52c284822f 100644 --- a/src/docs/guide/usage/linter/rules/eslint/prefer-object-spread.md +++ b/src/docs/guide/usage/linter/rules/eslint/prefer-object-spread.md @@ -63,24 +63,8 @@ Object.assign(foo, { ...baz }); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "prefer-object-spread": "error" - } -} -``` - -```bash [CLI] -oxlint --deny prefer-object-spread -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/prefer-promise-reject-errors.md b/src/docs/guide/usage/linter/rules/eslint/prefer-promise-reject-errors.md index 53dbf8efa4f..a9a61add26d 100644 --- a/src/docs/guide/usage/linter/rules/eslint/prefer-promise-reject-errors.md +++ b/src/docs/guide/usage/linter/rules/eslint/prefer-promise-reject-errors.md @@ -76,24 +76,8 @@ Whether to allow calls to `Promise.reject()` with no arguments. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "prefer-promise-reject-errors": "error" - } -} -``` - -```bash [CLI] -oxlint --deny prefer-promise-reject-errors -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/prefer-rest-params.md b/src/docs/guide/usage/linter/rules/eslint/prefer-rest-params.md index 42cae1f26a1..22c7b08f6f7 100644 --- a/src/docs/guide/usage/linter/rules/eslint/prefer-rest-params.md +++ b/src/docs/guide/usage/linter/rules/eslint/prefer-rest-params.md @@ -67,24 +67,8 @@ function foo() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "prefer-rest-params": "error" - } -} -``` - -```bash [CLI] -oxlint --deny prefer-rest-params -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/prefer-spread.md b/src/docs/guide/usage/linter/rules/eslint/prefer-spread.md index 93a14bd9a0e..e1e63d53621 100644 --- a/src/docs/guide/usage/linter/rules/eslint/prefer-spread.md +++ b/src/docs/guide/usage/linter/rules/eslint/prefer-spread.md @@ -66,24 +66,8 @@ obj.foo.apply(obj, [1, 2, 3]); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "prefer-spread": "error" - } -} -``` - -```bash [CLI] -oxlint --deny prefer-spread -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/prefer-template.md b/src/docs/guide/usage/linter/rules/eslint/prefer-template.md index 0d35e54f5df..20eee240274 100644 --- a/src/docs/guide/usage/linter/rules/eslint/prefer-template.md +++ b/src/docs/guide/usage/linter/rules/eslint/prefer-template.md @@ -42,24 +42,8 @@ const str4 = "Hello, " + "World!"; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "prefer-template": "error" - } -} -``` - -```bash [CLI] -oxlint --deny prefer-template -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/preserve-caught-error.md b/src/docs/guide/usage/linter/rules/eslint/preserve-caught-error.md index 14805d28ebf..42a3c69bb92 100644 --- a/src/docs/guide/usage/linter/rules/eslint/preserve-caught-error.md +++ b/src/docs/guide/usage/linter/rules/eslint/preserve-caught-error.md @@ -61,24 +61,8 @@ When set to `true`, requires that catch clauses always have a parameter. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "preserve-caught-error": "error" - } -} -``` - -```bash [CLI] -oxlint --deny preserve-caught-error -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/radix.md b/src/docs/guide/usage/linter/rules/eslint/radix.md index 3946ab79334..f90762ed7b8 100644 --- a/src/docs/guide/usage/linter/rules/eslint/radix.md +++ b/src/docs/guide/usage/linter/rules/eslint/radix.md @@ -56,24 +56,8 @@ let num = parseInt("071", 10); // 71 ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "radix": "error" - } -} -``` - -```bash [CLI] -oxlint --deny radix -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/require-await.md b/src/docs/guide/usage/linter/rules/eslint/require-await.md index ce3da30c7f7..449b88fc49b 100644 --- a/src/docs/guide/usage/linter/rules/eslint/require-await.md +++ b/src/docs/guide/usage/linter/rules/eslint/require-await.md @@ -74,24 +74,8 @@ async function foo() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "require-await": "error" - } -} -``` - -```bash [CLI] -oxlint --deny require-await -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/require-yield.md b/src/docs/guide/usage/linter/rules/eslint/require-yield.md index 30afa6fb053..607f75476f8 100644 --- a/src/docs/guide/usage/linter/rules/eslint/require-yield.md +++ b/src/docs/guide/usage/linter/rules/eslint/require-yield.md @@ -35,24 +35,8 @@ function* foo() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "require-yield": "error" - } -} -``` - -```bash [CLI] -oxlint --deny require-yield -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/sort-imports.md b/src/docs/guide/usage/linter/rules/eslint/sort-imports.md index e33589fcfff..2ee13b7c31c 100644 --- a/src/docs/guide/usage/linter/rules/eslint/sort-imports.md +++ b/src/docs/guide/usage/linter/rules/eslint/sort-imports.md @@ -89,24 +89,8 @@ type: `"none" | "all" | "multiple" | "single"` ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "sort-imports": "error" - } -} -``` - -```bash [CLI] -oxlint --deny sort-imports -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/sort-keys.md b/src/docs/guide/usage/linter/rules/eslint/sort-keys.md index fc4bc500ac5..ec76c588064 100644 --- a/src/docs/guide/usage/linter/rules/eslint/sort-keys.md +++ b/src/docs/guide/usage/linter/rules/eslint/sort-keys.md @@ -90,24 +90,8 @@ Use natural sort order so that, for example, "a2" comes before "a10". ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "sort-keys": "error" - } -} -``` - -```bash [CLI] -oxlint --deny sort-keys -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/sort-vars.md b/src/docs/guide/usage/linter/rules/eslint/sort-vars.md index d6a6a313c86..55db5748912 100644 --- a/src/docs/guide/usage/linter/rules/eslint/sort-vars.md +++ b/src/docs/guide/usage/linter/rules/eslint/sort-vars.md @@ -54,24 +54,8 @@ When `true`, the rule ignores case-sensitivity when sorting variables. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "sort-vars": "error" - } -} -``` - -```bash [CLI] -oxlint --deny sort-vars -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/symbol-description.md b/src/docs/guide/usage/linter/rules/eslint/symbol-description.md index 6be4e158707..57d49eed417 100644 --- a/src/docs/guide/usage/linter/rules/eslint/symbol-description.md +++ b/src/docs/guide/usage/linter/rules/eslint/symbol-description.md @@ -55,24 +55,8 @@ var foo = Symbol("some description"); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "symbol-description": "error" - } -} -``` - -```bash [CLI] -oxlint --deny symbol-description -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/unicode-bom.md b/src/docs/guide/usage/linter/rules/eslint/unicode-bom.md index e509052a746..809872ac7a0 100644 --- a/src/docs/guide/usage/linter/rules/eslint/unicode-bom.md +++ b/src/docs/guide/usage/linter/rules/eslint/unicode-bom.md @@ -50,24 +50,8 @@ This is the default option. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "unicode-bom": "error" - } -} -``` - -```bash [CLI] -oxlint --deny unicode-bom -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/use-isnan.md b/src/docs/guide/usage/linter/rules/eslint/use-isnan.md index f14b914123b..e501688cc61 100644 --- a/src/docs/guide/usage/linter/rules/eslint/use-isnan.md +++ b/src/docs/guide/usage/linter/rules/eslint/use-isnan.md @@ -67,24 +67,8 @@ Whether to disallow NaN in switch cases and discriminants ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "use-isnan": "error" - } -} -``` - -```bash [CLI] -oxlint --deny use-isnan -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/valid-typeof.md b/src/docs/guide/usage/linter/rules/eslint/valid-typeof.md index 92b40075e12..aa7a8037cdb 100644 --- a/src/docs/guide/usage/linter/rules/eslint/valid-typeof.md +++ b/src/docs/guide/usage/linter/rules/eslint/valid-typeof.md @@ -82,24 +82,8 @@ typeof bar === typeof qux; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "valid-typeof": "error" - } -} -``` - -```bash [CLI] -oxlint --deny valid-typeof -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/vars-on-top.md b/src/docs/guide/usage/linter/rules/eslint/vars-on-top.md index 37c33113fcf..33d927fd6e3 100644 --- a/src/docs/guide/usage/linter/rules/eslint/vars-on-top.md +++ b/src/docs/guide/usage/linter/rules/eslint/vars-on-top.md @@ -90,24 +90,8 @@ class C { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "vars-on-top": "error" - } -} -``` - -```bash [CLI] -oxlint --deny vars-on-top -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/eslint/yoda.md b/src/docs/guide/usage/linter/rules/eslint/yoda.md index f26fd1179e6..96b74c6eb61 100644 --- a/src/docs/guide/usage/linter/rules/eslint/yoda.md +++ b/src/docs/guide/usage/linter/rules/eslint/yoda.md @@ -204,24 +204,8 @@ both options are not useful together. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "rules": { - "yoda": "error" - } -} -``` - -```bash [CLI] -oxlint --deny yoda -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/consistent-type-specifier-style.md b/src/docs/guide/usage/linter/rules/import/consistent-type-specifier-style.md index 2e13b31ad53..fd7bf9e775e 100644 --- a/src/docs/guide/usage/linter/rules/import/consistent-type-specifier-style.md +++ b/src/docs/guide/usage/linter/rules/import/consistent-type-specifier-style.md @@ -69,25 +69,8 @@ Prefer `import { type Foo } from 'foo'` for type imports. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/consistent-type-specifier-style": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/consistent-type-specifier-style --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/default.md b/src/docs/guide/usage/linter/rules/import/default.md index 943fa9d87e3..caba07bc337 100644 --- a/src/docs/guide/usage/linter/rules/import/default.md +++ b/src/docs/guide/usage/linter/rules/import/default.md @@ -55,25 +55,8 @@ import { bar } from "./bar"; // correct usage of named import ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/default": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/default --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/export.md b/src/docs/guide/usage/linter/rules/import/export.md index 41e637f0523..cd3b5e22845 100644 --- a/src/docs/guide/usage/linter/rules/import/export.md +++ b/src/docs/guide/usage/linter/rules/import/export.md @@ -45,25 +45,8 @@ export * from "./export-all"; // No conflict if export-all.js also exports foo ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/export": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/export --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/exports-last.md b/src/docs/guide/usage/linter/rules/import/exports-last.md index 273aecece2e..9256fc38277 100644 --- a/src/docs/guide/usage/linter/rules/import/exports-last.md +++ b/src/docs/guide/usage/linter/rules/import/exports-last.md @@ -48,25 +48,8 @@ export function func() { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/exports-last": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/exports-last --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/extensions.md b/src/docs/guide/usage/linter/rules/import/extensions.md index 38492c77990..14f57154351 100644 --- a/src/docs/guide/usage/linter/rules/import/extensions.md +++ b/src/docs/guide/usage/linter/rules/import/extensions.md @@ -262,25 +262,8 @@ Glob pattern to match import specifiers. This uses Rust's fast-glob library for ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/extensions": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/extensions --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/first.md b/src/docs/guide/usage/linter/rules/import/first.md index e103222f5b7..87608467ee3 100644 --- a/src/docs/guide/usage/linter/rules/import/first.md +++ b/src/docs/guide/usage/linter/rules/import/first.md @@ -73,25 +73,8 @@ This is the default behavior. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/first": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/first --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/group-exports.md b/src/docs/guide/usage/linter/rules/import/group-exports.md index 38112888b78..d6d8e3f4e10 100644 --- a/src/docs/guide/usage/linter/rules/import/group-exports.md +++ b/src/docs/guide/usage/linter/rules/import/group-exports.md @@ -46,25 +46,8 @@ export { first, second }; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/group-exports": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/group-exports --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/max-dependencies.md b/src/docs/guide/usage/linter/rules/import/max-dependencies.md index 213d5ad1ef3..f5abc39ce91 100644 --- a/src/docs/guide/usage/linter/rules/import/max-dependencies.md +++ b/src/docs/guide/usage/linter/rules/import/max-dependencies.md @@ -76,25 +76,8 @@ Maximum number of dependencies allowed in a file. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/max-dependencies": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/max-dependencies --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/named.md b/src/docs/guide/usage/linter/rules/import/named.md index ce7ccc56845..0eb76b52497 100644 --- a/src/docs/guide/usage/linter/rules/import/named.md +++ b/src/docs/guide/usage/linter/rules/import/named.md @@ -78,25 +78,8 @@ import { SomeNonsenseThatDoesntExist } from "react"; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/named": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/named --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/namespace.md b/src/docs/guide/usage/linter/rules/import/namespace.md index 1b5f0cedabe..6d9e1d8efcb 100644 --- a/src/docs/guide/usage/linter/rules/import/namespace.md +++ b/src/docs/guide/usage/linter/rules/import/namespace.md @@ -82,25 +82,8 @@ Whether to allow computed references to an imported namespace. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/namespace": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/namespace --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-absolute-path.md b/src/docs/guide/usage/linter/rules/import/no-absolute-path.md index 5be7ddef64b..ce30d612ab8 100644 --- a/src/docs/guide/usage/linter/rules/import/no-absolute-path.md +++ b/src/docs/guide/usage/linter/rules/import/no-absolute-path.md @@ -112,25 +112,8 @@ import foo from "/foo"; // reported ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-absolute-path": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-absolute-path --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-amd.md b/src/docs/guide/usage/linter/rules/import/no-amd.md index d8d95794b03..13f884fb84a 100644 --- a/src/docs/guide/usage/linter/rules/import/no-amd.md +++ b/src/docs/guide/usage/linter/rules/import/no-amd.md @@ -45,25 +45,8 @@ require(`../name`); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-amd": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-amd --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-anonymous-default-export.md b/src/docs/guide/usage/linter/rules/import/no-anonymous-default-export.md index 948a6a8032c..dbc17e96d79 100644 --- a/src/docs/guide/usage/linter/rules/import/no-anonymous-default-export.md +++ b/src/docs/guide/usage/linter/rules/import/no-anonymous-default-export.md @@ -145,25 +145,8 @@ Allow anonymous object as default export. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-anonymous-default-export": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-anonymous-default-export --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-commonjs.md b/src/docs/guide/usage/linter/rules/import/no-commonjs.md index e220019dbeb..87c6a6c9dbf 100644 --- a/src/docs/guide/usage/linter/rules/import/no-commonjs.md +++ b/src/docs/guide/usage/linter/rules/import/no-commonjs.md @@ -110,25 +110,8 @@ but `module.exports` is reported as usual. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-commonjs": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-commonjs --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-cycle.md b/src/docs/guide/usage/linter/rules/import/no-cycle.md index eaabcab1936..91fbefe874e 100644 --- a/src/docs/guide/usage/linter/rules/import/no-cycle.md +++ b/src/docs/guide/usage/linter/rules/import/no-cycle.md @@ -107,25 +107,8 @@ Maximum dependency depth to traverse ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-cycle": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-cycle --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-default-export.md b/src/docs/guide/usage/linter/rules/import/no-default-export.md index ca7981f5dc8..90b9ba72c54 100644 --- a/src/docs/guide/usage/linter/rules/import/no-default-export.md +++ b/src/docs/guide/usage/linter/rules/import/no-default-export.md @@ -47,25 +47,8 @@ export const bar = "bar"; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-default-export": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-default-export --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-duplicates.md b/src/docs/guide/usage/linter/rules/import/no-duplicates.md index 3d81be8fe12..f7cad4699b8 100644 --- a/src/docs/guide/usage/linter/rules/import/no-duplicates.md +++ b/src/docs/guide/usage/linter/rules/import/no-duplicates.md @@ -88,25 +88,8 @@ import { Foo, type Bar } from "./module"; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-duplicates": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-duplicates --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-dynamic-require.md b/src/docs/guide/usage/linter/rules/import/no-dynamic-require.md index 12d159ca068..a09d5b3a8ee 100644 --- a/src/docs/guide/usage/linter/rules/import/no-dynamic-require.md +++ b/src/docs/guide/usage/linter/rules/import/no-dynamic-require.md @@ -57,25 +57,8 @@ When `true`, also check `import()` expressions for dynamic module specifiers. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-dynamic-require": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-dynamic-require --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-empty-named-blocks.md b/src/docs/guide/usage/linter/rules/import/no-empty-named-blocks.md index 6bde242cafa..714a19fed69 100644 --- a/src/docs/guide/usage/linter/rules/import/no-empty-named-blocks.md +++ b/src/docs/guide/usage/linter/rules/import/no-empty-named-blocks.md @@ -42,25 +42,8 @@ import Default, { mod } from "mod"; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-empty-named-blocks": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-empty-named-blocks --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-mutable-exports.md b/src/docs/guide/usage/linter/rules/import/no-mutable-exports.md index 3982294ef7b..c3990ce8b8b 100644 --- a/src/docs/guide/usage/linter/rules/import/no-mutable-exports.md +++ b/src/docs/guide/usage/linter/rules/import/no-mutable-exports.md @@ -50,25 +50,8 @@ but are not flagged by this rule at this time. They may be in the future. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-mutable-exports": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-mutable-exports --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-named-as-default-member.md b/src/docs/guide/usage/linter/rules/import/no-named-as-default-member.md index 9993f0afa42..c87c1738a6c 100644 --- a/src/docs/guide/usage/linter/rules/import/no-named-as-default-member.md +++ b/src/docs/guide/usage/linter/rules/import/no-named-as-default-member.md @@ -59,25 +59,8 @@ import { bar } from "./bar"; // Correct: accessing named export directly ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-named-as-default-member": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-named-as-default-member --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-named-as-default.md b/src/docs/guide/usage/linter/rules/import/no-named-as-default.md index bf8a588c28b..0e87dfe339c 100644 --- a/src/docs/guide/usage/linter/rules/import/no-named-as-default.md +++ b/src/docs/guide/usage/linter/rules/import/no-named-as-default.md @@ -64,25 +64,8 @@ imports, especially when TypeScript paths are used or in monorepo setups with mu ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-named-as-default": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-named-as-default --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-named-default.md b/src/docs/guide/usage/linter/rules/import/no-named-default.md index 43927c37c1d..2824f4541c2 100644 --- a/src/docs/guide/usage/linter/rules/import/no-named-default.md +++ b/src/docs/guide/usage/linter/rules/import/no-named-default.md @@ -42,25 +42,8 @@ import foo, { bar } from "./foo.js"; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-named-default": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-named-default --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-named-export.md b/src/docs/guide/usage/linter/rules/import/no-named-export.md index bca5e8fba20..b6d91ad720f 100644 --- a/src/docs/guide/usage/linter/rules/import/no-named-export.md +++ b/src/docs/guide/usage/linter/rules/import/no-named-export.md @@ -46,25 +46,8 @@ export { foo as default } ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-named-export": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-named-export --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-namespace.md b/src/docs/guide/usage/linter/rules/import/no-namespace.md index f43fb7308b4..a8bb4250f57 100644 --- a/src/docs/guide/usage/linter/rules/import/no-namespace.md +++ b/src/docs/guide/usage/linter/rules/import/no-namespace.md @@ -72,25 +72,8 @@ For example, `["*.json"]` will ignore all JSON imports. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-namespace": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-namespace --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-nodejs-modules.md b/src/docs/guide/usage/linter/rules/import/no-nodejs-modules.md index 34635a96918..8fa054a13eb 100644 --- a/src/docs/guide/usage/linter/rules/import/no-nodejs-modules.md +++ b/src/docs/guide/usage/linter/rules/import/no-nodejs-modules.md @@ -63,25 +63,8 @@ Array of names of allowed modules. Defaults to an empty array. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-nodejs-modules": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-nodejs-modules --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-relative-parent-imports.md b/src/docs/guide/usage/linter/rules/import/no-relative-parent-imports.md index 68652f962a3..95a057460f0 100644 --- a/src/docs/guide/usage/linter/rules/import/no-relative-parent-imports.md +++ b/src/docs/guide/usage/linter/rules/import/no-relative-parent-imports.md @@ -47,25 +47,8 @@ import b from "./b"; ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-relative-parent-imports": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-relative-parent-imports --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-self-import.md b/src/docs/guide/usage/linter/rules/import/no-self-import.md index a6c9c57ee83..5be8250a41a 100644 --- a/src/docs/guide/usage/linter/rules/import/no-self-import.md +++ b/src/docs/guide/usage/linter/rules/import/no-self-import.md @@ -44,25 +44,8 @@ import bar from "./bar.js"; // Correct: module imports another module ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-self-import": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-self-import --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-unassigned-import.md b/src/docs/guide/usage/linter/rules/import/no-unassigned-import.md index 0ed1731987b..cd3e2ebab80 100644 --- a/src/docs/guide/usage/linter/rules/import/no-unassigned-import.md +++ b/src/docs/guide/usage/linter/rules/import/no-unassigned-import.md @@ -68,25 +68,8 @@ For example: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-unassigned-import": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-unassigned-import --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/no-webpack-loader-syntax.md b/src/docs/guide/usage/linter/rules/import/no-webpack-loader-syntax.md index cf94e99e78c..acd2723ea3f 100644 --- a/src/docs/guide/usage/linter/rules/import/no-webpack-loader-syntax.md +++ b/src/docs/guide/usage/linter/rules/import/no-webpack-loader-syntax.md @@ -48,25 +48,8 @@ var theme = require("./theme.css"); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/no-webpack-loader-syntax": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/no-webpack-loader-syntax --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/prefer-default-export.md b/src/docs/guide/usage/linter/rules/import/prefer-default-export.md index 58b409a4815..6047d70a370 100644 --- a/src/docs/guide/usage/linter/rules/import/prefer-default-export.md +++ b/src/docs/guide/usage/linter/rules/import/prefer-default-export.md @@ -70,25 +70,8 @@ Configuration option to specify the target type for preferring default exports. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/prefer-default-export": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/prefer-default-export --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/import/unambiguous.md b/src/docs/guide/usage/linter/rules/import/unambiguous.md index 37a1989bee3..fb89ee61dcd 100644 --- a/src/docs/guide/usage/linter/rules/import/unambiguous.md +++ b/src/docs/guide/usage/linter/rules/import/unambiguous.md @@ -56,25 +56,8 @@ export {}; // simple way to mark side-effects-only file as 'module' without any ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["import"], - "rules": { - "import/unambiguous": "error" - } -} -``` - -```bash [CLI] -oxlint --deny import/unambiguous --import-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/consistent-test-it.md b/src/docs/guide/usage/linter/rules/jest/consistent-test-it.md index 3e7190bcc64..0c9d5a3de27 100644 --- a/src/docs/guide/usage/linter/rules/jest/consistent-test-it.md +++ b/src/docs/guide/usage/linter/rules/jest/consistent-test-it.md @@ -93,25 +93,8 @@ If only `fn` is provided, this will default to the value of `fn`. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/consistent-test-it": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/consistent-test-it --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/expect-expect.md b/src/docs/guide/usage/linter/rules/jest/expect-expect.md index 3d34e23b4e9..09750aba56f 100644 --- a/src/docs/guide/usage/linter/rules/jest/expect-expect.md +++ b/src/docs/guide/usage/linter/rules/jest/expect-expect.md @@ -70,25 +70,8 @@ NOTE: The default value is `["expect"]` for Jest and ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/expect-expect": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/expect-expect --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/max-expects.md b/src/docs/guide/usage/linter/rules/jest/max-expects.md index 76effe2a5a9..e37a3f429da 100644 --- a/src/docs/guide/usage/linter/rules/jest/max-expects.md +++ b/src/docs/guide/usage/linter/rules/jest/max-expects.md @@ -74,25 +74,8 @@ Maximum number of `expect()` assertion calls allowed within a single test. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/max-expects": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/max-expects --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/max-nested-describe.md b/src/docs/guide/usage/linter/rules/jest/max-nested-describe.md index 86d2d27e22d..e552bb71334 100644 --- a/src/docs/guide/usage/linter/rules/jest/max-nested-describe.md +++ b/src/docs/guide/usage/linter/rules/jest/max-nested-describe.md @@ -126,25 +126,8 @@ Maximum allowed depth of nested describe calls. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/max-nested-describe": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/max-nested-describe --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-alias-methods.md b/src/docs/guide/usage/linter/rules/jest/no-alias-methods.md index be64adcc55d..875954bb2b7 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-alias-methods.md +++ b/src/docs/guide/usage/linter/rules/jest/no-alias-methods.md @@ -97,25 +97,8 @@ expect(a); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-alias-methods": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-alias-methods --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-commented-out-tests.md b/src/docs/guide/usage/linter/rules/jest/no-commented-out-tests.md index c417046c557..1d8bf17f52c 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-commented-out-tests.md +++ b/src/docs/guide/usage/linter/rules/jest/no-commented-out-tests.md @@ -53,25 +53,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-commented-out-tests": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-commented-out-tests --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-conditional-expect.md b/src/docs/guide/usage/linter/rules/jest/no-conditional-expect.md index a93f42afe93..a66e9b7fafb 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-conditional-expect.md +++ b/src/docs/guide/usage/linter/rules/jest/no-conditional-expect.md @@ -101,25 +101,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-conditional-expect": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-conditional-expect --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-conditional-in-test.md b/src/docs/guide/usage/linter/rules/jest/no-conditional-in-test.md index dfa59c0478e..0395a675943 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-conditional-in-test.md +++ b/src/docs/guide/usage/linter/rules/jest/no-conditional-in-test.md @@ -104,25 +104,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-conditional-in-test": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-conditional-in-test --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-confusing-set-timeout.md b/src/docs/guide/usage/linter/rules/jest/no-confusing-set-timeout.md index 26d70277e15..227c4525403 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-confusing-set-timeout.md +++ b/src/docs/guide/usage/linter/rules/jest/no-confusing-set-timeout.md @@ -57,25 +57,8 @@ describe("unit test", () => { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-confusing-set-timeout": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-confusing-set-timeout --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-deprecated-functions.md b/src/docs/guide/usage/linter/rules/jest/no-deprecated-functions.md index b8cd5825553..432d87c2bb6 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-deprecated-functions.md +++ b/src/docs/guide/usage/linter/rules/jest/no-deprecated-functions.md @@ -83,25 +83,8 @@ The version of Jest being used. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-deprecated-functions": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-deprecated-functions --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-disabled-tests.md b/src/docs/guide/usage/linter/rules/jest/no-disabled-tests.md index 8173c9a6e7e..c8780cde8ec 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-disabled-tests.md +++ b/src/docs/guide/usage/linter/rules/jest/no-disabled-tests.md @@ -62,25 +62,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-disabled-tests": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-disabled-tests --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-done-callback.md b/src/docs/guide/usage/linter/rules/jest/no-done-callback.md index b5a5758f4bb..8397f403e8c 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-done-callback.md +++ b/src/docs/guide/usage/linter/rules/jest/no-done-callback.md @@ -61,25 +61,8 @@ test("myFunction()", function (done) { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-done-callback": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-done-callback --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-duplicate-hooks.md b/src/docs/guide/usage/linter/rules/jest/no-duplicate-hooks.md index f7eb3805316..fe960c26446 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-duplicate-hooks.md +++ b/src/docs/guide/usage/linter/rules/jest/no-duplicate-hooks.md @@ -107,25 +107,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-duplicate-hooks": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-duplicate-hooks --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-export.md b/src/docs/guide/usage/linter/rules/jest/no-export.md index b0973fd96e5..a39eec94903 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-export.md +++ b/src/docs/guide/usage/linter/rules/jest/no-export.md @@ -38,25 +38,8 @@ describe("a test", () => { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-export": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-export --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-focused-tests.md b/src/docs/guide/usage/linter/rules/jest/no-focused-tests.md index a40ecd52022..73e4464310f 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-focused-tests.md +++ b/src/docs/guide/usage/linter/rules/jest/no-focused-tests.md @@ -59,25 +59,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-focused-tests": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-focused-tests --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-hooks.md b/src/docs/guide/usage/linter/rules/jest/no-hooks.md index 543722f43d6..edf2dba4d66 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-hooks.md +++ b/src/docs/guide/usage/linter/rules/jest/no-hooks.md @@ -95,25 +95,8 @@ An array of hook function names that are permitted for use. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-hooks": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-hooks --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-identical-title.md b/src/docs/guide/usage/linter/rules/jest/no-identical-title.md index 00540f615f9..35d859c5125 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-identical-title.md +++ b/src/docs/guide/usage/linter/rules/jest/no-identical-title.md @@ -53,25 +53,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-identical-title": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-identical-title --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-interpolation-in-snapshots.md b/src/docs/guide/usage/linter/rules/jest/no-interpolation-in-snapshots.md index 24170d59ebe..1d701e82303 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-interpolation-in-snapshots.md +++ b/src/docs/guide/usage/linter/rules/jest/no-interpolation-in-snapshots.md @@ -60,25 +60,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-interpolation-in-snapshots": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-interpolation-in-snapshots --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-jasmine-globals.md b/src/docs/guide/usage/linter/rules/jest/no-jasmine-globals.md index 23da333bba4..5fa4edd9d83 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-jasmine-globals.md +++ b/src/docs/guide/usage/linter/rules/jest/no-jasmine-globals.md @@ -57,25 +57,8 @@ test("my test", () => { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-jasmine-globals": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-jasmine-globals --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-large-snapshots.md b/src/docs/guide/usage/linter/rules/jest/no-large-snapshots.md index 316f79f4162..5f43616d5e5 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-large-snapshots.md +++ b/src/docs/guide/usage/linter/rules/jest/no-large-snapshots.md @@ -140,25 +140,8 @@ Maximum number of lines allowed for external snapshot files. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-large-snapshots": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-large-snapshots --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-mocks-import.md b/src/docs/guide/usage/linter/rules/jest/no-mocks-import.md index 01cf5d74f5f..81569a871ca 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-mocks-import.md +++ b/src/docs/guide/usage/linter/rules/jest/no-mocks-import.md @@ -56,25 +56,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-mocks-import": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-mocks-import --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-restricted-jest-methods.md b/src/docs/guide/usage/linter/rules/jest/no-restricted-jest-methods.md index d77a99473e8..d4ba873cdc3 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-restricted-jest-methods.md +++ b/src/docs/guide/usage/linter/rules/jest/no-restricted-jest-methods.md @@ -78,25 +78,8 @@ A mapping of restricted Jest method names to custom messages - or ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-restricted-jest-methods": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-restricted-jest-methods --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-restricted-matchers.md b/src/docs/guide/usage/linter/rules/jest/no-restricted-matchers.md index 9b9156331b4..e68ca991629 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-restricted-matchers.md +++ b/src/docs/guide/usage/linter/rules/jest/no-restricted-matchers.md @@ -103,25 +103,8 @@ The value is an optional custom message to display when the matcher/modifier is ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-restricted-matchers": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-restricted-matchers --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-standalone-expect.md b/src/docs/guide/usage/linter/rules/jest/no-standalone-expect.md index d9666a089c0..ea0d9817992 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-standalone-expect.md +++ b/src/docs/guide/usage/linter/rules/jest/no-standalone-expect.md @@ -66,25 +66,8 @@ An array of function names that should also be treated as test blocks. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-standalone-expect": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-standalone-expect --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-test-prefixes.md b/src/docs/guide/usage/linter/rules/jest/no-test-prefixes.md index 5a1a6245512..704d366ed4f 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-test-prefixes.md +++ b/src/docs/guide/usage/linter/rules/jest/no-test-prefixes.md @@ -54,25 +54,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-test-prefixes": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-test-prefixes --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-test-return-statement.md b/src/docs/guide/usage/linter/rules/jest/no-test-return-statement.md index 95a87540d2e..25debc9d0a9 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-test-return-statement.md +++ b/src/docs/guide/usage/linter/rules/jest/no-test-return-statement.md @@ -56,25 +56,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-test-return-statement": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-test-return-statement --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-unneeded-async-expect-function.md b/src/docs/guide/usage/linter/rules/jest/no-unneeded-async-expect-function.md index f35788f406c..604b3daefbd 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-unneeded-async-expect-function.md +++ b/src/docs/guide/usage/linter/rules/jest/no-unneeded-async-expect-function.md @@ -56,25 +56,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-unneeded-async-expect-function": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-unneeded-async-expect-function --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/no-untyped-mock-factory.md b/src/docs/guide/usage/linter/rules/jest/no-untyped-mock-factory.md index 6ab05fd0555..f0e282b81ea 100644 --- a/src/docs/guide/usage/linter/rules/jest/no-untyped-mock-factory.md +++ b/src/docs/guide/usage/linter/rules/jest/no-untyped-mock-factory.md @@ -80,25 +80,8 @@ jest.mock( ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/no-untyped-mock-factory": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/no-untyped-mock-factory --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/padding-around-test-blocks.md b/src/docs/guide/usage/linter/rules/jest/padding-around-test-blocks.md index 2a726b46a34..44c38cdb557 100644 --- a/src/docs/guide/usage/linter/rules/jest/padding-around-test-blocks.md +++ b/src/docs/guide/usage/linter/rules/jest/padding-around-test-blocks.md @@ -63,25 +63,8 @@ it("bar", () => {}); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/padding-around-test-blocks": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/padding-around-test-blocks --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-called-with.md b/src/docs/guide/usage/linter/rules/jest/prefer-called-with.md index 6c929d4f5b0..9799ad81941 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-called-with.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-called-with.md @@ -58,25 +58,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-called-with": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-called-with --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-comparison-matcher.md b/src/docs/guide/usage/linter/rules/jest/prefer-comparison-matcher.md index fe792d34a81..1e0ebe79008 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-comparison-matcher.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-comparison-matcher.md @@ -65,25 +65,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-comparison-matcher": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-comparison-matcher --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-each.md b/src/docs/guide/usage/linter/rules/jest/prefer-each.md index 5f4b97db9ea..b67066fe008 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-each.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-each.md @@ -58,25 +58,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-each": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-each --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-equality-matcher.md b/src/docs/guide/usage/linter/rules/jest/prefer-equality-matcher.md index f781d46780f..347c4ec2579 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-equality-matcher.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-equality-matcher.md @@ -59,25 +59,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-equality-matcher": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-equality-matcher --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-expect-resolves.md b/src/docs/guide/usage/linter/rules/jest/prefer-expect-resolves.md index 8cf780d80be..dc4b8f288f5 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-expect-resolves.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-expect-resolves.md @@ -80,25 +80,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-expect-resolves": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-expect-resolves --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-hooks-in-order.md b/src/docs/guide/usage/linter/rules/jest/prefer-hooks-in-order.md index c5aef17c189..2a16cec6242 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-hooks-in-order.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-hooks-in-order.md @@ -133,25 +133,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-hooks-in-order": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-hooks-in-order --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-hooks-on-top.md b/src/docs/guide/usage/linter/rules/jest/prefer-hooks-on-top.md index 5f111c4a634..edc8eb9be1e 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-hooks-on-top.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-hooks-on-top.md @@ -151,25 +151,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-hooks-on-top": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-hooks-on-top --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-jest-mocked.md b/src/docs/guide/usage/linter/rules/jest/prefer-jest-mocked.md index d3832587a0c..ded4773087d 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-jest-mocked.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-jest-mocked.md @@ -59,25 +59,8 @@ jest.mocked([].foo).mockReturnValue(1); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-jest-mocked": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-jest-mocked --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-lowercase-title.md b/src/docs/guide/usage/linter/rules/jest/prefer-lowercase-title.md index dadeb7ae02a..77e767a8a74 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-lowercase-title.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-lowercase-title.md @@ -172,25 +172,8 @@ describe("MyClass", () => { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-lowercase-title": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-lowercase-title --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-mock-promise-shorthand.md b/src/docs/guide/usage/linter/rules/jest/prefer-mock-promise-shorthand.md index 5cd185c1bab..c68f9985dde 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-mock-promise-shorthand.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-mock-promise-shorthand.md @@ -68,25 +68,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-mock-promise-shorthand": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-mock-promise-shorthand --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-mock-return-shorthand.md b/src/docs/guide/usage/linter/rules/jest/prefer-mock-return-shorthand.md index f44ce247dc8..06dcaa47767 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-mock-return-shorthand.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-mock-return-shorthand.md @@ -69,25 +69,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-mock-return-shorthand": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-mock-return-shorthand --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-spy-on.md b/src/docs/guide/usage/linter/rules/jest/prefer-spy-on.md index 7d3b492ddf5..6383ca765f3 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-spy-on.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-spy-on.md @@ -65,25 +65,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-spy-on": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-spy-on --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-strict-equal.md b/src/docs/guide/usage/linter/rules/jest/prefer-strict-equal.md index 35eb0a3e9b0..9ac4f5d515b 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-strict-equal.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-strict-equal.md @@ -53,25 +53,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-strict-equal": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-strict-equal --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-to-be.md b/src/docs/guide/usage/linter/rules/jest/prefer-to-be.md index 114d015ab52..d9900ac676a 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-to-be.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-to-be.md @@ -64,25 +64,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-to-be": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-to-be --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-to-contain.md b/src/docs/guide/usage/linter/rules/jest/prefer-to-contain.md index f68c8c6dbd7..6ba962042c9 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-to-contain.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-to-contain.md @@ -57,25 +57,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-to-contain": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-to-contain --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-to-have-been-called-times.md b/src/docs/guide/usage/linter/rules/jest/prefer-to-have-been-called-times.md index e7bb3d41820..f535b86f12e 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-to-have-been-called-times.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-to-have-been-called-times.md @@ -46,25 +46,8 @@ expect(method.mock.calls[0][0]).toStrictEqual(value); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-to-have-been-called-times": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-to-have-been-called-times --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-to-have-been-called.md b/src/docs/guide/usage/linter/rules/jest/prefer-to-have-been-called.md index 98d8ca62dfa..471b76e400c 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-to-have-been-called.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-to-have-been-called.md @@ -43,25 +43,8 @@ expect(mock).toHaveBeenCalledTimes(1); ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-to-have-been-called": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-to-have-been-called --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-to-have-length.md b/src/docs/guide/usage/linter/rules/jest/prefer-to-have-length.md index bfad819b216..8859d8278e7 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-to-have-length.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-to-have-length.md @@ -54,25 +54,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-to-have-length": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-to-have-length --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/prefer-todo.md b/src/docs/guide/usage/linter/rules/jest/prefer-todo.md index 45a1ccede2c..3efd3ef19e1 100644 --- a/src/docs/guide/usage/linter/rules/jest/prefer-todo.md +++ b/src/docs/guide/usage/linter/rules/jest/prefer-todo.md @@ -53,25 +53,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/prefer-todo": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/prefer-todo --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/require-hook.md b/src/docs/guide/usage/linter/rules/jest/require-hook.md index 43add18d2ba..90b13092ac8 100644 --- a/src/docs/guide/usage/linter/rules/jest/require-hook.md +++ b/src/docs/guide/usage/linter/rules/jest/require-hook.md @@ -158,25 +158,8 @@ An array of function names that are allowed to be called outside of hooks. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/require-hook": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/require-hook --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/require-to-throw-message.md b/src/docs/guide/usage/linter/rules/jest/require-to-throw-message.md index ce6e4da0736..3610a2d2dbd 100644 --- a/src/docs/guide/usage/linter/rules/jest/require-to-throw-message.md +++ b/src/docs/guide/usage/linter/rules/jest/require-to-throw-message.md @@ -64,25 +64,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/require-to-throw-message": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/require-to-throw-message --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/require-top-level-describe.md b/src/docs/guide/usage/linter/rules/jest/require-top-level-describe.md index b363710e5d2..ff629bc5be7 100644 --- a/src/docs/guide/usage/linter/rules/jest/require-top-level-describe.md +++ b/src/docs/guide/usage/linter/rules/jest/require-top-level-describe.md @@ -93,25 +93,8 @@ The maximum number of top-level `describe` blocks allowed in a test file. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/require-top-level-describe": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/require-top-level-describe --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/valid-describe-callback.md b/src/docs/guide/usage/linter/rules/jest/valid-describe-callback.md index bcdc38cd1de..55a1044dbdc 100644 --- a/src/docs/guide/usage/linter/rules/jest/valid-describe-callback.md +++ b/src/docs/guide/usage/linter/rules/jest/valid-describe-callback.md @@ -65,25 +65,8 @@ to use it, add the following configuration to your `.oxlintrc.json`: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/valid-describe-callback": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/valid-describe-callback --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/valid-expect.md b/src/docs/guide/usage/linter/rules/jest/valid-expect.md index b14c69d1284..293b6ed9367 100644 --- a/src/docs/guide/usage/linter/rules/jest/valid-expect.md +++ b/src/docs/guide/usage/linter/rules/jest/valid-expect.md @@ -93,25 +93,8 @@ Minimum number of arguments `expect` should be called with. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/valid-expect": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/valid-expect --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jest/valid-title.md b/src/docs/guide/usage/linter/rules/jest/valid-title.md index a33654c3cd4..39430881c05 100644 --- a/src/docs/guide/usage/linter/rules/jest/valid-title.md +++ b/src/docs/guide/usage/linter/rules/jest/valid-title.md @@ -70,25 +70,8 @@ interface Options { ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jest"], - "rules": { - "jest/valid-title": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jest/valid-title --jest-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/check-access.md b/src/docs/guide/usage/linter/rules/jsdoc/check-access.md index c51fff70d0d..cd2d0dc134d 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/check-access.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/check-access.md @@ -54,25 +54,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/check-access": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/check-access --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/check-property-names.md b/src/docs/guide/usage/linter/rules/jsdoc/check-property-names.md index 8747edd5ae5..224e253b583 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/check-property-names.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/check-property-names.md @@ -57,25 +57,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/check-property-names": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/check-property-names --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/check-tag-names.md b/src/docs/guide/usage/linter/rules/jsdoc/check-tag-names.md index 8748a3015ad..da9924a54ea 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/check-tag-names.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/check-tag-names.md @@ -115,25 +115,8 @@ If typed is `true`, disallow tags that are unnecessary/duplicative of TypeScript ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/check-tag-names": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/check-tag-names --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/empty-tags.md b/src/docs/guide/usage/linter/rules/jsdoc/empty-tags.md index 14ec04f87b7..67fcdabb467 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/empty-tags.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/empty-tags.md @@ -74,25 +74,8 @@ Additional tags to check for their descriptions. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/empty-tags": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/empty-tags --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/implements-on-classes.md b/src/docs/guide/usage/linter/rules/jsdoc/implements-on-classes.md index f2fbe633668..4ca5acd353d 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/implements-on-classes.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/implements-on-classes.md @@ -53,25 +53,8 @@ function quux() {} ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/implements-on-classes": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/implements-on-classes --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/no-defaults.md b/src/docs/guide/usage/linter/rules/jsdoc/no-defaults.md index 8b6586e584b..261677479cf 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/no-defaults.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/no-defaults.md @@ -58,25 +58,8 @@ If true, report the presence of optional param names (square brackets) on `@para ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/no-defaults": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/no-defaults --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/require-param-description.md b/src/docs/guide/usage/linter/rules/jsdoc/require-param-description.md index 872a9e052d0..b6f00ec5b61 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/require-param-description.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/require-param-description.md @@ -41,25 +41,8 @@ function quux(foo) {} ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/require-param-description": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/require-param-description --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/require-param-name.md b/src/docs/guide/usage/linter/rules/jsdoc/require-param-name.md index 008f7635d2a..e28e1339761 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/require-param-name.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/require-param-name.md @@ -41,25 +41,8 @@ function quux(foo) {} ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/require-param-name": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/require-param-name --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/require-param-type.md b/src/docs/guide/usage/linter/rules/jsdoc/require-param-type.md index 10667b7813f..d880893136d 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/require-param-type.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/require-param-type.md @@ -41,25 +41,8 @@ function quux(foo) {} ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/require-param-type": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/require-param-type --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/require-param.md b/src/docs/guide/usage/linter/rules/jsdoc/require-param.md index a269ce0b088..a1e7d5c05f4 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/require-param.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/require-param.md @@ -113,25 +113,8 @@ List of JSDoc tags that exempt functions from `@param` checking. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/require-param": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/require-param --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/require-property-description.md b/src/docs/guide/usage/linter/rules/jsdoc/require-property-description.md index 84d14a65617..e165862e877 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/require-property-description.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/require-property-description.md @@ -45,25 +45,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/require-property-description": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/require-property-description --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/require-property-name.md b/src/docs/guide/usage/linter/rules/jsdoc/require-property-name.md index 41e556696ef..d82cc0961c0 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/require-property-name.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/require-property-name.md @@ -45,25 +45,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/require-property-name": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/require-property-name --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/require-property-type.md b/src/docs/guide/usage/linter/rules/jsdoc/require-property-type.md index effb7612451..949fa791208 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/require-property-type.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/require-property-type.md @@ -45,25 +45,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/require-property-type": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/require-property-type --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/require-property.md b/src/docs/guide/usage/linter/rules/jsdoc/require-property.md index a88e0503d10..874400940d4 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/require-property.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/require-property.md @@ -56,25 +56,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/require-property": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/require-property --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/require-returns-description.md b/src/docs/guide/usage/linter/rules/jsdoc/require-returns-description.md index 86eda2320e2..35f35c50515 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/require-returns-description.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/require-returns-description.md @@ -42,25 +42,8 @@ function quux(foo) {} ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/require-returns-description": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/require-returns-description --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/require-returns-type.md b/src/docs/guide/usage/linter/rules/jsdoc/require-returns-type.md index 5de91e506e6..fb95ddeeaa9 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/require-returns-type.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/require-returns-type.md @@ -41,25 +41,8 @@ function quux(foo) {} ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/require-returns-type": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/require-returns-type --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/require-returns.md b/src/docs/guide/usage/linter/rules/jsdoc/require-returns.md index 78067243804..ee19b3a1d78 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/require-returns.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/require-returns.md @@ -98,25 +98,8 @@ Whether to require a `@returns` tag for async functions. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/require-returns": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/require-returns --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsdoc/require-yields.md b/src/docs/guide/usage/linter/rules/jsdoc/require-yields.md index 80e37c0129a..90ce69226b6 100644 --- a/src/docs/guide/usage/linter/rules/jsdoc/require-yields.md +++ b/src/docs/guide/usage/linter/rules/jsdoc/require-yields.md @@ -79,25 +79,8 @@ When `true`, require `@yields` when a `@generator` tag is present. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsdoc"], - "rules": { - "jsdoc/require-yields": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsdoc/require-yields --jsdoc-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/alt-text.md b/src/docs/guide/usage/linter/rules/jsx_a11y/alt-text.md index a37a80e270c..3c864a30d9a 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/alt-text.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/alt-text.md @@ -85,25 +85,8 @@ Custom components to check for alt text on `object` elements. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/alt-text": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/alt-text --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/anchor-ambiguous-text.md b/src/docs/guide/usage/linter/rules/jsx_a11y/anchor-ambiguous-text.md index ea3576ac933..3aa3bb9d99e 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/anchor-ambiguous-text.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/anchor-ambiguous-text.md @@ -61,25 +61,8 @@ List of ambiguous words or phrases that should be flagged in anchor text. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/anchor-ambiguous-text": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/anchor-ambiguous-text --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/anchor-has-content.md b/src/docs/guide/usage/linter/rules/jsx_a11y/anchor-has-content.md index 561364d568a..f8694ff3275 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/anchor-has-content.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/anchor-has-content.md @@ -48,25 +48,8 @@ Examples of **incorrect** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/anchor-has-content": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/anchor-has-content --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/anchor-is-valid.md b/src/docs/guide/usage/linter/rules/jsx_a11y/anchor-is-valid.md index f6a90e64a1f..bbc542a5361 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/anchor-is-valid.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/anchor-is-valid.md @@ -102,25 +102,8 @@ List of strings that are valid href values. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/anchor-is-valid": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/anchor-is-valid --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/aria-activedescendant-has-tabindex.md b/src/docs/guide/usage/linter/rules/jsx_a11y/aria-activedescendant-has-tabindex.md index 06fa9484c04..1b678d641a2 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/aria-activedescendant-has-tabindex.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/aria-activedescendant-has-tabindex.md @@ -60,25 +60,8 @@ const Good = ( ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/aria-activedescendant-has-tabindex": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/aria-activedescendant-has-tabindex --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/aria-props.md b/src/docs/guide/usage/linter/rules/jsx_a11y/aria-props.md index ff4958c2e7d..728967cd423 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/aria-props.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/aria-props.md @@ -43,25 +43,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/aria-props": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/aria-props --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/aria-proptypes.md b/src/docs/guide/usage/linter/rules/jsx_a11y/aria-proptypes.md index 8dbdf17d489..575905e98a7 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/aria-proptypes.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/aria-proptypes.md @@ -44,25 +44,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/aria-proptypes": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/aria-proptypes --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/aria-role.md b/src/docs/guide/usage/linter/rules/jsx_a11y/aria-role.md index 6e3700d18fb..cd00ec91336 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/aria-role.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/aria-role.md @@ -88,25 +88,8 @@ Determines if developer-created components are checked. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/aria-role": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/aria-role --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/aria-unsupported-elements.md b/src/docs/guide/usage/linter/rules/jsx_a11y/aria-unsupported-elements.md index 15d959f8fd3..31f383c841c 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/aria-unsupported-elements.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/aria-unsupported-elements.md @@ -43,25 +43,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/aria-unsupported-elements": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/aria-unsupported-elements --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/autocomplete-valid.md b/src/docs/guide/usage/linter/rules/jsx_a11y/autocomplete-valid.md index aceb2a7a8fe..b297773f333 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/autocomplete-valid.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/autocomplete-valid.md @@ -51,25 +51,8 @@ List of custom component names that should be treated as input elements. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/autocomplete-valid": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/autocomplete-valid --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/click-events-have-key-events.md b/src/docs/guide/usage/linter/rules/jsx_a11y/click-events-have-key-events.md index b27346aea08..8c87f9a0fc1 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/click-events-have-key-events.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/click-events-have-key-events.md @@ -40,25 +40,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/click-events-have-key-events": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/click-events-have-key-events --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/heading-has-content.md b/src/docs/guide/usage/linter/rules/jsx_a11y/heading-has-content.md index a5fb8d1a9ef..2f90f3f02d2 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/heading-has-content.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/heading-has-content.md @@ -57,25 +57,8 @@ These will be validated in addition to the standard h1-h6 elements. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/heading-has-content": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/heading-has-content --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/html-has-lang.md b/src/docs/guide/usage/linter/rules/jsx_a11y/html-has-lang.md index f6da43dc3ab..a9cb2711879 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/html-has-lang.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/html-has-lang.md @@ -42,25 +42,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/html-has-lang": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/html-has-lang --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/iframe-has-title.md b/src/docs/guide/usage/linter/rules/jsx_a11y/iframe-has-title.md index 510cd5555c1..0a1c1cd483a 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/iframe-has-title.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/iframe-has-title.md @@ -51,25 +51,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/iframe-has-title": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/iframe-has-title --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/img-redundant-alt.md b/src/docs/guide/usage/linter/rules/jsx_a11y/img-redundant-alt.md index fddb56fb2be..d478809c30f 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/img-redundant-alt.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/img-redundant-alt.md @@ -68,25 +68,8 @@ Words considered redundant in alt text that should trigger a warning. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/img-redundant-alt": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/img-redundant-alt --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/label-has-associated-control.md b/src/docs/guide/usage/linter/rules/jsx_a11y/label-has-associated-control.md index 00cfd6eb29d..80d13fad151 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/label-has-associated-control.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/label-has-associated-control.md @@ -97,25 +97,8 @@ Custom JSX components to be treated as labels. ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/label-has-associated-control": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/label-has-associated-control --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/lang.md b/src/docs/guide/usage/linter/rules/jsx_a11y/lang.md index 29cf673d9e5..aa6c64caa5a 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/lang.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/lang.md @@ -49,25 +49,8 @@ Examples of **correct** code for this rule: ## How to use -To **enable** this rule using the config file or in the CLI, you can use: - -::: code-group - -```json [Config (.oxlintrc.json)] -{ - "plugins": ["jsx-a11y"], - "rules": { - "jsx-a11y/lang": "error" - } -} -``` - -```bash [CLI] -oxlint --deny jsx-a11y/lang --jsx-a11y-plugin -``` - -::: + ## References -- Rule Source + diff --git a/src/docs/guide/usage/linter/rules/jsx_a11y/media-has-caption.md b/src/docs/guide/usage/linter/rules/jsx_a11y/media-has-caption.md index 9be2e482a41..1cd5d2a95f2 100644 --- a/src/docs/guide/usage/linter/rules/jsx_a11y/media-has-caption.md +++ b/src/docs/guide/usage/linter/rules/jsx_a11y/media-has-caption.md @@ -71,25 +71,8 @@ Element names to treat as `