@typescript-eslint/eslint-plugin 7.2.1-alpha.1 → 7.2.1-alpha.3

package/docs/rules/{sort-type-constituents.md → sort-type-constituents.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce constituents of a type union/intersection to be sorted alphabetically.'
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 > 🛑 This file is source code, not the primary documentation location! 🛑
 >
 > See **https://typescript-eslint.io/rules/sort-type-constituents** for documentation.
@@ -18,9 +21,8 @@ This rule reports on any types that aren't sorted alphabetically.
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 type T1 = B | A;
@@ -50,7 +52,8 @@ type T4 =
   | any;
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 type T1 = A | B;
@@ -80,6 +83,9 @@ type T4 =
   | [1, 2, 4];
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 ### `checkIntersections`
@@ -88,40 +94,46 @@ Whether to check intersection types (`&`).
 
 Examples of code with `{ "checkIntersections": true }` (the default):
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "checkIntersections": true }'
 type ExampleIntersection = B & A;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "checkIntersections": true }'
 type ExampleIntersection = A & B;
 ```
 
+</TabItem>
+</Tabs>
+
 ### `checkUnions`
 
 Whether to check union types (`|`).
 
 Examples of code with `{ "checkUnions": true }` (the default):
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "checkUnions": true }'
 type ExampleUnion = B | A;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "checkUnions": true }'
 type ExampleUnion = A | B;
 ```
 
+</TabItem>
+</Tabs>
+
 ### `groupOrder`
 
 Each constituent of the type is placed into a group, and then the rule sorts alphabetically within each group.
@@ -142,20 +154,23 @@ The ordering of groups is determined by this option.
 
 For example, configuring the rule with `{ "groupOrder": ["literal", "nullish" ]}`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "groupOrder": ["literal", "nullish" ]}'
 type ExampleGroup = null | 123;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "groupOrder": ["literal", "nullish" ]}'
 type ExampleGroup = 123 | null;
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 This rule is purely a stylistic rule for maintaining consistency in your project.

