@typescript-eslint/eslint-plugin 8.9.1-alpha.1 → 8.9.1-alpha.10

package/docs/rules/no-empty-object-type.mdx

@@ -83,7 +83,9 @@ By default, this rule flags both interfaces and object types.
 
 ### `allowInterfaces`
 
-Whether to allow empty interfaces, as one of:
+{/* insert option description */}
+
+Allowed values are:
 
 - `'always'`: to always allow interfaces with no fields
 - `'never'` _(default)_: to never allow interfaces with no fields
@@ -101,14 +103,17 @@ interface Derived extends Base {}
 
 ### `allowObjectTypes`
 
-Whether to allow empty object type literals, as one of:
+{/* insert option description */}
+
+Allowed values are:
 
 - `'always'`: to always allow object type literals with no fields
 - `'never'` _(default)_: to never allow object type literals with no fields
 
 ### `allowWithName`
 
-A stringified regular expression to allow interfaces and object type aliases with the configured name.
+{/* insert option description */}
+
 This can be useful if your existing code style includes a pattern of declaring empty types with `{}` instead of `object`.
 
 Examples of code for this rule with `{ allowWithName: 'Props$' }`:

package/docs/rules/no-explicit-any.mdx

@@ -107,6 +107,8 @@ function greet(param: Array<string>): Array<string> {}
 
 ### `fixToUnknown`
 
+{/* insert option description */}
+
 By default, this rule will not provide automatic ESLint _fixes_: only opt-in _suggestions_.
 Switching types to `unknown` is safer but is likely to cause additional type errors.
 
@@ -114,7 +116,7 @@ Enabling `{ "fixToUnknown": true }` gives the rule an auto-fixer to replace `: a
 
 ### `ignoreRestArgs`
 
-A boolean to specify if arrays from the rest operator are considered okay. `false` by default.
+{/* insert option description */}
 
 The examples below are **incorrect** when `{ignoreRestArgs: false}`, but **correct** when `{ignoreRestArgs: true}`.
 

package/docs/rules/no-extraneous-class.mdx

@@ -221,7 +221,7 @@ The rule's options each add an exemption for a specific type of class.
 
 ### `allowConstructorOnly`
 
-`allowConstructorOnly` adds an exemption for classes that have only a constructor and no fields.
+{/* insert option description */}
 
 <Tabs>
 <TabItem value="❌ Incorrect">
@@ -246,7 +246,7 @@ class NoFields {
 
 ### `allowEmpty`
 
-The `allowEmpty` option adds an exemption for classes that are entirely empty.
+{/* insert option description */}
 
 <Tabs>
 <TabItem value="❌ Incorrect">
@@ -271,7 +271,7 @@ class NoFields {}
 
 ### `allowStaticOnly`
 
-The `allowStaticOnly` option adds an exemption for classes that only contain static members.
+{/* insert option description */}
 
 :::caution
 We strongly recommend against the `allowStaticOnly` exemption.
@@ -299,7 +299,7 @@ class NotEmptyClass {
 
 ### `allowWithDecorator`
 
-The `allowWithDecorator` option adds an exemption for classes decorated with a `@` decorator.
+{/* insert option description */}
 
 <Tabs>
 <TabItem value="❌ Incorrect">

package/docs/rules/no-floating-promises.mdx

@@ -87,6 +87,8 @@ await Promise.all([1, 2, 3].map(async x => x + 1));
 
 ### `checkThenables`
 
+{/* insert option description */}
+
 A ["Thenable"](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise#thenables) value is an object which has a `then` method, such as a `Promise`.
 Other Thenables include TypeScript's built-in `PromiseLike` interface and any custom object that happens to have a `.then()`.
 
@@ -132,8 +134,9 @@ await createMyThenable();
 
 ### `ignoreVoid`
 
-This option, which is `true` by default, allows you to stop the rule reporting promises consumed with the [`void` operator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/void).
-This can be a good way to explicitly mark a promise as intentionally not awaited.
+{/* insert option description */}
+
+Placing the [`void` operator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/void) in front of a Promise can be a convenient way to explicitly mark that Promise as intentionally not awaited.
 
 :::warning
 Voiding a Promise doesn't handle it or change the runtime behavior.
@@ -152,11 +155,11 @@ void returnsPromise();
 void Promise.reject('value');
 ```
 
