xo 0.47.0 → 0.50.0

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

@@ -0,0 +1,53 @@
+# `your-rule-name`
+
+Your rule description here.
+
+## Rule Details
+
+To fill out: tell us more about this rule.
+
+<!--tabs-->
+
+### ❌ Incorrect
+
+```ts
+// To fill out: incorrect code
+```
+
+### ✅ Correct
+
+```ts
+// To fill out: correct code
+```
+
+## Options
+
+This rule is not configurable.
+
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/your-rule-name": "error"
+  }
+}
+```
+
+If not configurable: This rule is not configurable.
+
+If configurable...
+
+```ts
+type Options = {
+  someOption?: boolean;
+};
+
+const defaultOptions: Options = {
+  someOption: false,
+};
+```
+
+## When Not To Use It
+
+To fill out: why wouldn't you want to use this rule?
+For example if this rule requires a feature released in a certain TS version.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/adjacent-overload-signatures.md

@@ -1,4 +1,6 @@
-# Require that member overloads be consecutive (`adjacent-overload-signatures`)
+# `adjacent-overload-signatures`
+
+Requires that member overloads be consecutive.
 
 Grouping overloaded members together can improve readability of the code.
 
@@ -6,7 +8,9 @@ Grouping overloaded members together can improve readability of the code.
 
 This rule aims to standardize the way overloaded members are organized.
 
-The following patterns are considered warnings:
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 declare namespace Foo {
@@ -43,7 +47,7 @@ export function bar(): void;
 export function foo(sn: string | number): void;
 ```
 
-The following patterns are not warnings:
+### ✅ Correct
 
 ```ts
 declare namespace Foo {
@@ -80,16 +84,23 @@ export function foo(n: number): void;
 export function foo(sn: string | number): void;
 ```
 
+## Options
+
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/adjacent-overload-signatures": "error"
+  }
+}
+```
+
+This rule is not configurable.
+
 ## When Not To Use It
 
 If you don't care about the general structure of the code, then you will not need this rule.
 
-## Compatibility
+## Related To
 
 - TSLint: [adjacent-overload-signatures](https://palantir.github.io/tslint/rules/adjacent-overload-signatures/)
-
-## Attributes
-
-- [x] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,4 +1,6 @@
-# Requires using either `T[]` or `Array<T>` for arrays (`array-type`)
+# `array-type`
+
+Requires using either `T[]` or `Array<T>` for arrays.
 
 Using the same style for array definitions across your codebase makes it easier for your developers to read and understand the types.
 
@@ -33,14 +35,16 @@ The default config will enforce that all mutable and readonly arrays use the `'a
 
 Always use `T[]` or `readonly T[]` for all array types.
 
-Incorrect code for `"array"`:
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 const x: Array<string> = ['a', 'b'];
 const y: ReadonlyArray<string> = ['a', 'b'];
 ```
 
-Correct code for `"array"`:
+#### ✅ Correct
 
 ```ts
 const x: string[] = ['a', 'b'];
@@ -51,14 +55,16 @@ const y: readonly string[] = ['a', 'b'];
 
 Always use `Array<T>` or `ReadonlyArray<T>` for all array types.
 
-Incorrect code for `"generic"`:
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 const x: string[] = ['a', 'b'];
 const y: readonly string[] = ['a', 'b'];
 ```
 
-Correct code for `"generic"`:
+#### ✅ Correct
 
 ```ts
 const x: Array<string> = ['a', 'b'];
@@ -70,7 +76,9 @@ const y: ReadonlyArray<string> = ['a', 'b'];
 Use `T[]` or `readonly T[]` for simple types (i.e. types which are just primitive names or type references).
 Use `Array<T>` or `ReadonlyArray<T>` for all other types (union types, intersection types, object types, function types, etc).
 
