@typescript-eslint/eslint-plugin 8.9.1-alpha.5 → 8.9.1-alpha.7

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.

package/docs/rules/prefer-optional-chain.mdx

@@ -68,6 +68,8 @@ Specifically the argument of the not operator (`!loose`) or a bare value in a lo
 
 ### `allowPotentiallyUnsafeFixesThatModifyTheReturnTypeIKnowWhatImDoing`
 
+{/* insert option description */}
+
 When this option is `true`, the rule will provide an auto-fixer for cases where the return type of the expression would change. For example for the expression `!foo || foo.bar` the return type of the expression is `true | T`, however for the equivalent optional chain `foo?.bar` the return type of the expression is `undefined | T`. Thus changing the code from a logical expression to an optional chain expression has altered the type of the expression.
 
 In some cases this distinction _may_ matter - which is why these fixers are considered unsafe - they may break the build! For example in the following code:
@@ -89,11 +91,12 @@ When this option is `false` unsafe cases will have suggestion fixers provided in
 
 ### `checkAny`
 
-When this option is `true` the rule will check operands that are typed as `any` when inspecting "loose boolean" operands.
+{/* insert option description */}
 
-<Tabs>
+Examples of code for this rule with `{ checkAny: false }`:
 
-<TabItem value="❌ Incorrect for `checkAny: true`">
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "checkAny": true }'
 declare const thing: any;
@@ -102,7 +105,7 @@ thing && thing.toString();
 ```
 
 </TabItem>
-<TabItem value="✅ Correct for `checkAny: false`">
+<TabItem value="✅ Correct">
 
 ```ts option='{ "checkAny": false }'
 declare const thing: any;
@@ -115,11 +118,12 @@ thing && thing.toString();
 
 ### `checkUnknown`
 
-When this option is `true` the rule will check operands that are typed as `unknown` when inspecting "loose boolean" operands.
+{/* insert option description */}
 
-<Tabs>
+Examples of code for this rule with `{ checkUnknown: false }`:
 
-<TabItem value="❌ Incorrect for `checkUnknown: true`">
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "checkUnknown": true }'
 declare const thing: unknown;
@@ -128,7 +132,7 @@ thing && thing.toString();
 ```
 
 </TabItem>
-<TabItem value="✅ Correct for `checkUnknown: false`">
+<TabItem value="✅ Correct">
 
 ```ts option='{ "checkUnknown": false }'
 declare const thing: unknown;
@@ -141,11 +145,12 @@ thing && thing.toString();
 
 ### `checkString`
 
-When this option is `true` the rule will check operands that are typed as `string` when inspecting "loose boolean" operands.
+{/* insert option description */}
 
-<Tabs>
+Examples of code for this rule with `{ checkString: false }`:
 
-<TabItem value="❌ Incorrect for `checkString: true`">
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "checkString": true }'
 declare const thing: string;
@@ -154,7 +159,7 @@ thing && thing.toString();
 ```
 
 </TabItem>
-<TabItem value="✅ Correct for `checkString: false`">
+<TabItem value="✅ Correct">
 
 ```ts option='{ "checkString": false }'
 declare const thing: string;
@@ -167,11 +172,12 @@ thing && thing.toString();
 
 ### `checkNumber`
 
-When this option is `true` the rule will check operands that are typed as `number` when inspecting "loose boolean" operands.
+{/* insert option description */}
 
-<Tabs>
+Examples of code for this rule with `{ checkNumber: false }`:
 
-<TabItem value="❌ Incorrect for `checkNumber: true`">
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "checkNumber": true }'
 declare const thing: number;
@@ -180,7 +186,7 @@ thing && thing.toString();
 ```
 
 </TabItem>
-<TabItem value="✅ Correct for `checkNumber: false`">
+<TabItem value="✅ Correct">
 
 ```ts option='{ "checkNumber": false }'
 declare const thing: number;
@@ -193,7 +199,7 @@ thing && thing.toString();
 
 ### `checkBoolean`
 
