xo 0.51.0 → 0.52.0

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-non-null-asserted-nullish-coalescing.md

@@ -1,6 +1,10 @@
-# `no-non-null-asserted-nullish-coalescing`
+---
+description: 'Disallow non-null assertions in the left operand of a nullish coalescing operator.'
+---
 
-Disallows non-null assertions in the left operand of a nullish coalescing operator.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-non-null-asserted-nullish-coalescing** for documentation.
 
 ## Rule Details
 
@@ -45,19 +49,6 @@ let x: string;
 x! ?? '';
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-non-null-asserted-nullish-coalescing": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you are not using TypeScript 3.7 (or greater), then you will not need to use this rule, as the nullish coalescing operator is not supported.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-non-null-asserted-optional-chain.md

@@ -1,6 +1,10 @@
-# `no-non-null-asserted-optional-chain`
+---
+description: 'Disallow non-null assertions after an optional chain expression.'
+---
 
-Disallows non-null assertions after an optional chain expression.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-non-null-asserted-optional-chain** for documentation.
 
 ## Rule Details
 
@@ -44,19 +48,6 @@ foo?.bar!();
 foo?.bar!().baz;
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-non-null-asserted-optional-chain": "error"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you are not using TypeScript 3.7 (or greater), then you will not need to use this rule, as the operator is not supported.

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

@@ -1,6 +1,10 @@
-# `no-non-null-assertion`
+---
+description: 'Disallow non-null assertions using the `!` postfix operator.'
+---
 
-Disallows non-null assertions using the `!` postfix operator.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-non-null-assertion** for documentation.
 
 ## Rule Details
 
@@ -32,19 +36,6 @@ const foo: Foo = getFoo();
 const includesBaz: boolean = foo.bar?.includes('baz') ?? false;
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-non-null-assertion": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you don't care about strict null-checking, then you will not need this rule.

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

@@ -1,6 +1,15 @@
-# `no-parameter-properties`
+---
+description: 'Disallow the use of parameter properties in class constructors.'
+---
 
-Disallows the use of parameter properties in class constructors.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-parameter-properties** for documentation.
+
+:::danger Deprecated
+
+This rule has been deprecated in favour of the equivalent, better named [`parameter-properties`](./parameter-properties) rule.
+:::
 
 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/no-redeclare.md

@@ -1,25 +1,18 @@
-# `no-redeclare`
+---
+description: 'Disallow variable redeclaration.'
+---
 
-Disallows variable redeclaration.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-redeclare** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-redeclare`](https://eslint.org/docs/rules/no-redeclare) rule.
 It adds support for TypeScript function overloads, and declaration merging.
 
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-redeclare": "off",
-  "@typescript-eslint/no-redeclare": ["error"]
-}
-```
-
 ## Options
 
