xo 0.47.0 → 0.50.0

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

@@ -1,4 +1,6 @@
-# Require explicit return types on functions and class methods (`explicit-function-return-type`)
+# `explicit-function-return-type`
+
+Requires explicit return types on functions and class methods.
 
 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
@@ -9,7 +11,9 @@ shouldn't.
 
 This rule aims to ensure that the values returned from functions are of the expected type.
 
-The following patterns are considered warnings:
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 // Should indicate that no value is returned (void)
@@ -33,7 +37,7 @@ class Test {
 }
 ```
 
-The following patterns are not warnings:
+### ✅ Correct
 
 ```ts
 // No return value should be expected (void)
@@ -73,6 +77,10 @@ type Options = {
   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 = {
@@ -81,12 +89,13 @@ const defaults = {
   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`/`.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`/`.tsx` files. If you don't, then you will get unfixable lint errors reported within `.js`/`.jsx` files.
+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
 {
@@ -97,7 +106,7 @@ If you are working on a codebase within which you lint non-TypeScript code (i.e.
   "overrides": [
     {
       // enable the rule specifically for TypeScript files
-      "files": ["*.ts", "*.tsx"],
+      "files": ["*.ts", "*.mts", "*.cts", "*.tsx"],
       "rules": {
         "@typescript-eslint/explicit-function-return-type": ["error"]
       }
@@ -108,7 +117,11 @@ If you are working on a codebase within which you lint non-TypeScript code (i.e.
 
 ### `allowExpressions`
 
-Examples of **incorrect** code for this rule with `{ allowExpressions: true }`:
+Examples of code for this rule with `{ allowExpressions: true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 function test() {}
@@ -118,7 +131,7 @@ const fn = () => {};
 export default () => {};
 ```
 
-Examples of **correct** code for this rule with `{ allowExpressions: true }`:
+#### ✅ Correct
 
 ```ts
 node.addEventListener('click', () => {});
@@ -130,7 +143,11 @@ const foo = arr.map(i => i * i);
 
 ### `allowTypedFunctionExpressions`
 
-Examples of **incorrect** code for this rule with `{ allowTypedFunctionExpressions: true }`:
+Examples of code for this rule with `{ allowTypedFunctionExpressions: true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 let arrowFn = () => 'test';
@@ -144,7 +161,7 @@ let objectProp = {
 };
 ```
 
-Examples of additional **correct** code for this rule with `{ allowTypedFunctionExpressions: true }`:
+#### ✅ Correct
 
 ```ts
 type FuncType = () => string;
@@ -184,7 +201,11 @@ functionWithObjectArg({
 
 ### `allowHigherOrderFunctions`
 
-Examples of **incorrect** code for this rule with `{ allowHigherOrderFunctions: true }`:
+Examples of code for this rule with `{ allowHigherOrderFunctions: true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 var arrowFn = () => () => {};
@@ -194,7 +215,7 @@ function fn() {
 }
 ```
 
-Examples of **correct** code for this rule with `{ allowHigherOrderFunctions: true }`:
+#### ✅ Correct
 
 ```ts
 var arrowFn = () => (): void => {};
@@ -206,14 +227,18 @@ function fn() {
 
 ### `allowDirectConstAssertionInArrowFunctions`
 
-Examples of **incorrect** code for this rule with `{ allowDirectConstAssertionInArrowFunctions: true }`:
+Examples of code for this rule with `{ allowDirectConstAssertionInArrowFunctions: true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 const func = (value: number) => ({ type: 'X', value } as any);
 const func = (value: number) => ({ type: 'X', value } as Action);
 ```
 
-Examples of **correct** code for this rule with `{ allowDirectConstAssertionInArrowFunctions: true }`:
+#### ✅ Correct
 
 ```ts
 const func = (value: number) => ({ foo: 'bar', value } as const);
@@ -222,7 +247,11 @@ const func = () => x as const;
 
 ### `allowConciseArrowFunctionExpressionsStartingWithVoid`
 
-Examples of **incorrect** code for this rule with `{ allowConciseArrowFunctionExpressionsStartingWithVoid: true }`:
+Examples of code for this rule with `{ allowConciseArrowFunctionExpressionsStartingWithVoid: true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 var join = (a: string, b: string) => `${a}${b}`;
@@ -232,12 +261,27 @@ const log = (message: string) => {
 };
 ```
 
-Examples of **correct** code for this rule with `{ allowConciseArrowFunctionExpressionsStartingWithVoid: true }`:
+#### ✅ Correct
 
 ```ts
 var log = (message: string) => void console.log(message);
 ```
 
+### `allowedNames`
+
+You may pass function/method names you would like this rule to ignore, like so:
+
+```json
+{
+  "@typescript-eslint/explicit-function-return-type": [
+    "error",
+    {
+      "allowedNames": ["ignoredFunctionName", "ignoredMethodName"]
+    }
+  ]
+}
+```
+
 ## When Not To Use It
 
 If you don't wish to prevent calling code from using function return values in unexpected ways, then
@@ -246,9 +290,3 @@ you will not need this rule.
 ## Further Reading
 
 - TypeScript [Functions](https://www.typescriptlang.org/docs/handbook/functions.html#function-types)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,4 +1,6 @@
-# Require explicit accessibility modifiers on class properties and methods (`explicit-member-accessibility`)
+# `explicit-member-accessibility`
+
+Requires explicit accessibility modifiers on class properties and methods.
 
 Leaving off accessibility modifier and making everything public can make
 your interface hard to use by others.
@@ -37,7 +39,7 @@ const defaultOptions: 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`/`.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`/`.tsx` files. If you don't, then you will get unfixable lint errors reported within `.js`/`.jsx` files.
+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
 {
@@ -48,7 +50,7 @@ If you are working on a codebase within which you lint non-TypeScript code (i.e.
   "overrides": [
     {
       // enable the rule specifically for TypeScript files
-      "files": ["*.ts", "*.tsx"],
+      "files": ["*.ts", "*.mts", "*.cts", "*.tsx"],
       "rules": {
         "@typescript-eslint/explicit-member-accessibility": ["error"]
       }
@@ -343,12 +345,6 @@ If you think defaulting to public is a good default, then you should consider us
 
 - TypeScript [Accessibility Modifiers](https://www.typescriptlang.org/docs/handbook/classes.html#public-private-and-protected-modifiers)
 
-## Compatibility
+## Related To
 
 - TSLint: [member-access](http://palantir.github.io/tslint/rules/member-access/)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,4 +1,6 @@
-# Require explicit return and argument types on exported functions' and classes' public class methods (`explicit-module-boundary-types`)
+# `explicit-module-boundary-types`
+
+Requires explicit return and argument types on exported functions' and classes' public class methods.
 
 Explicit types for function return values and arguments makes it clear to any calling code what is the module boundary's input and output.
 
@@ -6,7 +8,9 @@ Explicit types for function return values and arguments makes it clear to any ca
 
 This rule aims to ensure that the values returned from a module are of the expected type.
 
-The following patterns are considered warnings:
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 // Should indicate that no value is returned (void)
@@ -34,7 +38,7 @@ export class Test {
 }
 ```
 
-The following patterns are not warnings:
+### ✅ Correct
 
 ```ts
 // Function is not exported
@@ -106,7 +110,7 @@ const defaults = {
 
 ### Configuring in a mixed JS/TS codebase
 
-If you are working on a codebase within which you lint non-TypeScript code (i.e. `.js`/`.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`/`.tsx` files. If you don't, then you will get unfixable lint errors reported within `.js`/`.jsx` files.
+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
 {
@@ -117,7 +121,7 @@ If you are working on a codebase within which you lint non-TypeScript code (i.e.
   "overrides": [
     {
       // enable the rule specifically for TypeScript files
-      "files": ["*.ts", "*.tsx"],
+      "files": ["*.ts", "*.mts", "*.cts", "*.tsx"],
       "rules": {
         "@typescript-eslint/explicit-module-boundary-types": ["error"]
       }
@@ -128,13 +132,17 @@ If you are working on a codebase within which you lint non-TypeScript code (i.e.
 
 ### `allowArgumentsExplicitlyTypedAsAny`
 
-Examples of **incorrect** code for this rule with `{ allowArgumentsExplicitlyTypedAsAny: false }`:
+Examples of code for this rule with `{ allowArgumentsExplicitlyTypedAsAny: false }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 export const func = (value: any): number => value + 1;
 ```
 
-Examples of **correct** code for this rule with `{ allowArgumentsExplicitlyTypedAsAny: true }`:
+#### ✅ Correct
 
 ```ts
 export const func = (value: number): number => value + 1;
@@ -142,7 +150,11 @@ export const func = (value: number): number => value + 1;
 
 ### `allowDirectConstAssertionInArrowFunctions`
 
-Examples of **incorrect** code for this rule with `{ allowDirectConstAssertionInArrowFunctions: false }`:
+Examples of code for this rule with `{ allowDirectConstAssertionInArrowFunctions: false }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 export const func = (value: number) => ({ type: 'X', value });
@@ -153,7 +165,7 @@ export const foo = () =>
 export const bar = () => 1;
 ```
 
-Examples of **correct** code for this rule with `{ allowDirectConstAssertionInArrowFunctions: true }`:
+#### ✅ Correct
 
 ```ts
 export const func = (value: number) => ({ type: 'X', value } as const);
@@ -181,21 +193,25 @@ You may pass function/method names you would like this rule to ignore, like so:
 
 ### `allowHigherOrderFunctions`
 
-Examples of **incorrect** code for this rule with `{ allowHigherOrderFunctions: false }`:
+Examples of code for this rule with `{ allowHigherOrderFunctions: false }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
-export const arrowFn = () => (): void => {};
+export const arrowFn = () => () => {};
 
 export function fn() {
-  return function (): void {};
+  return function () {};
 }
 
 export function foo(outer: string) {
-  return function (inner: string): void {};
+  return function (inner: string) {};
 }
 ```
 
-Examples of **correct** code for this rule with `{ allowHigherOrderFunctions: true }`:
+#### ✅ Correct
 
 ```ts
 export const arrowFn = () => (): void => {};
@@ -211,7 +227,11 @@ export function foo(outer: string) {
 
 ### `allowTypedFunctionExpressions`
 
-Examples of **incorrect** code for this rule with `{ allowTypedFunctionExpressions: false }`:
+Examples of code for this rule with `{ allowTypedFunctionExpressions: false }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 export let arrowFn = () => 'test';
@@ -227,7 +247,7 @@ export let objectProp = {
 export const foo = bar => {};
 ```
 
-Examples of additional **correct** code for this rule with `{ allowTypedFunctionExpressions: true }`:
+#### ✅ Correct
 
 ```ts
 type FuncType = () => string;
@@ -265,9 +285,3 @@ If you wish to make sure all functions have explicit return types, as opposed to
 ## Further Reading
 
 - TypeScript [Functions](https://www.typescriptlang.org/docs/handbook/functions.html#function-types)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,11 +1,13 @@
-# Require or disallow spacing between function identifiers and their invocations (`func-call-spacing`)
+# `func-call-spacing`
+
+Requires or disallows spacing between function identifiers and their invocations.
 
 ## 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
+## How to Use
 
 ```jsonc
 {
@@ -19,10 +21,8 @@ It adds support for generic type parameters on function calls.
 
 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/master/docs/rules/func-call-spacing.md)</sup>
+<sup>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/func-call-spacing.md)
 
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information
+</sup>

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

@@ -1,13 +1,17 @@
-# Enforce consistent indentation (`indent`)
+# `indent`
 
-## PLEASE READ THIS ISSUE BEFORE USING THIS RULE [#1824](https://github.com/typescript-eslint/typescript-eslint/issues/1824)
+Enforces consistent indentation.
+
+## Warning
+
+PLEASE READ THIS ISSUE BEFORE USING THIS RULE [#1824](https://github.com/typescript-eslint/typescript-eslint/issues/1824)
 
 ## 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
+## How to Use
 
 ```jsonc
 {
@@ -21,10 +25,8 @@ It adds support for TypeScript nodes.
 
 See [`eslint/indent` options](https://eslint.org/docs/rules/indent#options).
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/indent.md)</sup>
+<sup>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/indent.md)
 
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information
+</sup>

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

@@ -1,11 +1,13 @@
-# require or disallow initialization in variable declarations (`init-declarations`)
+# `init-declarations`
+
+Requires or disallows initialization in variable declarations.
 
 ## 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
+## How to Use
 
 ```jsonc
 {
@@ -19,10 +21,8 @@ It adds support for TypeScript's `declare` variables.
 
 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/master/docs/rules/init-declarations.md)</sup>
+<sup>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/init-declarations.md)
 
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information
+</sup>

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

@@ -1,11 +1,13 @@
-# Enforce consistent spacing before and after keywords (`keyword-spacing`)
+# `keyword-spacing`
+
+Enforces consistent spacing before and after keywords.
 
 ## 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
+## How to Use
 
 ```jsonc
 {
@@ -19,10 +21,8 @@ This version adds support for generic type parameters on function calls.
 
 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/master/docs/rules/keyword-spacing.md)</sup>
+<sup>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/keyword-spacing.md)
 
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information
+</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/lines-between-class-members.md

@@ -1,4 +1,6 @@
-# Require or disallow an empty line between class members (`lines-between-class-members`)
+# `lines-between-class-members`
+
+Requires or disallows an empty line between class members.
 
 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 require or disallow an empty line between class members.
 
@@ -30,7 +32,7 @@ This rule has a string option and an object option.
   - `"exceptAfterOverload": true` (default) - Skip checking empty lines after overload class members
   - `"exceptAfterOverload": false` - **do not** skip checking empty lines after overload class members
 
-- [See the other options allowed](https://github.com/eslint/eslint/blob/master/docs/rules/lines-between-class-members.md#options)
+- [See the other options allowed](https://github.com/eslint/eslint/blob/main/docs/rules/lines-between-class-members.md#options)
 
 ### `exceptAfterOverload: true`
 
@@ -70,10 +72,8 @@ class foo {
 }
 ```
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/lines-between-class-members.md)</sup>
+<sup>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/lines-between-class-members.md)
 
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information
+</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/member-delimiter-style.md

@@ -1,4 +1,6 @@
-# Require a specific member delimiter style for interfaces and type literals (`member-delimiter-style`)
+# `member-delimiter-style`
+
+Requires a specific member delimiter style for interfaces and type literals.
 
 Enforces a consistent member delimiter style in interfaces and type literals. There are three member delimiter styles primarily used in TypeScript:
 
@@ -149,7 +151,11 @@ For example, to require commas for `type`s, and semicolons for multiline `interf
 
 ## Examples
 
-Examples of **incorrect** code for this rule with the default config:
+Examples of code for this rule with the default config:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 <!-- prettier-ignore -->
 ```ts
@@ -178,7 +184,7 @@ type FooBar = { name: string, greet(): string }
 type FooBar = { name: string; greet(): string; }
 ```
 
-Examples of **correct** code for this rule with the default config:
+### ✅ Correct
 
 <!-- prettier-ignore -->
 ```ts
@@ -202,9 +208,3 @@ 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.
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information