xo 0.48.0 → 0.51.0

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/consistent-generic-constructors.md

@@ -0,0 +1,82 @@
+# `consistent-generic-constructors`
+
+Enforces specifying generic type arguments on type annotation or constructor name of a constructor call.
+
+When constructing a generic class, you can specify the type arguments on either the left-hand side (as a type annotation) or the right-hand side (as part of the constructor call):
+
+```ts
+// Left-hand side
+const map: Map<string, number> = new Map();
+
+// Right-hand side
+const map = new Map<string, number>();
+```
+
+This rule ensures that type arguments appear consistently on one side of the declaration.
+
+## Options
+
+```jsonc
+{
+  "rules": {
+    "@typescript-eslint/consistent-generic-constructors": [
+      "error",
+      "constructor"
+    ]
+  }
+}
+```
+
+This rule takes a string option:
+
+- If it's set to `constructor` (default), type arguments that **only** appear on the type annotation are disallowed.
+- If it's set to `type-annotation`, type arguments that **only** appear on the constructor are disallowed.
+
+## Rule Details
+
+The rule never reports when there are type parameters on both sides, or neither sides of the declaration. It also doesn't report if the names of the type annotation and the constructor don't match.
+
+### `constructor`
+
+<!--tabs-->
+
+#### ❌ Incorrect
+
+```ts
+const map: Map<string, number> = new Map();
+const set: Set<string> = new Set();
+```
+
+#### ✅ Correct
+
+```ts
+const map = new Map<string, number>();
+const map: Map<string, number> = new MyMap();
+const set = new Set<string>();
+const set = new Set();
+const set: Set<string> = new Set<string>();
+```
+
+### `type-annotation`
+
+<!--tabs-->
+
+#### ❌ Incorrect
+
+```ts
+const map = new Map<string, number>();
+const set = new Set<string>();
+```
+
+#### ✅ Correct
+
+```ts
+const map: Map<string, number> = new Map();
+const set: Set<string> = new Set();
+const set = new Set();
+const set: Set<string> = new Set<string>();
+```
+
+## When Not To Use It
+
+You can turn this rule off if you don't want to enforce one kind of generic constructor style over the other.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/consistent-indexed-object-style.md

@@ -1,6 +1,6 @@
 # `consistent-indexed-object-style`
 
-Enforce or disallow the use of the record type.
+Requires or disallows the `Record` type.
 
 TypeScript supports defining object show keys can be flexible using an index signature. TypeScript also has a builtin type named `Record` to create an empty object defining only an index signature. For example, the following types are equal:
 
@@ -82,9 +82,3 @@ type Foo = {
   [key: string]: unknown;
 };
 ```
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -111,14 +111,3 @@ const foo = <Foo props={{ ... } as Bar}/>;
 ## When Not To Use It
 
 If you do not want to enforce consistent type assertions.
-
-## Related To
-
-- TSLint: [no-angle-bracket-type-assertion](https://palantir.github.io/tslint/rules/no-angle-bracket-type-assertion/)
-- TSLint: [no-object-literal-type-assertion](https://palantir.github.io/tslint/rules/no-object-literal-type-assertion/)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,6 @@
 # `consistent-type-definitions`
 
-Consistent with type definition either `interface` or `type`.
+Enforces type definitions to consistently use either `interface` or `type`.
 
 There are two ways to define a type.
 
@@ -80,13 +80,3 @@ 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/)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -13,6 +13,37 @@ This rule aims to standardize the use of type exports style across a codebase.
 
 Given a class `Button`, and an interface `ButtonProps`, examples of code:
 
+<!--tabs-->
+
+### ❌ Incorrect
+
+```ts
+interface ButtonProps {
+  onClick: () => void;
+}
+class Button implements ButtonProps {
+  onClick() {
+    console.log('button!');
+  }
+}
+export { Button, ButtonProps };
+```
+
+### ✅ Correct
+
+```ts
+interface ButtonProps {
+  onClick: () => void;
+}
+class Button implements ButtonProps {
+  onClick() {
+    console.log('button!');
+  }
+}
+export { Button };
+export type { ButtonProps };
+```
+
 ## Options
 
 ```ts
