xo 0.51.0 → 0.52.2

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

@@ -1,6 +1,10 @@
-# `no-unsafe-assignment`
+---
+description: 'Disallow assigning a value with type `any` to variables and properties.'
+---
 
-Disallows assigning a value with type `any` to variables and properties.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-unsafe-assignment** for documentation.
 
 Despite your best intentions, the `any` type can sometimes leak into your codebase.
 Assigning an `any` typed value to a variable can be hard to pick up on, particularly if it leaks in from an external library. Operations on the variable will not be checked at all by TypeScript, so it creates a potential safety hole, and source of bugs in your codebase.
@@ -74,19 +78,6 @@ const x: unknown[] = y as any[];
 const x: Set<unknown> = y as Set<any>;
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-unsafe-assignment": "error"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## Related To
 
 - [`no-explicit-any`](./no-explicit-any.md)

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

@@ -1,6 +1,10 @@
-# `no-unsafe-call`
+---
+description: 'Disallow calling a value with type `any`.'
+---
 
-Disallows calling a value with type `any`.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-unsafe-call** for documentation.
 
 Despite your best intentions, the `any` type can sometimes leak into your codebase.
 The arguments to, and return value of calling an `any` typed variable are not checked at all by TypeScript, so it creates a potential safety hole, and source of bugs in your codebase.
@@ -48,19 +52,6 @@ new Map();
 String.raw`foo`;
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-unsafe-call": "error"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## Related To
 
 - [`no-explicit-any`](./no-explicit-any.md)

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-unsafe-member-access.md

@@ -1,6 +1,10 @@
-# `no-unsafe-member-access`
+---
+description: 'Disallow member access on a value with type `any`.'
+---
 
-Disallows member access on a value with type `any`.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-unsafe-member-access** for documentation.
 
 Despite your best intentions, the `any` type can sometimes leak into your codebase.
 Member access on `any` typed variables is not checked at all by TypeScript, so it creates a potential safety hole, and source of bugs in your codebase.
@@ -54,19 +58,6 @@ arr[idx];
 arr[idx++];
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-unsafe-member-access": "error"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## Related To
 
 - [`no-explicit-any`](./no-explicit-any.md)

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

@@ -1,6 +1,10 @@
-# `no-unsafe-return`
+---
+description: 'Disallow returning a value with type `any` from a function.'
+---
 
-Disallows returning a value with type `any` from a function.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-unsafe-return** for documentation.
 
 Despite your best intentions, the `any` type can sometimes leak into your codebase.
 Returned `any` typed values are not checked at all by TypeScript, so it creates a potential safety hole, and source of bugs in your codebase.
@@ -91,19 +95,6 @@ function foo2(): unknown[] {
 }
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-unsafe-return": "error"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## Related To
 
 - [`no-explicit-any`](./no-explicit-any.md)

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

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

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

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

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-use-before-define.md

@@ -1,25 +1,18 @@
-# `no-use-before-define`
+---
+description: 'Disallow the use of variables before they are defined.'
+---
 
-Disallows the use of variables before they are defined.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-use-before-define** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-use-before-define`](https://eslint.org/docs/rules/no-use-before-define) rule.
 It adds support for `type`, `interface` and `enum` declarations.
 
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-use-before-define": "off",
-  "@typescript-eslint/no-use-before-define": ["error"]
-}
-```
-
 ## Options
 