-When this option is `true` the rule will check operands that are typed as `boolean` when inspecting "loose boolean" operands.
+{/* insert option description */}
 
 :::note
 
@@ -209,9 +215,10 @@ The boolean expression narrows out the non-nullish falsy cases - so converting t
 
 :::
 
-<Tabs>
+Examples of code for this rule with `{ checkBoolean: false }`:
 
-<TabItem value="❌ Incorrect for `checkBoolean: true`">
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "checkBoolean": true }'
 declare const thing: true;
@@ -220,7 +227,7 @@ thing && thing.toString();
 ```
 
 </TabItem>
-<TabItem value="✅ Correct for `checkBoolean: false`">
+<TabItem value="✅ Correct">
 
 ```ts option='{ "checkBoolean": false }'
 declare const thing: true;
@@ -233,11 +240,12 @@ thing && thing.toString();
 
 ### `checkBigInt`
 
-When this option is `true` the rule will check operands that are typed as `bigint` when inspecting "loose boolean" operands.
+{/* insert option description */}
 
-<Tabs>
+Examples of code for this rule with `{ checkBigInt: false }`:
 
-<TabItem value="❌ Incorrect for `checkBigInt: true`">
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "checkBigInt": true }'
 declare const thing: bigint;
@@ -246,7 +254,7 @@ thing && thing.toString();
 ```
 
 </TabItem>
-<TabItem value="✅ Correct for `checkBigInt: false`">
+<TabItem value="✅ Correct">
 
 ```ts option='{ "checkBigInt": false }'
 declare const thing: bigint;
@@ -259,11 +267,12 @@ thing && thing.toString();
 
 ### `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.
+{/* insert option description */}
 
-<Tabs>
+Examples of code for this rule with `{ requireNullish: false }`:
 
-<TabItem value="❌ Incorrect for `requireNullish: true`">
+<Tabs>
+<TabItem value="❌ Incorrect">
 
 ```ts option='{ "requireNullish": true }'
 declare const thing1: string | null;
@@ -271,7 +280,7 @@ thing1 && thing1.toString();
 ```
 
 </TabItem>
