xo 0.47.0 → 0.48.0

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

@@ -1,11 +1,13 @@
-# Disallow the use of variables before they are defined (`no-use-before-define`)
+# `no-use-before-define`
+
+Disallow the use of variables before they are defined.
 
 ## 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
+## How to Use
 
 ```jsonc
 {
@@ -40,7 +42,11 @@ const defaultOptions: Options = {
 If this is `true`, this rule warns every reference to a enum before the enum declaration.
 If this is `false`, this rule will ignore references to enums, when the reference is in a child scope.
 
-Examples of **incorrect** code for the `{ "enums": true }` option:
+Examples of code for the `{ "enums": true }` option:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 /*eslint no-use-before-define: ["error", { "enums": true }]*/
@@ -52,7 +58,7 @@ enum Foo {
 }
 ```
 
-Examples of **correct** code for the `{ "enums": false }` option:
+#### ✅ Correct
 
 ```ts
 /*eslint no-use-before-define: ["error", { "enums": false }]*/
@@ -101,7 +107,11 @@ enum Enum {}
 
 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/master/docs/rules/no-use-before-define.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-use-before-define.md)
+
+</sup>
 
 ## Attributes
 

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

@@ -1,4 +1,6 @@
-# Disallow unnecessary constructors (`no-useless-constructor`)
+# `no-useless-constructor`
+
+Disallow unnecessary constructors.
 
 ## Rule Details
 
@@ -9,7 +11,7 @@ It adds support for:
 - `public` constructors when there is no superclass,
 - constructors with only parameter properties.
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -23,7 +25,16 @@ It adds support for:
 
 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/master/docs/rules/no-useless-constructor.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-useless-constructor.md)
+
+</sup>
+
+## 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.
 
 ## Attributes
 

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

@@ -1,10 +1,16 @@
-# Disallows the use of require statements except in import statements (`no-var-requires`)
+# `no-var-requires`
+
+Disallows the use of require statements except in import statements.
 
 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.
 
 ## Rule Details
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 var foo = require('foo');
@@ -12,7 +18,7 @@ const foo = require('foo');
 let foo = require('foo');
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 import foo = require('foo');
@@ -20,11 +26,24 @@ 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.
 
-## Compatibility
+## Related To
 
 - TSLint: [no-var-requires](https://palantir.github.io/tslint/rules/no-var-requires/)
 

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

@@ -1,10 +1,16 @@
-# Prefers a non-null assertion over explicit type cast when possible (`non-nullable-type-assertion-style`)
+# `non-nullable-type-assertion-style`
+
+Prefers a non-null assertion over explicit type cast when possible.
 
 This rule detects when an `as` cast is doing the same job as a `!` would, and suggests fixing the code to be an `!`.
 
 ## Rule Details
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 const maybe = Math.random() > 0.5 ? '' : undefined;
@@ -13,7 +19,7 @@ const definitely = maybe as string;
 const alsoDefinitely = <string>maybe;
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 const maybe = Math.random() > 0.5 ? '' : undefined;

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

@@ -1,11 +1,13 @@
-# Enforce consistent spacing inside braces (`object-curly-spacing`)
+# `object-curly-spacing`
+
+Enforce consistent spacing inside braces.
 
 ## 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
+## How to Use
 
 ```jsonc
 {
@@ -19,7 +21,11 @@ It adds support for TypeScript's object types.
 
 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/master/docs/rules/object-curly-spacing.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/object-curly-spacing.md)
+
+</sup>
 
 ## Attributes
 

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

@@ -1,4 +1,6 @@
-# require or disallow padding lines between statements (`padding-line-between-statements`)
+# `padding-line-between-statements`
+
+require or disallow padding lines between statements.
 
 ## Rule Details
 
@@ -6,7 +8,7 @@ This rule extends the base [`eslint/padding-line-between-statements`](https://es
 
 **It adds support for TypeScript constructs such as `interface` and `type`.**
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -47,7 +49,11 @@ In addition to options provided by ESLint, `interface` and `type` can be used as
 
 **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/master/docs/rules/padding-line-between-statements.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/padding-line-between-statements.md)
+
+</sup>
 
 ## Attributes
 

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

