@typescript-eslint/eslint-plugin 6.8.1-alpha.7 → 6.9.0

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

@@ -112,7 +112,7 @@ The setting accepts the following values:
 
 Examples of **correct** code for the `{ "allowAliases": "always" }` options:
 
-```ts
+```ts option='{ "allowAliases": "always" }' showPlaygroundButton
 // primitives
 type Foo = 'a';
 
@@ -139,7 +139,7 @@ type Foo = Bar & Baz;
 
 Examples of **incorrect** code for the `{ "allowAliases": "in-unions" }` option:
 
-```ts
+```ts option='{ "allowAliases": "in-unions" }' showPlaygroundButton
 // primitives
 type Foo = 'a';
 
@@ -160,7 +160,7 @@ type Foo = Bar & Baz;
 
 Examples of **correct** code for the `{ "allowAliases": "in-unions" }` option:
 
-```ts
+```ts option='{ "allowAliases": "in-unions" }' showPlaygroundButton
 // primitives
 type Foo = 'a' | 'b';
 
@@ -177,7 +177,7 @@ type Foo = Bar | Baz;
 
 Examples of **incorrect** code for the `{ "allowAliases": "in-intersections" }` option:
 
-```ts
+```ts option='{ "allowAliases": "in-intersections" }' showPlaygroundButton
 // primitives
 type Foo = 'a';
 
@@ -200,7 +200,7 @@ type Foo = Bar | Baz;
 
 Examples of **correct** code for the `{ "allowAliases": "in-intersections" }` option:
 
-```ts
+```ts option='{ "allowAliases": "in-intersections" }' showPlaygroundButton
 // primitives
 type Foo = string & string[];
 
@@ -215,7 +215,7 @@ type Foo = Bar & Baz;
 
 Examples of **incorrect** code for the `{ "allowAliases": "in-unions-and-intersections" }` option:
 
-```ts
+```ts option='{ "allowAliases": "in-unions-and-intersections" }' showPlaygroundButton
 // primitives
 type Foo = 'a';
 
@@ -232,7 +232,7 @@ type Foo = Bar;
 
 Examples of **correct** code for the `{ "allowAliases": "in-unions-and-intersections" }` option:
 
-```ts
+```ts option='{ "allowAliases": "in-unions-and-intersections" }' showPlaygroundButton
 // primitives
 type Foo = 'a' | 'b';
 
@@ -263,7 +263,7 @@ The setting accepts the following values:
 
 Examples of **correct** code for the `{ "allowCallbacks": "always" }` option:
 
-```ts
+```ts option='{ "allowCallbacks": "always" }' showPlaygroundButton
 type Foo = () => void;
 
 type Foo = (name: string) => string;
@@ -281,7 +281,7 @@ This applies to conditional types.
 
 Examples of **correct** code for the `{ "allowConditionalTypes": "always" }` option:
 
-```ts
+```ts option='{ "allowConditionalTypes": "always" }' showPlaygroundButton
 type Foo<T> = T extends number ? number : null;
 ```
 
@@ -295,7 +295,7 @@ The setting accepts the following values:
 
 Examples of **correct** code for the `{ "allowConstructors": "always" }` option:
 
-```ts
+```ts option='{ "allowConstructors": "always" }' showPlaygroundButton
 type Foo = new () => void;
 ```
 
@@ -312,7 +312,7 @@ The setting accepts the following options:
 
 Examples of **correct** code for the `{ "allowLiterals": "always" }` options:
 
