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

package/docs/rules/{prefer-string-starts-ends-with.md → prefer-string-starts-ends-with.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce using `String#startsWith` and `String#endsWith` over other equivalent methods of checking substrings.'
 ---
 
+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-string-starts-ends-with** for documentation.
@@ -14,9 +17,8 @@ This rule reports when a string method can be replaced safely with `String#start
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 declare const foo: string;
@@ -40,7 +42,8 @@ foo.match(/bar$/) != null;
 /bar$/.test(foo);
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 declare const foo: string;
@@ -52,7 +55,8 @@ foo.startsWith('bar');
 foo.endsWith('bar');
 ```
 
-<!--/tabs-->
+</TabItem>
+</Tabs>
 
 ## Options
 

package/docs/rules/{prefer-ts-expect-error.md → prefer-ts-expect-error.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce using `@ts-expect-error` over `@ts-ignore`.'
 ---
 
+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-ts-expect-error** for documentation.
@@ -16,9 +19,8 @@ This is dangerous, as if a new error arises on that line it'll be suppressed by
 
 This rule reports any usage of `@ts-ignore`, including a fixer to replace with `@ts-expect-error`.
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 // @ts-ignore
@@ -39,7 +41,8 @@ const isOptionEnabled = (key: string): boolean => {
 };
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 // @ts-expect-error
@@ -60,6 +63,9 @@ const isOptionEnabled = (key: string): boolean => {
 };
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you are compiling against multiple versions of TypeScript and using `@ts-ignore` to ignore version-specific type errors, this rule might get in your way.

package/docs/rules/{promise-function-async.md → promise-function-async.mdx}

@@ -2,6 +2,9 @@
 description: 'Require any function or method that returns a Promise to be marked async.'
 ---
 
+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/promise-function-async** for documentation.
@@ -21,9 +24,8 @@ This rule's practice removes a requirement for creating code to handle both case
 
 Examples of code for this rule
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 const arrowFunctionReturnsPromise = () => Promise.resolve('value');
@@ -37,7 +39,8 @@ function functionReturnsUnionWithPromiseImplicitly(p: boolean) {
 }
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 const arrowFunctionReturnsPromise = async () => Promise.resolve('value');
@@ -58,6 +61,9 @@ async function functionReturnsUnionWithPromiseImplicitly(p: boolean) {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 ### `allowAny`
@@ -67,20 +73,23 @@ If you want additional safety, consider turning this option off, as it makes the
 
 Examples of code with `{ "allowAny": false }`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowAny": false }'
 const returnsAny = () => ({}) as any;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowAny": false }'
 const returnsAny = async () => ({}) as any;
 ```
 
+</TabItem>
+</Tabs>
+
 ### `allowedPromiseNames`
 
 For projects that use constructs other than the global built-in `Promise` for asynchronous code.
@@ -88,9 +97,8 @@ This option allows specifying string names of classes or interfaces that cause a
 
 Examples of code with `{ "allowedPromiseNames": ["Bluebird"] }`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowedPromiseNames": ["Bluebird"] }'
 import { Bluebird } from 'bluebird';
@@ -98,7 +106,8 @@ import { Bluebird } from 'bluebird';
 const returnsBluebird = () => new Bluebird(() => {});
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowedPromiseNames": ["Bluebird"] }'
 import { Bluebird } from 'bluebird';
@@ -106,6 +115,9 @@ import { Bluebird } from 'bluebird';
 const returnsBluebird = async () => new Bluebird(() => {});
 ```
 
+</TabItem>
+</Tabs>
+
 ### `checkArrowFunctions`
 
 Whether to check arrow functions.

package/docs/rules/{quotes.md → quotes.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce the consistent use of either backticks, double, or single quotes.'
 ---
 
+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/quotes** for documentation.

package/docs/rules/{require-array-sort-compare.md → require-array-sort-compare.mdx}

@@ -2,6 +2,9 @@
 description: 'Require `Array#sort` and `Array#toSorted` calls to always provide a `compareFunction`.'
 ---
 
+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/require-array-sort-compare** for documentation.
@@ -21,9 +24,8 @@ This rule reports on any call to the sort methods that do not provide a `compare
 
 This rule aims to ensure all calls of the native sort methods provide a `compareFunction`, while ignoring calls to user-defined methods.
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 const array: any[];
@@ -35,7 +37,8 @@ array.sort();
 stringArray.sort();
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 const array: any[];
@@ -47,15 +50,17 @@ array.sort((a, b) => a.localeCompare(b));
 userDefinedType.sort();
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 ### `ignoreStringArrays`
 
 Examples of code for this rule with `{ ignoreStringArrays: true }`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "ignoreStringArrays": true }'
 const one = 1;
@@ -64,7 +69,8 @@ const three = 3;
 [one, two, three].sort();
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "ignoreStringArrays": true }'
 const one = '1';
@@ -73,6 +79,9 @@ const three = '3';
 [one, two, three].sort();
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you intentionally want your arrays to be always sorted in a string-like manner, you can turn this rule off safely.

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

@@ -2,6 +2,9 @@
 description: 'Disallow async functions which have no `await` 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/require-await** for documentation.

package/docs/rules/{restrict-plus-operands.md → restrict-plus-operands.mdx}

@@ -2,6 +2,9 @@
 description: 'Require both operands of addition to be the same type and be `bigint`, `number`, or `string`.'
 ---
 
+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/restrict-plus-operands** for documentation.
@@ -13,22 +16,25 @@ This rule reports when a `+` operation combines two values of different types, o
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 let foo = 1n + 1;
 let fn = (a: string, b: never) => a + b;
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 let foo = 1n + 1n;
 let fn = (a: string, b: string) => a + b;
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 :::caution
@@ -70,49 +76,54 @@ Safer alternatives to using the `allow*` options include:
 
 Examples of code for this rule with `{ allowAny: true }`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowAny": true }'
 let fn = (a: number, b: []) => a + b;
 let fn = (a: string, b: []) => a + b;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowAny": true }'
 let fn = (a: number, b: any) => a + b;
 let fn = (a: string, b: any) => a + b;
 ```
 
+</TabItem>
+</Tabs>
+
 ### `allowBoolean`
 
 Examples of code for this rule with `{ allowBoolean: true }`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowBoolean": true }'
 let fn = (a: number, b: unknown) => a + b;
 let fn = (a: string, b: unknown) => a + b;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowBoolean": true }'
 let fn = (a: number, b: boolean) => a + b;
 let fn = (a: string, b: boolean) => a + b;
 ```
 
+</TabItem>
+</Tabs>
+
 ### `allowNullish`
 
 Examples of code for this rule with `{ allowNullish: true }`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowNullish": true }'
 let fn = (a: number, b: unknown) => a + b;
@@ -121,7 +132,8 @@ let fn = (a: string, b: unknown) => a + b;
 let fn = (a: string, b: never) => a + b;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowNullish": true }'
 let fn = (a: number, b: undefined) => a + b;
@@ -130,51 +142,59 @@ let fn = (a: string, b: undefined) => a + b;
 let fn = (a: string, b: null) => a + b;
 ```
 
+</TabItem>
+</Tabs>
+
 ### `allowNumberAndString`
 
 Examples of code for this rule with `{ allowNumberAndString: true }`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowNumberAndString": true }'
 let fn = (a: number, b: unknown) => a + b;
 let fn = (a: number, b: never) => a + b;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowNumberAndString": true }'
 let fn = (a: number, b: string) => a + b;
 let fn = (a: number, b: number | string) => a + b;
 ```
 
+</TabItem>
+</Tabs>
+
 ### `allowRegExp`
 
 Examples of code for this rule with `{ allowRegExp: true }`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "allowRegExp": true }'
 let fn = (a: number, b: RegExp) => a + b;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "allowRegExp": true }'
 let fn = (a: string, b: RegExp) => a + b;
 ```
 
+</TabItem>
+</Tabs>
+
 ### `skipCompoundAssignments`
 
 Examples of code for this rule with `{ skipCompoundAssignments: false }`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "skipCompoundAssignments": true }'
 let foo: string | undefined;
@@ -184,7 +204,8 @@ let bar: string = '';
 bar += 0;
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='{ "skipCompoundAssignments": true }'
 let foo: number = 0;
@@ -194,14 +215,17 @@ let bar = '';
 bar += 'test';
 ```
 
+</TabItem>
+</Tabs>
+
 ## When Not To Use It
 
 If you don't mind a risk of `"[object Object]"` or incorrect type coercions in your values, then you will not need this rule.
 
 ## Related To
 
-- [`no-base-to-string`](./no-base-to-string.md)
-- [`restrict-template-expressions`](./restrict-template-expressions.md)
+- [`no-base-to-string`](./no-base-to-string.mdx)
+- [`restrict-template-expressions`](./restrict-template-expressions.mdx)
 
 ## Further Reading
 

package/docs/rules/{restrict-template-expressions.md → restrict-template-expressions.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce template literal expressions to be of `string` 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/restrict-template-expressions** for documentation.
@@ -12,19 +15,18 @@ This rule reports on values used in a template literal string that aren't string
 
 :::note
 
-This rule intentionally does not allow objects with a custom `toString()` method to be used in template literals, because the stringification result may not be user-friendly.
+The default settings of this rule intentionally do not allow objects with a custom `toString()` method to be used in template literals, because the stringification result may not be user-friendly.
 
 For example, arrays have a custom [`toString()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/toString) method, which only calls `join()` internally, which joins the array elements with commas. This means that (1) array elements are not necessarily stringified to useful results (2) the commas don't have spaces after them, making the result not user-friendly. The best way to format arrays is to use [`Intl.ListFormat`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/ListFormat), which even supports adding the "and" conjunction where necessary.
-You must explicitly call `object.toString()` if you want to use this object in a template literal.
-The [`no-base-to-string`](./no-base-to-string.md) rule can be used to guard this case against producing `"[object Object]"` by accident.
+You must explicitly call `object.toString()` if you want to use this object in a template literal, or turn on the `allowArray` option to specifically allow arrays.
+The [`no-base-to-string`](./no-base-to-string.mdx) rule can be used to guard this case against producing `"[object Object]"` by accident.
 
 :::
 
 ## Examples
 
-<!--tabs-->
-
-### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts
 const arg1 = [1, 2];
@@ -34,7 +36,8 @@ const arg2 = { name: 'Foo' };
 const msg2 = `arg2 = ${arg2 || null}`;
 ```
 
-### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts
 const arg = 'foo';
@@ -45,6 +48,9 @@ const stringWithKindProp: string & { _kind?: 'MyString' } = 'foo';
 const msg3 = `stringWithKindProp = ${stringWithKindProp}`;
 ```
 
+</TabItem>
+</Tabs>
+
 ## Options
 
 ### `allowNumber`
@@ -111,11 +117,20 @@ const arg = 'something';
 const msg1 = typeof arg === 'string' ? arg : `arg = ${arg}`;
 ```
 
+### `allowArray`
+
+Examples of additional **correct** code for this rule with `{ allowArray: true }`:
+
+```ts option='{ "allowArray": true }' showPlaygroundButton
+const arg = ['foo', 'bar'];
+const msg1 = `arg = ${arg}`;
+```
+
 ## When Not To Use It
 
 If you're not worried about incorrectly stringifying non-string values in template literals, then you likely don't need this rule.
 
 ## Related To
 
-- [`no-base-to-string`](./no-base-to-string.md)
-- [`restrict-plus-operands`](./restrict-plus-operands.md)
+- [`no-base-to-string`](./no-base-to-string.mdx)
+- [`restrict-plus-operands`](./restrict-plus-operands.mdx)

package/docs/rules/{return-await.md → return-await.mdx}

@@ -2,6 +2,9 @@
 description: 'Enforce consistent returning of awaited 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/return-await** for documentation.
@@ -33,9 +36,8 @@ Specifically:
 
 Examples of code with `in-try-catch`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='"in-try-catch"'
 async function invalidInTryCatch1() {
@@ -81,7 +83,8 @@ async function invalidInTryCatch6() {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='"in-try-catch"'
 async function validInTryCatch1() {
@@ -127,15 +130,17 @@ async function validInTryCatch6() {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### `always`
 
 Requires that all returned promises are `await`ed.
 
 Examples of code with `always`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='"always"'
 async function invalidAlways1() {
@@ -153,7 +158,8 @@ async function invalidAlways3() {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='"always"'
 async function validAlways1() {
@@ -171,15 +177,17 @@ async function validAlways3() {
 }
 ```
 
+</TabItem>
+</Tabs>
+
 ### `never`
 
 Disallows all `await`ing any returned promises.
 
 Examples of code with `never`:
 
-<!--tabs-->
-
-#### ❌ Incorrect
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='"never"'
 async function invalidNever1() {
@@ -197,7 +205,8 @@ async function invalidNever3() {
 }
 ```
 
-#### ✅ Correct
+</TabItem>
+<TabItem value="✅ Correct">
 
 ```ts option='"never"'
 async function validNever1() {
@@ -214,3 +223,6 @@ async function validNever3() {
   return 'value';
 }
 ```
+
+</TabItem>
+</Tabs>

package/docs/rules/{semi.md → semi.mdx}

@@ -2,6 +2,9 @@
 description: 'Require or disallow semicolons instead of ASI.'
 ---
 
+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/semi** for documentation.
@@ -9,4 +12,4 @@ description: 'Require or disallow semicolons instead of ASI.'
 This rule extends the base [`eslint/semi`](https://eslint.org/docs/rules/semi) rule.
 It adds support for TypeScript features that require semicolons.
 
-See also the [`@typescript-eslint/member-delimiter-style`](member-delimiter-style.md) rule, which allows you to specify the delimiter for `type` and `interface` members.
+See also the [`@typescript-eslint/member-delimiter-style`](member-delimiter-style.mdx) rule, which allows you to specify the delimiter for `type` and `interface` members.