xo 0.47.0 → 0.50.0

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

@@ -1,4 +1,6 @@
-# Recommends using `@ts-expect-error` over `@ts-ignore` (`prefer-ts-expect-error`)
+# `prefer-ts-expect-error`
+
+Enforces using `@ts-expect-error` over `@ts-ignore`.
 
 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.
@@ -14,7 +16,11 @@ This directive operates in the same manner as `@ts-ignore`, but will error if th
 
 This rule looks for usages of `@ts-ignore`, and flags them to be replaced with `@ts-expect-error`.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 // @ts-ignore
@@ -35,7 +41,7 @@ const isOptionEnabled = (key: string): boolean => {
 };
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 // @ts-expect-error
@@ -56,6 +62,19 @@ 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
@@ -63,9 +82,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
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,7 @@
-# Requires any function or method that returns a Promise to be marked async (`promise-function-async`)
+# `promise-function-async`
 
 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
@@ -12,7 +13,11 @@ This rule's practice removes a requirement for creating code to handle both case
 
 ## Rule Details
 
-Examples of **incorrect** code for this rule
+Examples of code for this rule
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 const arrowFunctionReturnsPromise = () => Promise.resolve('value');
@@ -22,7 +27,7 @@ function functionReturnsPromise() {
 }
 ```
 
-Examples of **correct** code for this rule
+### ✅ Correct
 
 ```ts
 const arrowFunctionReturnsPromise = async () => Promise.resolve('value');
@@ -64,9 +69,3 @@ In addition, each of the following properties may be provided, and default to `t
 ## Related To
 
 - TSLint: [promise-function-async](https://palantir.github.io/tslint/rules/promise-function-async)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,11 +1,13 @@
-# Enforce the consistent use of either backticks, double, or single quotes (`quotes`)
+# `quotes`
+
+Enforces the consistent use of either backticks, double, or single quotes.
 
 ## 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
+## How to Use
 
 ```jsonc
 {
@@ -19,10 +21,8 @@ It adds support for TypeScript features which allow quoted names, but not backti
 
 See [`eslint/quotes` options](https://eslint.org/docs/rules/quotes#options).
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/quotes.md)</sup>
+<sup>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/quotes.md)
 
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information
+</sup>

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

@@ -1,4 +1,6 @@
-# Requires `Array#sort` calls to always provide a `compareFunction` (`require-array-sort-compare`)
+# `require-array-sort-compare`
+
+Requires `Array#sort` calls to always provide a `compareFunction`.
 
 This rule prevents invoking the `Array#sort()` method without providing a `compare` argument.
 
@@ -23,7 +25,11 @@ https://www.ecma-international.org/ecma-262/9.0/#sec-sortcompare
 
 This rule aims to ensure all calls of the native `Array#sort` method provide a `compareFunction`, while ignoring calls to user-defined `sort` methods.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 const array: any[];
@@ -35,7 +41,7 @@ array.sort();
 stringArray.sort();
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 const array: any[];
@@ -66,7 +72,11 @@ const defaults = {
 
 ### `ignoreStringArrays`
 
-Examples of **incorrect** code for this rule with `{ ignoreStringArrays: true }`:
+Examples of code for this rule with `{ ignoreStringArrays: true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 const one = 1;
@@ -75,7 +85,7 @@ const three = 3;
 [one, two, three].sort();
 ```
 
-Examples of **correct** code for this rule with `{ ignoreStringArrays: true }`:
+#### ✅ Correct
 
 ```ts
 const one = '1';
@@ -87,9 +97,3 @@ const three = '3';
 ## When Not To Use It
 
 If you understand the language specification enough, you can turn this rule off safely.
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,4 +1,6 @@
-# Disallow async functions which have no `await` expression (`require-await`)
+# `require-await`
+
+Disallows async functions which have no `await` expression.
 
 ## Rule Details
 
@@ -15,7 +17,7 @@ async function returnsPromise1() {
 const returnsPromise2 = () => returnsPromise1();
 ```
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -29,10 +31,8 @@ const returnsPromise2 = () => returnsPromise1();
 
 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/master/docs/rules/require-await.md)</sup>
+<sup>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/require-await.md)
 
-- [x] ✅ Recommended
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information
+</sup>

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

