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

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

@@ -2,6 +2,9 @@
 description: 'Require using `namespace` keyword over `module` keyword to declare custom TypeScript modules.'
 ---
 
+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-namespace-keyword** for documentation.
@@ -18,15 +21,15 @@ This rule reports when the `module` keyword is used instead of `namespace`.
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 module Example {}
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 namespace Example {}
@@ -34,7 +37,8 @@ namespace Example {}
 declare module 'foo' {}
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ## When Not To Use It
 

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

@@ -2,6 +2,9 @@
 description: 'Enforce using the nullish coalescing operator instead of logical assignments or chaining.'
 ---
 
+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-nullish-coalescing** for documentation.

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

@@ -2,6 +2,9 @@
 description: 'Enforce using concise optional chain expressions instead of chained logical ands, negated logical ors, or empty 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-optional-chain** for documentation.
@@ -14,9 +17,8 @@ This rule reports on code where an `&&` operator can be safely replaced with `?.
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 foo && foo.a && foo.a.b && foo.a.b.c;
@@ -41,7 +43,8 @@ foo &&
   foo.a.b.c.d.e;
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 foo?.a?.b?.c;
@@ -55,7 +58,8 @@ foo?.a?.b?.c?.d?.e;
 !foo?.bar?.baz?.();
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ## Options
 
@@ -87,9 +91,9 @@ When this option is `false` unsafe cases will have suggestion fixers provided in
 
 When this option is `true` the rule will check operands that are typed as `any` when inspecting "loose boolean" operands.
 
-<!--tabs-->
+<Tabs>
 
-#### ❌ Incorrect for `checkAny: true`
+<TabItem value="❌ Incorrect for `checkAny: true`">
 
 ```ts option='{ "checkAny": true }'
 declare const thing: any;
@@ -97,7 +101,9 @@ declare const thing: any;
 thing && thing.toString();
 ```
 
-#### ✅ Correct for `checkAny: false`
+</TabItem>
+<TabItem value="✅ Correct">
+ for `checkAny: false`
 
 ```ts option='{ "checkAny": false }'
 declare const thing: any;
@@ -105,15 +111,16 @@ declare const thing: any;
 thing && thing.toString();
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ### `checkUnknown`
 
 When this option is `true` the rule will check operands that are typed as `unknown` when inspecting "loose boolean" operands.
 
-<!--tabs-->
+<Tabs>
 
-#### ❌ Incorrect for `checkUnknown: true`
+<TabItem value="❌ Incorrect for `checkUnknown: true`">
 
 ```ts option='{ "checkUnknown": true }'
 declare const thing: unknown;
@@ -121,7 +128,9 @@ declare const thing: unknown;
 thing && thing.toString();
 ```
 
-#### ✅ Correct for `checkUnknown: false`
+</TabItem>
+<TabItem value="✅ Correct">
+ for `checkUnknown: false`
 
 ```ts option='{ "checkUnknown": false }'
 declare const thing: unknown;
@@ -129,15 +138,16 @@ declare const thing: unknown;
 thing && thing.toString();
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ### `checkString`
 
 When this option is `true` the rule will check operands that are typed as `string` when inspecting "loose boolean" operands.
 
-<!--tabs-->
+<Tabs>
 
-#### ❌ Incorrect for `checkString: true`
+<TabItem value="❌ Incorrect for `checkString: true`">
 
 ```ts option='{ "checkString": true }'
 declare const thing: string;
@@ -145,7 +155,9 @@ declare const thing: string;
 thing && thing.toString();
 ```
 
-#### ✅ Correct for `checkString: false`
+</TabItem>
+<TabItem value="✅ Correct">
+ for `checkString: false`
 
 ```ts option='{ "checkString": false }'
 declare const thing: string;
@@ -153,15 +165,16 @@ declare const thing: string;
 thing && thing.toString();
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ### `checkNumber`
 
 When this option is `true` the rule will check operands that are typed as `number` when inspecting "loose boolean" operands.
 
-<!--tabs-->
+<Tabs>
 
-#### ❌ Incorrect for `checkNumber: true`
+<TabItem value="❌ Incorrect for `checkNumber: true`">
 
 ```ts option='{ "checkNumber": true }'
 declare const thing: number;
@@ -169,7 +182,9 @@ declare const thing: number;
 thing && thing.toString();
 ```
 
-#### ✅ Correct for `checkNumber: false`
+</TabItem>
+<TabItem value="✅ Correct">
+ for `checkNumber: false`
 
 ```ts option='{ "checkNumber": false }'
 declare const thing: number;
@@ -177,15 +192,16 @@ declare const thing: number;
 thing && thing.toString();
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ### `checkBoolean`
 
 When this option is `true` the rule will check operands that are typed as `boolean` when inspecting "loose boolean" operands.
 
-<!--tabs-->
+<Tabs>
 
-#### ❌ Incorrect for `checkBoolean: true`
+<TabItem value="❌ Incorrect for `checkBoolean: true`">
 
 ```ts option='{ "checkBoolean": true }'
 declare const thing: boolean;