-See [`eslint/no-use-before-define` options](https://eslint.org/docs/rules/no-use-before-define#options).
 This rule adds the following options:
 
 ```ts
@@ -102,13 +95,3 @@ type StringOrNumber = string | number;
 let var2: Enum;
 enum Enum {}
 ```
-
-### Other Options
-
-See [`eslint/no-use-before-define` options](https://eslint.org/docs/rules/no-use-before-define#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-use-before-define.md)
-
-</sup>

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

@@ -1,6 +1,10 @@
-# `no-useless-constructor`
+---
+description: 'Disallow unnecessary constructors.'
+---
 
-Disallows unnecessary constructors.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-useless-constructor** for documentation.
 
 ## Rule Details
 
@@ -11,27 +15,7 @@ It adds support for:
 - `public` constructors when there is no superclass,
 - constructors with only parameter properties.
 
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-useless-constructor": "off",
-  "@typescript-eslint/no-useless-constructor": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/no-useless-constructor` options](https://eslint.org/docs/rules/no-useless-constructor#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-useless-constructor.md)
-
-</sup>
-
-## Caveat
+### Caveat
 
 This lint rule will report on constructors whose sole purpose is to change visibility of a parent constructor.
 See [discussion on this rule's lack of type information](https://github.com/typescript-eslint/typescript-eslint/issues/3820#issuecomment-917821240) for context.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-useless-empty-export.md

@@ -1,6 +1,10 @@
-# `no-useless-empty-export`
+---
+description: "Disallow empty exports that don't change anything in a module file."
+---
 
-Disallows empty exports that don't change anything in a module file.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-useless-empty-export** for documentation.
 
 ## Rule Details
 
@@ -37,16 +41,3 @@ export const value = 'Hello, world!';
 ```ts
 import 'some-other-module';
 ```
-
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-useless-empty-export": "warn"
-  }
-}
-```
-
-This rule is not configurable.

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

@@ -1,6 +1,10 @@
-# `no-var-requires`
+---
+description: 'Disallow `require` statements except in import statements.'
+---
 
-Disallows `require` statements except in import statements.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-var-requires** for documentation.
 
 In other words, the use of forms such as `var foo = require("foo")` are banned. Instead use ES6 style imports or `import foo = require("foo")` imports.
 
@@ -26,19 +30,6 @@ require('foo');
 import foo from 'foo';
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-var-requires": "error"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you don't care about TypeScript module syntax, then you will not need this rule.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/non-nullable-type-assertion-style.md

@@ -1,6 +1,10 @@
-# `non-nullable-type-assertion-style`
+---
+description: 'Enforce non-null assertions over explicit type casts.'
+---
 
-Enforces non-null assertions over explicit type casts.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/non-nullable-type-assertion-style** for documentation.
 
 This rule detects when an `as` cast is doing the same job as a `!` would, and suggests fixing the code to be an `!`.
 
@@ -28,19 +32,6 @@ const definitely = maybe!;
 const alsoDefinitely = maybe!;
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/non-nullable-type-assertion-style": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you don't mind having unnecessarily verbose type casts, you can avoid this rule.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/object-curly-spacing.md

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

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/padding-line-between-statements.md

@@ -1,34 +1,25 @@
-# `padding-line-between-statements`
+---
+description: 'Require or disallow padding lines between statements.'
+---
 
-Requires or disallows padding lines between statements.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/padding-line-between-statements** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/padding-line-between-statements`](https://eslint.org/docs/rules/padding-line-between-statements) rule.
+It adds support for TypeScript constructs such as `interface` and `type`.
 
-**It adds support for TypeScript constructs such as `interface` and `type`.**
+## Options
 
-## How to Use
+In addition to options provided by ESLint, `interface` and `type` can be used as statement types.
 
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "padding-line-between-statements": "off",
-  "@typescript-eslint/padding-line-between-statements": [
-    "error",
-    {
-      "blankLine": "always",
-      "prev": "var",
-      "next": "return"
-    }
-  ]
-}
-```
+For example, to add blank lines before interfaces and type definitions:
 
 ```jsonc
 {
   // Example - Add blank lines before interface and type definitions.
-  // note you must disable the base rule as it can report incorrect errors
   "padding-line-between-statements": "off",
   "@typescript-eslint/padding-line-between-statements": [
     "error",
@@ -41,16 +32,4 @@ This rule extends the base [`eslint/padding-line-between-statements`](https://es
 }
 ```
 
-## Options
-
-See [`eslint/padding-line-between-statements` options](https://eslint.org/docs/rules/padding-line-between-statements#options).
-
-In addition to options provided by ESLint, `interface` and `type` can be used as statement types.
-
 **Note:** ESLint `cjs-export` and `cjs-import` statement types are renamed to `exports` and `require` respectively.
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/padding-line-between-statements.md)
-
-</sup>

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

@@ -1,6 +1,10 @@
-# `parameter-properties`
+---
+description: 'Require or disallow parameter properties in class constructors.'
+---
 
-Requires or disallows parameter properties in class constructors.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/parameter-properties** for documentation.
 
 Parameter properties can be confusing to those new to TypeScript as they are less explicit than other ways
 of declaring and initializing class members.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-as-const.md

@@ -1,6 +1,10 @@
-# `prefer-as-const`
+---
+description: 'Enforce the use of `as const` over literal type.'
+---
 
-Enforces the use of `as const` over literal type.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-as-const** for documentation.
 
 This rule recommends usage of `const` assertion when type primitive value is equal to type.
 
@@ -31,19 +35,6 @@ let foo = { bar: 'baz' };
 
 <!--/tabs-->
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/prefer-as-const": "error"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you are using TypeScript < 3.4

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-enum-initializers.md

@@ -1,6 +1,10 @@
-# `prefer-enum-initializers`
+---
+description: 'Require each enum member value to be explicitly initialized.'
+---
 
-Requires each enum member value to be explicitly initialized.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-enum-initializers** for documentation.
 
 This rule recommends having each `enum`s member value explicitly initialized.
 
@@ -71,19 +75,6 @@ enum Color {
 }
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/prefer-enum-initializers": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you don't care about `enum`s having implicit values you can safely disable this rule.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-for-of.md

@@ -1,6 +1,10 @@
-# `prefer-for-of`
+---
+description: 'Enforce the use of `for-of` loop over the standard `for` loop where possible.'
+---
 
-Enforces the use of `for-of` loop over the standard `for` loop where possible.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-for-of** for documentation.
 
 This rule recommends a for-of loop when the loop index is only used to read from an array that is being iterated.
 
@@ -38,19 +42,6 @@ for (let i = 0; i < arr.length; i++) {
 }
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/prefer-for-of": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you transpile for browsers that do not support for-of loops, you may wish to use traditional for loops that produce more compact code.

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

@@ -1,6 +1,10 @@
-# `prefer-function-type`
+---
+description: 'Enforce using function types instead of interfaces with call signatures.'
+---
 
-Enforces using function types instead of interfaces with call signatures.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-function-type** for documentation.
 
 ## Rule Details
 
@@ -78,19 +82,6 @@ interface Overloaded {
 type Intersection = ((data: string) => number) & ((id: number) => string);
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/prefer-function-type": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you specifically want to use an interface or type literal with a single call signature for stylistic reasons, you can disable this rule.

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

@@ -1,6 +1,10 @@
-# `prefer-includes`
+---
+description: 'Enforce `includes` method over `indexOf` method.'
+---
 
-Enforces `includes` method over `indexOf` method.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-includes** for documentation.
 
 Until ES5, we were using `String#indexOf` method to check whether a string contains an arbitrary substring or not.
 Until ES2015, we were using `Array#indexOf` method to check whether an array contains an arbitrary value or not.
@@ -70,19 +74,6 @@ userDefined.includes(value);
 mismatchExample.indexOf(value) >= 0;
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/prefer-includes": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you don't want to suggest `includes`, you can safely turn this rule off.