-Incorrect code for `"array-simple"`:
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 const a: (string | number)[] = ['a', 'b'];
@@ -81,7 +89,7 @@ const e: Array<string> = ['a', 'b'];
 const f: ReadonlyArray<string> = ['a', 'b'];
 ```
 
-Correct code for `"array-simple"`:
+#### ✅ Correct
 
 ```ts
 const a: Array<string | number> = ['a', 'b'];
@@ -92,7 +100,7 @@ const e: string[] = ['a', 'b'];
 const f: readonly string[] = ['a', 'b'];
 ```
 
-## Combination matrix
+## Combination Matrix
 
 This matrix lists all possible option combinations and their expected results for different types of Arrays.
 
@@ -111,12 +119,6 @@ This matrix lists all possible option combinations and their expected results fo
 | `generic`      | `array-simple` | `Array<number>`        | `Array<Foo & Bar>`         | `readonly number[]`             | `ReadonlyArray<Foo & Bar>`          |
 | `generic`      | `generic`      | `Array<number>`        | `Array<Foo & Bar>`         | `ReadonlyArray<number>`         | `ReadonlyArray<Foo & Bar>`          |
 
-## Related to
+## Related To
 
 - TSLint: [array-type](https://palantir.github.io/tslint/rules/array-type/)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,11 +1,17 @@
-# Disallows awaiting a value that is not a Thenable (`await-thenable`)
+# `await-thenable`
+
+Disallows awaiting a value that is not a Thenable.
 
 This rule disallows awaiting a value that is not a "Thenable" (an object which has `then` method, such as a Promise).
 While it is valid JavaScript to await a non-`Promise`-like value (it will resolve immediately), this pattern is often a programmer error, such as forgetting to add parenthesis to call a function that returns a Promise.
 
 ## Rule Details
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 await 'value';
@@ -14,7 +20,7 @@ const createValue = () => 'value';
 await createValue();
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 await Promise.resolve('value');
@@ -23,17 +29,24 @@ const createValue = async () => 'value';
 await createValue();
 ```
 
+## Options
+
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/await-thenable": "error"
+  }
+}
+```
+
+This rule is not configurable.
+
 ## When Not To Use It
 
 If you want to allow code to `await` non-Promise values.
 This is generally not preferred, but can sometimes be useful for visual consistency.
 
-## Related to
+## Related To
 
 - TSLint: ['await-promise'](https://palantir.github.io/tslint/rules/await-promise)
-
-## Attributes
-
-- [x] ✅ Recommended
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/ban-ts-comment.md

@@ -1,4 +1,6 @@
-# Bans `@ts-<directive>` comments from being used or requires descriptions after directive (`ban-ts-comment`)
+# `ban-ts-comment`
+
+Disallows `@ts-<directive>` comments or requires descriptions after directive.
 
 TypeScript provides several directive comments that can be used to alter how it processes files.
 Using these to suppress TypeScript Compiler Errors reduces the effectiveness of TypeScript overall.
@@ -41,7 +43,9 @@ const defaultOptions: Options = {
 
 A value of `true` for a particular directive means that this rule will report if it finds any usage of said directive.
 
-For example, with the defaults above the following patterns are considered warnings for single line or comment block lines:
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 if (false) {
@@ -56,7 +60,7 @@ if (false) {
 }
 ```
 