@@ -1,29 +1,52 @@
-# When adding two variables, operands must both be of type number or of type string (`restrict-plus-operands`)
+# `restrict-plus-operands`
 
-Examples of **correct** code:
+Requires both operands of addition to have type `number` or `string`.
 
-```ts
-var foo = parseInt('5.5', 10) + 10;
-var foo = 1n + 1n;
-```
+## Rule Details
 
-Examples of **incorrect** code:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 var foo = '5.5' + 5;
 var foo = 1n + 1;
 ```
 
+### ✅ Correct
+
+```ts
+var foo = parseInt('5.5', 10) + 10;
+var foo = 1n + 1n;
+```
+
 ## Options
 
-This rule has an object option:
+The rule accepts an options object with the following properties:
 
-- `"checkCompoundAssignments": false`: (default) does not check compound assignments (`+=`)
-- `"checkCompoundAssignments": true`
+```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 **incorrect** code for the `{ "checkCompoundAssignments": true }` option:
+Examples of code for this rule with `{ checkCompoundAssignments: true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 /*eslint @typescript-eslint/restrict-plus-operands: ["error", { "checkCompoundAssignments": true }]*/
@@ -35,7 +58,7 @@ let bar: string = '';
 bar += 0;
 ```
 
-Examples of **correct** code for the `{ "checkCompoundAssignments": true }` option:
+#### ✅ Correct
 
 ```ts
 /*eslint @typescript-eslint/restrict-plus-operands: ["error", { "checkCompoundAssignments": true }]*/
@@ -47,18 +70,37 @@ let bar = '';
 bar += 'test';
 ```
 
+### `allowAny`
+
+Examples of code for this rule with `{ allowAny: true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
+
+```ts
+var fn = (a: any, b: boolean) => a + b;
+var fn = (a: any, b: []) => a + b;
+var fn = (a: any, b: {}) => a + b;
+```
+
+#### ✅ Correct
+
+```ts
+var fn = (a: any, b: any) => a + b;
+var fn = (a: any, b: string) => a + b;
+var fn = (a: any, b: bigint) => a + b;
+var fn = (a: any, b: number) => a + b;
+```
+
+## How to Use
+
 ```json
 {
   "@typescript-eslint/restrict-plus-operands": "error"
 }
 ```
 
-## Compatibility
+## Related To
 
 - TSLint: [restrict-plus-operands](https://palantir.github.io/tslint/rules/restrict-plus-operands/)
-
-## Attributes
-
-- [x] ✅ Recommended
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,17 +1,14 @@
-# Enforce template literal expressions to be of string type (`restrict-template-expressions`)
+# `restrict-template-expressions`
 
-Examples of **correct** code:
+Enforces template literal expressions to be of `string` type.
 
-```ts
-const arg = 'foo';
-const msg1 = `arg = ${arg}`;
-const msg2 = `arg = ${arg || 'default'}`;
+## Rule Details
 
-const stringWithKindProp: string & { _kind?: 'MyString' } = 'foo';
-const msg3 = `stringWithKindProp = ${stringWithKindProp}`;
-```
+Examples of code for this rule:
+
+<!--tabs-->
 
-Examples of **incorrect** code:
+### ❌ Incorrect
 
 ```ts
 const arg1 = [1, 2];
@@ -21,6 +18,17 @@ const arg2 = { name: 'Foo' };
 const msg2 = `arg2 = ${arg2 || null}`;
 ```
 
+### ✅ Correct
+
+```ts
+const arg = 'foo';
+const msg1 = `arg = ${arg}`;
+const msg2 = `arg = ${arg || 'default'}`;
+
+const stringWithKindProp: string & { _kind?: 'MyString' } = 'foo';
+const msg3 = `stringWithKindProp = ${stringWithKindProp}`;
+```
+
 ## Options
 
 The rule accepts an options object with the following properties:
@@ -100,9 +108,3 @@ const msg1 = `arg = ${arg}`;
 const arg = /foo/;
 const msg1 = `arg = ${arg}`;
 ```
-
-## Attributes
-
-- [x] ✅ Recommended
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,4 +1,6 @@
-# Enforces consistent returning of awaited values (`return-await`)
+# `return-await`
+
+Enforces consistent returning of awaited values.
 
 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).
 
