xo 0.49.0 → 0.52.0

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-regexp-exec.md

@@ -1,6 +1,10 @@
-# `prefer-regexp-exec`
+---
+description: 'Enforce `RegExp#exec` over `String#match` if no global flag is provided.'
+---
 
-Enforce that `RegExp#exec` is used instead of `String#match` if no global flag is provided.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-regexp-exec** for documentation.
 
 As `String#match` is defined to be the same as `RegExp#exec` when the regular expression does not include the `g` flag, prefer a consistent usage.
 
@@ -42,27 +46,6 @@ const search = /thing/;
 search.exec(text);
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/prefer-regexp-exec": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you prefer consistent use of `String#match` for both, with `g` flag and without it, you can turn this rule off.
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-return-this-type.md

@@ -1,6 +1,10 @@
-# `prefer-return-this-type`
+---
+description: 'Enforce that `this` is used when only `this` type is returned.'
+---
 
-Enforce that `this` is used when only `this` type is returned.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-return-this-type** for documentation.
 
 [Method chaining](https://en.wikipedia.org/wiki/Method_chaining) is a common pattern in OOP languages and TypeScript provides a special [polymorphic this type](https://www.typescriptlang.org/docs/handbook/2/classes.html#this-types).
 If any type other than `this` is specified as the return type of these chaining methods, TypeScript will fail to cast it when invoking in subclass.
@@ -93,27 +97,6 @@ class Derived extends Base {
 }
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/prefer-return-this-type": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you don't use method chaining or explicit return values, you can safely turn this rule off.
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [x] 🔒 Strict
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-string-starts-ends-with.md

@@ -1,9 +1,12 @@
-# `prefer-string-starts-ends-with`
+---
+description: 'Enforce using `String#startsWith` and `String#endsWith` over other equivalent methods of checking substrings.'
+---
 
-Enforce the use of `String#startsWith` and `String#endsWith` instead of other equivalent methods of checking substrings.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-string-starts-ends-with** for documentation.
 
 There are multiple ways to verify if a string starts or ends with a specific string, such as `foo.indexOf('bar') === 0`.
-
 Since ES2015 has added `String#startsWith` and `String#endsWith`, this rule reports other ways to be consistent.
 
 ## Rule Details
@@ -45,27 +48,6 @@ foo.startsWith('bar');
 foo.endsWith('bar');
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/prefer-string-starts-ends-with": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you don't mind that style, you can turn this rule off safely.
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [x] 🔒 Strict
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-ts-expect-error.md

@@ -1,6 +1,10 @@
-# `prefer-ts-expect-error`
+---
+description: 'Enforce using `@ts-expect-error` over `@ts-ignore`.'
+---
 
-Recommends using `@ts-expect-error` over `@ts-ignore`.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-ts-expect-error** for documentation.
 
 TypeScript allows you to suppress all errors on a line by placing a single-line comment or a comment block line starting with `@ts-ignore` immediately before the erroring line.
 While powerful, there is no way to know if a `@ts-ignore` is actually suppressing an error without manually investigating what happens when the `@ts-ignore` is removed.
@@ -62,19 +66,6 @@ const isOptionEnabled = (key: string): boolean => {
 };
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/prefer-ts-expect-error": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you are **NOT** using TypeScript 3.9 (or greater), then you will not be able to use this rule, as the directive is not supported
@@ -82,11 +73,3 @@ If you are **NOT** using TypeScript 3.9 (or greater), then you will not be able
 ## Further Reading
 
 - [Original Implementing PR](https://github.com/microsoft/TypeScript/pull/36014)
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [x] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/promise-function-async.md

@@ -1,8 +1,11 @@
-# `promise-function-async`
+---
+description: 'Require any function or method that returns a Promise to be marked async.'
+---
 
-Requires any function or method that returns a Promise to be marked async.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/promise-function-async** for documentation.
 
-Requires any function or method that returns a Promise to be marked async.
 Ensures that each function is only capable of:
 
 - returning a rejected promise, or
@@ -37,44 +40,3 @@ async function functionReturnsPromise() {
   return Promise.resolve('value');
 }
 ```
-
-## Options
-
-Options may be provided as an object with:
-
-- `allowAny` to indicate that `any` or `unknown` shouldn't be considered Promises (`true` by default).
-- `allowedPromiseNames` to indicate any extra names of classes or interfaces to be considered Promises when returned.
-
-In addition, each of the following properties may be provided, and default to `true`:
-
-- `checkArrowFunctions`
-- `checkFunctionDeclarations`
-- `checkFunctionExpressions`
-- `checkMethodDeclarations`
-
-```json
-{
-  "@typescript-eslint/promise-function-async": [
-    "error",
-    {
-      "allowedPromiseNames": ["Thenable"],
-      "checkArrowFunctions": true,
-      "checkFunctionDeclarations": true,
-      "checkFunctionExpressions": true,
-      "checkMethodDeclarations": true
-    }
-  ]
-}
-```
-
-## Related To
-
-- TSLint: [promise-function-async](https://palantir.github.io/tslint/rules/promise-function-async)
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,36 +1,12 @@
-# `quotes`
+---
+description: 'Enforce the consistent use of either backticks, double, or single quotes.'
+---
 
-Enforce the consistent use of either backticks, double, or single quotes.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/quotes** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/quotes`](https://eslint.org/docs/rules/quotes) rule.
 It adds support for TypeScript features which allow quoted names, but not backtick quoted names.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "quotes": "off",
-  "@typescript-eslint/quotes": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/quotes` options](https://eslint.org/docs/rules/quotes#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/quotes.md)
-
-</sup>
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/require-array-sort-compare.md

@@ -1,9 +1,12 @@
-# `require-array-sort-compare`
+---
+description: 'Require `Array#sort` calls to always provide a `compareFunction`.'
+---
 
-Requires `Array#sort` calls to always provide a `compareFunction`.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/require-array-sort-compare** for documentation.
 
 This rule prevents invoking the `Array#sort()` method without providing a `compare` argument.
-
 When called without a compare function, `Array#sort()` converts all non-undefined array elements into strings and then compares said strings based off their UTF-16 code units.
 
 The result is that elements are sorted alphabetically, regardless of their type.
@@ -55,21 +58,6 @@ userDefinedType.sort();
 
 ## Options
 
-The rule accepts an options object with the following properties:
-
-```ts
-type Options = {
-  /**
-   * If true, an array which all elements are string is ignored.
-   */
-  ignoreStringArrays?: boolean;
-};
-
-const defaults = {
-  ignoreStringArrays: false,
-};
-```
-
 ### `ignoreStringArrays`
 
 Examples of code for this rule with `{ ignoreStringArrays: true }`:
@@ -97,11 +85,3 @@ const three = '3';
 ## When Not To Use It
 
 If you understand the language specification enough, you can turn this rule off safely.
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,6 +1,10 @@
-# `require-await`
+---
+description: 'Disallow async functions which have no `await` expression.'
+---
 
-Disallow async functions which have no `await` expression.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/require-await** for documentation.
 
 ## Rule Details
 
@@ -18,29 +22,3 @@ const returnsPromise2 = () => returnsPromise1();
 ```
 
 ## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "require-await": "off",
-  "@typescript-eslint/require-await": "error"
-}
-```
-
-## Options
-
-See [`eslint/require-await` options](https://eslint.org/docs/rules/require-await#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/require-await.md)
-
-</sup>
-
-## Attributes
-
-- Configs:
-  - [x] ✅ Recommended
-  - [x] 🔒 Strict
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/restrict-plus-operands.md

@@ -1,6 +1,10 @@
-# `restrict-plus-operands`
+---
+description: 'Require both operands of addition to have type `number` or `string`.'
+---
 
-When adding two variables, operands must both be of type number or of type string.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/restrict-plus-operands** for documentation.
 
 ## Rule Details
 
@@ -24,22 +28,6 @@ var foo = 1n + 1n;
 
 ## Options
 
-The rule accepts an options object with the following properties:
-
-```ts
-type Options = {
-  // if true, check compound assignments (`+=`)
-  checkCompoundAssignments?: boolean;
-  // if true, 'any' itself and `string`,`bigint`, `number` is allowed.
-  allowAny?: boolean;
-};
-
-const defaults = {
-  checkCompoundAssignments: false,
-  allowAny: false,
-};
-```
-
 ### `checkCompoundAssignments`
 
 Examples of code for this rule with `{ checkCompoundAssignments: true }`:
@@ -94,21 +82,3 @@ var fn = (a: any, b: number) => a + b;
 ```
 
 ## How to Use
-
-```json
-{
-  "@typescript-eslint/restrict-plus-operands": "error"
-}
-```
-
-## Related To
-
-- TSLint: [restrict-plus-operands](https://palantir.github.io/tslint/rules/restrict-plus-operands/)
-
-## Attributes
-
-- Configs:
-  - [x] ✅ Recommended
-  - [x] 🔒 Strict
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/restrict-template-expressions.md

@@ -1,6 +1,10 @@
-# `restrict-template-expressions`
+---
+description: 'Enforce template literal expressions to be of `string` type.'
+---
 
-Enforce template literal expressions to be of string type.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/restrict-template-expressions** for documentation.
 
 ## Rule Details
 
@@ -31,31 +35,6 @@ const msg3 = `stringWithKindProp = ${stringWithKindProp}`;
 
 ## Options
 
-The rule accepts an options object with the following properties:
-
-```ts
-type Options = {
-  // if true, also allow number type in template expressions
-  allowNumber?: boolean;
-  // if true, also allow boolean type in template expressions
-  allowBoolean?: boolean;
-  // if true, also allow any in template expressions
-  allowAny?: boolean;
-  // if true, also allow null and undefined in template expressions
-  allowNullish?: boolean;
-  // if true, also allow RegExp in template expressions
-  allowRegExp?: boolean;
-};
-
-const defaults = {
-  allowNumber: true,
-  allowBoolean: false,
-  allowAny: false,
-  allowNullish: false,
-  allowRegExp: false,
-};
-```
-
 ### `allowNumber`
 
 Examples of additional **correct** code for this rule with `{ allowNumber: true }`:
@@ -108,11 +87,3 @@ const msg1 = `arg = ${arg}`;
 const arg = /foo/;
 const msg1 = `arg = ${arg}`;
 ```
-
-## Attributes
-
-- Configs:
-  - [x] ✅ Recommended
-  - [x] 🔒 Strict
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,6 +1,10 @@
-# `return-await`
+---
+description: 'Enforce consistent returning of awaited values.'
+---
 
-Enforces consistent returning of awaited values.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/return-await** for documentation.
 
 Returning an awaited promise can make sense for better stack trace information as well as for consistent error handling (returned promises will not be caught in an async function try/catch).
 
@@ -9,16 +13,6 @@ Returning an awaited promise can make sense for better stack trace information a
 This rule builds on top of the [`eslint/no-return-await`](https://eslint.org/docs/rules/no-return-await) rule.
 It expands upon the base rule to add support for optionally requiring `return await` in certain cases.
 
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-return-await": "off",
-  "@typescript-eslint/return-await": "error"
-}
-```
-
 ## Options
 
 ```ts
@@ -220,11 +214,3 @@ async function validNever3() {
   return 'value';
 }
 ```
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,6 +1,10 @@
-# `semi`
+---
+description: 'Require or disallow semicolons instead of ASI.'
+---
 
-Require or disallow semicolons instead of ASI.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/semi** for documentation.
 
 This rule enforces consistent use of semicolons after statements.
 
@@ -10,31 +14,3 @@ This rule extends the base [`eslint/semi`](https://eslint.org/docs/rules/semi) r
 It adds support for TypeScript features that require semicolons.
 
 See also the [`@typescript-eslint/member-delimiter-style`](member-delimiter-style.md) rule, which allows you to specify the delimiter for `type` and `interface` members.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "semi": "off",
-  "@typescript-eslint/semi": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/semi` options](https://eslint.org/docs/rules/semi#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/semi.md)
-
-</sup>
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/sort-type-union-intersection-members.md

@@ -1,6 +1,10 @@
-# `sort-type-union-intersection-members`
+---
+description: 'Enforce members of a type union/intersection to be sorted alphabetically.'
+---
 
-Enforces that members of a type union/intersection are sorted alphabetically.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/sort-type-union-intersection-members** for documentation.
 
 Sorting union (`|`) and intersection (`&`) types can help:
 
@@ -91,49 +95,6 @@ type T4 =
 
 ## Options
 
-```ts
-type Options = {
-  // true to check intersection types, false otherwise
-  checkIntersections?: boolean;
-  // true to check union types, false otherwise
-  checkUnions?: boolean;
-  // the ordering of the groups
-  groupOrder?: (
-    | 'conditional'
-    | 'function'
-    | 'import'
-    | 'intersection'
-    | 'keyword'
-    | 'literal'
-    | 'named'
-    | 'object'
-    | 'operator'
-    | 'tuple'
-    | 'union'
-    | 'nullish'
-  )[];
-};
-
-const defaultOptions: Options = {
-  checkIntersections: true,
-  checkUnions: true,
-  groupOrder: [
-    'named',
-    'keyword',
-    'operator',
-    'literal',
-    'function',
-    'import',
-    'conditional',
-    'object',
-    'tuple',
-    'intersection',
-    'union',
-    'nullish',
-  ],
-};
-```
-
 ### `groupOrder`
 
 Each member of the type is placed into a group, and then the rule sorts alphabetically within each group.
@@ -151,11 +112,3 @@ The ordering of groups is determined by this option.
 - `tuple` - Tuple types (`[A, B, C]`)
 - `union` - Union types (`A | B`)
 - `nullish` - `null` and `undefined`
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information