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

package/docs/rules/{parameter-properties.md → parameter-properties.mdx}

@@ -2,6 +2,9 @@
 description: 'Require or disallow parameter properties in class constructors.'
 ---
 
+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/parameter-properties** for documentation.
@@ -59,9 +62,8 @@ In `"parameter-property"` mode, the rule will issue a report when:
 
 Examples of code for this rule with no options at all:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 class Foo {
@@ -93,7 +95,8 @@ class Foo {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 class Foo {
@@ -101,13 +104,15 @@ class Foo {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### readonly
 
 Examples of code for the `{ "allow": ["readonly"] }` options:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allow": ["readonly"] }'
 class Foo {
@@ -135,7 +140,8 @@ class Foo {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allow": ["readonly"] }'
 class Foo {
@@ -147,13 +153,15 @@ class Foo {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### private
 
 Examples of code for the `{ "allow": ["private"] }` options:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allow": ["private"] }'
 class Foo {
@@ -181,7 +189,8 @@ class Foo {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allow": ["private"] }'
 class Foo {
@@ -193,13 +202,15 @@ class Foo {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### protected
 
 Examples of code for the `{ "allow": ["protected"] }` options:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allow": ["protected"] }'
 class Foo {
@@ -227,7 +238,8 @@ class Foo {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allow": ["protected"] }'
 class Foo {
@@ -239,13 +251,15 @@ class Foo {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### public
 
 Examples of code for the `{ "allow": ["public"] }` options:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allow": ["public"] }'
 class Foo {
@@ -273,7 +287,8 @@ class Foo {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allow": ["public"] }'
 class Foo {
@@ -285,13 +300,15 @@ class Foo {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### private readonly
 
 Examples of code for the `{ "allow": ["private readonly"] }` options:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allow": ["private readonly"] }'
 class Foo {
@@ -319,7 +336,8 @@ class Foo {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allow": ["private readonly"] }'
 class Foo {
@@ -331,13 +349,15 @@ class Foo {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### protected readonly
 
 Examples of code for the `{ "allow": ["protected readonly"] }` options:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allow": ["protected readonly"] }'
 class Foo {
@@ -365,7 +385,8 @@ class Foo {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allow": ["protected readonly"] }'
 class Foo {
@@ -377,13 +398,15 @@ class Foo {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### public readonly
 
 Examples of code for the `{ "allow": ["public readonly"] }` options:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allow": ["public readonly"] }'
 class Foo {
@@ -411,7 +434,8 @@ class Foo {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allow": ["public readonly"] }'
 class Foo {
@@ -423,13 +447,15 @@ class Foo {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### `"parameter-property"`
 
 Examples of code for the `{ "prefer": "parameter-property" }` option:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "prefer": "parameter-property" }'
 class Foo {
@@ -454,7 +480,8 @@ class Foo {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "prefer": "parameter-property" }'
 class Foo {
@@ -480,6 +507,9 @@ class Foo {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you don't care about which style of parameter properties in constructors is used in your classes, then you will not need this rule.

package/docs/rules/{prefer-as-const.md → prefer-as-const.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce the use of `as const` over literal type.'
 ---
 
+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/prefer-as-const** for documentation.
@@ -16,9 +19,8 @@ This rule reports when an `as` with an explicit literal type can be replaced wit
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 let bar: 2 = 2;
@@ -26,7 +28,8 @@ let foo = <'bar'>'bar';
 let foo = { bar: 'baz' as 'baz' };
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 let foo = 'bar';
@@ -37,7 +40,8 @@ let foo = <string>'bar';
 let foo = { bar: 'baz' };
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ## When Not To Use It
 

package/docs/rules/{prefer-destructuring.md → prefer-destructuring.mdx}

@@ -2,6 +2,9 @@
 description: 'Require destructuring from arrays and/or objects.'
 ---
 
+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/prefer-destructuring** for documentation.
@@ -11,35 +14,37 @@ description: 'Require destructuring from arrays and/or objects.'
 This rule extends the base [`eslint/prefer-destructuring`](https://eslint.org/docs/latest/rules/prefer-destructuring) rule.
 It adds support for TypeScript's type annotations in variable declarations.
 
-<!-- tabs -->
+<Tabs>
 
-### `eslint/prefer-destructuring`
+<TabItem value="`eslint/prefer-destructuring`">
 
 ```ts
 const x: string = obj.x; // This is incorrect and the auto fixer provides following untyped fix.
 // const { x } = obj;
 ```
 
-### `@typescript-eslint/prefer-destructuring`
+</TabItem>
+<TabItem value="`@typescript-eslint/prefer-destructuring`">
 
 ```ts
 const x: string = obj.x; // This is correct by default. You can also forbid this by an option.
 ```
 
-<!-- /tabs -->
+</TabItem>
+</Tabs>
 
 And it infers binding patterns more accurately thanks to the type checker.
 
-<!-- tabs -->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 const x = ['a'];
 const y = x[0];
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 const x = { 0: 'a' };
@@ -49,6 +54,9 @@ const y = x[0];
 It is correct when `enforceForRenamedProperties` is not true.
 Valid destructuring syntax is renamed style like `{ 0: y } = x` rather than `[y] = x` because `x` is not iterable.
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 This rule adds the following options:
@@ -76,16 +84,19 @@ When set to `true`, type annotated variable declarations are enforced to use des
 
 Examples with `{ enforceForDeclarationWithTypeAnnotation: true }`:
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 const x: string = obj.x;
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 const { x }: { x: string } = obj;
 ```
+
+</TabItem>
+</Tabs>

package/docs/rules/{prefer-enum-initializers.md → prefer-enum-initializers.mdx}

@@ -2,6 +2,9 @@
 description: 'Require each enum member value to be explicitly initialized.'
 ---
 
+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/prefer-enum-initializers** for documentation.
@@ -15,9 +18,8 @@ This rule recommends having each `enum` member value explicitly initialized.
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 enum Status {
@@ -37,7 +39,8 @@ enum Color {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 enum Status {
@@ -57,6 +60,9 @@ enum Color {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you don't care about `enum`s having implicit values you can safely disable this rule.

package/docs/rules/{prefer-find.md → prefer-find.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce the use of Array.prototype.find() over Array.prototype.filter() followed by [0] when looking for a single result.'
 ---
 
+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/prefer-find** for documentation.
@@ -18,9 +21,8 @@ Therefore, when fixing errors from this rule, be sure that your `.filter()` call
 
 :::
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 [1, 2, 3].filter(x => x > 1)[0];
@@ -28,12 +30,16 @@ Therefore, when fixing errors from this rule, be sure that your `.filter()` call
 [1, 2, 3].filter(x => x > 1).at(0);
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 [1, 2, 3].find(x => x > 1);
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you intentionally use patterns like `.filter(callback)[0]` to execute side effects in `callback` on all array elements, you will want to avoid this rule.

package/docs/rules/{prefer-for-of.md → prefer-for-of.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce the use of `for-of` loop over the standard `for` loop where possible.'
 ---
 
+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/prefer-for-of** for documentation.
@@ -14,9 +17,8 @@ This rule recommends a for-of loop when the loop index is only used to read from
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 declare const array: string[];
@@ -26,7 +28,8 @@ for (let i = 0; i < array.length; i++) {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 declare const array: string[];
@@ -41,4 +44,7 @@ for (let i = 0; i < array.length; i++) {
 }
 ```
 
-<!-- Intentionally Omitted: When Not To Use It -->
+</TabItem>
+</Tabs>
+
+{/* Intentionally Omitted: When Not To Use It */}

package/docs/rules/{prefer-function-type.md → prefer-function-type.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce using function types instead of interfaces with call signatures.'
 ---
 
+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/prefer-function-type** for documentation.
@@ -17,9 +20,8 @@ This rule suggests using a function type instead of an interface or object type
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 interface Example {
@@ -40,7 +42,8 @@ interface ReturnsSelf {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 type Example = () => string;
@@ -82,6 +85,9 @@ interface Overloaded {
 type Intersection = ((data: string) => number) & ((id: number) => string);
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you specifically want to use an interface or type literal with a single call signature for stylistic reasons, you can avoid this rule.

package/docs/rules/{prefer-includes.md → prefer-includes.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce `includes` method over `indexOf` method.'
 ---
 
+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/prefer-includes** for documentation.
@@ -17,9 +20,8 @@ Additionally, this rule reports the tests of simple regular expressions in favor
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 const str: string;
@@ -42,7 +44,8 @@ userDefined.indexOf(value) >= 0;
 /example/.test(str);
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 const str: string;
@@ -72,4 +75,7 @@ declare const mismatchExample: {
 mismatchExample.indexOf(value) >= 0;
 ```
 
-<!-- Intentionally Omitted: When Not To Use It -->
+</TabItem>
+</Tabs>
+
+{/* Intentionally Omitted: When Not To Use It */}

package/docs/rules/{prefer-literal-enum-member.md → prefer-literal-enum-member.mdx}

@@ -2,6 +2,9 @@
 description: 'Require all enum members to be literal values.'
 ---
 
+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/prefer-literal-enum-member** for documentation.
@@ -30,9 +33,8 @@ This rule reports when an enum member is given a value that is not a literal.
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 const str = 'Test';
@@ -45,7 +47,8 @@ enum Invalid {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 enum Valid {
@@ -57,7 +60,8 @@ enum Valid {
 }
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ## Options
 
@@ -67,9 +71,8 @@ When set to `true` will allow you to use bitwise expressions in enum initializer
 
 Examples of code for the `{ "allowBitwiseExpressions": true }` option:
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowBitwiseExpressions": true }'
 const x = 1;
@@ -84,7 +87,8 @@ enum Foo {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowBitwiseExpressions": true }'
 enum Foo {
@@ -98,6 +102,9 @@ enum Foo {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you want use anything other than simple literals as an enum value, this rule might not be for you.