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

package/docs/rules/{no-extraneous-class.md → no-extraneous-class.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow classes used as namespaces.'
 ---
 
+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/no-extraneous-class** for documentation.
@@ -22,9 +25,8 @@ Those classes can generally be replaced with a standalone function.
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 class StaticConstants {
@@ -42,7 +44,8 @@ class HelloWorldLogger {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 export const version = 42;
@@ -56,15 +59,17 @@ function logHelloWorld() {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## Alternatives
 
 ### Individual Exports (Recommended)
 
 Instead of using a static utility class we recommend you individually export the utilities from your module.
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 export class Utilities {
@@ -82,7 +87,8 @@ export class Utilities {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 export function util1() {
@@ -98,6 +104,9 @@ export function util3() {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### Namespace Imports (Not Recommended)
 
 If you strongly prefer to have all constructs from a module available as properties of a single object, you can `import * as` the module.
@@ -109,9 +118,8 @@ However, namespace imports are impacted by these downsides:
 - They also don't play as well with tree shaking in modern bundlers
 - They require a name prefix before each property's usage
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 // utilities.ts
@@ -127,7 +135,8 @@ import { Utilities } from './utilities';
 Utilities.sayHello();
 ```
 
-#### ⚠️ Namespace Imports
+</TabItem>
+<TabItem value="⚠️ Namespace Imports">
 
 ```ts
 // utilities.ts
@@ -141,7 +150,8 @@ import * as utilities from './utilities';
 utilities.sayHello();
 ```
 
-#### ✅ Standalone Imports
+</TabItem>
+<TabItem value="✅ Standalone Imports">
 
 ```ts
 // utilities.ts
@@ -155,6 +165,9 @@ import { sayHello } from './utilities';
 sayHello();
 ```
 
+</TabItem>
+</Tabs>
+
 ### Notes on Mutating Variables
 
 One case you need to be careful of is exporting mutable variables.
@@ -164,9 +177,8 @@ This means that importers can only ever read the first value they are assigned a
 Needing to write to an exported variable is very rare and is generally considered a code smell.
 If you do need it you can accomplish it using getter and setter functions:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 export class Utilities {
@@ -178,7 +190,8 @@ export class Utilities {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 let mutableCount = 1;
@@ -192,6 +205,9 @@ export function incrementCount() {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 This rule normally bans classes that are empty (have no constructor or fields).
@@ -201,15 +217,15 @@ The rule's options each add an exemption for a specific type of class.
 
 `allowConstructorOnly` adds an exemption for classes that have only a constructor and no fields.
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowConstructorOnly": true }'
 class NoFields {}
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowConstructorOnly": true }'
 class NoFields {
@@ -219,13 +235,15 @@ class NoFields {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### `allowEmpty`
 
 The `allowEmpty` option adds an exemption for classes that are entirely empty.
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowEmpty": true }'
 class NoFields {
@@ -235,12 +253,16 @@ class NoFields {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowEmpty": true }'
 class NoFields {}
 ```
 
+</TabItem>
+</Tabs>
+
 ### `allowStaticOnly`
 
 The `allowStaticOnly` option adds an exemption for classes that only contain static members.
@@ -250,15 +272,15 @@ We strongly recommend against the `allowStaticOnly` exemption.
 It works against this rule's primary purpose of discouraging classes used only for static members.
 :::
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowStaticOnly": true }'
 class EmptyClass {}
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowStaticOnly": true }'
 class NotEmptyClass {
@@ -266,13 +288,15 @@ class NotEmptyClass {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### `allowWithDecorator`
 
 The `allowWithDecorator` option adds an exemption for classes that contain a member decorated with a `@` decorator.
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowWithDecorator": true }'
 class Constants {
@@ -280,7 +304,8 @@ class Constants {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowWithDecorator": true }'
 class Constants {
@@ -289,6 +314,9 @@ class Constants {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If your project was set up before modern class and namespace practices, and you don't have the time to switch over, you might not be practically able to use this rule.

package/docs/rules/{no-floating-promises.md → no-floating-promises.mdx}

@@ -2,6 +2,9 @@
 description: 'Require Promise-like statements to be handled appropriately.'
 ---
 
+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/no-floating-promises** for documentation.
@@ -26,14 +29,13 @@ This rule also reports when an Array containing Promises is created and not prop
 
 :::tip
 `no-floating-promises` only detects unhandled Promise _statements_.
-See [`no-misused-promises`](./no-misused-promises.md) for detecting code that provides Promises to _logical_ locations such as if statements.
+See [`no-misused-promises`](./no-misused-promises.mdx) for detecting code that provides Promises to _logical_ locations such as if statements.
 :::
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 const promise = new Promise((resolve, reject) => resolve('value'));
@@ -51,7 +53,8 @@ Promise.reject('value').finally();
 [1, 2, 3].map(async x => x + 1);
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 const promise = new Promise((resolve, reject) => resolve('value'));
@@ -72,6 +75,9 @@ await Promise.reject('value').finally(() => {});
 await Promise.all([1, 2, 3].map(async x => x + 1));
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 ### `ignoreVoid`
@@ -117,7 +123,7 @@ You might consider using `void`s and/or [ESLint disable comments](https://eslint
 
 ## Related To
 
-- [`no-misused-promises`](./no-misused-promises.md)
+- [`no-misused-promises`](./no-misused-promises.mdx)
 
 ## Further Reading
 

package/docs/rules/{no-for-in-array.md → no-for-in-array.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow iterating over an array with a for-in loop.'
 ---
 
+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/no-for-in-array** for documentation.
@@ -17,9 +20,8 @@ You may have confused for-in with for-of, which iterates over the elements of th
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 declare const array: string[];
@@ -33,7 +35,8 @@ for (const i in array) {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 declare const array: string[];
@@ -55,6 +58,9 @@ for (const [i, value] of array.entries()) {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If your project is a rare one that intentionally loops over string indices of arrays, you can turn off this rule.

package/docs/rules/{no-implied-eval.md → no-implied-eval.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow the use of `eval()`-like methods.'
 ---
 
+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/no-implied-eval** for documentation.
@@ -29,9 +32,8 @@ The best practice is to avoid using `new Function()` or `execScript()` and alway
 
 This rule aims to eliminate implied `eval()` through the use of `new Function()`, `setTimeout()`, `setInterval()`, `setImmediate()` or `execScript()`.
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 /* eslint @typescript-eslint/no-implied-eval: "error" */
@@ -59,7 +61,8 @@ setTimeout(fn(), 100);
 const fn = new Function('a', 'b', 'return a + b');
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 /* eslint @typescript-eslint/no-implied-eval: "error" */
@@ -96,6 +99,9 @@ class Foo {
 setTimeout(Foo.fn, 100);
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If your project is a rare one that needs to allow `new Function()` or `setTimeout()`, `setInterval()`, `setImmediate()` and `execScript()` with string arguments, then you can disable this rule.

package/docs/rules/{no-import-type-side-effects.md → no-import-type-side-effects.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce the use of top-level import type qualifier when an import only has specifiers with inline type qualifiers.'
 ---
 
+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/no-import-type-side-effects** for documentation.
@@ -27,9 +30,8 @@ For the rare case of needing to import for side effects, this may be desirable -
 
 This rule enforces that you use a top-level `type` qualifier for imports when it only imports specifiers with an inline `type` qualifier
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 import { type A } from 'mod';
@@ -38,7 +40,8 @@ import { type A, type B } from 'mod';
 import { type A as AA, type B as BB } from 'mod';
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 import type { A } from 'mod';
@@ -63,12 +66,15 @@ import type T, { U } from 'mod';
 import T, { type U } from 'mod';
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you're not using TypeScript 5.0's `verbatimModuleSyntax` option and your project is built with a bundler that manages import side effects for you, this rule may not be as useful for you.
 
 ## Related To
 
-- [`consistent-type-imports`](./consistent-type-imports.md)
-- [`import/consistent-type-specifier-style`](https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/consistent-type-specifier-style.md)
+- [`consistent-type-imports`](./consistent-type-imports.mdx)
+- [`import/consistent-type-specifier-style`](https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/consistent-type-specifier-style.mdx)
 - [`import/no-duplicates` with `{"prefer-inline": true}`](https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-duplicates.md#inline-type-imports)

package/docs/rules/{no-inferrable-types.md → no-inferrable-types.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow explicit type declarations for variables or parameters initialized to a number, string, or boolean.'
 ---
 
+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/no-inferrable-types** for documentation.
@@ -12,9 +15,8 @@ Doing so adds unnecessary verbosity to code -making it harder to read- and in so
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 const a: bigint = 10n;
@@ -42,7 +44,8 @@ class Foo {
 function fn(a: number = 5, b: boolean = true) {}
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 const a = 10n;
@@ -70,7 +73,8 @@ class Foo {
 function fn(a = 5, b = true) {}
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ## Options
 

package/docs/rules/{no-invalid-this.md → no-invalid-this.mdx}

@@ -2,11 +2,14 @@
 description: 'Disallow `this` keywords outside of classes or class-like 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/no-invalid-this** for documentation.
 
-import TypeScriptOverlap from "@site/src/components/TypeScriptOverlap";
+import TypeScriptOverlap from '@site/src/components/TypeScriptOverlap';
 
 <TypeScriptOverlap strict />
 

package/docs/rules/{no-invalid-void-type.md → no-invalid-void-type.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow `void` type outside of generic or return types.'
 ---
 
+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/no-invalid-void-type** for documentation.
@@ -15,9 +18,8 @@ Attempting to use a `void` type outside of a return type or generic type argumen
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 type PossibleValues = string | number | void;
@@ -38,7 +40,8 @@ class MyClass {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 type NoOp = () => void;
@@ -52,6 +55,9 @@ async function promiseMeSomething(): Promise<void> {}
 type stillVoid = void | never;
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 ### `allowInGenericTypeArguments`

package/docs/rules/{no-loop-func.md → no-loop-func.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow function declarations that contain unsafe references inside loop statements.'
 ---
 
+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/no-loop-func** for documentation.

package/docs/rules/{no-loss-of-precision.md → no-loss-of-precision.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow literal numbers that lose precision.'
 ---
 
+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/no-loss-of-precision** for documentation.

package/docs/rules/{no-magic-numbers.md → no-magic-numbers.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow magic numbers.'
 ---
 
+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/no-magic-numbers** for documentation.

package/docs/rules/{no-meaningless-void-operator.md → no-meaningless-void-operator.mdx}

@@ -2,13 +2,16 @@
 description: 'Disallow the `void` operator except when used to discard a value.'
 ---
 
+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/no-meaningless-void-operator** for documentation.
 
 `void` in TypeScript refers to a function return that is meant to be ignored.
 The `void` operator is a useful tool to convey the programmer's intent to discard a value.
-For example, it is recommended as one way of suppressing [`@typescript-eslint/no-floating-promises`](./no-floating-promises.md) instead of adding `.catch()` to a promise.
+For example, it is recommended as one way of suppressing [`@typescript-eslint/no-floating-promises`](./no-floating-promises.mdx) instead of adding `.catch()` to a promise.
 
 This rule helps an authors catch API changes where previously a value was being discarded at a call site, but the callee changed so it no longer returns a value.
 When combined with [no-unused-expressions](https://eslint.org/docs/rules/no-unused-expressions), it also helps _readers_ of the code by ensuring consistency: a statement that looks like `void foo();` is **always** discarding a return value, and a statement that looks like `foo();` is **never** discarding a return value.
@@ -16,9 +19,10 @@ This rule reports on any `void` operator whose argument is already of type `void
 
 ## Examples
 
-<!--tabs-->
+## Examples
 
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 void (() => {})();
@@ -27,7 +31,8 @@ function foo() {}
 void foo();
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 (() => {})();
@@ -42,6 +47,9 @@ function bar(x: number) {
 void bar(); // discarding a number
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 ### `checkNever`

package/docs/rules/{no-misused-new.md → no-misused-new.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce valid definition of `new` and `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/no-misused-new** for documentation.
@@ -14,9 +17,8 @@ This rule reports when a class defines a method named `new` or an interface defi
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 declare class C {
@@ -29,7 +31,8 @@ interface I {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 declare class C {
@@ -41,6 +44,9 @@ interface I {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you intentionally want a class with a `new` method, and you're confident nobody working in your code will mistake it with a constructor, you might not want this rule.