xo 0.49.0 → 0.52.0

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

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.'
+---
 
-Require or disallow the use of 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.
@@ -482,15 +486,3 @@ class Foo {
 ## When Not To Use It
 
 If you don't care about the using parameter properties in constructors, then you will not need this rule.
-
-## Related To
-
-- TSLint: [no-parameter-properties](https://palantir.github.io/tslint/rules/no-parameter-properties/)
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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

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.'
+---
 
-Prefer initializing each enums member value.
+> 🛑 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,27 +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.
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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.'
+---
 
-Prefer a ‘for-of’ loop over a standard ‘for’ loop if the index is only used to access the array being iterated.
+> 🛑 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,31 +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.
-
-## Related To
-
-- TSLint: ['prefer-for-of'](https://palantir.github.io/tslint/rules/prefer-for-of/)
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [x] 🔒 Strict
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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.'
+---
 
-Use 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,31 +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.
-
-## Further Reading
-
-- TSLint: [`callable-types`](https://palantir.github.io/tslint/rules/callable-types/)
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [x] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

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

@@ -1,6 +1,10 @@
-# `prefer-literal-enum-member`
+---
+description: 'Require all enum members to be literal values.'
+---
 
-Require that all enum members be literal values to prevent unintended enum member name shadow issues.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-literal-enum-member** for documentation.
 
 TypeScript allows the value of an enum member to be many different kinds of valid JavaScript expressions. However, because enums create their own scope whereby each enum member becomes a variable in that scope, unexpected values could be used at runtime. Example:
 
@@ -96,11 +100,3 @@ enum Foo {
 ## When Not To Use It
 
 If you want use anything other than simple literals as an enum value.
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [x] 🔒 Strict
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,10 @@
-# `prefer-namespace-keyword`
+---
+description: 'Require using `namespace` keyword over `module` keyword to declare custom TypeScript modules.'
+---
 
-Require the use of the `namespace` keyword instead of the `module` keyword to declare custom TypeScript modules.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-namespace-keyword** for documentation.
 
 In an effort to prevent further confusion between custom TypeScript modules and the new ES2015 modules, starting
 with TypeScript `v1.5` the keyword `namespace` is now the preferred way to declare custom TypeScript modules.
@@ -13,33 +17,8 @@ This rule aims to standardize the way modules are declared.
 
 If you are using the ES2015 module syntax, then you will not need this rule.
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/prefer-namespace-keyword": "error"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## Further Reading
 
 - [Modules](https://www.typescriptlang.org/docs/handbook/modules.html)
 - [Namespaces](https://www.typescriptlang.org/docs/handbook/namespaces.html)
 - [Namespaces and Modules](https://www.typescriptlang.org/docs/handbook/namespaces-and-modules.html)
-
-## Related To
-
-- TSLint: [no-internal-module](https://palantir.github.io/tslint/rules/no-internal-module/)
-
-## Attributes
-
-- Configs:
-  - [x] ✅ Recommended
-  - [x] 🔒 Strict
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,6 +1,10 @@
-# `prefer-nullish-coalescing`
+---
+description: 'Enforce using the nullish coalescing operator instead of logical chaining.'
+---
 
-Enforce the usage of the nullish coalescing operator instead of logical chaining.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-nullish-coalescing** for documentation.
 
 TypeScript 3.7 added support for the nullish coalescing operator.
 This operator allows you to safely cascade a value when dealing with `null` or `undefined`.
@@ -46,6 +50,7 @@ This rule aims enforce the usage of the safer operator.
 ```ts
 type Options = [
   {
+    ignoreTernaryTests?: boolean;
     ignoreConditionalTests?: boolean;
     ignoreMixedLogicalExpressions?: boolean;
   },
@@ -53,12 +58,53 @@ type Options = [
 
 const defaultOptions = [
   {
+    ignoreTernaryTests: true;
     ignoreConditionalTests: true,
     ignoreMixedLogicalExpressions: true,
   },
 ];
 ```
 
+### `ignoreTernaryTests`
+
+Setting this option to `true` (the default) will cause the rule to ignore any ternary expressions that could be simplified by using the nullish coalescing operator.
+
+Incorrect code for `ignoreTernaryTests: false`, and correct code for `ignoreTernaryTests: true`:
+
+```ts
+const foo: any = 'bar';
+foo !== undefined && foo !== null ? foo : 'a string';
+foo === undefined || foo === null ? 'a string' : foo;
+foo == undefined ? 'a string' : foo;
+foo == null ? 'a string' : foo;
+
+const foo: string | undefined = 'bar';
+foo !== undefined ? foo : 'a string';
+foo === undefined ? 'a string' : foo;
+
+const foo: string | null = 'bar';
+foo !== null ? foo : 'a string';
+foo === null ? 'a string' : foo;
+```
+
+Correct code for `ignoreTernaryTests: false`:
+
+```ts
+const foo: any = 'bar';
+foo ?? 'a string';
+foo ?? 'a string';
+foo ?? 'a string';
+foo ?? 'a string';
+
+const foo: string | undefined = 'bar';
+foo ?? 'a string';
+foo ?? 'a string';
+
+const foo: string | null = 'bar';
+foo ?? 'a string';
+foo ?? 'a string';
+```
+
 ### `ignoreConditionalTests`
 
 Setting this option to `true` (the default) will cause the rule to ignore any cases that are located within a conditional test.
@@ -141,11 +187,3 @@ If you are not using TypeScript 3.7 (or greater), then you will not be able to u
 
 - [TypeScript 3.7 Release Notes](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html)
 - [Nullish Coalescing Operator Proposal](https://github.com/tc39/proposal-nullish-coalescing/)
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [x] 🔒 Strict
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,6 +1,10 @@
-# `prefer-optional-chain`
+---
+description: 'Enforce using concise optional chain expressions instead of chained logical ands, negated logical ors, or empty objects.'
+---
 
-Prefer using concise optional chain expressions instead of chained logical ands.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-optional-chain** for documentation.
 
 TypeScript 3.7 added support for the optional chain operator.
 This operator allows you to safely access properties and methods on objects when they are potentially `null` or `undefined`.
@@ -61,8 +65,14 @@ foo && foo.a && foo.a.b && foo.a.b.c;
 foo && foo['a'] && foo['a'].b && foo['a'].b.c;
 foo && foo.a && foo.a.b && foo.a.b.method && foo.a.b.method();
 
-(((foo || {}).a || {}).b {}).c;
-(((foo || {})['a'] || {}).b {}).c;
+// With empty objects
+(((foo || {}).a || {}).b || {}).c;
+(((foo || {})['a'] || {}).b || {}).c;
+
+// With negated `or`s
+!foo || !foo.bar;
+!foo || !foo[bar];
+!foo || !foo.bar || !foo.bar.baz || !foo.bar.baz();
 
 // this rule also supports converting chained strict nullish checks:
 foo &&
@@ -81,22 +91,13 @@ foo?.['a']?.b?.c;
 foo?.a?.b?.method?.();
 
 foo?.a?.b?.c?.d?.e;
-```
-
-**Note:** there are a few edge cases where this rule will false positive. Use your best judgement when evaluating reported errors.
-
-## Options
 
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/prefer-optional-chain": "warn"
-  }
-}
+!foo?.bar;
+!foo?.[bar];
+!foo?.bar?.baz?.();
 ```
 
-This rule is not configurable.
+**Note:** there are a few edge cases where this rule will false positive. Use your best judgement when evaluating reported errors.
 
 ## When Not To Use It
 
@@ -106,11 +107,3 @@ If you are not using TypeScript 3.7 (or greater), then you will not be able to u
 
 - [TypeScript 3.7 Release Notes](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html)
 - [Optional Chaining Proposal](https://github.com/tc39/proposal-optional-chaining/)
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [x] 🔒 Strict
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-readonly-parameter-types.md

@@ -1,6 +1,10 @@
-# `prefer-readonly-parameter-types`
+---
+description: 'Require function parameters to be typed as `readonly` to prevent accidental mutation of inputs.'
+---
 
-Requires that function parameters are typed as readonly to prevent accidental mutation of inputs.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-readonly-parameter-types** for documentation.
 
 Mutating function arguments can lead to confusing, hard to debug behavior.
 Whilst it's easy to implicitly remember to not modify function arguments, explicitly typing arguments as readonly provides clear contract to consumers.
@@ -127,19 +131,6 @@ interface Foo {
 
 ## Options
 
-```ts
-interface Options {
-  checkParameterProperties?: boolean;
-  ignoreInferredTypes?: boolean;
-}
-
-const defaultOptions: Options = {
-  checkParameterProperties: true,
-  ignoreInferredTypes: false,
-  treatMethodsAsReadonly: false,
-};
-```
-
 ### `checkParameterProperties`
 
 This option allows you to enable or disable the checking of parameter properties.
@@ -191,7 +182,7 @@ Examples of code for this rule with `{ignoreInferredTypes: true}`:
 ```ts
 import { acceptsCallback, CallbackOptions } from 'external-dependency';
 
-acceceptsCallback((options: CallbackOptions) => {});
+acceptsCallback((options: CallbackOptions) => {});
 ```
 
 <details>
@@ -214,7 +205,7 @@ export const acceptsCallback: AcceptsCallback;
 ```ts
 import { acceptsCallback } from 'external-dependency';
 
-acceceptsCallback(options => {});
+acceptsCallback(options => {});
 ```
 
 <details>
@@ -277,11 +268,3 @@ type MyType = {
 };
 function foo(arg: MyType) {}
 ```
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,6 +1,10 @@
-# `prefer-readonly`
+---
+description: "Require private members to be marked as `readonly` if they're never modified outside of the constructor."
+---
 
-Requires that private members are marked as `readonly` if they're never modified outside of the constructor.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-readonly** for documentation.
 
 This rule enforces that private members are marked as `readonly` if they're never modified outside of the constructor.
 
@@ -52,8 +56,6 @@ class Container {
 
 ## Options
 
-This rule, in its default state, does not require any argument.
-
 ### `onlyInlineLambdas`
 
 You may pass `"onlyInlineLambdas": true` as a rule option within an object to restrict checking only to members immediately assigned a lambda value.
@@ -85,15 +87,3 @@ class Container {
   private neverModifiedPrivate = 'unchanged';
 }
 ```
-
-## Related To
-
-- TSLint: ['prefer-readonly'](https://palantir.github.io/tslint/rules/prefer-readonly)
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [ ] 🔒 Strict
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,6 +1,10 @@
-# `prefer-reduce-type-parameter`
+---
+description: 'Enforce using type parameter when calling `Array#reduce` instead of casting.'
+---
 
-Prefer using type parameter when calling `Array#reduce` instead of casting.
+> 🛑 This file is source code, not the primary documentation location! 🛑
+>
+> See **https://typescript-eslint.io/rules/prefer-reduce-type-parameter** for documentation.
 
 It's common to call `Array#reduce` with a generic type, such as an array or object, as the initial value.
 Since these values are empty, their types are not usable:
@@ -51,27 +55,6 @@ Examples of code for this rule:
 );
 ```
 
-## Options
-
-```jsonc
-// .eslintrc.json
-{
-  "rules": {
-    "@typescript-eslint/prefer-reduce-type-parameter": "warn"
-  }
-}
-```
-
-This rule is not configurable.
-
 ## When Not To Use It
 
 If you don't want to use typechecking in your linting, you can't use this rule.
-
-## Attributes
-
-- Configs:
-  - [ ] ✅ Recommended
-  - [x] 🔒 Strict
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information