@@ -70,8 +101,6 @@ export type { ButtonProps } from 'some-library';
 ### ✅ Correct
 
 ```ts
-export { Button } from 'some-library';
-export type { ButtonProps } from 'some-library';
 export { Button, type ButtonProps } from 'some-library';
 ```
 
@@ -79,9 +108,4 @@ export { Button, type ButtonProps } from 'some-library';
 
 - 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.
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information
+- 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

@@ -64,9 +64,3 @@ const x: import('Bar') = 1;
 
 - 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.
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,6 @@
 # `default-param-last`
 
-Enforce default parameters to be last.
+Enforces default parameters to be last.
 
 ## Rule Details
 
@@ -62,9 +62,3 @@ See [`eslint/default-param-last` options](https://eslint.org/docs/rules/default-
 Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/default-param-last.md)
 
 </sup>
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,6 @@
 # `dot-notation`
 
-enforce dot notation whenever possible.
+Enforces dot notation whenever possible.
 
 ## Rule Details
 
@@ -87,9 +87,3 @@ If the TypeScript compiler option `noPropertyAccessFromIndexSignature` is set to
 Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/dot-notation.md)
 
 </sup>
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,6 +1,6 @@
 # `explicit-function-return-type`
 
-Require explicit return types on functions and class methods.
+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
@@ -95,7 +95,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
 {
@@ -106,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"]
       }
@@ -290,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,6 +1,6 @@
 # `explicit-member-accessibility`
 
-Require explicit accessibility modifiers on class properties and methods.
+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.
@@ -39,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
 {
@@ -50,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"]
       }
@@ -344,13 +344,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/)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,6 @@
 # `explicit-module-boundary-types`
 
-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.
 
 Explicit types for function return values and arguments makes it clear to any calling code what is the module boundary's input and output.
 
@@ -110,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
 {
@@ -121,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"]
       }
@@ -158,10 +158,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;
 ```
 
@@ -285,9 +284,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,6 +1,6 @@
 # `func-call-spacing`
 
-Require or disallow spacing between function identifiers and their invocations.
+Requires or disallows spacing between function identifiers and their invocations.
 
 ## Rule Details
 
@@ -26,9 +26,3 @@ See [`eslint/func-call-spacing` options](https://eslint.org/docs/rules/func-call
 Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/func-call-spacing.md)
 
 </sup>
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,6 @@
 # `indent`
 
-Enforce consistent indentation.
+Enforces consistent indentation.
 
 ## Warning
 
@@ -30,9 +30,3 @@ See [`eslint/indent` options](https://eslint.org/docs/rules/indent#options).
 Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/indent.md)
 
 </sup>
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,6 @@
 # `init-declarations`
 
-require or disallow initialization in variable declarations.
+Requires or disallows initialization in variable declarations.
 
 ## Rule Details
 
@@ -26,9 +26,3 @@ See [`eslint/init-declarations` options](https://eslint.org/docs/rules/init-decl
 Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/init-declarations.md)
 
 </sup>
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,6 @@
 # `keyword-spacing`
 
-Enforce consistent spacing before and after keywords.
+Enforces consistent spacing before and after keywords.
 
 ## Rule Details
 
@@ -26,9 +26,3 @@ See [`eslint/keyword-spacing` options](https://eslint.org/docs/rules/keyword-spa
 Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/keyword-spacing.md)
 
 </sup>
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,6 @@
 # `lines-between-class-members`
 
-Require or disallow an empty line 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.
 
@@ -77,9 +77,3 @@ class foo {
 Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/lines-between-class-members.md)
 
 </sup>
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,6 @@
 # `member-delimiter-style`
 
-Require a specific member delimiter style for interfaces and type literals.
+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:
 
@@ -208,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