-<TabItem value="✅ Correct for `requireNullish: true`">
+<TabItem value="✅ Correct">
 
 ```ts option='{ "requireNullish": true }'
 declare const thing1: string | null;

package/docs/rules/prefer-readonly-parameter-types.mdx

@@ -140,7 +140,8 @@ interface Foo {
 
 ### `allow`
 
-An array of type specifiers to ignore.
+{/* insert option description */}
+
 Some complex types cannot easily be made readonly, for example the `HTMLElement` type or the `JQueryStatic` type from `@types/jquery`. This option allows you to globally disable reporting of such types.
 
 This option takes the shared [`TypeOrValueSpecifier` format](/packages/type-utils/type-or-value-specifier).
@@ -251,7 +252,8 @@ function fn(arg: Foo) {}
 
 ### `checkParameterProperties`
 
-Whether to check class parameter properties.
+{/* insert option description */}
+
 Because parameter properties create properties on the class, it may be undesirable to force them to be readonly.
 
 Examples of code for this rule with `{checkParameterProperties: true}`:
@@ -290,7 +292,8 @@ class Foo {
 
 ### `ignoreInferredTypes`
 
-Whether to ignore parameters which don't explicitly specify a type.
+{/* insert option description */}
+
 This may be desirable in cases where an external dependency specifies a callback with mutable parameters, and manually annotating the callback's parameters is undesirable.
 
 Examples of code for this rule with `{ignoreInferredTypes: true}`:
@@ -348,7 +351,8 @@ export const acceptsCallback: AcceptsCallback;
 
 ### `treatMethodsAsReadonly`
 
-Whether to treat all mutable methods as though they are readonly.
+{/* insert option description */}
+
 This may be desirable when you are never reassigning methods.
 
 Examples of code for this rule with `{treatMethodsAsReadonly: false}`:

package/docs/rules/prefer-readonly.mdx

@@ -70,7 +70,7 @@ class Container {
 
 ### `onlyInlineLambdas`
 
-You may pass `"onlyInlineLambdas": true` as a rule option within an object to restrict checking only to members immediately assigned a lambda value.
+{/* insert option description */}
 
 ```jsonc
 {

package/docs/rules/prefer-string-starts-ends-with.mdx

@@ -62,6 +62,8 @@ foo.endsWith('bar');
 
 ### `allowSingleElementEquality`
 
+{/* insert option description */}
+
 If switched to `'always'`, the rule will allow equality checks against the first or last character in a string.
 This can be preferable in projects that don't deal with special character encodings and prefer a more succinct style.
 

package/docs/rules/promise-function-async.mdx

@@ -68,7 +68,8 @@ async function functionReturnsUnionWithPromiseImplicitly(p: boolean) {
 
 ### `allowAny`
 
-Whether to ignore functions that return `any` or `unknown`.
+{/* insert option description */}
+
 If you want additional safety, consider turning this option off, as it makes the rule less able to catch incorrect Promise behaviors.
 
 Examples of code with `{ "allowAny": false }`:
@@ -92,6 +93,8 @@ const returnsAny = async () => ({}) as any;
 
 ### `allowedPromiseNames`
 
+{/* insert option description */}
+
 For projects that use constructs other than the global built-in `Promise` for asynchronous code.
 This option allows specifying string names of classes or interfaces that cause a function to be checked as well.
 
@@ -120,23 +123,19 @@ const returnsBluebird = async () => new Bluebird(() => {});
 
 ### `checkArrowFunctions`
 
-Whether to check arrow functions.
-`true` by default, but can be set to `false` to ignore them.
+{/* insert option description */}
 
 ### `checkFunctionDeclarations`
 
-Whether to check standalone function declarations.
-`true` by default, but can be set to `false` to ignore them.
+{/* insert option description */}
 
 ### `checkFunctionExpressions`
 
-Whether to check inline function expressions.
-`true` by default, but can be set to `false` to ignore them.
+{/* insert option description */}
 
 ### `checkMethodDeclarations`
 
-Whether to check methods on classes and object literals.
-`true` by default, but can be set to `false` to ignore them.
+{/* insert option description */}
 
 ## When Not To Use It
 

package/docs/rules/require-array-sort-compare.mdx

@@ -57,6 +57,8 @@ userDefinedType.sort();
 
 ### `ignoreStringArrays`
 
+{/* insert option description */}
+
 Examples of code for this rule with `{ ignoreStringArrays: true }`:
 
 <Tabs>

package/docs/rules/restrict-plus-operands.mdx

@@ -74,6 +74,8 @@ Safer alternatives to using the `allow*` options include:
 
 ### `allowAny`
 
+{/* insert option description */}
+
 Examples of code for this rule with `{ allowAny: true }`:
 
 <Tabs>
@@ -97,6 +99,8 @@ let fn = (a: string, b: any) => a + b;
 
 ### `allowBoolean`
 
+{/* insert option description */}
+
 Examples of code for this rule with `{ allowBoolean: true }`:
 
 <Tabs>
@@ -120,6 +124,8 @@ let fn = (a: string, b: boolean) => a + b;
 
 ### `allowNullish`
 
+{/* insert option description */}
+
 Examples of code for this rule with `{ allowNullish: true }`:
 
 <Tabs>
@@ -147,6 +153,8 @@ let fn = (a: string, b: null) => a + b;
 
 ### `allowNumberAndString`
 
+{/* insert option description */}
+
 Examples of code for this rule with `{ allowNumberAndString: true }`:
 
 <Tabs>
@@ -170,6 +178,8 @@ let fn = (a: number, b: number | string) => a + b;
 
 ### `allowRegExp`
 
+{/* insert option description */}
+
 Examples of code for this rule with `{ allowRegExp: true }`:
 
 <Tabs>
@@ -191,6 +201,8 @@ let fn = (a: string, b: RegExp) => a + b;
 
 ### `skipCompoundAssignments`
 
+{/* insert option description */}
+
 Examples of code for this rule with `{ skipCompoundAssignments: false }`:
 
 <Tabs>