-```ts
+```ts option='{ "allowLiterals": "always" }' showPlaygroundButton
 type Foo = {};
 
 type Foo = {
@@ -333,7 +333,7 @@ type Foo = { name: string } & { age: number };
 
 Examples of **incorrect** code for the `{ "allowLiterals": "in-unions" }` option:
 
-```ts
+```ts option='{ "allowLiterals": "in-unions" }' showPlaygroundButton
 type Foo = {};
 
 type Foo = {
@@ -352,13 +352,13 @@ type Foo = { name: string } & { age: number };
 
 Examples of **correct** code for the `{ "allowLiterals": "in-unions" }` option:
 
-```ts
+```ts option='{ "allowLiterals": "in-unions" }' showPlaygroundButton
 type Foo = { name: string } | { age: number };
 ```
 
 Examples of **incorrect** code for the `{ "allowLiterals": "in-intersections" }` option:
 
-```ts
+```ts option='{ "allowLiterals": "in-intersections" }' showPlaygroundButton
 type Foo = {};
 
 type Foo = {
@@ -377,13 +377,13 @@ type Foo = { name: string } | { age: number };
 
 Examples of **correct** code for the `{ "allowLiterals": "in-intersections" }` option:
 
-```ts
+```ts option='{ "allowLiterals": "in-intersections" }' showPlaygroundButton
 type Foo = { name: string } & { age: number };
 ```
 
 Examples of **incorrect** code for the `{ "allowLiterals": "in-unions-and-intersections" }` option:
 
-```ts
+```ts option='{ "allowLiterals": "in-unions-and-intersections" }' showPlaygroundButton
 type Foo = {};
 
 type Foo = {
@@ -400,7 +400,7 @@ type Foo = {
 
 Examples of **correct** code for the `{ "allowLiterals": "in-unions-and-intersections" }` option:
 
-```ts
+```ts option='{ "allowLiterals": "in-unions-and-intersections" }' showPlaygroundButton
 type Foo = { name: string } | { age: number };
 
 type Foo = { name: string } & { age: number };
@@ -419,7 +419,7 @@ The setting accepts the following values:
 
 Examples of **correct** code for the `{ "allowMappedTypes": "always" }` options:
 
-```ts
+```ts option='{ "allowMappedTypes": "always" }' showPlaygroundButton
 type Foo<T> = { readonly [P in keyof T]: T[P] };
 
 type Foo<T> = { [P in keyof T]?: T[P] };
@@ -439,7 +439,7 @@ type Foo<T, U> = { [P in keyof T]?: T[P] } & { [P in keyof U]?: U[P] };
 
 Examples of **incorrect** code for the `{ "allowMappedTypes": "in-unions" }` option:
 
-```ts
+```ts option='{ "allowMappedTypes": "in-unions" }' showPlaygroundButton
 type Foo<T> = { readonly [P in keyof T]: T[P] };
 
 type Foo<T> = { [P in keyof T]?: T[P] };
@@ -453,7 +453,7 @@ type Foo<T, U> = { [P in keyof T]?: T[P] } & { [P in keyof U]?: U[P] };
 
 Examples of **correct** code for the `{ "allowMappedTypes": "in-unions" }` option:
 
-```ts
+```ts option='{ "allowMappedTypes": "in-unions" }' showPlaygroundButton
 type Foo<T, U> =
   | { readonly [P in keyof T]: T[P] }
   | { readonly [P in keyof U]: U[P] };
@@ -463,7 +463,7 @@ type Foo<T, U> = { [P in keyof T]?: T[P] } | { [P in keyof U]?: U[P] };
 
 Examples of **incorrect** code for the `{ "allowMappedTypes": "in-intersections" }` option:
 
-```ts
+```ts option='{ "allowMappedTypes": "in-intersections" }' showPlaygroundButton
 type Foo<T> = { readonly [P in keyof T]: T[P] };
 
 type Foo<T> = { [P in keyof T]?: T[P] };
@@ -477,7 +477,7 @@ type Foo<T, U> = { [P in keyof T]?: T[P] } | { [P in keyof U]?: U[P] };
 
 Examples of **correct** code for the `{ "allowMappedTypes": "in-intersections" }` option:
 
-```ts
+```ts option='{ "allowMappedTypes": "in-intersections" }' showPlaygroundButton
 type Foo<T, U> = { readonly [P in keyof T]: T[P] } & {
   readonly [P in keyof U]: U[P];
 };
@@ -487,7 +487,7 @@ type Foo<T, U> = { [P in keyof T]?: T[P] } & { [P in keyof U]?: U[P] };
 
 Examples of **incorrect** code for the `{ "allowMappedTypes": "in-unions-and-intersections" }` option:
 
-```ts
+```ts option='{ "allowMappedTypes": "in-unions-and-intersections" }' showPlaygroundButton
 type Foo<T> = { readonly [P in keyof T]: T[P] };
 
 type Foo<T> = { [P in keyof T]?: T[P] };
@@ -495,7 +495,7 @@ type Foo<T> = { [P in keyof T]?: T[P] };
 
 Examples of **correct** code for the `{ "allowMappedTypes": "in-unions-and-intersections" }` option:
 
-```ts
+```ts option='{ "allowMappedTypes": "in-unions-and-intersections" }' showPlaygroundButton
 type Foo<T, U> =
   | { readonly [P in keyof T]: T[P] }
   | { readonly [P in keyof U]: U[P] };
@@ -522,7 +522,7 @@ The setting accepts the following options:
 
 Examples of **correct** code for the `{ "allowTupleTypes": "always" }` options:
 
-```ts
+```ts option='{ "allowTupleTypes": "always" }' showPlaygroundButton
 type Foo = [number];
 
 type Foo = [number] | [number, number];
@@ -534,7 +534,7 @@ type Foo = [number] | ([number, number] & [string, string]);
 
 Examples of **incorrect** code for the `{ "allowTupleTypes": "in-unions" }` option:
 
-```ts
+```ts option='{ "allowTupleTypes": "in-unions" }' showPlaygroundButton
 type Foo = [number];
 
 type Foo = [number] & [number, number];
@@ -544,7 +544,7 @@ type Foo = [string] & [number];
 
 Examples of **correct** code for the `{ "allowTupleTypes": "in-unions" }` option:
 
-```ts
+```ts option='{ "allowTupleTypes": "in-unions" }' showPlaygroundButton
 type Foo = [number] | [number, number];
 
 type Foo = [string] | [number];
@@ -552,7 +552,7 @@ type Foo = [string] | [number];
 
 Examples of **incorrect** code for the `{ "allowTupleTypes": "in-intersections" }` option:
 
-```ts
+```ts option='{ "allowTupleTypes": "in-intersections" }' showPlaygroundButton
 type Foo = [number];
 
 type Foo = [number] | [number, number];
@@ -562,7 +562,7 @@ type Foo = [string] | [number];
 
 Examples of **correct** code for the `{ "allowTupleTypes": "in-intersections" }` option:
 
-```ts
+```ts option='{ "allowTupleTypes": "in-intersections" }' showPlaygroundButton
 type Foo = [number] & [number, number];
 
 type Foo = [string] & [number];
@@ -570,15 +570,15 @@ type Foo = [string] & [number];
 
 Examples of **incorrect** code for the `{ "allowTupleTypes": "in-unions-and-intersections" }` option:
 
-```ts
+```ts option='{ "allowTupleTypes": "in-unions-and-intersections" }' showPlaygroundButton
 type Foo = [number];
 
 type Foo = [string];
 ```
 
-Examples of **correct** code for the `{ "allowLiterals": "in-unions-and-intersections" }` option:
+Examples of **correct** code for the `{ "allowTupleTypes": "in-unions-and-intersections" }` option:
 
-```ts
+```ts option='{ "allowTupleTypes": "in-unions-and-intersections" }' showPlaygroundButton
 type Foo = [number] & [number, number];
 
 type Foo = [string] | [number];
@@ -594,7 +594,7 @@ The setting accepts the following options:
 
 Examples of **correct** code for the `{ "allowGenerics": "always" }` options:
 
-```ts
+```ts option='{ "allowGenerics": "always" }' showPlaygroundButton
 type Foo = Bar<string>;
 
 type Foo = Record<string, number>;

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

@@ -61,7 +61,7 @@ Examples of code for this rule with `{ allowComparingNullableBooleansToTrue: fal
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allowComparingNullableBooleansToTrue": false }'
 declare const someUndefinedCondition: boolean | undefined;
 if (someUndefinedCondition === true) {
 }
@@ -73,7 +73,7 @@ if (someNullCondition !== true) {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "allowComparingNullableBooleansToTrue": false }'
 declare const someUndefinedCondition: boolean | undefined;
 if (someUndefinedCondition) {
 }
@@ -91,7 +91,7 @@ Examples of code for this rule with `{ allowComparingNullableBooleansToFalse: fa
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allowComparingNullableBooleansToFalse": false }'
 declare const someUndefinedCondition: boolean | undefined;
 if (someUndefinedCondition === false) {
 }
@@ -103,7 +103,7 @@ if (someNullCondition !== false) {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "allowComparingNullableBooleansToFalse": false }'
 declare const someUndefinedCondition: boolean | undefined;
 if (someUndefinedCondition ?? true) {
 }

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

@@ -77,7 +77,7 @@ function bar(arg?: string | null) {
 
 Example of correct code for `{ allowConstantLoopConditions: true }`:
 
-```ts
+```ts option='{ "allowConstantLoopConditions": true }' showPlaygroundButton
 while (true) {}
 for (; true; ) {}
 do {} while (true);

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

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

package/docs/rules/no-unsafe-argument.md

@@ -73,8 +73,8 @@ There are cases where the rule allows passing an argument of `any` to `unknown`.
 
 Example of `any` to `unknown` assignment that are allowed:
 
-```ts
-declare function foo(arg1: unknown, arg2: Set<unkown>, arg3: unknown[]): void;
+```ts showPlaygroundButton
+declare function foo(arg1: unknown, arg2: Set<unknown>, arg3: unknown[]): void;
 foo(1 as any, new Set<any>(), [] as any[]);
 ```
 

package/docs/rules/no-unsafe-assignment.md

@@ -75,7 +75,7 @@ There are cases where the rule allows assignment of `any` to `unknown`.
 
 Example of `any` to `unknown` assignment that are allowed:
 
-```ts
+```ts showPlaygroundButton
 const x: unknown = y as any;
 const x: unknown[] = y as any[];
 const x: Set<unknown> = y as Set<any>;

package/docs/rules/no-unsafe-return.md

@@ -88,7 +88,7 @@ There are cases where the rule allows to return `any` to `unknown`.
 
 Examples of `any` to `unknown` return that are allowed:
 
-```ts
+```ts showPlaygroundButton
 function foo1(): unknown {
   return JSON.parse(singleObjString); // Return type for JSON.parse is any.
 }

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

@@ -39,9 +39,7 @@ Examples of code for the `{ "enums": true }` option:
 
 #### ❌ Incorrect
 
-```ts
-/*eslint no-use-before-define: ["error", { "enums": true }]*/
-
+```ts option='{ "enums": true }'
 const x = Foo.FOO;
 
 enum Foo {
@@ -51,9 +49,7 @@ enum Foo {
 
 #### ✅ Correct
 
-```ts
-/*eslint no-use-before-define: ["error", { "enums": false }]*/
-
+```ts option='{ "enums": false }'
 function foo() {
   return Foo.FOO;
 }
@@ -70,9 +66,7 @@ If this is `false`, this rule will ignore references to types.
 
 Examples of **correct** code for the `{ "typedefs": false }` option:
 
-```ts
-/*eslint no-use-before-define: ["error", { "typedefs": false }]*/
-
+```ts option='{ "typedefs": false }' showPlaygroundButton
 let myVar: StringOrNumber;
 type StringOrNumber = string | number;
 ```
@@ -84,9 +78,7 @@ If this is `false`, this will will check all type references.
 
 Examples of **correct** code for the `{ "ignoreTypeReferences": true }` option:
 
-```ts
-/*eslint no-use-before-define: ["error", { "ignoreTypeReferences": true }]*/
-
+```ts option='{ "ignoreTypeReferences": true }' showPlaygroundButton
 let var1: StringOrNumber;
 type StringOrNumber = string | number;
 

package/docs/rules/parameter-properties.md

@@ -109,7 +109,7 @@ Examples of code for the `{ "allow": ["readonly"] }` options:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allow": ["readonly"] }'
 class Foo {
   constructor(private name: string) {}
 }
@@ -137,7 +137,7 @@ class Foo {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "allow": ["readonly"] }'
 class Foo {
   constructor(name: string) {}
 }
@@ -155,7 +155,7 @@ Examples of code for the `{ "allow": ["private"] }` options:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allow": ["private"] }'
 class Foo {
   constructor(readonly name: string) {}
 }
@@ -183,7 +183,7 @@ class Foo {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "allow": ["private"] }'
 class Foo {
   constructor(name: string) {}
 }
@@ -201,7 +201,7 @@ Examples of code for the `{ "allow": ["protected"] }` options:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allow": ["protected"] }'
 class Foo {
   constructor(readonly name: string) {}
 }
@@ -229,7 +229,7 @@ class Foo {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "allow": ["protected"] }'
 class Foo {
   constructor(name: string) {}
 }
@@ -247,7 +247,7 @@ Examples of code for the `{ "allow": ["public"] }` options:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allow": ["public"] }'
 class Foo {
   constructor(readonly name: string) {}
 }
@@ -275,7 +275,7 @@ class Foo {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "allow": ["public"] }'
 class Foo {
   constructor(name: string) {}
 }
@@ -293,7 +293,7 @@ Examples of code for the `{ "allow": ["private readonly"] }` options:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allow": ["private readonly"] }'
 class Foo {
   constructor(readonly name: string) {}
 }
@@ -321,7 +321,7 @@ class Foo {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "allow": ["private readonly"] }'
 class Foo {
   constructor(name: string) {}
 }
@@ -339,7 +339,7 @@ Examples of code for the `{ "allow": ["protected readonly"] }` options:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allow": ["protected readonly"] }'
 class Foo {
   constructor(readonly name: string) {}
 }
@@ -367,7 +367,7 @@ class Foo {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "allow": ["protected readonly"] }'
 class Foo {
   constructor(name: string) {}
 }
@@ -385,7 +385,7 @@ Examples of code for the `{ "allow": ["public readonly"] }` options:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allow": ["public readonly"] }'
 class Foo {
   constructor(readonly name: string) {}
 }
@@ -413,7 +413,7 @@ class Foo {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "allow": ["public readonly"] }'
 class Foo {
   constructor(name: string) {}
 }
@@ -431,7 +431,7 @@ Examples of code for the `{ "prefer": "parameter-property" }` option:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "prefer": "parameter-property" }'
 class Foo {
   private name: string;
   constructor(name: string) {
@@ -456,7 +456,7 @@ class Foo {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "prefer": "parameter-property" }'
 class Foo {
   private differentName: string;
   constructor(name: string) {

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

@@ -69,7 +69,7 @@ Examples of code for the `{ "allowBitwiseExpressions": true }` option:
 
 ### ❌ Incorrect
 
-```ts
+```ts option='{ "allowBitwiseExpressions": true }'
 const x = 1;
 enum Foo {
   A = x << 0,
@@ -84,7 +84,7 @@ enum Foo {
 
 ### ✅ Correct
 
-```ts
+```ts option='{ "allowBitwiseExpressions": true }'
 enum Foo {
   A = 1 << 0,
   B = 1 >> 0,

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

@@ -26,7 +26,7 @@ Setting this option to `true` will cause the rule to ignore any ternary expressi
 
 Incorrect code for `ignoreTernaryTests: false`, and correct code for `ignoreTernaryTests: true`:
 
-```ts
+```ts option='{ "ignoreTernaryTests": false }' showPlaygroundButton
 const foo: any = 'bar';
 foo !== undefined && foo !== null ? foo : 'a string';
 foo === undefined || foo === null ? 'a string' : foo;
@@ -44,7 +44,7 @@ foo === null ? 'a string' : foo;
 
 Correct code for `ignoreTernaryTests: false`:
 
-```ts
+```ts option='{ "ignoreTernaryTests": false }' showPlaygroundButton
 const foo: any = 'bar';
 foo ?? 'a string';
 foo ?? 'a string';
@@ -70,7 +70,7 @@ If you're looking to enforce stricter conditional tests, you should consider usi
 
 Incorrect code for `ignoreConditionalTests: false`, and correct code for `ignoreConditionalTests: true`:
 
-```ts
+```ts option='{ "ignoreConditionalTests": false }' showPlaygroundButton
 declare const a: string | null;
 declare const b: string | null;
 
@@ -87,7 +87,7 @@ a || b ? true : false;
 
 Correct code for `ignoreConditionalTests: false`:
 
-```ts
+```ts option='{ "ignoreConditionalTests": false }' showPlaygroundButton
 declare const a: string | null;
 declare const b: string | null;
 
@@ -112,7 +112,7 @@ If you're looking to enforce stricter conditional tests, you should consider usi
 
 Incorrect code for `ignoreMixedLogicalExpressions: false`, and correct code for `ignoreMixedLogicalExpressions: true`:
 
-```ts
+```ts option='{ "ignoreMixedLogicalExpressions": false }' showPlaygroundButton
 declare const a: string | null;
 declare const b: string | null;
 declare const c: string | null;
@@ -127,7 +127,7 @@ a || (b && c && d);
 
 Correct code for `ignoreMixedLogicalExpressions: false`:
 
-```ts
+```ts option='{ "ignoreMixedLogicalExpressions": false }' showPlaygroundButton
 declare const a: string | null;
 declare const b: string | null;
 declare const c: string | null;
@@ -153,14 +153,14 @@ If you would like to ignore expressions containing operands of certain primitive
 
 Incorrect code for `ignorePrimitives: { string: false }`, and correct code for `ignorePrimitives: { string: true }`:
 
-```ts
+```ts option='{ "ignorePrimitives": { "string": true } }' showPlaygroundButton
 const foo: string | undefined = 'bar';
 foo || 'a string';
 ```
 
 Correct code for both `ignorePrimitives: { string: false }` and `ignorePrimitives: { string: true }`:
 
-```ts
+```ts option='{ "ignorePrimitives": { "string": true } }' showPlaygroundButton
 const foo: string | undefined = 'bar';
 foo ?? 'a string';
 ```