-With this option set to `true`, and if you are using `no-void`, you should turn on the [`allowAsStatement`](https://eslint.org/docs/rules/no-void#allowasstatement) option.
+When this option is set to `true`, if you are using `no-void`, you should turn on the [`allowAsStatement`](https://eslint.org/docs/rules/no-void#allowasstatement) option.
 
 ### `ignoreIIFE`
 
-This allows you to skip checking of async IIFEs (Immediately Invoked Function Expressions).
+{/* insert option description */}
 
 Examples of **correct** code for this rule with `{ ignoreIIFE: true }`:
 
@@ -173,7 +176,9 @@ await (async function () {
 
 ### `allowForKnownSafePromises`
 
-Specific types to be marked as "safe" to be floating. For example, you may need to do this in the case of libraries whose APIs return Promises whose rejections are safely handled by the library.
+{/* insert option description */}
+
+For example, you may need to do this in the case of libraries whose APIs return Promises whose rejections are safely handled by the library.
 
 This option takes the shared [`TypeOrValueSpecifier` format](/packages/type-utils/type-or-value-specifier).
 
@@ -225,7 +230,8 @@ returnsSafePromise();
 
 ### `allowForKnownSafeCalls`
 
-Specific functions to be marked as "safe" to be called to create floating Promises.
+{/* insert option description */}
+
 For example, you may need to do this in the case of libraries whose APIs may be called without handling the resultant Promises.
 
 This option takes the shared [`TypeOrValueSpecifier` format](/packages/type-utils/type-or-value-specifier).

package/docs/rules/no-inferrable-types.mdx

@@ -80,7 +80,7 @@ function fn(a = 5, b = true) {}
 
 ### `ignoreParameters`
 
-Whether to ignore function parameters.
+{/* insert option description */}
 
 When set to true, the following pattern is considered valid:
 
@@ -92,7 +92,7 @@ function foo(a: number = 5, b: boolean = true) {
 
 ### `ignoreProperties`
 
-Whether to ignore class properties.
+{/* insert option description */}
 
 When set to true, the following pattern is considered valid:
 

package/docs/rules/no-invalid-void-type.mdx

@@ -62,9 +62,9 @@ type stillVoid = void | never;
 
 ### `allowInGenericTypeArguments`
 
-Whether `void` can be used as a valid value for generic type parameters.
+{/* insert option description */}
 
-Alternatively, you can provide an array of strings which whitelist which types may accept `void` as a generic type parameter.
+Alternatively, you can provide an array of strings which allowlist which types may accept `void` as a generic type parameter.
 
 Any types considered valid by this option will be considered valid as part of a union type with `void`.
 
@@ -98,7 +98,8 @@ type AllowedVoidUnion = void | Ex.Mx.Tx<void>;
 
 ### `allowAsThisParameter`
 
-Whether a `this` parameter of a function may be `void`.
+{/* insert option description */}
+
 This pattern can be useful to explicitly label function types that do not use a `this` argument. [See the TypeScript docs for more information](https://www.typescriptlang.org/docs/handbook/functions.html#this-parameters-in-callbacks).
 
 This option is `false` by default.

package/docs/rules/no-magic-numbers.mdx

@@ -39,6 +39,8 @@ const defaultOptions: Options = {
 
 ### `ignoreEnums`
 
+{/* insert option description */}
+
 Whether enums used in TypeScript are considered okay. `false` by default.
 
 Examples of **incorrect** code for the `{ "ignoreEnums": false }` option:
@@ -59,6 +61,8 @@ enum foo {
 
 ### `ignoreNumericLiteralTypes`
 
+{/* insert option description */}
+
 Whether numbers used in TypeScript numeric literal types are considered okay. `false` by default.
 
 Examples of **incorrect** code for the `{ "ignoreNumericLiteralTypes": false }` option:
@@ -75,6 +79,8 @@ type SmallPrimes = 2 | 3 | 5 | 7 | 11;
 
 ### `ignoreReadonlyClassProperties`
 
+{/* insert option description */}
+
 Whether `readonly` class properties are considered okay.
 
 Examples of **incorrect** code for the `{ "ignoreReadonlyClassProperties": false }` option:
@@ -101,6 +107,8 @@ class Foo {
 
 ### `ignoreTypeIndexes`
 
+{/* insert option description */}
+
 Whether numbers used to index types are okay. `false` by default.
 
 Examples of **incorrect** code for the `{ "ignoreTypeIndexes": false }` option:

package/docs/rules/no-meaningless-void-operator.mdx

@@ -54,7 +54,7 @@ void bar(1); // discarding a number
 
 ### `checkNever`
 
-Whether to suggest removing `void` when the argument has type `never`.
+{/* insert option description */}
 
 ## When Not To Use It
 

package/docs/rules/no-misused-promises.mdx

@@ -22,6 +22,8 @@ See [`no-floating-promises`](./no-floating-promises.mdx) for detecting unhandled
 
 ### `checksConditionals`
 
+{/* insert option description */}
+
 If you don't want to check conditionals, you can configure the rule with `"checksConditionals": false`:
 
 ```json
@@ -39,6 +41,8 @@ Doing so prevents the rule from looking at code like `if (somePromise)`.
 
 ### `checksVoidReturn`
 
+{/* insert option description */}
+
 Likewise, if you don't want to check functions that return promises where a void return is
 expected, your configuration will look like this:
 
@@ -101,7 +105,7 @@ Disables checking an asynchronous function used as a variable whose return type
 
 ### `checksSpreads`
 
-Whether to warn when `...` spreading a `Promise`.
+{/* insert option description */}
 
 If you don't want to check object spreads, you can add this configuration:
 
@@ -120,6 +124,8 @@ If you don't want to check object spreads, you can add this configuration:
 
 ### `checksConditionals`
 
+{/* insert option description */}
+
 Examples of code for this rule with `checksConditionals: true`:
 
 <Tabs>
@@ -167,6 +173,8 @@ while (await promise) {
 
 ### `checksVoidReturn`
 
+{/* insert option description */}
+
 Examples of code for this rule with `checksVoidReturn: true`:
 
 <Tabs>
@@ -254,6 +262,8 @@ class MyClass implements MyAsyncInterface {
 
 ### `checksSpreads`
 
+{/* insert option description */}
+
 Examples of code for this rule with `checksSpreads: true`:
 
 <Tabs>

package/docs/rules/no-namespace.mdx

@@ -46,6 +46,8 @@ declare module 'foo' {}
 
 ### `allowDeclarations`
 
+{/* insert option description */}
+
 Examples of code with the `{ "allowDeclarations": true }` option:
 
 <Tabs>
@@ -100,6 +102,8 @@ declare module 'foo' {}
 
 ### `allowDefinitionFiles`
 
+{/* insert option description */}
+
 Examples of code for the `{ "allowDefinitionFiles": true }` option:
 
 <Tabs>

package/docs/rules/no-redeclare.mdx

@@ -33,7 +33,9 @@ const defaultOptions: Options = {
 
 ### `ignoreDeclarationMerge`
 
-Whether to ignore declaration merges between the following sets:
+{/* insert option description */}
+
+The following sets will be ignored when this option is enabled:
 
 - interface + interface
 - namespace + namespace

package/docs/rules/no-require-imports.mdx

@@ -38,7 +38,9 @@ import * as lib3 from 'lib3';
 
 ### `allow`
 
-An array of strings. These strings will be compiled into regular expressions with the `u` flag and be used to test against the imported path. A common use case is to allow importing `package.json`. This is because `package.json` commonly lives outside of the TS root directory, so statically importing it would lead to root directory conflicts, especially with `resolveJsonModule` enabled. You can also use it to allow importing any JSON if your environment doesn't support JSON modules, or use it for other cases where `import` statements cannot work.
+{/* insert option description */}
+
+These strings will be compiled into regular expressions with the `u` flag and be used to test against the imported path. A common use case is to allow importing `package.json`. This is because `package.json` commonly lives outside of the TS root directory, so statically importing it would lead to root directory conflicts, especially with `resolveJsonModule` enabled. You can also use it to allow importing any JSON if your environment doesn't support JSON modules, or use it for other cases where `import` statements cannot work.
 
 With `{allow: ['/package\\.json$']}`:
 
@@ -61,7 +63,9 @@ console.log(require('../package.json').version);
 
 ### `allowAsImport`
 
-When set to `true`, the `import x = require(...)` declaration won't be reported.
+{/* insert option description */}
+
+When set to `true`, `import ... = require(...)` declarations won't be reported.
 This is useful if you use certain module options that require strict CommonJS interop semantics.
 
 With `{allowAsImport: true}`:

package/docs/rules/no-restricted-imports.mdx

@@ -17,7 +17,10 @@ This rule adds the following options:
 
 ### `allowTypeImports`
 
-(default: `false`)
+{/* insert option description */}
+
+Whether to allow type-only imports for a path.
+Default: `false`.
 
 You can specify this option for a specific path or pattern as follows:
 

package/docs/rules/no-restricted-types.mdx

@@ -19,7 +19,7 @@ Note that it does not ban the corresponding runtime objects from being used.
 
 ### `types`
 
-An object whose keys are the types you want to ban, and the values are error messages.
+{/* insert option description */}
 
 The type can either be a type name literal (`OldType`) or a a type name with generic parameter instantiation(s) (`OldType<MyArgument>`).
 

package/docs/rules/no-shadow.mdx

@@ -31,7 +31,9 @@ const defaultOptions: Options = {
 
 ### `ignoreTypeValueShadow`
 
-Whether to ignore types named the same as a variable. This is generally safe because you cannot use variables in type locations without a `typeof` operator, so there's little risk of confusion.
+{/* insert option description */}
+
+This is generally safe because you cannot use variables in type locations without a `typeof` operator, so there's little risk of confusion.
 
 Examples of **correct** code with `{ ignoreTypeValueShadow: true }`:
 
@@ -55,7 +57,7 @@ _Shadowing_ specifically refers to two identical identifiers that are in differe
 
 ### `ignoreFunctionTypeParameterNameValueShadow`
 
-Whether to ignore function parameters named the same as a variable.
+{/* insert option description */}
 
 Each of a function type's arguments creates a value variable within the scope of the function type. This is done so that you can reference the type later using the `typeof` operator:
 

package/docs/rules/no-this-alias.mdx

@@ -41,6 +41,8 @@ setTimeout(() => {
 
 ### `allowDestructuring`
 
+{/* insert option description */}
+
 It can sometimes be useful to destructure properties from a class instance, such as retrieving multiple properties from the instance in one of its methods.
 `allowDestructuring` allows those destructures and is `true` by default.
 You can explicitly disallow them by setting `allowDestructuring` to `false`.
@@ -84,6 +86,8 @@ class ComponentLike {
 
 ### `allowedNames`
 
+{/* insert option description */}
+
 `no-this-alias` can alternately be used to allow only a specific list of names as `this` aliases.
 We recommend against this except as a transitory step towards fixing all rule violations.
 

package/docs/rules/no-type-alias.mdx

@@ -114,7 +114,7 @@ and simplified types (primitives, tuples, unions, intersections, etc).
 
 ### `allowAliases`
 
-This applies to primitive types and reference types.
+{/* insert option description */}
 
 The setting accepts the following values:
 
@@ -268,7 +268,7 @@ type Foo = Bar & Baz;
 
 ### `allowCallbacks`
 
-This applies to function types.
+{/* insert option description */}
 
 The setting accepts the following values:
 
@@ -290,7 +290,7 @@ type Foo = (name: string, age: number) => string & Person;
 
 ### `allowConditionalTypes`
 
-This applies to conditional types.
+{/* insert option description */}
 
 Examples of **correct** code for the `{ "allowConditionalTypes": "always" }` option:
 
@@ -300,7 +300,7 @@ type Foo<T> = T extends number ? number : null;
 
 ### `allowConstructors`
 
-This applies to constructor types.
+{/* insert option description */}
 
 The setting accepts the following values:
 
@@ -314,7 +314,7 @@ type Foo = new () => void;
 
 ### `allowLiterals`
 
-This applies to literal types (`type Foo = { ... }`).
+{/* insert option description */}
 
 The setting accepts the following options:
 
@@ -421,7 +421,7 @@ type Foo = { name: string } & { age: number };
 
 ### `allowMappedTypes`
 
-This applies to literal types.
+{/* insert option description */}
 
 The setting accepts the following values:
 
@@ -524,7 +524,7 @@ type Foo<T, U> = { [P in keyof T]?: T[P] } & { [P in keyof U]?: U[P] };
 
 ### `allowTupleTypes`
 
-This applies to tuple types (`type Foo = [number]`).
+{/* insert option description */}
 
 The setting accepts the following options:
 
@@ -599,7 +599,7 @@ type Foo = [string] | [number];
 
 ### `allowGenerics`
 
-This applies to generic types, including TypeScript provided global utility types (`type Foo = Record<string, number>`).
+{/* insert option description */}
 
 The setting accepts the following options:
 

package/docs/rules/no-unnecessary-boolean-literal-compare.mdx

@@ -61,6 +61,8 @@ are **not** checked by default.
 
 ### `allowComparingNullableBooleansToTrue`
 
+{/* insert option description */}
+
 Examples of code for this rule with `{ allowComparingNullableBooleansToTrue: false }`:
 
 <Tabs>
@@ -94,6 +96,8 @@ if (!someNullCondition) {
 
 ### `allowComparingNullableBooleansToFalse`
 
+{/* insert option description */}
+
 Examples of code for this rule with `{ allowComparingNullableBooleansToFalse: false }`:
 
 <Tabs>

package/docs/rules/no-unnecessary-condition.mdx

@@ -82,6 +82,8 @@ function bar(arg?: string | null) {
 
 ### `allowConstantLoopConditions`
 
+{/* insert option description */}
+
 Example of correct code for `{ allowConstantLoopConditions: true }`:
 
 ```ts option='{ "allowConstantLoopConditions": true }' showPlaygroundButton
@@ -92,6 +94,8 @@ do {} while (true);
 
 ### `checkTypePredicates`
 
+{/* insert option description */}
+
 Example of additional incorrect code with `{ checkTypePredicates: true }`:
 
 ```ts option='{ "checkTypePredicates": true }' showPlaygroundButton
@@ -132,6 +136,8 @@ However, in some contexts, it may be more appropriate to keep this option disabl
 
 ### `allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing`
 
+{/* insert option description */}
+
 :::danger Deprecated
 This option will be removed in the next major version of typescript-eslint.
 :::

package/docs/rules/no-unnecessary-type-assertion.mdx

@@ -75,6 +75,8 @@ function foo(x: number | undefined): number {
 
 ### `typesToIgnore`
 
+{/* insert option description */}
+
 With `@typescript-eslint/no-unnecessary-type-assertion: ["error", { typesToIgnore: ['Foo'] }]`, the following is **correct** code:
 
 ```ts option='{ "typesToIgnore": ["Foo"] }' showPlaygroundButton

package/docs/rules/no-use-before-define.mdx

@@ -33,7 +33,7 @@ const defaultOptions: Options = {
 
 ### `enums`
 
-Whether to check references to enums before the enum declaration.
+{/* insert option description */}
 
 If this is `true`, this rule warns every reference to a enum before the enum declaration.
 If this is `false`, this rule will ignore references to enums, when the reference is in a child scope.
@@ -69,7 +69,7 @@ enum Foo {
 
 ### `typedefs`
 
-Whether to check references to types before the type declaration.
+{/* insert option description */}
 
 If this is `true`, this rule warns every reference to a type before the type declaration.
 If this is `false`, this rule will ignore references to types.
@@ -83,7 +83,7 @@ type StringOrNumber = string | number;
 
 ### `ignoreTypeReferences`
 
-Whether to ignore type references, such as in type annotations and assertions.
+{/* insert option description */}
 
 If this is `true`, this rule ignores all type references.
 If this is `false`, this will check all type references.

package/docs/rules/no-var-requires.mdx

@@ -44,6 +44,8 @@ import foo from 'foo';
 
 ### `allow`
 
+{/* insert option description */}
+
 A array of strings. These strings will be compiled into regular expressions with the `u` flag and be used to test against the imported path. A common use case is to allow importing `package.json`. This is because `package.json` commonly lives outside of the TS root directory, so statically importing it would lead to root directory conflicts, especially with `resolveJsonModule` enabled. You can also use it to allow importing any JSON if your environment doesn't support JSON modules, or use it for other cases where `import` statements cannot work.
 
 With `{allow: ['/package\\.json$']}`:

package/docs/rules/parameter-properties.mdx

@@ -24,6 +24,8 @@ It may take an options object containing either or both of:
 
 ### `allow`
 
+{/* insert option description */}
+
 If you would like to ignore certain kinds of properties then you may pass an object containing `"allow"` as an array of any of the following options:
 
 - `allow`, an array containing one or more of the allowed modifiers. Valid values are:
@@ -50,8 +52,10 @@ For example, to ignore `public` properties:
 
 ### `prefer`
 
-By default, the rule prefers class property (`"class-property"`).
-You can switch it to instead preferring parameter property with (`"parameter-property"`).
+{/* insert option description */}
+
+By default, the rule prefers class properties.
+You can switch it to instead preferring parameter properties with (`"parameter-property"`).
 
 In `"parameter-property"` mode, the rule will issue a report when:
 

package/docs/rules/prefer-destructuring.mdx

@@ -80,7 +80,7 @@ const defaultOptions: Options = [
 
 ### `enforceForDeclarationWithTypeAnnotation`
 
-When set to `true`, type annotated variable declarations are enforced to use destructuring assignment.
+{/* insert option description */}
 
 Examples with `{ enforceForDeclarationWithTypeAnnotation: true }`:
 

package/docs/rules/prefer-literal-enum-member.mdx

@@ -68,7 +68,7 @@ enum Valid {
 
 ### `allowBitwiseExpressions`
 
-Whether to allow using bitwise expressions in enum initializers (default: `false`).
+{/* insert option description */}
 
 Examples of code for the `{ "allowBitwiseExpressions": true }` option:
 

package/docs/rules/prefer-nullish-coalescing.mdx

@@ -25,7 +25,7 @@ This rule will not work as expected if [`strictNullChecks`](https://www.typescri
 
 ### `ignoreTernaryTests`
 
-Whether to ignore any ternary expressions that could be simplified by using the nullish coalescing operator. This is set to `false` by default.
+{/* insert option description */}
 
 Incorrect code for `ignoreTernaryTests: false`, and correct code for `ignoreTernaryTests: true`:
 
@@ -65,7 +65,7 @@ foo ?? 'a string';
 
 ### `ignoreConditionalTests`
 
-Whether to ignore cases that are located within a conditional test. This is set to `true` by default.
+{/* insert option description */}
 
 Generally expressions within conditional tests intentionally use the falsy fallthrough behavior of the logical or operator, meaning that fixing the operator to the nullish coalesce operator could cause bugs.
 
@@ -107,7 +107,7 @@ a ?? b ? true : false;
 
 ### `ignoreMixedLogicalExpressions`
 
-Whether to ignore any logical or expressions that are part of a mixed logical expression (with `&&`). This is set to `false` by default.
+{/* insert option description */}
 
 Generally expressions within mixed logical expressions intentionally use the falsy fallthrough behavior of the logical or operator, meaning that fixing the operator to the nullish coalesce operator could cause bugs.
 
@@ -147,7 +147,7 @@ a ?? (b && c && d);
 
 ### `ignorePrimitives`
 
-Whether to ignore all (`true`) or some (an object with properties) primitive types.
+{/* insert option description */}
 
 If you would like to ignore expressions containing operands of certain primitive types that can be falsy then you may pass an object containing a boolean value for each primitive:
 
@@ -174,6 +174,8 @@ Also, if you would like to ignore all primitives types, you can set `ignorePrimi
 
 ### `allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing`
 
+{/* insert option description */}
+
 :::danger Deprecated
 
 > This option will be removed in the next major version of typescript-eslint.