xo 0.51.0 → 0.52.0

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/lines-between-class-members.md

@@ -1,31 +1,21 @@
-# `lines-between-class-members`
+---
+description: 'Require or disallow an empty line between class members.'
+---
 
-Requires or disallows an empty line between class members.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/lines-between-class-members** for documentation.
 
-This rule improves readability by enforcing lines between class members. It will not check empty lines before the first member and after the last member. This rule require or disallow an empty line between class members.
+This rule improves readability by enforcing lines between class members. It will not check empty lines before the first member and after the last member. This rule will require or disallow an empty line between class members.
 
 ## Rule Details
 
 This rule extends the base [`eslint/lines-between-class-members`](https://eslint.org/docs/rules/lines-between-class-members) rule.
 It adds support for ignoring overload methods in a class.
 
-See the [ESLint documentation](https://eslint.org/docs/rules/lines-between-class-members) for more details on the `lines-between-class-members` rule.
-
-## Rule Changes
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "lines-between-class-members": "off",
-  "@typescript-eslint/lines-between-class-members": ["error"]
-}
-```
-
-In addition to the options supported by the `lines-between-class-members` rule in ESLint core, the rule adds the following options:
-
 ## Options
 
-This rule has a string option and an object option.
+In addition to the options supported by the `lines-between-class-members` rule in ESLint core, the rule adds the following options:
 
 - Object option:
 
@@ -71,9 +61,3 @@ class foo {
   qux() {}
 }
 ```
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/lines-between-class-members.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/member-delimiter-style.md

@@ -1,6 +1,10 @@
-# `member-delimiter-style`
+---
+description: 'Require a specific member delimiter style for interfaces and type literals.'
+---
 
-Requires a specific member delimiter style for interfaces and type literals.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/member-delimiter-style** for documentation.
 
 Enforces a consistent member delimiter style in interfaces and type literals. There are three member delimiter styles primarily used in TypeScript:
 

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

@@ -1,6 +1,10 @@
-# `member-ordering`
+---
+description: 'Require a consistent member declaration order.'
+---
 
-Requires a consistent member declaration order.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/member-ordering** for documentation.
 
 A consistent ordering of fields, methods and constructors can make interfaces, type literals, classes and class expressions easier to read, navigate, and edit.
 
@@ -40,7 +44,7 @@ You can configure `OrderConfig` options for:
 
 The `OrderConfig` settings for each kind of construct may configure sorting on one or both two levels:
 
-- **`memberType`**: organizing on member type groups such as methods vs. properties
+- **`memberTypes`**: organizing on member type groups such as methods vs. properties
 - **`order`**: organizing based on member names, such as alphabetically
 
 ### Groups
@@ -94,6 +98,9 @@ The default configuration looks as follows:
 
     "field",
 
+    // Static initialization
+    "static-initialization",
+
     // Constructors
     "public-constructor",
     "protected-constructor",
@@ -908,6 +915,9 @@ The most explicit and granular form is the following:
   "protected-abstract-field",
   "private-abstract-field",
 
+  // Static initialization
+  "static-initialization",
+
   // Constructors
   "public-constructor",
   "protected-constructor",
@@ -1006,6 +1016,9 @@ It is also possible to group member types by their accessibility (`static`, `ins
   "protected-field", // = ["protected-static-field", "protected-instance-field"]
   "private-field", // = ["private-static-field", "private-instance-field"]
 
+  // Static initialization
+  // No accessibility for static initialization.
+
   // Constructors
   // Only the accessibility of constructors is configurable. See below.
 
@@ -1043,6 +1056,9 @@ their accessibility.
 
   "decorated-field", // = ["public-decorated-field", "protected-decorated-field", "private-decorated-field"]
 
+  // Static initialization
+  // No decorators for static initialization.
+
   // Constructors
   // There are no decorators for constructors.
 
@@ -1051,14 +1067,14 @@ their accessibility.
   "protected-decorated-get",
   "private-decorated-get",
 
-  "decorated-get" // = ["public-decorated-get", "protected-decorated-get", "private-decorated-get"]
+  "decorated-get", // = ["public-decorated-get", "protected-decorated-get", "private-decorated-get"]
 
   // Setters
   "public-decorated-set",
   "protected-decorated-set",
   "private-decorated-set",
 
-  "decorated-set" // = ["public-decorated-set", "protected-decorated-set", "private-decorated-set"]
+  "decorated-set", // = ["public-decorated-set", "protected-decorated-set", "private-decorated-set"]
 
   // Methods
   "public-decorated-method",
@@ -1083,18 +1099,21 @@ Another option is to group the member types by their scope (`public`, `protected
   "instance-field", // = ["public-instance-field", "protected-instance-field", "private-instance-field"]
   "abstract-field", // = ["public-abstract-field", "protected-abstract-field", "private-abstract-field"]
 
+  // Static initialization
+  // No scope for static initialization.
+
   // Constructors
   "constructor", // = ["public-constructor", "protected-constructor", "private-constructor"]
 
   // Getters
   "static-get", // = ["public-static-get", "protected-static-get", "private-static-get"]
   "instance-get", // = ["public-instance-get", "protected-instance-get", "private-instance-get"]
-  "abstract-get" // = ["public-abstract-get", "protected-abstract-get", "private-abstract-get"]
+  "abstract-get", // = ["public-abstract-get", "protected-abstract-get", "private-abstract-get"]
 
   // Setters
   "static-set", // = ["public-static-set", "protected-static-set", "private-static-set"]
   "instance-set", // = ["public-instance-set", "protected-instance-set", "private-instance-set"]
-  "abstract-set" // = ["public-abstract-set", "protected-abstract-set", "private-abstract-set"]
+  "abstract-set", // = ["public-abstract-set", "protected-abstract-set", "private-abstract-set"]
 
   // Methods
   "static-method", // = ["public-static-method", "protected-static-method", "private-static-method"]
@@ -1116,15 +1135,18 @@ The third grouping option is to ignore both scope and accessibility.
   "field", // = ["public-static-field", "protected-static-field", "private-static-field", "public-instance-field", "protected-instance-field", "private-instance-field",
   //              "public-abstract-field", "protected-abstract-field", private-abstract-field"]
 
+  // Static initialization
+  // No grouping for static initialization.
+
   // Constructors
   // Only the accessibility of constructors is configurable.
 
   // Getters
-  "get" // = ["public-static-get", "protected-static-get", "private-static-get", "public-instance-get", "protected-instance-get", "private-instance-get",
+  "get", // = ["public-static-get", "protected-static-get", "private-static-get", "public-instance-get", "protected-instance-get", "private-instance-get",
   //                "public-abstract-get", "protected-abstract-get", "private-abstract-get"]
 
   // Setters
-  "set" // = ["public-static-set", "protected-static-set", "private-static-set", "public-instance-set", "protected-instance-set", "private-instance-set",
+  "set", // = ["public-static-set", "protected-static-set", "private-static-set", "public-instance-set", "protected-instance-set", "private-instance-set",
   //                "public-abstract-set", "protected-abstract-set", "private-abstract-set"]
 
   // Methods
@@ -1145,6 +1167,9 @@ It is also possible to group different member types at the same rank.
   // Fields
   "field",
 
+  // Static initialization
+  "static-initialization",
+
   // Constructors
   "constructor",
 

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/method-signature-style.md

@@ -1,6 +1,10 @@
-# `method-signature-style`
+---
+description: 'Enforce using a particular method signature syntax.'
+---
 
-Enforces using a particular method signature syntax.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/method-signature-style** for documentation.
 
 There are two ways to define an object/interface function property.
 

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

@@ -1,6 +1,10 @@
-# `naming-convention`
+---
+description: 'Enforce naming conventions for everything across a codebase.'
+---
 
-Enforces naming conventions for everything across a codebase.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/naming-convention** for documentation.
 
 Enforcing naming conventions helps keep the codebase consistent, and reduces overhead when thinking about how to name a variable.
 Additionally, a well-designed style guide can help communicate intent, such as by enforcing all private properties begin with an `_`, and all global-level constants are written in `UPPER_CASE`.

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

@@ -1,6 +1,10 @@
-# `no-array-constructor`
+---
+description: 'Disallow generic `Array` constructors.'
+---
 
-Disallows generic `Array` constructors.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-array-constructor** for documentation.
 
 ## Rule Details
 
@@ -29,23 +33,3 @@ new Array<Foo>(x, y, z);
 Array(500);
 new Array(someOtherArray.length);
 ```
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-array-constructor": "off",
-  "@typescript-eslint/no-array-constructor": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/no-array-constructor` options](https://eslint.org/docs/rules/no-array-constructor#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-array-constructor.md)
-
-</sup>

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-base-to-string.md

@@ -1,4 +1,10 @@
-# `no-base-to-string`
+---
+description: 'Require `.toString()` to only be called on objects which provide useful information when stringified.'
+---
+
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-base-to-string** for documentation.
 
 Requires `.toString()` to only be called on objects which provide useful information when stringified.
 
@@ -58,16 +64,6 @@ const literalWithToString = {
 
 ## Options
 
-```ts
-type Options = {
-  ignoredTypeNames?: string[];
-};
-
-const defaultOptions: Options = {
-  ignoredTypeNames: ['RegExp'],
-};
-```
-
 ### `ignoredTypeNames`
 
 A string array of type names to ignore, this is useful for types missing `toString()` (but actually has `toString()`).

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

@@ -1,6 +1,10 @@
-# `no-confusing-non-null-assertion`
+---
+description: 'Disallow non-null assertion in locations that may be confusing.'
+---
 
-Disallows non-null assertion in locations that may be confusing.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-confusing-non-null-assertion** for documentation.
 
 ## Rule Details
 
@@ -41,19 +45,6 @@ const isEqualsBar = foo.bar == 'hello';
 const isEqualsNum = (1 + foo.num!) == 2;
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-confusing-non-null-assertion": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you don't care about this confusion, then you will not need this rule.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-confusing-void-expression.md

@@ -1,6 +1,10 @@
-# `no-confusing-void-expression`
+---
+description: 'Require expressions of type void to appear in statement position.'
+---
 
-Requires expressions of type void to appear in statement position.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-confusing-void-expression** for documentation.
 
 Returning the results of an expression whose type is void can be misleading.
 Attempting to do so is likely a symptom of expecting a different return type from a function.
@@ -66,33 +70,8 @@ cond ? console.log('true') : console.error('false');
 
 ## Options
 
-An object option can be specified. Each boolean flag makes the rule less strict.
-
-```ts
-type Options = {
-  ignoreArrowShorthand?: boolean;
-  ignoreVoidOperator?: boolean;
-};
-
-const defaults: Options = {
-  ignoreArrowShorthand: false,
-  ignoreVoidOperator: false,
-};
-```
-
 ### `ignoreArrowShorthand`
 
-`false` by default.
-
-```json
-{
-  "@typescript-eslint/no-confusing-void-expression": [
-    "error",
-    { "ignoreArrowShorthand": true }
-  ]
-}
-```
-
 It might be undesirable to wrap every arrow function shorthand expression with braces.
 Especially when using Prettier formatter, which spreads such code across 3 lines instead of 1.
 
@@ -104,17 +83,6 @@ promise.then(value => window.postMessage(value));
 
 ### `ignoreVoidOperator`
 
-`false` by default.
-
-```json
-{
-  "@typescript-eslint/no-confusing-void-expression": [
-    "error",
-    { "ignoreVoidOperator": true }
-  ]
-}
-```
-
 It might be preferable to only use some distinct syntax
 to explicitly mark the confusing but valid usage of void expressions.
 This option allows void expressions which are explicitly wrapped in the `void` operator.

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

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

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-duplicate-enum-values.md

@@ -1,6 +1,10 @@
-# `no-duplicate-enum-values`
+---
+description: 'Disallow duplicate enum member values.'
+---
 
-Disallows duplicate enum member values.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-duplicate-enum-values** for documentation.
 
 Although TypeScript supports duplicate enum member values, people usually expect members to have unique values within the same enum. Duplicate values can lead to bugs that are hard to track down.
 
@@ -21,8 +25,8 @@ enum E {
 
 ```ts
 enum E {
-  A = 'A'
-  B = 'A'
+  A = 'A',
+  B = 'A',
 }
 ```
 
@@ -37,20 +41,7 @@ enum E {
 
 ```ts
 enum E {
-  A = 'A'
-  B = 'B'
+  A = 'A',
+  B = 'B',
 }
 ```
-
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-duplicate-enum-values": "warn"
-  }
-}
-```
-
-This rule is not configurable.

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

@@ -1,32 +1,12 @@
-# `no-duplicate-imports`
+---
+description: 'Disallow duplicate imports.'
+---
 
-Disallows duplicate imports.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-duplicate-imports** for documentation.
 
-## DEPRECATED
+:::danger Deprecated
 
 This rule has been deprecated in favour of the [`import/no-duplicates`](https://github.com/import-js/eslint-plugin-import/blob/HEAD/docs/rules/no-duplicates.md) rule.
-
-## Rule Details
-
-This rule extends the base [`eslint/no-duplicate-imports`](https://eslint.org/docs/rules/no-duplicate-imports) rule.
-This version adds support for type-only import and export.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-duplicate-imports": "off",
-  "@typescript-eslint/no-duplicate-imports": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/no-duplicate-imports` options](https://eslint.org/docs/rules/no-duplicate-imports#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-duplicate-imports.md)
-
-</sup>
+:::

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

@@ -1,6 +1,10 @@
-# `no-dynamic-delete`
+---
+description: 'Disallow using the `delete` operator on computed key expressions.'
+---
 
-Disallows using the `delete` operator on computed key expressions.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-dynamic-delete** for documentation.
 
 Deleting dynamically computed keys can be dangerous and in some cases not well optimized.
 
@@ -40,19 +44,6 @@ delete container[7];
 delete container['-Infinity'];
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/no-dynamic-delete": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 When you know your keys are safe to delete, this rule can be unnecessary.

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

@@ -1,6 +1,10 @@
-# `no-empty-function`
+---
+description: 'Disallow empty functions.'
+---
 
-Disallows empty functions.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-empty-function** for documentation.
 
 ## Rule Details
 
@@ -9,19 +13,8 @@ It adds support for handling TypeScript specific code that would otherwise trigg
 
 One example of valid TypeScript specific code that would otherwise trigger the `no-empty-function` rule is the use of [parameter properties](https://www.typescriptlang.org/docs/handbook/classes.html#parameter-properties) in constructor functions.
 
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-empty-function": "off",
-  "@typescript-eslint/no-empty-function": ["error"]
-}
-```
-
 ## Options
 
-See [`eslint/no-empty-function` options](https://eslint.org/docs/rules/no-empty-function#options).
 This rule adds the following options:
 
 ```ts
@@ -93,19 +86,3 @@ class Foo extends Base {
   protected override greet(): void {}
 }
 ```
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "no-empty-function": "off",
-  "@typescript-eslint/no-empty-function": ["error"]
-}
-```
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-empty-function.md)
-
-</sup>

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

@@ -1,6 +1,10 @@
-# `no-empty-interface`
+---
+description: 'Disallow the declaration of empty interfaces.'
+---
 
-Disallows the declaration of empty interfaces.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-empty-interface** for documentation.
 
 An empty interface is equivalent to its supertype. If the interface does not implement a supertype, then
 the interface is equivalent to an empty object (`{}`). In both cases it can be omitted.

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

@@ -1,6 +1,10 @@
-# `no-explicit-any`
+---
+description: 'Disallow the `any` type.'
+---
 
-Disallows the `any` type.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/no-explicit-any** for documentation.
 
 Using the `any` type defeats the purpose of using TypeScript.
 When `any` is used, all compiler type checks around that value are ignored.
@@ -93,22 +97,6 @@ function greet(param: Array<string>): Array<string> {}
 
 ## Options
 
-The rule accepts an options object with the following properties:
-
-```ts
-type Options = {
-  // if true, auto-fixing will be made available in which the "any" type is converted to an "unknown" type
-  fixToUnknown: boolean;
-  // specify if arrays from the rest operator are considered okay
-  ignoreRestArgs: boolean;
-};
-
-const defaults = {
-  fixToUnknown: false,
-  ignoreRestArgs: false,
-};
-```
-
 ### `ignoreRestArgs`
 
 A boolean to specify if arrays from the rest operator are considered okay. `false` by default.