@@ -7,7 +9,7 @@ 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
+## How to Use
 
 ```jsonc
 {
@@ -35,7 +37,11 @@ Specifically:
 - if you `return` a promise within a `catch`, and there **_is a_** `finally`, then it **_must_** be `await`ed.
 - if you `return` a promise within a `finally`, then it **_must not_** be `await`ed.
 
-Examples of **incorrect** code with `in-try-catch`:
+Examples of code with `in-try-catch`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 async function invalidInTryCatch1() {
@@ -81,7 +87,7 @@ async function invalidInTryCatch6() {
 }
 ```
 
-Examples of **correct** code with `in-try-catch`:
+#### ✅ Correct
 
 ```ts
 async function validInTryCatch1() {
@@ -131,7 +137,11 @@ async function validInTryCatch6() {
 
 Requires that all returned promises are `await`ed.
 
-Examples of **incorrect** code with `always`:
+Examples of code with `always`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 async function invalidAlways1() {
@@ -149,7 +159,7 @@ async function invalidAlways3() {
 }
 ```
 
-Examples of **correct** code with `always`:
+#### ✅ Correct
 
 ```ts
 async function validAlways1() {
@@ -171,7 +181,11 @@ async function validAlways3() {
 
 Disallows all `await`ing any returned promises.
 
-Examples of **incorrect** code with `never`:
+Examples of code with `never`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 async function invalidNever1() {
@@ -189,7 +203,7 @@ async function invalidNever3() {
 }
 ```
 
-Examples of **correct** code with `never`:
+#### ✅ Correct
 
 ```ts
 async function validNever1() {
@@ -206,9 +220,3 @@ async function validNever3() {
   return 'value';
 }
 ```
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,4 +1,6 @@
-# Require or disallow semicolons instead of ASI (`semi`)
+# `semi`
+
+Requires or disallows semicolons instead of ASI.
 
 This rule enforces consistent use of semicolons after statements.
 
@@ -9,7 +11,7 @@ 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
+## How to Use
 
 ```jsonc
 {
@@ -23,10 +25,8 @@ See also the [`@typescript-eslint/member-delimiter-style`](member-delimiter-styl
 
 See [`eslint/semi` options](https://eslint.org/docs/rules/semi#options).
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/semi.md)</sup>
+<sup>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/semi.md)
 
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information
+</sup>

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

@@ -1,4 +1,6 @@
-# Enforces that members of a type union/intersection are sorted alphabetically (`sort-type-union-intersection-members`)
+# `sort-type-union-intersection-members`
+
+Enforces members of a type union/intersection to be sorted alphabetically.
 
 Sorting union (`|`) and intersection (`&`) types can help:
 
@@ -23,7 +25,11 @@ function compare(a, b) {
 
 In other words, the types are sorted alphabetically, case-insensitively and treating numbers like a human would, falling back to character code sorting in case of ties.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 type T1 = B | A;
@@ -53,7 +59,7 @@ type T4 =
   | any;
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 type T1 = A | B;
@@ -145,9 +151,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
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -0,0 +1,54 @@
+# `space-before-blocks`
+
+Enforces consistent spacing before blocks.
+
+## 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:
+
+### ❌ Incorrect
+
+```ts
+enum Breakpoint{
+  Large, Medium;
+}
+
+interface State{
+  currentBreakpoint: Breakpoint;
+}
+```
+
+### ✅ Correct
+
+```ts
+enum Breakpoint {
+  Large, Medium;
+}
+
+interface State {
+  currentBreakpoint: Breakpoint;
+}
+```
+
+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>

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

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

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

@@ -1,4 +1,6 @@
-# This rule is aimed at ensuring there are spaces around infix operators. (`space-infix-ops`)
+# `space-infix-ops`
+
+Requires spacing around infix operators.
 
 This rule extends the base [`eslint/space-infix-ops`](https://eslint.org/docs/rules/space-infix-ops) rule.
 
@@ -10,7 +12,7 @@ enum MyEnum {
 }
 ```
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -23,10 +25,8 @@ enum MyEnum {
 
 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/master/docs/rules/space-infix-ops.md)</sup>
+<sup>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/space-infix-ops.md)
 
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information
+</sup>