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

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

@@ -2,6 +2,9 @@
 description: 'Disallow Promises in places not designed to handle them.'
 ---
 
+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-promises** for documentation.
@@ -12,7 +15,7 @@ functions are handled/awaited.
 
 :::tip
 `no-misused-promises` only detects code that provides Promises to incorrect _logical_ locations.
-See [`no-floating-promises`](./no-floating-promises.md) for detecting unhandled Promise _statements_.
+See [`no-floating-promises`](./no-floating-promises.mdx) for detecting unhandled Promise _statements_.
 :::
 
 ## Options
@@ -36,9 +39,10 @@ Doing so prevents the rule from looking at code like `if (somePromise)`.
 
 Examples of code for this rule with `checksConditionals: true`:
 
-<!--tabs-->
+## Examples
 
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "checksConditionals": true }'
 const promise = Promise.resolve('value');
@@ -54,7 +58,8 @@ while (promise) {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "checksConditionals": true }'
 const promise = Promise.resolve('value');
@@ -71,7 +76,8 @@ while (await promise) {
 }
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ### `checksVoidReturn`
 
@@ -116,9 +122,8 @@ For example, if you don't mind that passing a `() => Promise<void>` to a `() =>
 
 Examples of code for this rule with `checksVoidReturn: true`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "checksVoidReturn": true }'
 [1, 2, 3].forEach(async value => {
@@ -138,7 +143,8 @@ eventEmitter.on('some-event', async () => {
 });
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "checksVoidReturn": true }'
 // for-of puts `await` in outer context
@@ -180,7 +186,8 @@ eventEmitter.on('some-event', () => {
 });
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ### `checksSpreads`
 
@@ -199,9 +206,8 @@ If you don't want to check object spreads, you can add this configuration:
 
 Examples of code for this rule with `checksSpreads: true`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "checksSpreads": true }'
 const getData = () => someAsyncOperation({ myArg: 'foo' });
@@ -215,7 +221,8 @@ const getData2 = async () => {
 return { foo: 42, ...getData2() };
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "checksSpreads": true }'
 const getData = () => someAsyncOperation({ myArg: 'foo' });
