xo 0.49.0 → 0.52.0

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

@@ -1,40 +1,20 @@
-# `indent`
+---
+description: 'Enforce consistent indentation.'
+---
 
-Enforce consistent indentation.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/indent** for documentation.
 
 ## Warning
 
-PLEASE READ THIS ISSUE BEFORE USING THIS RULE [#1824](https://github.com/typescript-eslint/typescript-eslint/issues/1824)
+:::warning
+
+Please read [Issue #1824: Problems with the indent rule](https://github.com/typescript-eslint/typescript-eslint/issues/1824) before using this rule!
+
+:::
 
 ## Rule Details
 
 This rule extends the base [`eslint/indent`](https://eslint.org/docs/rules/indent) rule.
 It adds support for TypeScript nodes.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "indent": "off",
-  "@typescript-eslint/indent": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/indent` options](https://eslint.org/docs/rules/indent#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/indent.md)
-
-</sup>
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,36 +1,12 @@
-# `init-declarations`
+---
+description: 'Require or disallow initialization in variable declarations.'
+---
 
-require or disallow initialization in variable declarations.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/init-declarations** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/init-declarations`](https://eslint.org/docs/rules/init-declarations) rule.
 It adds support for TypeScript's `declare` variables.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "init-declarations": "off",
-  "@typescript-eslint/init-declarations": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/init-declarations` options](https://eslint.org/docs/rules/init-declarations#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/init-declarations.md)
-
-</sup>
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,36 +1,12 @@
-# `keyword-spacing`
+---
+description: 'Enforce consistent spacing before and after keywords.'
+---
 
-Enforce consistent spacing before and after keywords.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/keyword-spacing** for documentation.
 
 ## Rule Details
 
 This rule extends the base [`eslint/keyword-spacing`](https://eslint.org/docs/rules/keyword-spacing) rule.
 This version adds support for generic type parameters on function calls.
-
-## How to Use
-
-```jsonc
-{
-  // note you must disable the base rule as it can report incorrect errors
-  "keyword-spacing": "off",
-  "@typescript-eslint/keyword-spacing": ["error"]
-}
-```
-
-## Options
-
-See [`eslint/keyword-spacing` options](https://eslint.org/docs/rules/keyword-spacing#options).
-
-<sup>
-
-Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/keyword-spacing.md)
-
-</sup>
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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.'
+---
 
-Require or disallow 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,17 +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>
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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.'
+---
 
-Require 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:
 
@@ -208,11 +212,3 @@ type FooBar = { name: string; greet(): string }
 ## When Not To Use It
 
 If you don't care about enforcing a consistent member delimiter in interfaces and type literals, then you will not need this rule.
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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.'
+---
 
-Require 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",
 
@@ -1159,15 +1184,3 @@ It is also possible to group different member types at the same rank.
 ## When Not To Use It
 
 If you don't care about the general order of your members, then you will not need this rule.
-
-## Related To
-
-- TSLint: [member-ordering](https://palantir.github.io/tslint/rules/member-ordering/)
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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.
 
@@ -104,11 +108,3 @@ type T2 = {
 ## When Not To Use It
 
 If you don't want to enforce a particular style for object/interface function types, and/or if you don't use `strictFunctionTypes`, then you don't need this rule.
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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`.
@@ -700,11 +704,3 @@ You can use the `destructured` modifier to match these names, and explicitly set
 ## When Not To Use It
 
 If you do not want to enforce naming conventions for anything.
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

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.'
+---
 
-Disallow 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,31 +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>
-
-## Attributes
-
-- Configs:
-  - [x] ✅ Recommended
-  - [x] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,12 @@
-# `no-base-to-string`
+---
+description: 'Require `.toString()` to only be called on objects which provide useful information when stringified.'
+---
 
-Requires that `.toString()` is only 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.
 
 JavaScript will call `toString()` on an object when it is converted to a string, such as when `+` adding to a string or in `${}` template literals.
 
@@ -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()`).
@@ -89,11 +85,3 @@ let text = `${value}`;
 If you don't mind `"[object Object]"` in your strings, then you will not need this rule.
 
 - [`Object.prototype.toString()` MDN documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/toString)
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [x] 🔒 Strict
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

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.'
+---
 
-Disallow 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.
@@ -61,11 +52,3 @@ If you don't care about this confusion, then you will not need this rule.
 ## Further Reading
 
 - [`Issue: Easy misunderstanding: "! ==="`](https://github.com/microsoft/TypeScript/issues/37837) in [TypeScript repo](https://github.com/microsoft/TypeScript)
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [x] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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.
@@ -147,15 +115,3 @@ console.log(void alert('Hello, world!'));
 The return type of a function can be inspected by going to its definition or hovering over it in an IDE.
 If you don't care about being explicit about the void type in actual code then don't use this rule.
 Also, if you prefer concise coding style then also don't use it.
-
-## Related To
-
-- TSLint: ['no-void-expression'](https://palantir.github.io/tslint/rules/no-void-expression/)
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,36 +1,12 @@
-# `no-dupe-class-members`
+---
+description: 'Disallow duplicate class members.'
+---
 
-Disallow 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>
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information