@@ -193,7 +209,9 @@ declare const thing: boolean;
 thing && thing.toString();
 ```
 
-#### ✅ Correct for `checkBoolean: false`
+</TabItem>
+<TabItem value="✅ Correct">
+ for `checkBoolean: false`
 
 ```ts option='{ "checkBoolean": false }'
 declare const thing: boolean;
@@ -201,15 +219,16 @@ declare const thing: boolean;
 thing && thing.toString();
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ### `checkBigInt`
 
 When this option is `true` the rule will check operands that are typed as `bigint` when inspecting "loose boolean" operands.
 
-<!--tabs-->
+<Tabs>
 
-#### ❌ Incorrect for `checkBigInt: true`
+<TabItem value="❌ Incorrect for `checkBigInt: true`">
 
 ```ts option='{ "checkBigInt": true }'
 declare const thing: bigint;
@@ -217,7 +236,9 @@ declare const thing: bigint;
 thing && thing.toString();
 ```
 
-#### ✅ Correct for `checkBigInt: false`
+</TabItem>
+<TabItem value="✅ Correct">
+ for `checkBigInt: false`
 
 ```ts option='{ "checkBigInt": false }'
 declare const thing: bigint;
@@ -225,22 +246,25 @@ declare const thing: bigint;
 thing && thing.toString();
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ### `requireNullish`
 
 When this option is `true` the rule will skip operands that are not typed with `null` and/or `undefined` when inspecting "loose boolean" operands.
 
-<!--tabs-->
+<Tabs>
 
-#### ❌ Incorrect for `requireNullish: true`
+<TabItem value="❌ Incorrect for `requireNullish: true`">
 
 ```ts option='{ "requireNullish": true }'
 declare const thing1: string | null;
 thing1 && thing1.toString();
 ```
 
-#### ✅ Correct for `requireNullish: true`
+</TabItem>
+<TabItem value="✅ Correct">
+ for `requireNullish: true`
 
 ```ts option='{ "requireNullish": true }'
 declare const thing1: string | null;
@@ -250,7 +274,8 @@ declare const thing2: string;
 thing2 && thing2.toString();
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ## When Not To Use It
 

package/docs/rules/{prefer-promise-reject-errors.md → prefer-promise-reject-errors.mdx}

@@ -2,6 +2,9 @@
 description: 'Require using Error objects as Promise rejection reasons.'
 ---
 
+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-promise-reject-errors** for documentation.
@@ -11,9 +14,8 @@ It uses type information to enforce that `Promise`s are only rejected with `Erro
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 Promise.reject('error');
@@ -29,7 +31,8 @@ new Promise((resolve, reject) => {
 });
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 Promise.reject(new Error());
@@ -48,3 +51,6 @@ new Promise((resolve, reject) => {
   return reject(new CustomError());
 });
 ```
+
+</TabItem>
+</Tabs>

package/docs/rules/{prefer-readonly-parameter-types.md → prefer-readonly-parameter-types.mdx}

@@ -2,6 +2,9 @@
 description: 'Require function parameters to be typed as `readonly` to prevent accidental mutation of inputs.'
 ---
 
+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-readonly-parameter-types** for documentation.
@@ -21,9 +24,8 @@ A type is considered readonly if:
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 function array1(arg: string[]) {} // array is not readonly
@@ -65,7 +67,8 @@ interface Foo {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 function array1(arg: readonly string[]) {}
@@ -130,6 +133,9 @@ interface Foo {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 ### `allow`
@@ -157,9 +163,8 @@ Examples of code for this rule with:
 }
 ```
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{"allow":["$",{"from":"file","name":"Foo"},{"from":"lib","name":"HTMLElement"},{"from":"package","name":"Bar","package":"bar-lib"}]}'
 interface ThisIsMutable {
@@ -203,7 +208,8 @@ function fn2(arg: HTMLElement) {}
 function fn3(arg: Bar) {}
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{"allow":["$",{"from":"file","name":"Foo"},{"from":"lib","name":"HTMLElement"},{"from":"package","name":"Bar","package":"bar-lib"}]}'
 interface Foo {
@@ -246,6 +252,9 @@ import { Foo } from './foo';
 function fn(arg: Foo) {}
 ```
 
+</TabItem>
+</Tabs>
+
 ### `checkParameterProperties`
 
 This option allows you to enable or disable the checking of parameter properties.
@@ -253,9 +262,8 @@ Because parameter properties create properties on the class, it may be undesirab
 
 Examples of code for this rule with `{checkParameterProperties: true}`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "checkParameterProperties": true }'
 class Foo {
@@ -263,7 +271,8 @@ class Foo {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "checkParameterProperties": true }'
 class Foo {
@@ -271,7 +280,8 @@ class Foo {
 }
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 Examples of **correct** code for this rule with `{checkParameterProperties: false}`:
 
@@ -290,9 +300,8 @@ This option allows you to ignore parameters which don't explicitly specify a typ
 
 Examples of code for this rule with `{ignoreInferredTypes: true}`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "ignoreInferredTypes": true }'
 import { acceptsCallback, CallbackOptions } from 'external-dependency';
@@ -315,7 +324,8 @@ export const acceptsCallback: AcceptsCallback;
 
 </details>
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "ignoreInferredTypes": true }'
 import { acceptsCallback } from 'external-dependency';
