xo 0.50.0 → 0.52.1

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/consistent-type-definitions.md

@@ -1,6 +1,10 @@
-# `consistent-type-definitions`
+---
+description: 'Enforce type definitions to consistently use either `interface` or `type`.'
+---
 
-Enforces type definitions to consistently use either `interface` or `type`.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/consistent-type-definitions** for documentation.
 
 There are two ways to define a type.
 
@@ -20,35 +24,26 @@ interface T2 {
 
 ## Options
 
-This rule accepts one string option:
-
-- `"interface"`: enforce using `interface`s for object type definitions.
+- `"interface"` _(default)_: enforce using `interface`s for object type definitions.
 - `"type"`: enforce using `type`s for object type definitions.
 
-For example:
-
-```jsonc
-{
-  // Use type for object definitions
-  "@typescript-eslint/consistent-type-definitions": ["error", "type"]
-}
-```
-
 ### `interface`
 
-Examples of code with `interface` option.
-
 <!--tabs-->
 
 #### ❌ Incorrect
 
 ```ts
+/* eslint @typescript-eslint/consistent-type-definitions: ["error", "interface"] */
+
 type T = { x: number };
 ```
 
 #### ✅ Correct
 
 ```ts
+/* eslint @typescript-eslint/consistent-type-definitions: ["error", "interface"] */
+
 type T = string;
 type Foo = string | {};
 
@@ -59,13 +54,13 @@ interface T {
 
 ### `type`
 
-Examples of code with `type` option.
-
 <!--tabs-->
 
 #### ❌ Incorrect
 
 ```ts
+/* eslint @typescript-eslint/consistent-type-definitions: ["error", "type"] */
+
 interface T {
   x: number;
 }
@@ -74,13 +69,11 @@ interface T {
 #### ✅ Correct
 
 ```ts
+/* eslint @typescript-eslint/consistent-type-definitions: ["error", "type"] */
+
 type T = { x: number };
 ```
 
 ## When Not To Use It
 
 If you specifically want to use an interface or type literal for stylistic reasons, you can disable this rule.
-
-## Related To
-
-- TSLint: [interface-over-type-literal](https://palantir.github.io/tslint/rules/interface-over-type-literal/)

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/consistent-type-exports.md

@@ -1,15 +1,17 @@
-# `consistent-type-exports`
+---
+description: 'Enforce consistent usage of type exports.'
+---
 
-Enforces consistent usage of type exports.
-
-TypeScript 3.8 added support for type-only exports.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/consistent-type-exports** for documentation.
 
 Type-only exports allow you to specify that 1 or more named exports are exported as type-only. This allows
 transpilers to drop exports without knowing the types of the dependencies.
 
 ## Rule Details
 
-This rule aims to standardize the use of type exports style across a codebase.
+This rule aims to standardize the use of type exports style.
 
 Given a class `Button`, and an interface `ButtonProps`, examples of code:
 
@@ -21,11 +23,13 @@ Given a class `Button`, and an interface `ButtonProps`, examples of code:
 interface ButtonProps {
   onClick: () => void;
 }
+
 class Button implements ButtonProps {
   onClick() {
     console.log('button!');
   }
 }
+
 export { Button, ButtonProps };
 ```
 
@@ -46,16 +50,6 @@ export type { ButtonProps };
 
 ## Options
 
-```ts
-interface Options {
-  fixMixedExportsWithInlineTypeSpecifier?: boolean;
-}
-
-const defaultOptions: Options = {
-  fixMixedExportsWithInlineTypeSpecifier: false,
-};
-```
-
 ### `fixMixedExportsWithInlineTypeSpecifier`
 
 When this is set to true, the rule will autofix "mixed" export cases using TS 4.5's "inline type specifier".
@@ -106,6 +100,5 @@ export { Button, type ButtonProps } from 'some-library';
 
 ## When Not To Use It
 
-- If you are using a TypeScript version less than 3.8, then you will not be able to use this rule as type exports are not supported.
 - If you specifically want to use both export kinds for stylistic reasons, you can disable this rule.
 - If you use `--isolatedModules` the compiler would error if a type is not re-exported using `export type`. If you also don't wish to enforce one style over the other, you can disable this rule.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/consistent-type-imports.md

@@ -1,28 +1,19 @@
-# `consistent-type-imports`
+---
+description: 'Enforce consistent usage of type imports.'
+---
 
-Enforces consistent usage of type imports.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/consistent-type-imports** for documentation.
 
-TypeScript 3.8 added support for type-only imports.
 Type-only imports allow you to specify that an import can only be used in a type location, allowing certain optimizations within compilers.
 
 ## Rule Details
 
-This rule aims to standardize the use of type imports style across the codebase.
+This rule aims to standardize the use of type imports style.
 
 ## Options
 
-```ts
-type Options = {
-  prefer: 'type-imports' | 'no-type-imports';
-  disallowTypeAnnotations: boolean;
-};
-
-const defaultOptions: Options = {
-  prefer: 'type-imports',
-  disallowTypeAnnotations: true,
-};
-```
-
 ### `prefer`
 
 This option defines the expected import kind for type-only imports. Valid values for `prefer` are:
@@ -50,10 +41,10 @@ const x: Bar = 1;
 
 ### `disallowTypeAnnotations`
 
-If `true`, type imports in type annotations (`import()`) is not allowed.
+If `true`, type imports in type annotations (`import()`) are not allowed.
 Default is `true`.
 
-Examples of **incorrect** code with `{disallowTypeAnnotations: true}`.
+Examples of **incorrect** code with `{disallowTypeAnnotations: true}`:
 
 ```ts
 type T = import('Foo').Foo;
@@ -62,5 +53,4 @@ const x: import('Bar') = 1;
 
 ## When Not To Use It
 
-- If you are not using TypeScript 3.8 (or greater), then you will not be able to use this rule, as type-only imports are not allowed.
 - If you specifically want to use both import kinds for stylistic reasons, you can disable this rule.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/default-param-last.md

@@ -1,6 +1,10 @@
-# `default-param-last`
+---
+description: 'Enforce default parameters to be last.'
+---
 
-Enforces default parameters to be last.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/default-param-last** for documentation.
 
 ## Rule Details
 
@@ -12,7 +16,7 @@ It adds support for optional parameters.
 ### ❌ Incorrect
 
 ```ts
-/* eslint @typescript-eslint/default-param-last: ["error"] */
+/* eslint @typescript-eslint/default-param-last: "error" */
 
 function f(a = 0, b: number) {}
 function f(a: number, b = 0, c: number) {}
@@ -28,7 +32,7 @@ class Foo {
 ### ✅ Correct
 
 ```ts
-/* eslint @typescript-eslint/default-param-last: ["error"] */
+/* eslint @typescript-eslint/default-param-last: "error" */
 
 function f(a = 0) {}
 function f(a: number, b = 0) {}
@@ -42,23 +46,3 @@ class Foo {
   constructor(public a, private b?: number) {}
 }
 ```
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "default-param-last": "off",
-  "@typescript-eslint/default-param-last": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/default-param-last` options](https://eslint.org/docs/rules/default-param-last#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/default-param-last.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/dot-notation.md

@@ -1,6 +1,10 @@
-# `dot-notation`
+---
+description: 'Enforce dot notation whenever possible.'
+---
 
-Enforces dot notation whenever possible.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/dot-notation** for documentation.
 
 ## Rule Details
 
@@ -10,19 +14,8 @@ It adds:
 - Support for optionally ignoring computed `private` and/or `protected` member access.
 - Compatibility with TypeScript's `noPropertyAccessFromIndexSignature` option.
 
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "dot-notation": "off",
-  "@typescript-eslint/dot-notation": ["error"]
-}
-```
-
 ## Options
 
-See [`eslint/dot-notation`](https://eslint.org/docs/rules/dot-notation#options) options.
 This rule adds the following options:
 
 ```ts
@@ -31,6 +24,7 @@ interface Options extends BaseDotNotationOptions {
   allowProtectedClassPropertyAccess?: boolean;
   allowIndexSignaturePropertyAccess?: boolean;
 }
+
 const defaultOptions: Options = {
   ...baseDotNotationDefaultOptions,
   allowPrivateClassPropertyAccess: false,
@@ -43,7 +37,7 @@ If the TypeScript compiler option `noPropertyAccessFromIndexSignature` is set to
 
 ### `allowPrivateClassPropertyAccess`
 
-Example of a correct code when `allowPrivateClassPropertyAccess` is set to `true`
+Example of a correct code when `allowPrivateClassPropertyAccess` is set to `true`:
 
 ```ts
 class X {
@@ -56,7 +50,7 @@ x['priv_prop'] = 123;
 
 ### `allowProtectedClassPropertyAccess`
 
-Example of a correct code when `allowProtectedClassPropertyAccess` is set to `true`
+Example of a correct code when `allowProtectedClassPropertyAccess` is set to `true`:
 
 ```ts
 class X {
@@ -69,7 +63,7 @@ x['protected_prop'] = 123;
 
 ### `allowIndexSignaturePropertyAccess`
 
-Example of correct code when `allowIndexSignaturePropertyAccess` is set to `true`
+Example of correct code when `allowIndexSignaturePropertyAccess` is set to `true`:
 
 ```ts
 class X {
@@ -81,9 +75,3 @@ x['hello'] = 123;
 ```
 
 If the TypeScript compiler option `noPropertyAccessFromIndexSignature` is set to `true`, then the above code is always allowed, even if `allowIndexSignaturePropertyAccess` is `false`.
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/dot-notation.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/explicit-function-return-type.md

@@ -1,6 +1,10 @@
-# `explicit-function-return-type`
+---
+description: 'Require explicit return types on functions and class methods.'
+---
 
-Requires explicit return types on functions and class methods.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/explicit-function-return-type** for documentation.
 
 Explicit types for function return values makes it clear to any calling code what type is returned.
 This ensures that the return value is assigned to a variable of the correct type; or in the case
@@ -63,36 +67,6 @@ class Test {
 
 ## Options
 
-The rule accepts an options object with the following properties:
-
-```ts
-type Options = {
-  // if true, only functions which are part of a declaration will be checked
-  allowExpressions?: boolean;
-  // if true, type annotations are also allowed on the variable of a function expression rather than on the function directly
-  allowTypedFunctionExpressions?: boolean;
-  // if true, functions immediately returning another function expression will not be checked
-  allowHigherOrderFunctions?: boolean;
-  // if true, arrow functions immediately returning a `as const` value will not be checked
-  allowDirectConstAssertionInArrowFunctions?: boolean;
-  // if true, concise arrow functions that start with the void keyword will not be checked
-  allowConciseArrowFunctionExpressionsStartingWithVoid?: boolean;
-  /**
-   * An array of function/method names that will not have their arguments or their return values checked.
-   */
-  allowedNames?: string[];
-};
-
-const defaults = {
-  allowExpressions: false,
-  allowTypedFunctionExpressions: true,
-  allowHigherOrderFunctions: true,
-  allowDirectConstAssertionInArrowFunctions: true,
-  allowConciseArrowFunctionExpressionsStartingWithVoid: false,
-  allowedNames: [],
-};
-```
-
 ### 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.
@@ -108,7 +82,7 @@ If you are working on a codebase within which you lint non-TypeScript code (i.e.
       // enable the rule specifically for TypeScript files
       "files": ["*.ts", "*.mts", "*.cts", "*.tsx"],
       "rules": {
-        "@typescript-eslint/explicit-function-return-type": ["error"]
+        "@typescript-eslint/explicit-function-return-type": "error"
       }
     }
   ]

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/explicit-member-accessibility.md

@@ -1,6 +1,10 @@
-# `explicit-member-accessibility`
+---
+description: 'Require explicit accessibility modifiers on class properties and methods.'
+---
 
-Requires explicit accessibility modifiers on class properties and methods.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/explicit-member-accessibility** for documentation.
 
 Leaving off accessibility modifier and making everything public can make
 your interface hard to use by others.
@@ -14,29 +18,6 @@ which properties.
 
 ## Options
 
-```ts
-type AccessibilityLevel =
-  | 'explicit' // require an accessor (including public)
-  | 'no-public' // don't require public
-  | 'off'; // don't check
-
-type Options = {
-  accessibility?: AccessibilityLevel;
-  ignoredMethodNames?: string[];
-  overrides?: {
-    accessors?: AccessibilityLevel;
-    constructors?: AccessibilityLevel;
-    methods?: AccessibilityLevel;
-    properties?: AccessibilityLevel;
-    parameterProperties?: AccessibilityLevel;
-  };
-};
-
-const defaultOptions: Options = {
-  accessibility: 'explicit',
-};
-```
-
 ### 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.
@@ -52,7 +33,7 @@ If you are working on a codebase within which you lint non-TypeScript code (i.e.
       // 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"
       }
     }
   ]
@@ -344,7 +325,3 @@ If you think defaulting to public is a good default, then you should consider us
 ## Further Reading
 
 - TypeScript [Accessibility Modifiers](https://www.typescriptlang.org/docs/handbook/classes.html#public-private-and-protected-modifiers)
-
-## Related To
-
-- TSLint: [member-access](http://palantir.github.io/tslint/rules/member-access/)

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/explicit-module-boundary-types.md

@@ -1,6 +1,10 @@
-# `explicit-module-boundary-types`
+---
+description: "Require explicit return and argument types on exported functions' and classes' public class methods."
+---
 
-Requires explicit return and argument types on exported functions' and classes' public class methods.
+> 🛑 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.
 
@@ -68,46 +72,6 @@ class Test {
 
 ## Options
 
-The rule accepts an options object with the following properties:
-
-```ts
-type Options = {
-  /**
-   * If true, the rule will not report for arguments that are explicitly typed as `any`
-   */
-  allowArgumentsExplicitlyTypedAsAny?: boolean;
-  /**
-   * If true, body-less arrow functions that return an `as const` type assertion will not
-   * require an explicit return value annotation.
-   * You must still type the parameters of the function.
-   */
-  allowDirectConstAssertionInArrowFunctions?: boolean;
-  /**
-   * An array of function/method names that will not have their arguments or their return values checked.
-   */
-  allowedNames?: string[];
-  /**
-   * If true, functions immediately returning another function expression will not
-   * require an explicit return value annotation.
-   * You must still type the parameters of the function.
-   */
-  allowHigherOrderFunctions?: boolean;
-  /**
-   * If true, type annotations are also allowed on the variable of a function expression
-   * rather than on the function arguments/return value directly.
-   */
-  allowTypedFunctionExpressions?: boolean;
-};
-
-const defaults = {
-  allowArgumentsExplicitlyTypedAsAny: false,
-  allowDirectConstAssertionInArrowFunctions: true,
-  allowedNames: [],
-  allowHigherOrderFunctions: true,
-  allowTypedFunctionExpressions: true,
-};
-```
-
 ### 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.
@@ -123,7 +87,7 @@ If you are working on a codebase within which you lint non-TypeScript code (i.e.
       // 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"
       }
     }
   ]
@@ -158,10 +122,9 @@ Examples of code for this rule with `{ allowDirectConstAssertionInArrowFunctions
 
 ```ts
 export const func = (value: number) => ({ type: 'X', value });
-export const foo = () =>
-  ({
-    bar: true,
-  } as const);
+export const foo = () => ({
+  bar: true,
+});
 export const bar = () => 1;
 ```
 

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/func-call-spacing.md

@@ -1,28 +1,12 @@
-# `func-call-spacing`
+---
+description: 'Require or disallow spacing between function identifiers and their invocations.'
+---
 
-Requires or disallows spacing between function identifiers and their invocations.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/func-call-spacing** for documentation.
 
 ## Rule Details
 
 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.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "func-call-spacing": "off",
-  "@typescript-eslint/func-call-spacing": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/func-call-spacing` options](https://eslint.org/docs/rules/func-call-spacing#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/func-call-spacing.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/indent.md

@@ -1,32 +1,20 @@
-# `indent`
+---
+description: 'Enforce consistent indentation.'
+---
 
-Enforces consistent indentation.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/indent** for documentation.
 
 ## Warning
 
-PLEASE READ THIS ISSUE BEFORE USING THIS RULE [#1824](https://github.com/typescript-eslint/typescript-eslint/issues/1824)
+:::warning
+
+Please read [Issue #1824: Problems with the indent rule](https://github.com/typescript-eslint/typescript-eslint/issues/1824) before using this rule!
+
+:::
 
 ## Rule Details
 
 This rule extends the base [`eslint/indent`](https://eslint.org/docs/rules/indent) rule.
 It adds support for TypeScript nodes.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "indent": "off",
-  "@typescript-eslint/indent": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/indent` options](https://eslint.org/docs/rules/indent#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/indent.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/init-declarations.md

@@ -1,28 +1,12 @@
-# `init-declarations`
+---
+description: 'Require or disallow initialization in variable declarations.'
+---
 
-Requires or disallows initialization in variable declarations.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/init-declarations** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/init-declarations`](https://eslint.org/docs/rules/init-declarations) rule.
 It adds support for TypeScript's `declare` variables.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "init-declarations": "off",
-  "@typescript-eslint/init-declarations": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/init-declarations` options](https://eslint.org/docs/rules/init-declarations#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/init-declarations.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/keyword-spacing.md

@@ -1,28 +1,12 @@
-# `keyword-spacing`
+---
+description: 'Enforce consistent spacing before and after keywords.'
+---
 
-Enforces consistent spacing before and after keywords.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/keyword-spacing** for documentation.
 
 ## Rule Details
 
 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.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "keyword-spacing": "off",
-  "@typescript-eslint/keyword-spacing": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/keyword-spacing` options](https://eslint.org/docs/rules/keyword-spacing#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/keyword-spacing.md)
-
-</sup>