-See [`eslint/no-redeclare` options](https://eslint.org/docs/rules/no-redeclare#options).
 This rule adds the following options:
 
 ```ts
@@ -78,9 +71,3 @@ type something = string;
 // eslint-disable-next-line @typescript-eslint/no-redeclare -- intentionally naming the variable the same as the type
 const something = 2;
 ```
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-redeclare.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-redundant-type-constituents.md

@@ -1,6 +1,10 @@
-# `no-redundant-type-constituents`
+---
+description: 'Disallow members of unions and intersections that do nothing or override type information.'
+---
 
-Disallows members of unions and intersections that do nothing or override type information.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-redundant-type-constituents** for documentation.
 
 ## Rule Details
 
@@ -66,19 +70,6 @@ type IntersectionStringLiteral = 'foo';
 type ReturnUnionNever = () => string | never;
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-redundant-type-constituents": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## Limitations
 
 This rule plays it safe and only works with bottom types, top types, and comparing literal types to primitive types.

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

@@ -1,6 +1,10 @@
-# `no-require-imports`
+---
+description: 'Disallow invocation of `require()`.'
+---
 
-Disallows invocation of `require()`.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-require-imports** for documentation.
 
 Prefer the newer ES6-style imports over `require()`.
 
@@ -31,19 +35,6 @@ import lib9 = lib2.anotherSubImport;
 import lib10 from 'lib10';
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-require-imports": "warn"
-  }
-}
-```
-
-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/no-restricted-imports.md

@@ -1,24 +1,17 @@
-# `no-restricted-imports`
+---
+description: 'Disallow specified modules when loaded by `import`.'
+---
 
-Disallows specified modules when loaded by `import`.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-restricted-imports** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-restricted-imports`](https://eslint.org/docs/rules/no-restricted-imports) rule.
 
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-restricted-imports": "off",
-  "@typescript-eslint/no-restricted-imports": ["error"]
-}
-```
-
 ## Options
 
-See [`eslint/no-restricted-imports` options](https://eslint.org/docs/rules/no-restricted-imports#options).
 This rule adds the following options:
 
 ### `allowTypeImports`

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

@@ -1,25 +1,18 @@
-# `no-shadow`
+---
+description: 'Disallow variable declarations from shadowing variables declared in the outer scope.'
+---
 
-Disallows variable declarations from shadowing variables declared in the outer scope.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-shadow** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-shadow`](https://eslint.org/docs/rules/no-shadow) rule.
 It adds support for TypeScript's `this` parameters and global augmentation, and adds options for TypeScript features.
 
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-shadow": "off",
-  "@typescript-eslint/no-shadow": ["error"]
-}
-```
-
 ## Options
 
-See [`eslint/no-shadow` options](https://eslint.org/docs/rules/no-shadow#options).
 This rule adds the following options:
 
 ```ts
@@ -85,9 +78,3 @@ Examples of **correct** code with `{ ignoreFunctionTypeParameterNameValueShadow:
 const test = 1;
 type Func = (test: string) => typeof test;
 ```
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-shadow.md)
-
-</sup>

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

@@ -1,6 +1,10 @@
-# `no-this-alias`
+---
+description: 'Disallow aliasing `this`.'
+---
 
-Disallows aliasing `this`.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-this-alias** for documentation.
 
 This rule prohibits assigning variables to `this`.
 
@@ -35,22 +39,6 @@ Examples of **correct** code for this rule:
 
 (see the rationale above)
 
-## Options
-
-You can pass an object option:
-
-```jsonc
-{
-  "@typescript-eslint/no-this-alias": [
-    "error",
-    {
-      "allowDestructuring": false, // Disallow `const { props, state } = this`; true by default
-      "allowedNames": ["self"] // Allow `const self = this`; `[]` by default
-    }
-  ]
-}
-```
-
 ## When Not To Use It
 
 If you need to assign `this` to variables, you shouldn’t use this rule.

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

@@ -1,6 +1,10 @@
-# `no-throw-literal`
+---
+description: 'Disallow throwing literals as exceptions.'
+---
 
-Disallows throwing literals as exceptions.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-throw-literal** for documentation.
 
 It is considered good practice to only `throw` the `Error` object itself or an object using the `Error` object as base objects for user-defined exceptions.
 The fundamental benefit of `Error` objects is that they automatically keep track of where they were built and originated.
