xo 0.50.0 → 0.52.1

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

@@ -1,28 +1,12 @@
-# `quotes`
+---
+description: 'Enforce the consistent use of either backticks, double, or single quotes.'
+---
 
-Enforces 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>

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 }`:

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.'
+---
 
-Disallows 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,21 +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>

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`.'
+---
 
-Requires both operands of addition to have type `number` or `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,13 +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/)

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.'
+---
 
-Enforces 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 }`:

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

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

@@ -1,6 +1,10 @@
-# `semi`
+---
+description: 'Require or disallow semicolons instead of ASI.'
+---
 
-Requires or disallows 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,23 +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>

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 members of a type union/intersection to be 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.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/space-before-blocks.md

@@ -1,11 +1,17 @@
-# `space-before-blocks`
+---
+description: 'Enforce consistent spacing before blocks.'
+---
 
-Enforces consistent spacing before blocks.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/space-before-blocks** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/space-before-blocks`](https://eslint.org/docs/rules/space-before-blocks) rule.
-It adds support for interfaces and enums:
+It adds support for interfaces and enums.
+
+<!-- tabs -->
 
 ### ❌ Incorrect
 
@@ -31,24 +37,6 @@ interface State {
 }
 ```
 
-In case a more specific options object is passed these blocks will follow `classes` configuration option.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "space-before-blocks": "off",
-  "@typescript-eslint/space-before-blocks": ["error"]
-}
-```
-
 ## Options
 
-See [`eslint/space-before-blocks` options](https://eslint.org/docs/rules/space-before-blocks#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/space-before-blocks.md)
-
-</sup>
+In case a more specific options object is passed these blocks will follow `classes` configuration option.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/space-before-function-paren.md

@@ -1,28 +1,12 @@
-# `space-before-function-paren`
+---
+description: 'Enforce consistent spacing before function parenthesis.'
+---
 
-Enforces consistent spacing before function parenthesis.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/space-before-function-paren** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/space-before-function-paren`](https://eslint.org/docs/rules/space-before-function-paren) 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
-  "space-before-function-paren": "off",
-  "@typescript-eslint/space-before-function-paren": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/space-before-function-paren` options](https://eslint.org/docs/rules/space-before-function-paren#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/space-before-function-paren.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/space-infix-ops.md

@@ -1,32 +1,16 @@
-# `space-infix-ops`
+---
+description: 'Require spacing around infix operators.'
+---
 
-Requires spacing around infix operators.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/space-infix-ops** for documentation.
 
 This rule extends the base [`eslint/space-infix-ops`](https://eslint.org/docs/rules/space-infix-ops) rule.
-
-It also add support for enum members
+It adds support for enum members.
 
 ```ts
 enum MyEnum {
   KEY = 'value',
 }
 ```
-
-## How to Use
-
-```jsonc
-{
-  "space-infix-ops": "off",
-  "@typescript-eslint/space-infix-ops": ["error", { "int32Hint": false }]
-}
-```
-
-## Options
-
-See [`eslint/space-infix-ops` options](https://eslint.org/docs/rules/space-infix-ops#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/space-infix-ops.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/strict-boolean-expressions.md

@@ -1,6 +1,10 @@
-# `strict-boolean-expressions`
+---
+description: 'Disallow certain types in boolean expressions.'
+---
 
-Disallows certain types in boolean expressions.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/strict-boolean-expressions** for documentation.
 
 Forbids usage of non-boolean types in expressions where a boolean is expected.
 `boolean` and `never` types are always allowed.
@@ -85,29 +89,6 @@ const foo = (arg: any) => (Boolean(arg) ? 1 : 0);
 
 ## Options
 
-```ts
-type Options = {
-  allowString?: boolean;
-  allowNumber?: boolean;
-  allowNullableObject?: boolean;
-  allowNullableBoolean?: boolean;
-  allowNullableString?: boolean;
-  allowNullableNumber?: boolean;
-  allowAny?: boolean;
-};
-
-const defaultOptions: Options = {
-  allowString: true,
-  allowNumber: true,
-  allowNullableObject: true,
-  allowNullableBoolean: false,
-  allowNullableString: false,
-  allowNullableNumber: false,
-  allowAny: false,
-  allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing: false,
-};
-```
-
 ### `allowString`
 
 Allows `string` in a boolean context.
@@ -195,5 +176,4 @@ This rule provides following fixes and suggestions for particular types in boole
 
 ## Related To
 
-- TSLint: [strict-boolean-expressions](https://palantir.github.io/tslint/rules/strict-boolean-expressions)
 - [no-unnecessary-condition](./no-unnecessary-condition.md) - Similar rule which reports always-truthy and always-falsy values in conditions

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/switch-exhaustiveness-check.md

@@ -1,6 +1,10 @@
-# `switch-exhaustiveness-check`
+---
+description: 'Require switch-case statements to be exhaustive with union type.'
+---
 
-Requires switch-case statements to be exhaustive with union type.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/switch-exhaustiveness-check** for documentation.
 
 Union type may have a lot of parts. It's easy to forget to consider all cases in switch. This rule reminds which parts are missing. If domain of the problem requires to have only a partial switch, developer may _explicitly_ add a default clause.
 
@@ -106,19 +110,6 @@ switch (day) {
 }
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/switch-exhaustiveness-check": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If program doesn't have union types with many parts. Downside of this rule is the need for type information, so it's slower than regular rules.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/triple-slash-reference.md

@@ -1,10 +1,16 @@
-# `triple-slash-reference`
+---
+description: 'Disallow certain triple slash directives in favor of ES6-style import declarations.'
+---
 
-Disallows certain triple slash directives in favor of ES6-style import declarations.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/triple-slash-reference** for documentation.
+
+## Rule Details
 
 Use of triple-slash reference type directives is discouraged in favor of the newer `import` style. This rule allows you to ban use of `/// <reference path="" />`, `/// <reference types="" />`, or `/// <reference lib="" />` directives.
 
-## Rule Details
+## Options
 
 With `{ "path": "never", "types": "never", "lib": "never" }` options set, the following will all be **incorrect** usage:
 
@@ -44,22 +50,6 @@ import * as foo from 'foo';
 import foo = require('foo');
 ```
 
-## Options
-
-```ts
-type Options = {
-  lib?: 'always' | 'never';
-  path?: 'always' | 'never';
-  types?: 'always' | 'never' | 'prefer-import';
-};
-
-const defaultOptions: Options = {
-  lib: 'always',
-  path: 'never',
-  types: 'prefer-import',
-};
-```
-
 ## When To Use It
 
 If you want to ban use of one or all of the triple slash reference directives, or any time you might use triple-slash type reference directives and ES6 import declarations in the same file.
@@ -67,8 +57,3 @@ If you want to ban use of one or all of the triple slash reference directives, o
 ## When Not To Use It
 
 If you want to use all flavors of triple slash reference directives.
-
-## Related To
-
-- TSLint: [no-reference](http://palantir.github.io/tslint/rules/no-reference/)
-- TSLint: [no-reference-import](https://palantir.github.io/tslint/rules/no-reference-import/)

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

@@ -1,6 +1,10 @@
-# `type-annotation-spacing`
+---
+description: 'Require consistent spacing around type annotations.'
+---
 
-Requires consistent spacing around type annotations.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/type-annotation-spacing** for documentation.
 
 Spacing around type annotations improves readability of the code. Although the most commonly used style guideline for type annotations in TypeScript prescribes adding a space after the colon, but not before it, it is subjective to the preferences of a project. For example:
 
@@ -37,21 +41,11 @@ This rule aims to enforce specific spacing patterns around type annotations and
 
 ## Options
 
-This rule has an object option:
-
-- `"before": false`, (default for colon) disallows spaces before the colon/arrow.
-- `"before": true`, (default for arrow) requires a space before the colon/arrow.
-- `"after": true`, (default) requires a space after the colon/arrow.
-- `"after": false`, disallows spaces after the colon/arrow.
-- `"overrides"`, overrides the default options for type annotations with `colon` (e.g. `const foo: string`) and function types with `arrow` (e.g. `type Foo = () => {}`). Additionally allows granular overrides for `variable` (`const foo: string`),`parameter` (`function foo(bar: string) {...}`),`property` (`interface Foo { bar: string }`) and `returnType` (`function foo(): string {...}`) annotations.
-
-### defaults
-
 Examples of code for this rule with no options at all:
 
 <!--tabs-->
 
-#### ❌ Incorrect
+### ❌ Incorrect
 
 <!-- prettier-ignore -->
 ```ts
@@ -80,7 +74,7 @@ type Foo = () =>{};
 type Foo = ()=> {};
 ```
 
-#### ✅ Correct
+### ✅ Correct
 
 <!-- prettier-ignore -->
 ```ts
@@ -307,7 +301,3 @@ If you don't want to enforce spacing for your type annotations, you can safely t
 
 - [TypeScript Type System](https://basarat.gitbooks.io/typescript/docs/types/type-system.html)
 - [Type Inference](https://www.typescriptlang.org/docs/handbook/type-inference.html)
-
-## Related To
-
-- TSLint: [`typedef-whitespace`](https://palantir.github.io/tslint/rules/typedef-whitespace/)