@@ -1,10 +1,16 @@
-# Prefer usage of `as const` over literal type (`prefer-as-const`)
+# `prefer-as-const`
+
+Prefer usage of `as const` over literal type.
 
 This rule recommends usage of `const` assertion when type primitive value is equal to type.
 
 ## Rule Details
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 let bar: 2 = 2;
@@ -12,7 +18,7 @@ let foo = <'bar'>'bar';
 let foo = { bar: 'baz' as 'baz' };
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 let foo = 'bar';
@@ -23,6 +29,21 @@ let foo = <string>'bar';
 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,4 +1,6 @@
-# Prefer initializing each enums member value (`prefer-enum-initializers`)
+# `prefer-enum-initializers`
+
+Prefer initializing each enums member value.
 
 This rule recommends having each `enum`s member value explicitly initialized.
 
@@ -25,7 +27,11 @@ enum Status {
 }
 ```
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 enum Status {
@@ -45,7 +51,7 @@ enum Color {
 }
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 enum Status {

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

@@ -1,4 +1,6 @@
-# Prefer a ‘for-of’ loop over a standard ‘for’ loop if the index is only used to access the array being iterated (`prefer-for-of`)
+# `prefer-for-of`
+
+Prefer a ‘for-of’ loop over a standard ‘for’ loop if the index is only used to access the array being iterated.
 
 This rule recommends a for-of loop when the loop index is only used to read from an array that is being iterated.
 
@@ -6,7 +8,11 @@ This rule recommends a for-of loop when the loop index is only used to read from
 
 For cases where the index is only used to read from the array being iterated, a for-of loop is easier to read and write.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```js
 for (let i = 0; i < arr.length; i++) {
@@ -14,7 +20,7 @@ for (let i = 0; i < arr.length; i++) {
 }
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```js
 for (const x of arr) {
@@ -36,7 +42,7 @@ for (let i = 0; i < arr.length; i++) {
 
 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
+## Related To
 
 - TSLint: ['prefer-for-of'](https://palantir.github.io/tslint/rules/prefer-for-of/)
 

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

@@ -1,10 +1,16 @@
-# Use function types instead of interfaces with call signatures (`prefer-function-type`)
+# `prefer-function-type`
+
+Use function types instead of interfaces with call signatures.
 
 ## Rule Details
 
 This rule suggests using a function type instead of an interface or object type literal with a single call signature.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 interface Foo {
@@ -31,7 +37,7 @@ interface MixinMethod {
 }
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 interface Foo {

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

@@ -1,4 +1,6 @@
-# Enforce `includes` method over `indexOf` method (`prefer-includes`)
+# `prefer-includes`
+
+Enforce `includes` method over `indexOf` method.
 
 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.
@@ -15,7 +17,11 @@ There are such types: `String`, `Array`, `ReadonlyArray`, and typed arrays.
 
 Additionally, this rule reports the tests of simple regular expressions in favor of `String#includes`.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 let str: string;
@@ -39,7 +45,7 @@ userDefined.indexOf(value) >= 0;
 /foo/.test(str);
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 let array: any[];

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

@@ -1,4 +1,6 @@
-# Require that all enum members be literal values to prevent unintended enum member name shadow issues (`prefer-literal-enum-member`)
+# `prefer-literal-enum-member`
+
+Require that all enum members be literal values to prevent unintended enum member name shadow issues.
 
 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:
 
@@ -25,7 +27,11 @@ This rule is meant to prevent unexpected results in code by requiring the use of
 
 - `allowBitwiseExpressions` set to `true` will allow you to use bitwise expressions in enum initializer (Default: `false`).
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 const str = 'Test';
@@ -38,7 +44,7 @@ enum Invalid {
 }
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 enum Valid {
@@ -50,9 +56,15 @@ enum Valid {
 }
 ```
 
+<!--/tabs-->
+
 ### `allowBitwiseExpressions`
 
-Examples of **incorrect** code for the `{ "allowBitwiseExpressions": true }` option:
+Examples of code for the `{ "allowBitwiseExpressions": true }` option:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 const x = 1;
@@ -67,7 +79,7 @@ enum Foo {
 }
 ```
 
-Examples of **correct** code for the `{ "allowBitwiseExpressions": true }` option:
+#### ✅ Correct
 
 ```ts
 enum Foo {

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

@@ -1,4 +1,6 @@
-# Require the use of the `namespace` keyword instead of the `module` keyword to declare custom TypeScript modules (`prefer-namespace-keyword`)
+# `prefer-namespace-keyword`
+
+Require the use of the `namespace` keyword instead of the `module` keyword to declare custom TypeScript modules.
 
 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.
@@ -11,13 +13,26 @@ 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)
 
-## Compatibility
+## Related To
 
 - TSLint: [no-internal-module](https://palantir.github.io/tslint/rules/no-internal-module/)
 

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

@@ -1,4 +1,6 @@
-# Enforce the usage of the nullish coalescing operator instead of logical chaining (`prefer-nullish-coalescing`)
+# `prefer-nullish-coalescing`
+
+Enforce the usage of the nullish coalescing operator instead of logical chaining.
 
 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`.

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

@@ -1,4 +1,6 @@
-# Prefer using concise optional chain expressions instead of chained logical ands (`prefer-optional-chain`)
+# `prefer-optional-chain`
+
+Prefer using concise optional chain expressions instead of chained logical ands.
 
 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`.
@@ -44,7 +46,11 @@ Because the optional chain operator _only_ chains when the property value is `nu
 
 This rule aims enforce the usage of the safer operator.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 foo && foo.a && foo.a.b && foo.a.b.c;
@@ -60,7 +66,7 @@ foo &&
   foo.a.b.c.d.e;
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 foo?.a?.b?.c;

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

@@ -1,4 +1,6 @@
-# Requires that function parameters are typed as readonly to prevent accidental mutation of inputs (`prefer-readonly-parameter-types`)
+# `prefer-readonly-parameter-types`
+
+Requires that function parameters are typed as readonly to prevent accidental mutation of inputs.
 
 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.
@@ -15,7 +17,11 @@ A type is considered readonly if:
 - it is a readonly tuple type whose elements are all considered readonly.
 - it is an object type whose properties are all marked as readonly, and whose values are all considered readonly.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 function array1(arg: string[]) {} // array is not readonly
@@ -57,7 +63,7 @@ interface Foo {
 }
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 function array1(arg: readonly string[]) {}
@@ -139,7 +145,11 @@ const defaultOptions: Options = {
 This option allows you to enable or disable the checking of parameter properties.
 Because parameter properties create properties on the class, it may be undesirable to force them to be readonly.
 
-Examples of **incorrect** code for this rule with `{checkParameterProperties: true}`:
+Examples of code for this rule with `{checkParameterProperties: true}`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 class Foo {
@@ -147,7 +157,7 @@ class Foo {
 }
 ```
 
-Examples of **correct** code for this rule with `{checkParameterProperties: true}`:
+#### ✅ Correct
 
 ```ts
 class Foo {
@@ -155,6 +165,8 @@ class Foo {
 }
 ```
 
+<!--/tabs-->
+
 Examples of **correct** code for this rule with `{checkParameterProperties: false}`:
 
 ```ts
@@ -170,7 +182,11 @@ class Foo {
 
 This option allows you to ignore parameters which don't explicitly specify a type. This may be desirable in cases where an external dependency specifies a callback with mutable parameters, and manually annotating the callback's parameters is undesirable.
 
-Examples of **incorrect** code for this rule with `{ignoreInferredTypes: true}`:
+Examples of code for this rule with `{ignoreInferredTypes: true}`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 import { acceptsCallback, CallbackOptions } from 'external-dependency';
@@ -193,7 +209,7 @@ export const acceptsCallback: AcceptsCallback;
 
 </details>
 
-Examples of **correct** code for this rule with `{ignoreInferredTypes: true}`:
+#### ✅ Correct
 
 ```ts
 import { acceptsCallback } from 'external-dependency';
@@ -220,7 +236,11 @@ export const acceptsCallback: AcceptsCallback;
 
 This option allows you to treat all mutable methods as though they were readonly. This may be desirable in when you are never reassigning methods.
 
-Examples of **incorrect** code for this rule with `{treatMethodsAsReadonly: false}`:
+Examples of code for this rule with `{treatMethodsAsReadonly: false}`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 type MyType = {
@@ -230,7 +250,7 @@ type MyType = {
 function foo(arg: MyType) {}
 ```
 
-Examples of **correct** code for this rule with `{treatMethodsAsReadonly: false}`:
+#### ✅ Correct
 
 ```ts
 type MyType = Readonly<{
@@ -246,6 +266,8 @@ type MyOtherType = {
 function bar(arg: MyOtherType) {}
 ```
 
+<!--/tabs-->
+
 Examples of **correct** code for this rule with `{treatMethodsAsReadonly: true}`:
 
 ```ts