package/docs/rules/{space-before-blocks.md → space-before-blocks.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce consistent spacing before blocks.'
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 > 🛑 This file is source code, not the primary documentation location! 🛑
 >
 > See **https://typescript-eslint.io/rules/space-before-blocks** for documentation.
@@ -9,9 +12,8 @@ description: 'Enforce consistent spacing before blocks.'
 This rule extends the base [`eslint/space-before-blocks`](https://eslint.org/docs/rules/space-before-blocks) rule.
 It adds support for interfaces and enums.
 
-<!-- tabs -->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 <!-- prettier-ignore -->
 ```ts
@@ -25,7 +27,8 @@ interface State{
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 enum Breakpoint {
@@ -38,6 +41,9 @@ interface State {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 In case a more specific options object is passed these blocks will follow `classes` configuration option.

package/docs/rules/{space-before-function-paren.md → space-before-function-paren.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce consistent spacing before function parenthesis.'
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 > 🛑 This file is source code, not the primary documentation location! 🛑
 >
 > See **https://typescript-eslint.io/rules/space-before-function-paren** for documentation.

package/docs/rules/{space-infix-ops.md → space-infix-ops.mdx}

@@ -2,6 +2,9 @@
 description: 'Require spacing around infix operators.'
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 > 🛑 This file is source code, not the primary documentation location! 🛑
 >
 > See **https://typescript-eslint.io/rules/space-infix-ops** for documentation.

package/docs/rules/{strict-boolean-expressions.md → strict-boolean-expressions.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow certain types in boolean expressions.'
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 > 🛑 This file is source code, not the primary documentation location! 🛑
 >
 > See **https://typescript-eslint.io/rules/strict-boolean-expressions** for documentation.
@@ -21,9 +24,8 @@ The following nodes are considered boolean expressions and their type is checked
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 // nullable numbers are considered unsafe by default
@@ -55,7 +57,8 @@ while (obj) {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```tsx
 // Using logical operator short-circuiting is allowed
@@ -85,6 +88,9 @@ function foo(bool?: boolean) {
 const foo = (arg: any) => (Boolean(arg) ? 1 : 0);
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 ### `allowString`
@@ -187,4 +193,4 @@ If you prefer more succinct checks over more precise boolean logic, this rule mi
 
 ## Related To
 
-- [no-unnecessary-condition](./no-unnecessary-condition.md) - Similar rule which reports always-truthy and always-falsy values in conditions
+- [no-unnecessary-condition](./no-unnecessary-condition.mdx) - Similar rule which reports always-truthy and always-falsy values in conditions

package/docs/rules/{switch-exhaustiveness-check.md → switch-exhaustiveness-check.mdx}

@@ -2,6 +2,9 @@
 description: 'Require switch-case statements to be exhaustive.'
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 > 🛑 This file is source code, not the primary documentation location! 🛑
 >
 > See **https://typescript-eslint.io/rules/switch-exhaustiveness-check** for documentation.
@@ -50,17 +53,14 @@ switch (value) {
 
 Since `value` is a non-union type it requires the switch case to have a default clause only with `requireDefaultForNonUnion` enabled.
 
-<!--/tabs-->
-
 ## Examples
 
 When the switch doesn't have exhaustive cases, either filling them all out or adding a default will correct the rule's complaint.
 
 Here are some examples of code working with a union of literals:
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 type Day =
@@ -82,7 +82,8 @@ switch (day) {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct (Exhaustive)">
 
 ```ts
 type Day =
@@ -122,7 +123,8 @@ switch (day) {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct (Defaulted)">
 
 ```ts
 type Day =
@@ -146,13 +148,13 @@ switch (day) {
 }
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 Likewise, here are some examples of code working with an enum:
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 enum Fruit {
@@ -170,7 +172,8 @@ switch (fruit) {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct (Exhaustive)">
 
 ```ts
 enum Fruit {
@@ -196,7 +199,8 @@ switch (fruit) {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct (Defaulted)">
 
 ```ts
 enum Fruit {
@@ -218,7 +222,8 @@ switch (fruit) {
 }
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ## When Not To Use It
 

package/docs/rules/{triple-slash-reference.md → triple-slash-reference.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow certain triple slash directives in favor of ES6-style import declarations.'
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 > 🛑 This file is source code, not the primary documentation location! 🛑
 >
 > See **https://typescript-eslint.io/rules/triple-slash-reference** for documentation.
@@ -19,9 +22,8 @@ Specifying `'always'` disables this lint rule for that kind of reference.
 
 When set to `'never'`, bans `/// <reference lib="..." />` and enforces using an `import` instead:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "lib": "never" }'
 /// <reference lib="code" />
@@ -29,19 +31,22 @@ When set to `'never'`, bans `/// <reference lib="..." />` and enforces using an
 globalThis.value;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "lib": "never" }'
 import { value } from 'code';
 ```
 
+</TabItem>
+</Tabs>
+
 ### `path`
 
 When set to `'never'`, bans `/// <reference path="..." />` and enforces using an `import` instead:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "path": "never" }'
 /// <reference path="code" />
@@ -49,19 +54,22 @@ When set to `'never'`, bans `/// <reference path="..." />` and enforces using an
 globalThis.value;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "path": "never" }'
 import { value } from 'code';
 ```
 
+</TabItem>
+</Tabs>
+
 ### `types`
 
 When set to `'never'`, bans `/// <reference types="..." />` and enforces using an `import` instead:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "types": "never" }'
 /// <reference types="code" />
@@ -69,20 +77,21 @@ When set to `'never'`, bans `/// <reference types="..." />` and enforces using a
 globalThis.value;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "types": "never" }'
 import { value } from 'code';
 ```
 
-<!-- /tabs -->
+</TabItem>
+</Tabs>
 
 The `types` option may alternately be given a `"prefer-import"` value.
 Doing so indicates the rule should only report if there is already an `import` from the same location:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "types": "prefer-import" }'
 /// <reference types="code" />
@@ -92,12 +101,16 @@ import { valueA } from 'code';
 globalThis.valueB;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "types": "prefer-import" }'
 import { valueA, valueB } from 'code';
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 Most modern TypeScript projects generally use `import` statements to bring in types.

package/docs/rules/{type-annotation-spacing.md → type-annotation-spacing.mdx}

@@ -2,13 +2,16 @@
 description: 'Require consistent spacing around type annotations.'
 ---
 
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
 > 🛑 This file is source code, not the primary documentation location! 🛑
 >
 > See **https://typescript-eslint.io/rules/type-annotation-spacing** for documentation.
 
 Spacing around type annotations improves readability of the code. Although the most commonly used style guideline for type annotations in TypeScript prescribes adding a space after the colon, but not before it, it is subjective to the preferences of a project. For example:
 
-<!-- prettier-ignore -->
+{/* prettier-ignore */}
 ```ts
 // with space after, but not before (default if no option is specified)
 let foo: string = "bar";
@@ -39,11 +42,10 @@ type Foo = (string: name) =>string;
 
 This rule aims to enforce specific spacing patterns around type annotations and function types in type literals.
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
-<!-- prettier-ignore -->
+{/* prettier-ignore */}
 ```ts
 let foo:string = "bar";
 let foo :string = "bar";
@@ -70,9 +72,10 @@ type Foo = () =>{};
 type Foo = ()=> {};
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
-<!-- prettier-ignore -->
+{/* prettier-ignore */}
 ```ts
 let foo: string = "bar";
 
@@ -85,6 +88,9 @@ class Foo {
 type Foo = () => {};
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 ### after
@@ -93,11 +99,10 @@ type Foo = () => {};
 { "before": false, "after": true }
 ```
 
-<!--tabs-->
+<Tabs>
+<TabItem value="❌ Incorrect">
 
-#### ❌ Incorrect
-
-<!-- prettier-ignore -->
+{/* prettier-ignore */}
 ```ts option='{ "before": false, "after": true }'
 let foo:string = "bar";
 let foo :string = "bar";
@@ -124,9 +129,10 @@ type Foo = () =>{};
 type Foo = () => {};
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
-<!-- prettier-ignore -->
+{/* prettier-ignore */}
 ```ts option='{ "before": false, "after": true }'
 let foo: string = "bar";
 
@@ -139,17 +145,19 @@ class Foo {
 type Foo = ()=> {};
 ```
 
+</TabItem>
+</Tabs>
+
 ### before
 
 ```json
 { "before": true, "after": true }
 ```
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
-<!-- prettier-ignore -->
+{/* prettier-ignore */}
 ```ts option='{ "before": true, "after": true }'
 let foo: string = "bar";
 let foo:string = "bar";
@@ -176,9 +184,10 @@ type Foo = () =>{};
 type Foo = ()=> {};
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
-<!-- prettier-ignore -->
+{/* prettier-ignore */}
 ```ts option='{ "before": true, "after": true }'
 let foo : string = "bar";
 
@@ -191,6 +200,9 @@ class Foo {
 type Foo = () => {};
 ```
 
+</TabItem>
+</Tabs>
+
 ### overrides - colon
 
 ```json
@@ -201,11 +213,10 @@ type Foo = () => {};
 }
 ```
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
-<!-- prettier-ignore -->
+{/* prettier-ignore */}
 ```ts option='{"before":false,"after":false,"overrides":{"colon":{"before":true,"after":true}}}'
 let foo: string = "bar";
 let foo:string = "bar";
@@ -232,9 +243,10 @@ type Foo = ()=> {};
 type Foo = () => {};
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
-<!-- prettier-ignore -->
+{/* prettier-ignore */}
 ```ts option='{"before":false,"after":false,"overrides":{"colon":{"before":true,"after":true}}}'
 let foo : string = "bar";
 
@@ -251,6 +263,9 @@ type Foo = {
 type Foo = ()=>{};
 ```
 
+</TabItem>
+</Tabs>
+
 ### overrides - arrow
 
 ```json
@@ -261,11 +276,10 @@ type Foo = ()=>{};
 }
 ```
 
-<!--tabs-->
+<Tabs>
+<TabItem value="❌ Incorrect">
 
-#### ❌ Incorrect
-
-<!-- prettier-ignore -->
+{/* prettier-ignore */}
 ```ts option='{"before":false,"after":false,"overrides":{"arrow":{"before":true,"after":true}}}'
 let foo: string = "bar";
 let foo : string = "bar";
@@ -292,9 +306,10 @@ type Foo = () =>{};
 type Foo = ()=> {};
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
-<!-- prettier-ignore -->
+{/* prettier-ignore */}
 ```ts option='{"before":false,"after":false,"overrides":{"arrow":{"before":true,"after":true}}}'
 let foo:string = "bar";
 
@@ -307,6 +322,9 @@ class Foo {
 type Foo = () => {};
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you don't want to enforce spacing for your type annotations, you can safely turn this rule off.