xo 0.51.0 → 0.52.0

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-extra-non-null-assertion.md

@@ -1,6 +1,10 @@
-# `no-extra-non-null-assertion`
+---
+description: 'Disallow extra non-null assertion.'
+---
 
-Disallows extra non-null assertion.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-extra-non-null-assertion** for documentation.
 
 ## Rule Details
 
@@ -45,16 +49,3 @@ function foo(bar?: { n: number }) {
   return bar?.n;
 }
 ```
-
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-extra-non-null-assertion": "error"
-  }
-}
-```
-
-This rule is not configurable.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-extra-parens.md

@@ -1,28 +1,12 @@
-# `no-extra-parens`
+---
+description: 'Disallow unnecessary parentheses.'
+---
 
-Disallows unnecessary parentheses.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-extra-parens** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-extra-parens`](https://eslint.org/docs/rules/no-extra-parens) rule.
 It adds support for TypeScript type assertions.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-extra-parens": "off",
-  "@typescript-eslint/no-extra-parens": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/no-extra-parens` options](https://eslint.org/docs/rules/no-extra-parens#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-extra-parens.md)
-
-</sup>

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

@@ -1,28 +1,12 @@
-# `no-extra-semi`
+---
+description: 'Disallow unnecessary semicolons.'
+---
 
-Disallows unnecessary semicolons.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-extra-semi** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-extra-semi`](https://eslint.org/docs/rules/no-extra-semi) rule.
 It adds support for class properties.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-extra-semi": "off",
-  "@typescript-eslint/no-extra-semi": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/no-extra-semi` options](https://eslint.org/docs/rules/no-extra-semi#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-extra-semi.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-extraneous-class.md

@@ -1,6 +1,10 @@
-# `no-extraneous-class`
+---
+description: 'Disallow classes used as namespaces.'
+---
 
-Disallows classes used as namespaces.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-extraneous-class** for documentation.
 
 This rule warns when a class has no non-static members, such as for a class used exclusively as a static namespace.
 
@@ -192,28 +196,6 @@ export function incrementCount() {
 
 ## Options
 
-This rule accepts a single object option.
-
-```ts
-type Options = {
-  // allow extraneous classes if they only contain a constructor
-  allowConstructorOnly?: boolean;
-  // allow extraneous classes if they have no body (i.e. are empty)
-  allowEmpty?: boolean;
-  // allow extraneous classes if they only contain static members
-  allowStaticOnly?: boolean;
-  // allow extraneous classes if they have a decorator
-  allowWithDecorator?: boolean;
-};
-
-const defaultOptions: Options = {
-  allowConstructorOnly: false,
-  allowEmpty: false,
-  allowStaticOnly: false,
-  allowWithDecorator: false,
-};
-```
-
 This rule normally bans classes that are empty (have no constructor or fields).
 The rule's options each add an exemption for a specific type of class.
 

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-floating-promises.md

@@ -1,6 +1,10 @@
-# `no-floating-promises`
+---
+description: 'Require Promise-like statements to be handled appropriately.'
+---
 
-Requires Promise-like statements to be handled appropriately.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-floating-promises** for documentation.
 
 A "floating" Promise is one that is created without any code set up to handle any errors it might throw.
 
@@ -61,22 +65,6 @@ Promise.reject('value').finally(() => {});
 
 ## Options
 
-The rule accepts an options object with the following properties:
-
-```ts
-type Options = {
-  // if true, checking void expressions will be skipped
-  ignoreVoid?: boolean;
-  // if true, checking for async iife will be skipped
-  ignoreIIFE?: boolean;
-};
-
-const defaults = {
-  ignoreVoid: true,
-  ignoreIIFE: false,
-};
-```
-
 ### `ignoreVoid`
 
 This allows you to stop the rule reporting promises consumed with void operator.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-for-in-array.md

@@ -1,6 +1,10 @@
-# `no-for-in-array`
+---
+description: 'Disallow iterating over an array with a for-in loop.'
+---
 
-Disallows iterating over an array with a for-in loop.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-for-in-array** for documentation.
 
 This rule prohibits iterating over an array with a for-in loop.
 
@@ -39,19 +43,6 @@ for (const x in { a: 3, b: 4, c: 5 }) {
 }
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-for-in-array": "error"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you want to iterate through a loop using the indices in an array as strings, you can turn off this rule.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-implicit-any-catch.md

@@ -1,6 +1,15 @@
-# `no-implicit-any-catch`
+---
+description: 'Disallow usage of the implicit `any` type in catch clauses.'
+---
 
-Disallows usage of the implicit `any` type in catch clauses.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-implicit-any-catch** for documentation.
+
+:::danger Deprecated
+
+This rule has been deprecated as TypeScript versions >=4 includes a `useUnknownInCatchVariables` compiler option with the same check.
+:::
 
 TypeScript 4.0 added support for adding an explicit `any` or `unknown` type annotation on a catch clause variable.
 
@@ -45,26 +54,10 @@ try {
 
 ## Options
 
-The rule accepts an options object with the following properties:
-
-```ts
-type Options = {
-  // if false, disallow specifying `: any` as the error type as well. See also `no-explicit-any`
-  allowExplicitAny: boolean;
-};
-
-const defaults = {
-  allowExplicitAny: false,
-};
-```
-
 ### `allowExplicitAny`
 
 The follow is is **_not_** considered a warning with `{ allowExplicitAny: true }`
 
-<!-- TODO: prettier currently removes the type annotations, re-enable this once prettier is updated -->
-<!-- prettier-ignore-start -->
-
 ```ts
 try {
   // ...
@@ -73,8 +66,6 @@ try {
 }
 ```
 
-<!-- prettier-ignore-end -->
-
 ## When Not To Use It
 
 If you are not using TypeScript 4.0 (or greater), then you will not be able to use this rule, annotations on catch clauses is not supported.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-implied-eval.md

@@ -1,6 +1,10 @@
-# `no-implied-eval`
+---
+description: 'Disallow the use of `eval()`-like methods.'
+---
 
-Disallows the use of `eval()`-like methods.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-implied-eval** for documentation.
 
 It's considered a good practice to avoid using `eval()`. There are security and performance implications involved with doing so, which is why many linters recommend disallowing `eval()`. However, there are some other ways to pass a string and have it interpreted as JavaScript code that have similar concerns.
 
@@ -94,22 +98,6 @@ class Foo {
 setTimeout(Foo.fn, 100);
 ```
 
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-implied-eval": "off",
-  "@typescript-eslint/no-implied-eval": ["error"]
-}
-```
-
 ## When Not To Use It
 
 If you want to allow `new Function()` or `setTimeout()`, `setInterval()`, `setImmediate()` and `execScript()` with string arguments, then you can safely disable this rule.
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-implied-eval.md)
-
-</sup>

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

@@ -1,6 +1,10 @@
-# `no-inferrable-types`
+---
+description: 'Disallow explicit type declarations for variables or parameters initialized to a number, string, or boolean.'
+---
 
-Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-inferrable-types** for documentation.
 
 Explicit types where they can be easily inferred may add unnecessary verbosity.
 
@@ -9,33 +13,11 @@ Explicit types where they can be easily inferred may add unnecessary verbosity.
 This rule disallows explicit type declarations on parameters, variables
 and properties where the type can be easily inferred from its value.
 
-## Options
-
-This rule accepts the following options:
-
-```ts
-interface Options {
-  ignoreParameters?: boolean;
-  ignoreProperties?: boolean;
-}
-```
-
-### Default
-
-The default options are:
-
-```json
-{
-  "ignoreParameters": false,
-  "ignoreProperties": false
-}
-```
-
-With these options, the following patterns are:
+Examples of code with the default options:
 
 <!--tabs-->
 
-#### ❌ Incorrect
+### ❌ Incorrect
 
 ```ts
 const a: bigint = 10n;
@@ -76,7 +58,7 @@ class Foo {
 function fn(a: number = 5, b: boolean = true) {}
 ```
 
-#### ✅ Correct
+### ✅ Correct
 
 ```ts
 const a = 10n;
@@ -121,6 +103,8 @@ function fn(a: number, b: boolean, c: string) {}
 
 <!--/tabs-->
 
+## Options
+
 ### `ignoreParameters`
 
 When set to true, the following pattern is considered valid:

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-invalid-this.md

@@ -1,32 +1,12 @@
-# `no-invalid-this`
+---
+description: 'Disallow `this` keywords outside of classes or class-like objects.'
+---
 
-Disallows `this` keywords outside of classes or class-like objects.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-invalid-this** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-invalid-this`](https://eslint.org/docs/rules/no-invalid-this) rule.
 It adds support for TypeScript's `this` parameters.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-invalid-this": "off",
-  "@typescript-eslint/no-invalid-this": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/no-invalid-this` options](https://eslint.org/docs/rules/no-invalid-this#options).
-
-## When Not To Use It
-
-When you are indifferent as to how your variables are initialized.
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-invalid-this.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-invalid-void-type.md

@@ -1,6 +1,10 @@
-# `no-invalid-void-type`
+---
+description: 'Disallow `void` type outside of generic or return types.'
+---
 
-Disallows `void` type outside of generic or return types.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-invalid-void-type** for documentation.
 
 Disallows usage of `void` type outside of return types or generic type arguments.
 If `void` is used as return type, it shouldn’t be a part of intersection/union type with most other types.
@@ -57,18 +61,6 @@ type stillVoid = void | never;
 
 ## Options
 
-```ts
-interface Options {
-  allowInGenericTypeArguments?: boolean | string[];
-  allowAsThisParameter?: boolean;
-}
-
-const defaultOptions: Options = {
-  allowInGenericTypeArguments: true,
-  allowAsThisParameter: false,
-};
-```
-
 ### `allowInGenericTypeArguments`
 
 This option lets you control if `void` can be used as a valid value for generic type parameters.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-loop-func.md

@@ -1,28 +1,12 @@
-# `no-loop-func`
+---
+description: 'Disallow function declarations that contain unsafe references inside loop statements.'
+---
 
-Disallows function declarations that contain unsafe references inside loop statements.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-loop-func** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-loop-func`](https://eslint.org/docs/rules/no-loop-func) rule.
 It adds support for TypeScript types.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-loop-func": "off",
-  "@typescript-eslint/no-loop-func": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/no-loop-func` options](https://eslint.org/docs/rules/no-loop-func#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-loop-func.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-loss-of-precision.md

@@ -1,25 +1,12 @@
-# `no-loss-of-precision`
+---
+description: 'Disallow literal numbers that lose precision.'
+---
 
-Disallows literal numbers that lose precision.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-loss-of-precision** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-loss-of-precision`](https://eslint.org/docs/rules/no-loss-of-precision) rule.
 It adds support for [numeric separators](https://github.com/tc39/proposal-numeric-separator).
-Note that this rule requires ESLint v7.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-loss-of-precision": "off",
-  "@typescript-eslint/no-loss-of-precision": ["error"]
-}
-```
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-loss-of-precision.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-magic-numbers.md

@@ -1,6 +1,10 @@
-# `no-magic-numbers`
+---
+description: 'Disallow magic numbers.'
+---
 
-Disallows magic numbers.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-magic-numbers** for documentation.
 
 ## Rule Details
 
@@ -11,24 +15,8 @@ It adds support for:
 - `enum` members (`enum Foo { bar = 1 }`),
 - `readonly` class properties (`class Foo { readonly bar = 1 }`).
 
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-magic-numbers": "off",
-  "@typescript-eslint/no-magic-numbers": [
-    "error",
-    {
-      /* options */
-    }
-  ]
-}
-```
-
 ## Options
 
-See [`eslint/no-magic-numbers` options](https://eslint.org/docs/rules/no-magic-numbers#options).
 This rule adds the following options:
 
 ```ts
@@ -141,9 +129,3 @@ Examples of **correct** code for the `{ "ignoreTypeIndexes": true }` option:
 type Foo = Bar[0];
 type Baz = Parameters<Foo>[2];
 ```
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-magic-numbers.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-meaningless-void-operator.md

@@ -1,6 +1,10 @@
-# `no-meaningless-void-operator`
+---
+description: 'Disallow the `void` operator except when used to discard a value.'
+---
 
-Disallows the `void` operator except when used to discard a value.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-meaningless-void-operator** for documentation.
 
 Disallows the `void` operator when its argument is already of type `void` or `undefined`.
 

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-misused-new.md

@@ -1,6 +1,10 @@
-# `no-misused-new`
+---
+description: 'Enforce valid definition of `new` and `constructor`.'
+---
 
-Enforces valid definition of `new` and `constructor`.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-misused-new** for documentation.
 
 Warns on apparent attempts to define constructors for interfaces or `new` for classes.
 
@@ -33,16 +37,3 @@ interface I {
   new (): C;
 }
 ```
-
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-misused-new": "error"
-  }
-}
-```
-
-This rule is not configurable.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-misused-promises.md

@@ -1,6 +1,10 @@
-# `no-misused-promises`
+---
+description: 'Disallow Promises in places not designed to handle them.'
+---
 
-Disallows Promises in places not designed to handle them.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-misused-promises** for documentation.
 
 This rule forbids providing Promises to logical locations such as if statements in places where the TypeScript compiler allows them but they are not handled properly.
 These situations can often arise due to a missing `await` keyword or just a misunderstanding of the way async

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

@@ -1,6 +1,10 @@
-# `no-namespace`
+---
+description: 'Disallow custom TypeScript modules and namespaces.'
+---
 
-Disallows custom TypeScript modules and namespaces.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-namespace** for documentation.
 
 Custom TypeScript modules (`module foo {}`) and namespaces (`namespace foo {}`) are considered outdated
 ways to organize TypeScript code. ES2015 module syntax is now preferred (`import`/`export`).
@@ -11,16 +15,7 @@ This rule still allows the use of TypeScript module declarations to describe ext
 
 This rule aims to standardize the way modules are declared.
 
-## Options
-
-This rule, in its default state, does not require any argument. If you would like to enable one
-or more of the following you may pass an object with the options set as follows:
-
-- `allowDeclarations` set to `true` will allow you to `declare` custom TypeScript modules and namespaces (Default: `false`).
-- `allowDefinitionFiles` set to `true` will allow you to `declare` and use custom TypeScript modules and namespaces
-  inside definition files (Default: `true`).
-
-Examples of code for the default `{ "allowDeclarations": false, "allowDefinitionFiles": true }` options:
+Examples of code with the default options:
 
 <!--tabs-->
 
@@ -44,9 +39,11 @@ declare module 'foo' {}
 
 <!--/tabs-->
 
+## Options
+
 ### `allowDeclarations`
 
-Examples of code for the `{ "allowDeclarations": true }` option:
+Examples of code with the `{ "allowDeclarations": true }` option:
 
 <!--tabs-->