@@ -229,7 +236,8 @@ const getData2 = async () => {
 return { foo: 42, ...(await getData2()) };
 ```
 
-<!--tabs-->
+</TabItem>
+</Tabs>
 
 ## When Not To Use It
 
@@ -243,4 +251,4 @@ You might consider using [ESLint disable comments](https://eslint.org/docs/lates
 
 ## Related To
 
-- [`no-floating-promises`](./no-floating-promises.md)
+- [`no-floating-promises`](./no-floating-promises.mdx)

package/docs/rules/{no-mixed-enums.md → no-mixed-enums.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow enums from having both number and string members.'
 ---
 
+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-mixed-enums** for documentation.
@@ -12,9 +15,8 @@ Mixing enum member types is generally considered confusing and a bad practice.
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 enum Status {
@@ -24,7 +26,8 @@ enum Status {
 }
 ```
 
-### ✅ Correct (Explicit Numbers)
+</TabItem>
+<TabItem value="✅ Correct (Explicit Numbers)">
 
 ```ts
 enum Status {
@@ -34,7 +37,8 @@ enum Status {
 }
 ```
 
-### ✅ Correct (Implicit Numbers)
+</TabItem>
+<TabItem value="✅ Correct (Implicit Numbers)">
 
 ```ts
 enum Status {
@@ -44,7 +48,8 @@ enum Status {
 }
 ```
 
-### ✅ Correct (Strings)
+</TabItem>
+<TabItem value="✅ Correct (Strings)">
 
 ```ts
 enum Status {
@@ -54,6 +59,9 @@ enum Status {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## Iteration Pitfalls of Mixed Enum Member Values
 
 Enum values may be iterated over using `Object.entries`/`Object.keys`/`Object.values`.

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

@@ -2,6 +2,9 @@
 description: 'Disallow TypeScript 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-namespace** for documentation.
@@ -16,9 +19,8 @@ ES2015 module syntax is now preferred (`import`/`export`).
 
 Examples of code with the default options:
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 module foo {}
@@ -28,7 +30,8 @@ declare module foo {}
 declare namespace foo {}
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 declare module 'foo' {}
@@ -36,7 +39,8 @@ declare module 'foo' {}
 // anything inside a d.ts file
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ## Options
 
@@ -44,16 +48,16 @@ declare module 'foo' {}
 
 Examples of code with the `{ "allowDeclarations": true }` option:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowDeclarations": true }'
 module foo {}
 namespace foo {}
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowDeclarations": true }'
 declare module 'foo' {}
@@ -69,13 +73,13 @@ declare module foo {
 }
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 Examples of code for the `{ "allowDeclarations": false }` option:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowDeclarations": false }'
 module foo {}
@@ -84,19 +88,22 @@ declare module foo {}
 declare namespace foo {}
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowDeclarations": false }'
 declare module 'foo' {}
 ```
 
+</TabItem>
+</Tabs>
+
 ### `allowDefinitionFiles`
 
 Examples of code for the `{ "allowDefinitionFiles": true }` option:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowDefinitionFiles": true }'
 // if outside a d.ts file
@@ -110,7 +117,8 @@ declare module foo {}
 declare namespace foo {}
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowDefinitionFiles": true }'
 declare module 'foo' {}
@@ -118,6 +126,9 @@ declare module 'foo' {}
 // anything inside a d.ts file
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If your project was architected before modern modules and namespaces, it may be difficult to migrate off of namespaces.

package/docs/rules/{no-non-null-asserted-nullish-coalescing.md → no-non-null-asserted-nullish-coalescing.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow non-null assertions in the left operand of a nullish coalescing operator.'
 ---
 
+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-non-null-asserted-nullish-coalescing** for documentation.
@@ -11,9 +14,8 @@ Using a `!` non-null assertion type operator in the left operand of a nullish co
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 foo! ?? bar;
@@ -29,7 +31,8 @@ x = foo();
 x! ?? '';
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 foo ?? bar;
@@ -43,6 +46,9 @@ let x: string;
 x! ?? '';
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If your project's types don't yet fully describe whether certain values may be nullable, such as if you're transitioning to `strictNullChecks`, this rule might create many false reports.

package/docs/rules/{no-non-null-asserted-optional-chain.md → no-non-null-asserted-optional-chain.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow non-null assertions after an optional chain expression.'
 ---
 
+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-non-null-asserted-optional-chain** for documentation.
@@ -13,22 +16,25 @@ Using a `!` non-null assertion to assert the result of an `?.` optional chain ex
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 foo?.bar!;
 foo?.bar()!;
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 foo?.bar;
 foo?.bar();
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If your project's types don't yet fully describe whether certain values may be nullable, such as if you're transitioning to `strictNullChecks`, this rule might create many false reports.

package/docs/rules/{no-non-null-assertion.md → no-non-null-assertion.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow non-null assertions using the `!` postfix operator.'
 ---
 
+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-non-null-assertion** for documentation.
@@ -12,9 +15,8 @@ It's generally better to structure program logic so that TypeScript understands
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 interface Example {
@@ -25,7 +27,8 @@ declare const example: Example;
 const includesBaz = example.property!.includes('baz');
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 interface Example {
@@ -36,6 +39,9 @@ declare const example: Example;
 const includesBaz = example.property?.includes('baz') ?? false;
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If your project's types don't yet fully describe whether certain values may be nullable, such as if you're transitioning to `strictNullChecks`, this rule might create many false reports.

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

@@ -2,11 +2,14 @@
 description: 'Disallow variable redeclaration.'
 ---
 
+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-redeclare** for documentation.
 
-import TypeScriptOverlap from "@site/src/components/TypeScriptOverlap";
+import TypeScriptOverlap from '@site/src/components/TypeScriptOverlap';
 
 <TypeScriptOverlap />
 

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

@@ -2,6 +2,9 @@
 description: 'Disallow members of unions and intersections that do nothing or override type information.'
 ---
 
+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-redundant-type-constituents** for documentation.
@@ -24,9 +27,8 @@ Within `&` intersections:
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 type UnionAny = any | 'foo';
@@ -46,7 +48,8 @@ type IntersectionNumberLiteral = number & 1;
 type IntersectionStringLiteral = string & 'foo';
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 type UnionAny = any;
@@ -66,6 +69,9 @@ type IntersectionNumberLiteral = 1;
 type IntersectionStringLiteral = 'foo';
 ```
 
+</TabItem>
+</Tabs>
+
 ## Limitations
 
 This rule plays it safe and only works with bottom types, top types, and comparing literal types to primitive types.

package/docs/rules/{no-require-imports.md → no-require-imports.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow invocation of `require()`.'
 ---
 
+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-require-imports** for documentation.
@@ -10,9 +13,8 @@ Prefer the newer ES6-style imports over `require()`.
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 const lib1 = require('lib1');
@@ -20,7 +22,8 @@ const { lib2 } = require('lib2');
 import lib3 = require('lib3');
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 import * as lib1 from 'lib1';
@@ -28,6 +31,9 @@ import { lib2 } from 'lib2';
 import * as lib3 from 'lib3';
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 ### `allow`
@@ -36,20 +42,23 @@ A array of strings. These strings will be compiled into regular expressions with
 
 With `{allow: ['/package\\.json$']}`:
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 console.log(require('../data.json').version);
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 console.log(require('../package.json').version);
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If your project frequently uses older CommonJS `require`s, then this rule might not be applicable to you.
@@ -57,4 +66,4 @@ If only a subset of your project uses `require`s then you might consider using [
 
 ## Related To
 
-- [`no-var-requires`](./no-var-requires.md)
+- [`no-var-requires`](./no-var-requires.mdx)

package/docs/rules/{no-restricted-imports.md → no-restricted-imports.mdx}

@@ -2,6 +2,9 @@
 description: 'Disallow specified modules when loaded by `import`.'
 ---
 
+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-restricted-imports** for documentation.
@@ -46,9 +49,8 @@ When set to `true`, the rule will allow [Type-Only Imports](https://www.typescri
 
 Examples of code with the above config:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{"paths":[{"name":"import-foo","message":"Please use import-bar instead.","allowTypeImports":true},{"name":"import-baz","message":"Please use import-quux instead.","allowTypeImports":true}]}'
 import foo from 'import-foo';
@@ -58,7 +60,8 @@ import baz from 'import-baz';
 export { Baz } from 'import-baz';
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{"paths":[{"name":"import-foo","message":"Please use import-bar instead.","allowTypeImports":true},{"name":"import-baz","message":"Please use import-quux instead.","allowTypeImports":true}]}'
 import { foo } from 'other-module';
@@ -69,3 +72,6 @@ export type { Foo } from 'import-foo';
 import type baz from 'import-baz';
 export type { Baz } from 'import-baz';
 ```
+
+</TabItem>
+</Tabs>

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

@@ -2,6 +2,9 @@
 description: 'Disallow variable declarations from shadowing variables declared in the outer scope.'
 ---
 
+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-shadow** for documentation.
@@ -46,7 +49,7 @@ function f() {
 
 :::note
 
-_Shadowing_ specifically refers to two identical identifiers that are in different, nested scopes. This is different from _redeclaration_, which is when two identical identifiers are in the same scope. Redeclaration is covered by the [`no-redeclare`](./no-redeclare.md) rule instead.
+_Shadowing_ specifically refers to two identical identifiers that are in different, nested scopes. This is different from _redeclaration_, which is when two identical identifiers are in the same scope. Redeclaration is covered by the [`no-redeclare`](./no-redeclare.mdx) rule instead.
 
 :::