@typescript-eslint/eslint-plugin 7.0.0-alpha.0 → 7.0.1

package/docs/rules/explicit-member-accessibility.md

@@ -7,7 +7,7 @@ description: 'Require explicit accessibility modifiers on class properties and m
 > See **https://typescript-eslint.io/rules/explicit-member-accessibility** for documentation.
 
 TypeScript allows placing explicit `public`, `protected`, and `private` accessibility modifiers in front of class members.
-The modifiers exist solely in the type system and just server to describe who is allowed to access those members.
+The modifiers exist solely in the type system and just serve to describe who is allowed to access those members.
 
 Leaving off accessibility modifiers makes for less code to read and write.
 Members are `public` by default.
@@ -30,17 +30,17 @@ If you are working on a codebase within which you lint non-TypeScript code (i.e.
 {
   "rules": {
     // disable the rule for all files
-    "@typescript-eslint/explicit-member-accessibility": "off"
+    "@typescript-eslint/explicit-member-accessibility": "off",
   },
   "overrides": [
     {
       // enable the rule specifically for TypeScript files
       "files": ["*.ts", "*.mts", "*.cts", "*.tsx"],
       "rules": {
-        "@typescript-eslint/explicit-member-accessibility": "error"
-      }
-    }
-  ]
+        "@typescript-eslint/explicit-member-accessibility": "error",
+      },
+    },
+  ],
 }
 ```
 
@@ -48,16 +48,16 @@ If you are working on a codebase within which you lint non-TypeScript code (i.e.
 
 This rule in its default state requires no configuration and will enforce that every class member has an accessibility modifier. If you would like to allow for some implicit public members then you have the following options:
 
-```ts
+```jsonc
 {
-  accessibility: 'explicit',
-  overrides: {
-    accessors: 'explicit',
-    constructors: 'no-public',
-    methods: 'explicit',
-    properties: 'off',
-    parameterProperties: 'explicit'
-  }
+  "accessibility": "explicit",
+  "overrides": {
+    "accessors": "explicit",
+    "constructors": "no-public",
+    "methods": "explicit",
+    "properties": "off",
+    "parameterProperties": "explicit",
+  },
 }
 ```
 
@@ -65,7 +65,7 @@ Note the above is an example of a possible configuration you could use - it is n
 
 The following patterns are considered incorrect code if no options are provided:
 