@@ -85,34 +89,26 @@ class CustomError extends Error {
 throw new CustomError();
 ```
 
-## How to Use
+## Options
 
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-throw-literal": "off",
-  "@typescript-eslint/no-throw-literal": ["error"]
-}
-```
+This rule adds the following options:
 
-### Options
-
-```jsonc
-{
-  "@typescript-eslint/no-throw-literal": [
-    "error",
-    {
-      "allowThrowingAny": true, // Default is to allow throwing values of type any
-      "allowThrowingUnknown": true // Default is to allow throwing values of type unknown
-    }
-  ]
+```ts
+interface Options extends BaseNoShadowOptions {
+  /**
+   * Whether to always allow throwing values typed as `any`.
+   */
+  allowThrowingAny?: boolean;
+
+  /**
+   * Whether to always allow throwing values typed as `unknown`.
+   */
+  allowThrowingUnknown?: boolean;
 }
-```
 
----
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-throw-literal.md)
-
-</sup>
+const defaultOptions: Options = {
+  ...baseNoShadowDefaultOptions,
+  allowThrowingAny: false,
+  allowThrowingUnknown: false,
+};
+```

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

@@ -1,6 +1,10 @@
-# `no-type-alias`
+---
+description: 'Disallow type aliases.'
+---
 
-Disallows type aliases.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-type-alias** for documentation.
 
 In TypeScript, type aliases serve three purposes:
 
@@ -81,18 +85,6 @@ and simplified types (primitives, tuples, unions, intersections, etc).
 
 ## 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:
-
-- `allowAliases` set to `"always"` will allow you to do aliasing (Defaults to `"never"`).
-- `allowCallbacks` set to `"always"` will allow you to use type aliases with callbacks (Defaults to `"never"`)
-- `allowConditionalTypes` set to `"always"` will allow you to use type aliases with conditional types (Defaults to `"never"`)
-- `allowConstructors` set to `"always"` will allow you to use type aliases with constructors (Defaults to `"never"`)
-- `allowLiterals` set to `"always"` will allow you to use type aliases with literal objects (Defaults to `"never"`)
-- `allowMappedTypes` set to `"always"` will allow you to use type aliases as mapping tools (Defaults to `"never"`)
-- `allowTupleTypes` set to `"always"` will allow you to use type aliases with tuples (Defaults to `"never"`)
-- `allowGenerics` set to `"always"` will allow you to use type aliases with generics (Defaults to `"never"`)
-
 ### `allowAliases`
 
 This applies to primitive types and reference types.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-unnecessary-boolean-literal-compare.md

@@ -1,6 +1,10 @@
-# `no-unnecessary-boolean-literal-compare`
+---
+description: 'Disallow unnecessary equality comparisons against boolean literals.'
+---
 
-Disallows unnecessary equality comparisons against boolean literals.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-unnecessary-boolean-literal-compare** for documentation.
 
 Comparing boolean values to boolean literals is unnecessary, those comparisons result in the same booleans. Using the boolean values directly, or via a unary negation (`!value`), is more concise and clearer.
 
@@ -50,30 +54,10 @@ if (someStringBoolean === true) {
 
 ## Options
 
-The rule accepts an options object with the following properties.
-
-```ts
-type Options = {
-  // if false, comparisons between a nullable boolean variable to `true` will be checked and fixed
-  allowComparingNullableBooleansToTrue?: boolean;
-  // if false, comparisons between a nullable boolean variable to `false` will be checked and fixed
-  allowComparingNullableBooleansToFalse?: boolean;
-};
-```
-
-### Defaults
-
 This rule always checks comparisons between a boolean variable and a boolean
 literal. Comparisons between nullable boolean variables and boolean literals
 are **not** checked by default.
 
-```ts
-const defaults = {
-  allowComparingNullableBooleansToTrue: true,
-  allowComparingNullableBooleansToFalse: true,
-};
-```
-
 ### `allowComparingNullableBooleansToTrue`
 
 Examples of code for this rule with `{ allowComparingNullableBooleansToTrue: false }`:

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

@@ -1,6 +1,10 @@
-# `no-unnecessary-condition`
+---
+description: 'Disallow conditionals where the type is always truthy or always falsy.'
+---
 
-Disallows conditionals where the type is always truthy or always falsy.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-unnecessary-condition** for documentation.
 
 Any expression being used as a condition must be able to evaluate as truthy or falsy in order to be considered "necessary". Conversely, any expression that always evaluates to truthy or always evaluates to falsy, as determined by the type of the expression, is considered unnecessary and will be flagged by this rule.
 
@@ -70,20 +74,6 @@ function bar(arg?: string | null) {
 
 ## Options
 
-```ts
-type Options = {
-  // if true, the rule will ignore constant loop conditions
-  allowConstantLoopConditions?: boolean;
-  // if true, the rule will not error when running with a tsconfig that has strictNullChecks turned **off**
-  allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing?: boolean;
-};
-
-const defaultOptions: Options = {
-  allowConstantLoopConditions: false,
-  allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing: false,
-};
-```
-
 ### `allowConstantLoopConditions`
 
 Example of correct code for `{ allowConstantLoopConditions: true }`:

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

@@ -1,6 +1,10 @@
-# `no-unnecessary-qualifier`
+---
+description: 'Disallow unnecessary namespace qualifiers.'
+---
 
-Disallows unnecessary namespace qualifiers.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-unnecessary-qualifier** for documentation.
 
 ## Rule Details
 
@@ -76,19 +80,6 @@ namespace X {
 }
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-unnecessary-qualifier": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you don't care about having unneeded namespace or enum qualifiers, then you don't need to use this rule.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-unnecessary-type-arguments.md

@@ -1,6 +1,10 @@
-# `no-unnecessary-type-arguments`
+---
+description: 'Disallow type arguments that are equal to the default.'
+---
 
-Disallows type arguments that are equal to the default.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-unnecessary-type-arguments** for documentation.
 
 Warns if an explicitly specified type argument is the default for that type parameter.
 
@@ -53,16 +57,3 @@ class D extends C<string> {}
 interface I<T = number> {}
 class Impl implements I<string> {}
 ```
-
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-unnecessary-type-arguments": "warn"
-  }
-}
-```
-
-This rule is not configurable.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-unnecessary-type-assertion.md

@@ -1,6 +1,10 @@
-# `no-unnecessary-type-assertion`
+---
+description: 'Disallow type assertions that do not change the type of an expression.'
+---
 
-Disallows type assertions that do not change the type of an expression.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-unnecessary-type-assertion** for documentation.
 
 This rule prohibits using a type assertion that does not change the type of an expression.
 
@@ -61,9 +65,9 @@ function foo(x: number | undefined): number {
 
 ## Options
 
-This rule optionally takes an object with a single property `typesToIgnore`, which can be set to a list of type names to ignore.
+### `typesToIgnore`
 
-For example, with `@typescript-eslint/no-unnecessary-type-assertion: ["error", { typesToIgnore: ['Foo'] }]`, the following is **correct** code":
+With `@typescript-eslint/no-unnecessary-type-assertion: ["error", { typesToIgnore: ['Foo'] }]`, the following is **correct** code":
 
 ```ts
 type Foo = 3;

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-unnecessary-type-constraint.md

@@ -1,6 +1,10 @@
-# `no-unnecessary-type-constraint`
+---
+description: 'Disallow unnecessary constraints on generic types.'
+---
 
-Disallows unnecessary constraints on generic types.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-unnecessary-type-constraint** for documentation.
 
 ## Rule Details
 
@@ -56,19 +60,6 @@ const Quux = <T>() => {};
 function Quuz<T>() {}
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-unnecessary-type-constraint": "error"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you don't care about the specific styles of your type constraints, or never use them in the first place, then you will not need this rule.

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

@@ -1,6 +1,10 @@
-# `no-unsafe-argument`
+---
+description: 'Disallow calling a function with a value with type `any`.'
+---
 
-Disallows calling a function with a value with type `any`.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-unsafe-argument** for documentation.
 
 Despite your best intentions, the `any` type can sometimes leak into your codebase.
 Call a function with `any` typed argument are not checked at all by TypeScript, so it creates a potential safety hole, and source of bugs in your codebase.
@@ -71,19 +75,6 @@ declare function foo(arg1: unknown, arg2: Set<unkown>, arg3: unknown[]): void;
 foo(1 as any, new Set<any>(), [] as any[]);
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-unsafe-argument": "error"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## Related To
 
 - [`no-explicit-any`](./no-explicit-any.md)