@typescript-eslint/eslint-plugin 8.33.1-alpha.5 → 8.33.1

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

@@ -1,353 +0,0 @@
----
-description: 'Require explicit accessibility modifiers on class properties and methods.'
----
-
-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/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 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.
-
-However, adding in explicit accessibility modifiers can be helpful in codebases with many classes for enforcing proper privacy of members.
-Some developers also find it preferable for code readability to keep member publicity explicit.
-
-## Examples
-
-This rule aims to make code more readable and explicit about who can use
-which properties.
-
-## Options
-
-### Configuring in a mixed JS/TS codebase
-
-If you are working on a codebase within which you lint non-TypeScript code (i.e. `.js`/`.mjs`/`.cjs`/`.jsx`), you should ensure that you should use [ESLint `overrides`](https://eslint.org/docs/user-guide/configuring#disabling-rules-only-for-a-group-of-files) to only enable the rule on `.ts`/`.mts`/`.cts`/`.tsx` files. If you don't, then you will get unfixable lint errors reported within `.js`/`.mjs`/`.cjs`/`.jsx` files.
-
-```jsonc
-{
-  "rules": {
-    // disable the rule for all files
-    "@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",
-      },
-    },
-  ],
-}
-```
-
-### `accessibility`
-
-{/* insert option description */}
-
-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:
-
-```jsonc
-{
-  "accessibility": "explicit",
-  "overrides": {
-    "accessors": "explicit",
-    "constructors": "no-public",
-    "methods": "explicit",
-    "properties": "off",
-    "parameterProperties": "explicit",
-  },
-}
-```
-
-Note the above is an example of a possible configuration you could use - it is not the default configuration.
-
-The following patterns are considered incorrect code if no options are provided:
-
-```ts showPlaygroundButton
-class Animal {
-  constructor(name) {
-    // No accessibility modifier
-    this.animalName = name;
-  }
-  animalName: string; // No accessibility modifier
-  get name(): string {
-    // No accessibility modifier
-    return this.animalName;
-  }
-  set name(value: string) {
-    // No accessibility modifier
-    this.animalName = value;
-  }
-  walk() {
-    // method
-  }
-}
-```
-
-The following patterns are considered correct with the default options `{ accessibility: 'explicit' }`:
-
-```ts option='{ "accessibility": "explicit" }' showPlaygroundButton
-class Animal {
-  public constructor(
-    public breed,
-    name,
-  ) {
-    // Parameter property and constructor
-    this.animalName = name;
-  }
-  private animalName: string; // Property
-  get name(): string {
-    // get accessor
-    return this.animalName;
-  }
-  set name(value: string) {
-    // set accessor
-    this.animalName = value;
-  }
-  public walk() {
-    // method
-  }
-}
-```
-
-The following patterns are considered incorrect with the accessibility set to **no-public** `[{ accessibility: 'no-public' }]`:
-
-```ts option='{ "accessibility": "no-public" }' showPlaygroundButton
-class Animal {
-  public constructor(
-    public breed,
-    name,
-  ) {
-    // Parameter property and constructor
-    this.animalName = name;
-  }
-  public animalName: string; // Property
-  public get name(): string {
-    // get accessor
-    return this.animalName;
-  }
-  public set name(value: string) {
-    // set accessor
-    this.animalName = value;
-  }
-  public walk() {
-    // method
-  }
-}
-```
-
-The following patterns are considered correct with the accessibility set to **no-public** `[{ accessibility: 'no-public' }]`:
-
-```ts option='{ "accessibility": "no-public" }' showPlaygroundButton
-class Animal {
-  constructor(
-    protected breed,
-    name,
-  ) {
-    // Parameter property and constructor
-    this.name = name;
-  }
-  private animalName: string; // Property
-  get name(): string {
-    // get accessor
-    return this.animalName;
-  }
-  private set name(value: string) {
-    // set accessor
-    this.animalName = value;
-  }
-  protected walk() {
-    // method
-  }
-}
-```
-
-### `overrides`
-
-{/* insert option description */}
-
-There are three ways in which an override can be used.
-
-- To disallow the use of public on a given member.
-- To enforce explicit member accessibility when the root has allowed implicit public accessibility
-- To disable any checks on given member type
-
-#### Disallow the use of public on a given member
-
-e.g. `[ { overrides: { constructors: 'no-public' } } ]`
-
-The following patterns are considered incorrect with the example override
-
-```ts option='{ "overrides": { "constructors": "no-public" } }' showPlaygroundButton
-class Animal {
-  public constructor(protected animalName) {}
-  public get name() {
-    return this.animalName;
-  }
-}
-```
-
-The following patterns are considered correct with the example override
-
-```ts option='{ "overrides": { "constructors": "no-public" } }' showPlaygroundButton
-class Animal {
-  constructor(protected animalName) {}
-  public get name() {
-    return this.animalName;
-  }
-}
-```
-
-#### Require explicit accessibility for a given member
-
-e.g. `[ { accessibility: 'no-public', overrides: { properties: 'explicit' } } ]`
-
-The following patterns are considered incorrect with the example override
-
-```ts option='{ "accessibility": "no-public", "overrides": { "properties": "explicit" } }' showPlaygroundButton
-class Animal {
-  constructor(protected animalName) {}
-  get name() {
-    return this.animalName;
-  }
-  protected set name(value: string) {
-    this.animalName = value;
-  }
-  legs: number;
-  private hasFleas: boolean;
-}
-```
-
-The following patterns are considered correct with the example override
-
-```ts option='{ "accessibility": "no-public", "overrides": { "properties": "explicit" } }' showPlaygroundButton
-class Animal {
-  constructor(protected animalName) {}
-  get name() {
-    return this.animalName;
-  }
-  protected set name(value: string) {
-    this.animalName = value;
-  }
-  public legs: number;
-  private hasFleas: boolean;
-}
-```
-
-e.g. `[ { accessibility: 'off', overrides: { parameterProperties: 'explicit' } } ]`
-
-The following code is considered incorrect with the example override
-
-```ts option='{ "accessibility": "off", "overrides": { "parameterProperties": "explicit" } }' showPlaygroundButton
-class Animal {
-  constructor(readonly animalName: string) {}
-}
-```
-
-The following code patterns are considered correct with the example override
-
-```ts option='{ "accessibility": "off", "overrides": { "parameterProperties": "explicit" } }' showPlaygroundButton
-class Animal {
-  constructor(public readonly animalName: string) {}
-}
-
-class Animal {
-  constructor(public animalName: string) {}
-}
-
-class Animal {
-  constructor(animalName: string) {}
-}
-```
-
-e.g. `[ { accessibility: 'off', overrides: { parameterProperties: 'no-public' } } ]`
-
-The following code is considered incorrect with the example override
-
-```ts option='{ "accessibility": "off", "overrides": { "parameterProperties": "no-public" } }' showPlaygroundButton
-class Animal {
-  constructor(public readonly animalName: string) {}
-}
-```
-
-The following code is considered correct with the example override
-
-```ts option='{ "accessibility": "off", "overrides": { "parameterProperties": "no-public" } }' showPlaygroundButton
-class Animal {
-  constructor(public animalName: string) {}
-}
-```
-
-#### Disable any checks on given member type
-
-e.g. `[{ overrides: { accessors : 'off' } } ]`
-
-As no checks on the overridden member type are performed all permutations of visibility are permitted for that member type
-
-The follow pattern is considered incorrect for the given configuration
-
-```ts option='{ "overrides": { "accessors" : "off" } }' showPlaygroundButton
-class Animal {
-  constructor(protected animalName) {}
-  public get name() {
-    return this.animalName;
-  }
-  get legs() {
-    return this.legCount;
-  }
-}
-```
-
-The following patterns are considered correct with the example override
-
-```ts option='{ "overrides": { "accessors" : "off" } }' showPlaygroundButton
-class Animal {
-  public constructor(protected animalName) {}
-  public get name() {
-    return this.animalName;
-  }
-  get legs() {
-    return this.legCount;
-  }
-}
-```
-
-### `ignoredMethodNames`
-
-{/* insert option description */}
-
-Note that this option does not care about 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 option='{ "ignoredMethodNames": ["specificMethod", "whateverMethod"] }' showPlaygroundButton
-class Animal {
-  get specificMethod() {
-    console.log('No error because you specified this method on option');
-  }
-  get whateverMethod() {
-    console.log('No error because you specified this method on option');
-  }
-  public get otherMethod() {
-    console.log('This method comply with this rule');
-  }
-}
-```
-
-## 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 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
-
-- TypeScript [Accessibility Modifiers Handbook Docs](https://www.typescriptlang.org/docs/handbook/2/classes.html#member-visibility)

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

@@ -1,287 +0,0 @@
----
-description: "Require explicit return and argument types on exported functions' and classes' public class methods."
----
-
-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/explicit-module-boundary-types** for documentation.
-
-Explicit types for function return values and arguments makes it clear to any calling code what is the module boundary's input and output.
-Adding explicit type annotations for those types can help improve code readability.
-It can also improve TypeScript type checking performance on larger codebases.
-
-## Examples
-
-<Tabs>
-<TabItem value="❌ Incorrect">
-
-```ts
-// Should indicate that no value is returned (void)
-export function test() {
-  return;
-}
-
-// Should indicate that a string is returned
-export var arrowFn = () => 'test';
-
-// All arguments should be typed
-export var arrowFn = (arg): string => `test ${arg}`;
-export var arrowFn = (arg: any): string => `test ${arg}`;
-
-export class Test {
-  // Should indicate that no value is returned (void)
-  method() {
-    return;
-  }
-}
-```
-
-</TabItem>
-<TabItem value="✅ Correct">
-
-```ts
-// A function with no return value (void)
-export function test(): void {
-  return;
-}
-
-// A return value of type string
-export var arrowFn = (): string => 'test';
-
-// All arguments should be typed
-export var arrowFn = (arg: string): string => `test ${arg}`;
-export var arrowFn = (arg: unknown): string => `test ${arg}`;
-
-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;
-}
-```
-
-</TabItem>
-</Tabs>
-
-## Options
-
-### Configuring in a mixed JS/TS codebase
-
-If you are working on a codebase within which you lint non-TypeScript code (i.e. `.js`/`.mjs`/`.cjs`/`.jsx`), you should ensure that you should use [ESLint `overrides`](https://eslint.org/docs/user-guide/configuring#disabling-rules-only-for-a-group-of-files) to only enable the rule on `.ts`/`.mts`/`.cts`/`.tsx` files. If you don't, then you will get unfixable lint errors reported within `.js`/`.mjs`/`.cjs`/`.jsx` files.
-
-```jsonc
-{
-  "rules": {
-    // disable the rule for all files
-    "@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",
-      },
-    },
-  ],
-}
-```
-
-### `allowArgumentsExplicitlyTypedAsAny`
-
-{/* insert option description */}
-
-Examples of code for this rule with `{ allowArgumentsExplicitlyTypedAsAny: false }`:
-
-<Tabs>
-<TabItem value="❌ Incorrect">
-
-```ts option='{ "allowArgumentsExplicitlyTypedAsAny": false }'
-export const func = (value: any): number => value + 1;
-```
-
-</TabItem>
-<TabItem value="✅ Correct">
-
-```ts option='{ "allowArgumentsExplicitlyTypedAsAny": true }'
-export const func = (value: any): number => value + 1;
-```
-
-</TabItem>
-</Tabs>
-
-### `allowDirectConstAssertionInArrowFunctions`
-
-{/* insert option description */}
-
-Examples of code for this rule with `{ allowDirectConstAssertionInArrowFunctions: false }`:
-
-<Tabs>
-<TabItem value="❌ Incorrect">
-
-```ts option='{ "allowDirectConstAssertionInArrowFunctions": false }'
-export const func = (value: number) => ({ type: 'X', value });
-export const foo = () => ({
-  bar: true,
-});
-export const bar = () => 1;
-```
-
-</TabItem>
-<TabItem value="✅ Correct">
-
-```ts option='{ "allowDirectConstAssertionInArrowFunctions": true }'
-export const func = (value: number) => ({ type: 'X', value }) as const;
-export const foo = () =>
-  ({
-    bar: true,
-  }) as const;
-export const bar = () => 1 as const;
-```
-
-</TabItem>
-</Tabs>
-
-### `allowedNames`
-
-{/* insert option description */}
-
-You may pass function/method names you would like this rule to ignore, like so:
-
-```json
-{
-  "@typescript-eslint/explicit-module-boundary-types": [
-    "error",
-    {
-      "allowedNames": ["ignoredFunctionName", "ignoredMethodName"]
-    }
-  ]
-}
-```
-
-### `allowHigherOrderFunctions`
-
-{/* insert option description */}
-
-Examples of code for this rule with `{ allowHigherOrderFunctions: false }`:
-
-<Tabs>
-<TabItem value="❌ Incorrect">
-
-```ts option='{ "allowHigherOrderFunctions": false }'
-export const arrowFn = () => () => {};
-
-export function fn() {
-  return function () {};
-}
-
-export function foo(outer: string) {
-  return function (inner: string) {};
-}
-```
-
-</TabItem>
-<TabItem value="✅ Correct">
-
-```ts option='{ "allowHigherOrderFunctions": true }'
-export const arrowFn = () => (): void => {};
-
-export function fn() {
-  return function (): void {};
-}
-
-export function foo(outer: string) {
-  return function (inner: string): void {};
-}
-```
-
-</TabItem>
-</Tabs>
-
-### `allowTypedFunctionExpressions`
-
-{/* insert option description */}
-
-Examples of code for this rule with `{ allowTypedFunctionExpressions: false }`:
-
-<Tabs>
-<TabItem value="❌ Incorrect">
-
-```ts option='{ "allowTypedFunctionExpressions": false }'
-export let arrowFn = () => 'test';
-
-export let funcExpr = function () {
-  return 'test';
-};
-
-export let objectProp = {
-  foo: () => 1,
-};
-
-export const foo = bar => {};
-```
-
-</TabItem>
-<TabItem value="✅ Correct">
-
-```ts option='{ "allowTypedFunctionExpressions": true }'
-type FuncType = () => string;
-
-export let arrowFn: FuncType = () => 'test';
-
-export let funcExpr: FuncType = function () {
-  return 'test';
-};
-
-export let asTyped = (() => '') as () => string;
-
-interface ObjectType {
-  foo(): number;
-}
-export let objectProp: ObjectType = {
-  foo: () => 1,
-};
-export let objectPropAs = {
-  foo: () => 1,
-} as ObjectType;
-
-type FooType = (bar: string) => void;
-export const foo: FooType = bar => {};
-```
-
-</TabItem>
-</Tabs>
-
-### `allowOverloadFunctions`
-
-{/* insert option description */}
-
-Examples of correct code when `allowOverloadFunctions` is set to `true`:
-
-```ts option='{ "allowOverloadFunctions": true }' showPlaygroundButton
-export function test(a: string): string;
-export function test(a: number): number;
-export function test(a: unknown) {
-  return a;
-}
-```
-
-## When Not To Use It
-
-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.mdx)

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

@@ -1,15 +0,0 @@
----
-displayed_sidebar: rulesSidebar
----
-
-:::danger Deprecated
-
-This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).
-See [#8072](https://github.com/typescript-eslint/typescript-eslint/issues/8072) and [#8074](https://github.com/typescript-eslint/typescript-eslint/issues/8074) for more information.
-
-:::
-
-<!-- This doc file has been left on purpose to help direct people to the stylistic plugin.
-
-Note that there is no actual way to get to this page in the normal navigation,
-so end-users will only be able to get to this page from the search bar. -->

package/docs/rules/indent.md

@@ -1,15 +0,0 @@
----
-displayed_sidebar: rulesSidebar
----
-
-:::danger Deprecated
-
-This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).
-See [#8072](https://github.com/typescript-eslint/typescript-eslint/issues/8072) and [#8074](https://github.com/typescript-eslint/typescript-eslint/issues/8074) for more information.
-
-:::
-
-<!-- This doc file has been left on purpose to help direct people to the stylistic plugin.
-
-Note that there is no actual way to get to this page in the normal navigation,
-so end-users will only be able to get to this page from the search bar. -->

package/docs/rules/init-declarations.mdx

@@ -1,12 +0,0 @@
----
-description: 'Require or disallow initialization in variable declarations.'
----
-
-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/init-declarations** for documentation.
-
-It adds support for TypeScript's `declare` variables.

package/docs/rules/key-spacing.md

@@ -1,15 +0,0 @@
----
-displayed_sidebar: rulesSidebar
----
-
-:::danger Deprecated
-
-This rule has been moved to the [ESLint stylistic plugin](https://eslint.style).
-See [#8072](https://github.com/typescript-eslint/typescript-eslint/issues/8072) and [#8074](https://github.com/typescript-eslint/typescript-eslint/issues/8074) for more information.
-
-:::
-
-<!-- This doc file has been left on purpose to help direct people to the stylistic plugin.
-
-Note that there is no actual way to get to this page in the normal navigation,
-so end-users will only be able to get to this page from the search bar. -->