-```ts
+```ts showPlaygroundButton
 class Animal {
   constructor(name) {
     // No accessibility modifier
@@ -88,9 +88,12 @@ class Animal {
 
 The following patterns are considered correct with the default options `{ accessibility: 'explicit' }`:
 
-```ts
+```ts option='{ "accessibility": "explicit" }' showPlaygroundButton
 class Animal {
-  public constructor(public breed, name) {
+  public constructor(
+    public breed,
+    name,
+  ) {
     // Parameter property and constructor
     this.animalName = name;
   }
@@ -111,9 +114,12 @@ class Animal {
 
 The following patterns are considered incorrect with the accessibility set to **no-public** `[{ accessibility: 'no-public' }]`:
 
-```ts
+```ts option='{ "accessibility": "no-public" }' showPlaygroundButton
 class Animal {
-  public constructor(public breed, name) {
+  public constructor(
+    public breed,
+    name,
+  ) {
     // Parameter property and constructor
     this.animalName = name;
   }
@@ -134,9 +140,12 @@ class Animal {
 
 The following patterns are considered correct with the accessibility set to **no-public** `[{ accessibility: 'no-public' }]`:
 
-```ts
+```ts option='{ "accessibility": "no-public" }' showPlaygroundButton
 class Animal {
-  constructor(protected breed, name) {
+  constructor(
+    protected breed,
+    name,
+  ) {
     // Parameter property and constructor
     this.name = name;
   }
@@ -155,7 +164,7 @@ class Animal {
 }
 ```
 
-### Overrides
+### `overrides`
 
 There are three ways in which an override can be used.
 
@@ -169,7 +178,7 @@ e.g. `[ { overrides: { constructors: 'no-public' } } ]`
 
 The following patterns are considered incorrect with the example override
 
-```ts
+```ts option='{ "overrides": { "constructors": "no-public" } }' showPlaygroundButton
 class Animal {
   public constructor(protected animalName) {}
   public get name() {
@@ -180,7 +189,7 @@ class Animal {
 
 The following patterns are considered correct with the example override
 
-```ts
+```ts option='{ "overrides": { "constructors": "no-public" } }' showPlaygroundButton
 class Animal {
   constructor(protected animalName) {}
   public get name() {
@@ -195,7 +204,7 @@ e.g. `[ { accessibility: 'no-public', overrides: { properties: 'explicit' } } ]`
 
 The following patterns are considered incorrect with the example override
 
-```ts
+```ts option='{ "accessibility": "no-public", "overrides": { "properties": "explicit" } }' showPlaygroundButton
 class Animal {
   constructor(protected animalName) {}
   get name() {
@@ -211,7 +220,7 @@ class Animal {
 
 The following patterns are considered correct with the example override
 
-```ts
+```ts option='{ "accessibility": "no-public", "overrides": { "properties": "explicit" } }' showPlaygroundButton
 class Animal {
   constructor(protected animalName) {}
   get name() {
@@ -229,7 +238,7 @@ e.g. `[ { accessibility: 'off', overrides: { parameterProperties: 'explicit' } }
 
 The following code is considered incorrect with the example override
 
-```ts
+```ts option='{ "accessibility": "off", "overrides": { "parameterProperties": "explicit" } }' showPlaygroundButton
 class Animal {
   constructor(readonly animalName: string) {}
 }
@@ -237,7 +246,7 @@ class Animal {
 
 The following code patterns are considered correct with the example override
 
-```ts
+```ts option='{ "accessibility": "off", "overrides": { "parameterProperties": "explicit" } }' showPlaygroundButton
 class Animal {
   constructor(public readonly animalName: string) {}
 }
@@ -255,7 +264,7 @@ e.g. `[ { accessibility: 'off', overrides: { parameterProperties: 'no-public' }
 
 The following code is considered incorrect with the example override
 
-```ts
+```ts option='{ "accessibility": "off", "overrides": { "parameterProperties": "no-public" } }' showPlaygroundButton
 class Animal {
   constructor(public readonly animalName: string) {}
 }
@@ -263,7 +272,7 @@ class Animal {
 
 The following code is considered correct with the example override
 
-```ts
+```ts option='{ "accessibility": "off", "overrides": { "parameterProperties": "no-public" } }' showPlaygroundButton
 class Animal {
   constructor(public animalName: string) {}
 }
@@ -277,7 +286,7 @@ As no checks on the overridden member type are performed all permutations of vis
 
 The follow pattern is considered incorrect for the given configuration
 
-```ts
+```ts option='{ "overrides": { "accessors" : "off" } }' showPlaygroundButton
 class Animal {
   constructor(protected animalName) {}
   public get name() {
@@ -291,7 +300,7 @@ class Animal {
 
 The following patterns are considered correct with the example override
 
-```ts
+```ts option='{ "overrides": { "accessors" : "off" } }' showPlaygroundButton
 class Animal {
   public constructor(protected animalName) {}
   public get name() {
@@ -303,12 +312,12 @@ class Animal {
 }
 ```
 
-### Except specific methods
+### `ignoredMethodNames`
 
 If you want to ignore some specific methods, you can do it by specifying method names. Note that this option does not care for the context, and will ignore every method with these names, which could lead to it missing some cases. You should use this sparingly.
 e.g. `[ { ignoredMethodNames: ['specificMethod', 'whateverMethod'] } ]`
 
-```ts
+```ts option='{ "ignoredMethodNames": ["specificMethod", "whateverMethod"] }' showPlaygroundButton
 class Animal {
   get specificMethod() {
     console.log('No error because you specified this method on option');
@@ -324,7 +333,11 @@ class Animal {
 
 ## When Not To Use It
 
-If you think defaulting to public is a good default, then you should consider using the `no-public` setting. If you want to mix implicit and explicit public members then disable this rule.
+If you think defaulting to public is a good default, then you should consider using the `no-public` setting.
+If you want to mix implicit and explicit public members then you can disable this rule.
+
+However, keep in mind that inconsistent style can harm readability in a project.
+We recommend picking a single option for this rule that works best for your project.
 
 ## Further Reading
 

package/docs/rules/explicit-module-boundary-types.md

@@ -22,11 +22,6 @@ export function test() {
   return;
 }
 
-// Should indicate that a number is returned
-export default function () {
-  return 1;
-}
-
 // Should indicate that a string is returned
 export var arrowFn = () => 'test';
 
@@ -45,16 +40,11 @@ export class Test {
 ### ✅ Correct
 
 ```ts
-// Function is not exported
-function test() {
+// A function with no return value (void)
+export function test(): void {
   return;
 }
 
-// A return value of type number
-export var fn = function (): number {
-  return 1;
-};
-
 // A return value of type string
 export var arrowFn = (): string => 'test';
 
@@ -62,12 +52,17 @@ export var arrowFn = (): string => 'test';
 export var arrowFn = (arg: string): string => `test ${arg}`;
 export var arrowFn = (arg: unknown): string => `test ${arg}`;
 
-// Class is not exported
-class Test {
-  method() {
+export class Test {
+  // A class method with no return value (void)
+  method(): void {
     return;
   }
 }
+
+// The function does not apply because it is not an exported function.
+function test() {
+  return;
+}
 ```
 
 ## Options
@@ -80,17 +75,17 @@ If you are working on a codebase within which you lint non-TypeScript code (i.e.
 {
   "rules": {
     // disable the rule for all files
-    "@typescript-eslint/explicit-module-boundary-types": "off"
+    "@typescript-eslint/explicit-module-boundary-types": "off",
   },
   "overrides": [
     {
       // enable the rule specifically for TypeScript files
       "files": ["*.ts", "*.mts", "*.cts", "*.tsx"],
       "rules": {
-        "@typescript-eslint/explicit-module-boundary-types": "error"
-      }
-    }
-  ]
+        "@typescript-eslint/explicit-module-boundary-types": "error",
+      },
+    },
+  ],
 }
 ```
 
@@ -102,13 +97,13 @@ Examples of code for this rule with `{ allowArgumentsExplicitlyTypedAsAny: false
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allowArgumentsExplicitlyTypedAsAny": false }'
 export const func = (value: any): number => value + 1;
 ```
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "allowArgumentsExplicitlyTypedAsAny": false }'
 export const func = (value: number): number => value + 1;
 ```
 
@@ -120,7 +115,7 @@ Examples of code for this rule with `{ allowDirectConstAssertionInArrowFunctions
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allowArgumentsExplicitlyTypedAsAny": false }'
 export const func = (value: number) => ({ type: 'X', value });
 export const foo = () => ({
   bar: true,
@@ -130,12 +125,12 @@ export const bar = () => 1;
 
 #### ✅ Correct
 
-```ts
-export const func = (value: number) => ({ type: 'X', value } as const);
+```ts option='{ "allowArgumentsExplicitlyTypedAsAny": false }'
+export const func = (value: number) => ({ type: 'X', value }) as const;
 export const foo = () =>
   ({
     bar: true,
-  } as const);
+  }) as const;
 export const bar = () => 1 as const;
 ```
 
@@ -162,7 +157,7 @@ Examples of code for this rule with `{ allowHigherOrderFunctions: false }`:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allowHigherOrderFunctions": false }'
 export const arrowFn = () => () => {};
 
 export function fn() {
@@ -176,7 +171,7 @@ export function foo(outer: string) {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "allowHigherOrderFunctions": false }'
 export const arrowFn = () => (): void => {};
 
 export function fn() {
@@ -196,7 +191,7 @@ Examples of code for this rule with `{ allowTypedFunctionExpressions: false }`:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "allowTypedFunctionExpressions": false }'
 export let arrowFn = () => 'test';
 
 export let funcExpr = function () {
@@ -212,7 +207,7 @@ export const foo = bar => {};
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "allowTypedFunctionExpressions": false }'
 type FuncType = () => string;
 
 export let arrowFn: FuncType = () => 'test';
@@ -243,8 +238,12 @@ export const foo: FooType = bar => {};
 
 ## When Not To Use It
 
-If you wish to make sure all functions have explicit return types, as opposed to only the module boundaries, you can use [explicit-function-return-type](./explicit-function-return-type.md)
+If your project is not used by downstream consumers that are sensitive to API types, you can disable this rule.
 
 ## Further Reading
 
 - TypeScript [Functions](https://www.typescriptlang.org/docs/handbook/functions.html#function-types)
+
+## Related To
+
+- [explicit-function-return-type](./explicit-function-return-type.md)

package/docs/rules/func-call-spacing.md

@@ -6,7 +6,5 @@ description: 'Require or disallow spacing between function identifiers and their
 >
 > See **https://typescript-eslint.io/rules/func-call-spacing** for documentation.
 
-## Examples
-
 This rule extends the base [`eslint/func-call-spacing`](https://eslint.org/docs/rules/func-call-spacing) rule.
 It adds support for generic type parameters on function calls.

package/docs/rules/indent.md

@@ -14,7 +14,5 @@ Please read [Issue #1824: Problems with the indent rule](https://github.com/type
 
 :::
 
-## Examples
-
 This rule extends the base [`eslint/indent`](https://eslint.org/docs/rules/indent) rule.
 It adds support for TypeScript nodes.

package/docs/rules/init-declarations.md

@@ -6,7 +6,5 @@ description: 'Require or disallow initialization in variable declarations.'
 >
 > See **https://typescript-eslint.io/rules/init-declarations** for documentation.
 
-## Examples
-
 This rule extends the base [`eslint/init-declarations`](https://eslint.org/docs/rules/init-declarations) rule.
 It adds support for TypeScript's `declare` variables.

package/docs/rules/key-spacing.md

@@ -6,7 +6,5 @@ description: 'Enforce consistent spacing between property names and type annotat
 >
 > See **https://typescript-eslint.io/rules/key-spacing** for documentation.
 
-## Examples
-
 This rule extends the base [`eslint/key-spacing`](https://eslint.org/docs/rules/key-spacing) rule.
-This version adds support for type annotations on interfaces, classes and type literals properties.
+It adds support for type annotations on interfaces, classes and type literals properties.

package/docs/rules/keyword-spacing.md

@@ -6,7 +6,5 @@ description: 'Enforce consistent spacing before and after keywords.'
 >
 > See **https://typescript-eslint.io/rules/keyword-spacing** for documentation.
 
-## Examples
-
 This rule extends the base [`eslint/keyword-spacing`](https://eslint.org/docs/rules/keyword-spacing) rule.
-This version adds support for generic type parameters on function calls.
+It adds support for generic type parameters on function calls.

package/docs/rules/lines-around-comment.md

@@ -6,8 +6,6 @@ description: 'Require empty lines around comments.'
 >
 > See **https://typescript-eslint.io/rules/lines-around-comment** for documentation.
 
-## Rule Details
-
 This rule extends the base [`eslint/lines-around-comment`](https://eslint.org/docs/rules/lines-around-comment) rule.
 It adds support for TypeScript syntax.
 

package/docs/rules/lines-between-class-members.md

@@ -6,10 +6,6 @@ description: 'Require or disallow an empty line between class members.'
 >
 > See **https://typescript-eslint.io/rules/lines-between-class-members** for documentation.
 
-This rule improves readability by enforcing lines between class members. It will not check empty lines before the first member and after the last member. This rule will require or disallow an empty line between class members.
-
-## Examples
-
 This rule extends the base [`eslint/lines-between-class-members`](https://eslint.org/docs/rules/lines-between-class-members) rule.
 It adds support for ignoring overload methods in a class.
 
@@ -28,9 +24,7 @@ In addition to the options supported by the `lines-between-class-members` rule i
 
 Examples of **correct** code for the `{ "exceptAfterOverload": true }` option:
 
-```ts
-/*eslint @typescript-eslint/lines-between-class-members: ["error", "always", { "exceptAfterOverload": true }]*/
-
+```ts option='"always", { "exceptAfterOverload": true }' showPlaygroundButton
 class foo {
   bar(a: string): void;
   bar(a: string, b: string): void;
@@ -46,9 +40,7 @@ class foo {
 
 Examples of **correct** code for the `{ "exceptAfterOverload": false }` option:
 
-```ts
-/*eslint @typescript-eslint/lines-between-class-members: ["error", "always", { "exceptAfterOverload": false }]*/
-
+```ts option='"always", { "exceptAfterOverload": false }' showPlaygroundButton
 class foo {
   bar(a: string): void;
 

package/docs/rules/max-params.md

@@ -0,0 +1,10 @@
+---
+description: 'Enforce a maximum number of parameters in function definitions.'
+---
+
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/max-params** for documentation.
+
+This rule extends the base [`eslint/max-params`](https://eslint.org/docs/rules/max-params) rule.
+This version adds support for TypeScript `this` parameters so they won't be counted as a parameter.

package/docs/rules/member-delimiter-style.md

@@ -158,4 +158,7 @@ type FooBar = { name: string; greet(): string }
 
 ## When Not To Use It
 
-If you don't care about enforcing a consistent member delimiter in interfaces and type literals, then you will not need this rule.
+If you specifically want to use both member delimiter kinds for stylistic reasons, or don't wish to enforce one style over the other, you can avoid this rule.
+
+However, keep in mind that inconsistent style can harm readability in a project.
+We recommend picking a single option for this rule that works best for your project.