-The following patterns are not warnings:
+#### ✅ Correct
 
 ```ts
 if (false) {
@@ -69,7 +73,11 @@ if (false) {
 
 A value of `'allow-with-description'` for a particular directive means that this rule will report if it finds a directive that does not have a description following the directive (on the same line).
 
-For example, with `{ 'ts-expect-error': 'allow-with-description' }` the following patterns are considered a warning:
+For example, with `{ 'ts-expect-error': 'allow-with-description' }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 if (false) {
@@ -82,7 +90,7 @@ if (false) {
 }
 ```
 
-The following patterns are not a warning:
+#### ✅ Correct
 
 ```ts
 if (false) {
@@ -101,7 +109,11 @@ if (false) {
 
 Use `minimumDescriptionLength` to set a minimum length for descriptions when using the `allow-with-description` option for a directive.
 
-For example, with `{ 'ts-expect-error': 'allow-with-description', minimumDescriptionLength: 10 }` the following pattern is considered a warning:
+For example, with `{ 'ts-expect-error': 'allow-with-description', minimumDescriptionLength: 10 }` the following pattern is:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 if (false) {
@@ -110,7 +122,7 @@ if (false) {
 }
 ```
 
-The following pattern is not a warning:
+#### ✅ Correct
 
 ```ts
 if (false) {
@@ -127,12 +139,6 @@ If you want to use all of the TypeScript directives.
 
 - TypeScript [Type Checking JavaScript Files](https://www.typescriptlang.org/docs/handbook/type-checking-javascript-files.html)
 
-## Compatibility
+## Related To
 
 - TSLint: [ban-ts-ignore](https://palantir.github.io/tslint/rules/ban-ts-ignore/)
-
-## Attributes
-
-- [x] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/ban-tslint-comment.md

@@ -1,13 +1,17 @@
-# Bans `// tslint:<rule-flag>` comments from being used (`ban-tslint-comment`)
+# `ban-tslint-comment`
+
+Disallows `// tslint:<rule-flag>` comments.
 
 Useful when migrating from TSLint to ESLint. Once TSLint has been removed, this rule helps locate TSLint annotations (e.g. `// tslint:disable`).
 
 ## Rule Details
 
-Examples of **incorrect** code for this rule:
-
 All TSLint [rule flags](https://palantir.github.io/tslint/usage/rule-flags/)
 
+<!--tabs-->
+
+### ❌ Incorrect
+
 ```js
 /* tslint:disable */
 /* tslint:enable */
@@ -18,18 +22,27 @@ someCode(); // tslint:disable-line
 // tslint:disable-next-line:rule1 rule2 rule3...
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```js
 // This is a comment that just happens to mention tslint
+/* This is a multiline comment that just happens to mention tslint */
+someCode(); // This is a comment that just happens to mention tslint
 ```
 
-## When Not To Use It
+## Options
 
-If you are still using TSLint.
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/ban-tslint-comment": "warn"
+  }
+}
+```
 
-## Attributes
+This rule is not configurable.
 
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information
+## When Not To Use It
+
+If you are still using TSLint.

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

@@ -1,4 +1,6 @@
-# Bans specific types from being used (`ban-types`)
+# `ban-types`
+
+Disallows certain types.
 
 Some builtin types have aliases, some types are considered dangerous or harmful.
 It's often a good idea to ban certain types to help with consistency and safety.
@@ -25,17 +27,27 @@ type Options = {
 };
 ```
 
-The rule accepts a single object as options, with the following keys:
+The rule accepts a single object as options.
+
+### `types`
+
+An object whose keys are the types you want to ban, and the values are error messages.
+
+The type can either be a type name literal (`Foo`), a type name with generic parameter instantiation(s) (`Foo<Bar>`), the empty object literal (`{}`), or the empty tuple type (`[]`).
+
+The values can be:
+
+- A string, which is the error message to be reported; or
+- `false` to specifically un-ban this type (useful when you are using `extendDefaults`); or
+- An object with the following properties:
+  - `message: string` - the message to display when the type is matched.
+  - `fixWith?: string` - a string to replace the banned type with when the fixer is run. If this is omitted, no fix will be done.
+
+### `extendDefaults`
+
+If you're specifying custom `types`, you can set this to `true` to extend the default `types` configuration. This is a convenience option to save you copying across the defaults when adding another type.
 
-- `types` - An object whose keys are the types you want to ban, and the values are error messages.
-  - The type can either be a type name literal (`Foo`), a type name with generic parameter instantiation(s) (`Foo<Bar>`), the empty object literal (`{}`), or the empty tuple type (`[]`).
-  - The values can be a string, which is the error message to be reported, `false` to specifically disable this type
-    or it can be an object with the following properties:
-    - `message: string` - the message to display when the type is matched.
-    - `fixWith?: string` - a string to replace the banned type with when the fixer is run. If this is omitted, no fix will be done.
-- `extendDefaults` - if you're specifying custom `types`, you can set this to `true` to extend the default `types` configuration.
-  - This is a convenience option to save you copying across the defaults when adding another type.
-  - If this is `false`, the rule will _only_ use the types defined in your configuration.
+If this is `false`, the rule will _only_ use the types defined in your configuration.
 
 Example configuration:
 
@@ -49,16 +61,15 @@ Example configuration:
         "Foo": "Don't use Foo because it is unsafe",
 
         // add a custom message, AND tell the plugin how to fix it
-        "String": {
-          "message": "Use string instead",
-          "fixWith": "string"
+        "OldAPI": {
+          "message": "Use NewAPI instead",
+          "fixWith": "NewAPI"
         },
 
-        "{}": {
-          "message": "Use object instead",
-          "fixWith": "object"
-        }
-      }
+        // un-ban a type that's banned by default
+        "{}": false
+      },
+      "extendDefaults": true
     }
   ]
 }
@@ -76,7 +87,11 @@ The default options provide a set of "best practices", intended to provide safet
   - This is a point of confusion for many developers, who think it means "any object type".
   - See [this comment for more information](https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-675156492).
 
-**_Important note:_** the default options suggest using `Record<string, unknown>`; this was a stylistic decision, as the built-in `Record` type is considered to look cleaner.
+:::important
+
+The default options suggest using `Record<string, unknown>`; this was a stylistic decision, as the built-in `Record` type is considered to look cleaner.
+
+:::
 
 <details>
 <summary>Default Options</summary>
@@ -99,6 +114,10 @@ const defaultTypes = {
     message: 'Use symbol instead',
     fixWith: 'symbol',
   },
+  BigInt: {
+    message: 'Use bigint instead',
+    fixWith: 'bigint',
+  },
 
   Function: {
     message: [
@@ -131,7 +150,11 @@ const defaultTypes = {
 
 ### Examples
 
-Examples of **incorrect** code with the default options:
+Examples of code with the default options:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 // use lower-case primitives for consistency
@@ -139,6 +162,7 @@ const str: String = 'foo';
 const bool: Boolean = true;
 const num: Number = 1;
 const symb: Symbol = Symbol('foo');
+const bigInt: BigInt = 1n;
 
 // use a proper function type
 const func: Function = () => 1;
@@ -151,7 +175,7 @@ const curly1: {} = 1;
 const curly2: {} = { a: 'string' };
 ```
 
-Examples of **correct** code with the default options:
+#### ✅ Correct
 
 ```ts
 // use lower-case primitives for consistency
@@ -159,6 +183,7 @@ const str: string = 'foo';
 const bool: boolean = true;
 const num: number = 1;
 const symb: symbol = Symbol('foo');
+const bigInt: bigint = 1n;
 
 // use a proper function type
 const func: () => number = () => 1;
@@ -173,12 +198,6 @@ const curly1: number = 1;
 const curly2: Record<'a', string> = { a: 'string' };
 ```
 
-## Compatibility
+## Related To
 
 - TSLint: [ban-types](https://palantir.github.io/tslint/rules/ban-types)
-
-## Attributes
-
-- [x] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,11 +1,13 @@
-# Enforce consistent brace style for blocks (`brace-style`)
+# `brace-style`
+
+Enforces consistent brace style for blocks.
 
 ## Rule Details
 
 This rule extends the base [`eslint/brace-style`](https://eslint.org/docs/rules/brace-style) rule.
 It adds support for `enum`, `interface`, `namespace` and `module` declarations.
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -19,10 +21,8 @@ It adds support for `enum`, `interface`, `namespace` and `module` declarations.
 
 See [`eslint/brace-style` options](https://eslint.org/docs/rules/brace-style#options).
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/brace-style.md)</sup>
+<sup>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/brace-style.md)
 
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information
+</sup>