@@ -338,15 +348,17 @@ export const acceptsCallback: AcceptsCallback;
 
 </details>
 
+</TabItem>
+</Tabs>
+
 ### `treatMethodsAsReadonly`
 
 This option allows you to treat all mutable methods as though they were readonly. This may be desirable when you are never reassigning methods.
 
 Examples of code for this rule with `{treatMethodsAsReadonly: false}`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "treatMethodsAsReadonly": false }'
 type MyType = {
@@ -356,7 +368,8 @@ type MyType = {
 function foo(arg: MyType) {}
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "treatMethodsAsReadonly": false }'
 type MyType = Readonly<{
@@ -372,7 +385,8 @@ type MyOtherType = {
 function bar(arg: MyOtherType) {}
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 Examples of **correct** code for this rule with `{treatMethodsAsReadonly: true}`:
 

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

@@ -2,6 +2,9 @@
 description: "Require private members to be marked as `readonly` if they're never modified outside of the constructor."
 ---
 
+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-readonly** for documentation.
@@ -13,9 +16,8 @@ This rule reports on private members are marked as `readonly` if they're never m
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 class Container {
@@ -34,7 +36,8 @@ class Container {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 class Container {
@@ -60,6 +63,9 @@ class Container {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 ### `onlyInlineLambdas`
@@ -77,9 +83,8 @@ You may pass `"onlyInlineLambdas": true` as a rule option within an object to re
 
 Example of code for the `{ "onlyInlineLambdas": true }` options:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "onlyInlineLambdas": true }'
 class Container {
@@ -89,7 +94,8 @@ class Container {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "onlyInlineLambdas": true }'
 class Container {
@@ -97,6 +103,9 @@ class Container {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you aren't trying to enforce strong immutability guarantees, this rule may be too restrictive for your project.

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

@@ -2,6 +2,9 @@
 description: 'Enforce using type parameter when calling `Array#reduce` instead of casting.'
 ---
 
+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-reduce-type-parameter** for documentation.
@@ -23,9 +26,8 @@ It will suggest instead pass the asserted type to `Array#reduce` as a generic ty
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 [1, 2, 3].reduce((arr, num) => arr.concat(num * 2), [] as number[]);
@@ -39,7 +41,8 @@ It will suggest instead pass the asserted type to `Array#reduce` as a generic ty
 );
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 [1, 2, 3].reduce<number[]>((arr, num) => arr.concat(num * 2), []);
@@ -53,6 +56,9 @@ It will suggest instead pass the asserted type to `Array#reduce` as a generic ty
 );
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 This rule can sometimes be difficult to work around when creating objects using a `.reduce`.

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

@@ -2,6 +2,9 @@
 description: 'Enforce `RegExp#exec` over `String#match` if no global flag is provided.'
 ---
 
+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-regexp-exec** for documentation.
@@ -15,9 +18,8 @@ This rule reports when a `String#match` call can be replaced with an equivalent
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 'something'.match(/thing/);
@@ -29,7 +31,8 @@ const search = /thing/;
 text.match(search);
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 /thing/.exec('something');
@@ -41,6 +44,9 @@ const search = /thing/;
 search.exec(text);
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you prefer consistent use of `String#match` for both with `g` flag and without it, you can turn this rule off.

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

@@ -2,6 +2,9 @@
 description: 'Enforce that `this` is used when only `this` type is returned.'
 ---
 
+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-return-this-type** for documentation.
@@ -38,9 +41,8 @@ cat.eat().meow();
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 class Foo {
@@ -56,7 +58,8 @@ class Foo {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 class Foo {
@@ -82,6 +85,9 @@ class Derived extends Base {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you don't use method chaining or explicit return values, you can safely turn this rule off.