xo 0.46.4 → 0.49.0

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

@@ -1,8 +1,14 @@
-# Disallow extra non-null assertion (`no-extra-non-null-assertion`)
+# `no-extra-non-null-assertion`
+
+Disallow extra non-null assertion.
 
 ## Rule Details
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 const foo: { bar: number } | null = null;
@@ -21,7 +27,7 @@ function foo(bar?: { n: number }) {
 }
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 const foo: { bar: number } | null = null;
@@ -40,16 +46,23 @@ function foo(bar?: { n: number }) {
 }
 ```
 
-## How to use
+## Options
 
-```json
+```jsonc
+// .eslintrc.json
 {
-  "@typescript-eslint/no-extra-non-null-assertion": ["error"]
+  "rules": {
+    "@typescript-eslint/no-extra-non-null-assertion": "error"
+  }
 }
 ```
 
+This rule is not configurable.
+
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [x] 🔧 Fixable
 - [ ] 💭 Requires type information

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

@@ -1,11 +1,13 @@
-# Disallow unnecessary parentheses (`no-extra-parens`)
+# `no-extra-parens`
+
+Disallow unnecessary parentheses.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-extra-parens`](https://eslint.org/docs/rules/no-extra-parens) rule.
 It adds support for TypeScript type assertions.
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -19,10 +21,16 @@ It adds support for TypeScript type assertions.
 
 See [`eslint/no-extra-parens` options](https://eslint.org/docs/rules/no-extra-parens#options).
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-extra-parens.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-extra-parens.md)
+
+</sup>
 
 ## Attributes
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [ ] 🔒 Strict
 - [x] 🔧 Fixable
 - [ ] 💭 Requires type information

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

@@ -1,11 +1,13 @@
-# Disallow unnecessary semicolons (`no-extra-semi`)
+# `no-extra-semi`
+
+Disallow unnecessary semicolons.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-extra-semi`](https://eslint.org/docs/rules/no-extra-semi) rule.
 It adds support for class properties.
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -19,10 +21,16 @@ It adds support for class properties.
 
 See [`eslint/no-extra-semi` options](https://eslint.org/docs/rules/no-extra-semi#options).
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-extra-semi.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-extra-semi.md)
+
+</sup>
 
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [x] 🔧 Fixable
 - [ ] 💭 Requires type information

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

@@ -1,4 +1,6 @@
-# Forbids the use of classes as namespaces (`no-extraneous-class`)
+# `no-extraneous-class`
+
+Forbids the use of classes as namespaces.
 
 This rule warns when a class is accidentally used as a namespace.
 
@@ -9,7 +11,11 @@ From TSLint’s docs:
 > Users who come from a Java-style OO language may wrap their utility functions in an extra class,
 > instead of putting them at the top level.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 class EmptyClass {}
@@ -29,7 +35,7 @@ class StaticOnly {
 }
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 class EmptyClass extends SuperClass {}
@@ -46,7 +52,7 @@ const StaticOnly = {
 };
 ```
 
-### Options
+## Options
 
 This rule accepts a single object option.
 
@@ -75,12 +81,14 @@ const defaultOptions: Options = {
 You can disable this rule if you don’t have anyone who would make these kinds of mistakes on your
 team or if you use classes as namespaces.
 
-## Compatibility
+## Related To
 
 [`no-unnecessary-class`](https://palantir.github.io/tslint/rules/no-unnecessary-class/) from TSLint
 
 ## Attributes
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [ ] 💭 Requires type information

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

@@ -1,14 +1,30 @@
-# Requires Promise-like values to be handled appropriately (`no-floating-promises`)
+# `no-floating-promises`
 
-This rule forbids usage of Promise-like values in statements without handling
-their errors appropriately. Unhandled promises can cause several issues, such
-as improperly sequenced operations, ignored Promise rejections and more. Valid
-ways of handling a Promise-valued statement include `await`ing, returning, and
-either calling `.then()` with two arguments or `.catch()` with one argument.
+Requires Promise-like statements to be handled appropriately.
+
+A "floating" Promise is one that is created without any code set up to handle any errors it might throw.
+
+Floating Promises can cause several issues, such as improperly sequenced operations, ignored Promise rejections, and more.
+
+Valid ways of handling a Promise-valued statement include:
+
+- `await`ing it
+- `return`ing it
+- Calling its `.then()` with two arguments
+- Calling its `.catch()` with one argument
+
+:::tip
+`no-floating-promises` only detects unhandled Promise _statements_.
+See [`no-misused-promises`](./no-misused-promises.md) for detecting code that provides Promises to _logical_ locations such as if statements.
+:::
 
 ## Rule Details
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 const promise = new Promise((resolve, reject) => resolve('value'));
@@ -24,7 +40,7 @@ Promise.reject('value').catch();
 Promise.reject('value').finally();
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 const promise = new Promise((resolve, reject) => resolve('value'));
@@ -81,7 +97,7 @@ With this option set to `true`, and if you are using `no-void`, you should turn
 
 ### `ignoreIIFE`
 
-This allows you to skip checking of async iife
+This allows you to skip checking of async IIFEs (Immediately Invocated function Expressions).
 
 Examples of **correct** code for this rule with `{ ignoreIIFE: true }`:
 
@@ -99,12 +115,15 @@ await(async function () {
 
 If you do not use Promise-like values in your codebase, or want to allow them to remain unhandled.
 
-## Related to
+## Related To
 
+- [`no-misused-promises`](./no-misused-promises.md)
 - TSLint: ['no-floating-promises'](https://palantir.github.io/tslint/rules/no-floating-promises/)
 
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [x] 💭 Requires type information

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

@@ -1,4 +1,6 @@
-# Disallow iterating over an array with a for-in loop (`no-for-in-array`)
+# `no-for-in-array`
+
+Disallow iterating over an array with a for-in loop.
 
 This rule prohibits iterating over an array with a for-in loop.
 
@@ -19,7 +21,11 @@ for (const [index, value] of array.entries()) { ... }
 for (let i = 0; i < array.length; i++) { ... }
 ```
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```js
 for (const x in [3, 4, 5]) {
@@ -27,7 +33,7 @@ for (const x in [3, 4, 5]) {
 }
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```js
 for (const x in { a: 3, b: 4, c: 5 }) {
@@ -35,16 +41,31 @@ for (const x in { a: 3, b: 4, c: 5 }) {
 }
 ```
 
+## Options
+
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/no-for-in-array": "error"
+  }
+}
+```
+
+This rule is not configurable.
+
 ## When Not To Use It
 
 If you want to iterate through a loop using the indices in an array as strings, you can turn off this rule.
 
-## Related to
+## Related To
 
 - TSLint: ['no-for-in-array'](https://palantir.github.io/tslint/rules/no-for-in-array/)
 
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [x] 💭 Requires type information

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

@@ -1,16 +1,22 @@
-# Disallow usage of the implicit `any` type in catch clauses (`no-implicit-any-catch`)
+# `no-implicit-any-catch`
+
+Disallow usage of the implicit `any` type in catch clauses.
 
 TypeScript 4.0 added support for adding an explicit `any` or `unknown` type annotation on a catch clause variable.
 
 By default, TypeScript will type a catch clause variable as `any`, so explicitly annotating it as `unknown` can add a lot of safety to your codebase.
 
-The `noImplicitAny` flag in TypeScript does not cover this for backwards compatibility reasons.
+The `noImplicitAny` flag in TypeScript does not cover this for backwards compatibility reasons, however you can use `useUnknownInCatchVariables` (part of `strict`) instead of this rule.
 
 ## Rule Details
 
 This rule requires an explicit type to be declared on a catch clause variable.
 
-The following pattern is considered a warning:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 try {
@@ -20,7 +26,7 @@ try {
 }
 ```
 
-The following pattern is **_not_** considered a warning:
+### ✅ Correct
 
 <!-- TODO: prettier currently removes the type annotations, re-enable this once prettier is updated -->
 <!-- prettier-ignore-start -->
@@ -73,10 +79,12 @@ If you are not using TypeScript 4.0 (or greater), then you will not be able to u
 
 ## Further Reading
 
-- [TypeScript 4.0 Beta Release Notes](https://devblogs.microsoft.com/typescript/announcing-typescript-4-0-beta/#unknown-on-catch)
+- [TypeScript 4.0 Release Notes](https://devblogs.microsoft.com/typescript/announcing-typescript-4-0/#unknown-on-catch)
 
 ## Attributes
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [ ] 🔒 Strict
 - [x] 🔧 Fixable
 - [ ] 💭 Requires type information

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

@@ -1,4 +1,6 @@
-# Disallow the use of `eval()`-like methods (`no-implied-eval`)
+# `no-implied-eval`
+
+Disallow the use of `eval()`-like methods.
 
 It's considered a good practice to avoid using `eval()`. There are security and performance implications involved with doing so, which is why many linters recommend disallowing `eval()`. However, there are some other ways to pass a string and have it interpreted as JavaScript code that have similar concerns.
 
@@ -23,7 +25,11 @@ The best practice is to avoid using `new Function()` or `execScript()` and alway
 
 This rule aims to eliminate implied `eval()` through the use of `new Function()`, `setTimeout()`, `setInterval()`, `setImmediate()` or `execScript()`.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 /* eslint @typescript-eslint/no-implied-eval: "error" */
@@ -51,7 +57,7 @@ setTimeout(fn(), 100);
 const fn = new Function('a', 'b', 'return a + b');
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 /* eslint @typescript-eslint/no-implied-eval: "error" */
@@ -88,7 +94,7 @@ class Foo {
 setTimeout(Foo.fn, 100);
 ```
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -102,10 +108,16 @@ setTimeout(Foo.fn, 100);
 
 If you want to allow `new Function()` or `setTimeout()`, `setInterval()`, `setImmediate()` and `execScript()` with string arguments, then you can safely disable this rule.
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-implied-eval.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-implied-eval.md)
+
+</sup>
 
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [x] 💭 Requires type information

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

@@ -1,4 +1,6 @@
-# Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean (`no-inferrable-types`)
+# `no-inferrable-types`
+
+Disallows explicit type declarations for variables or parameters initialized to a number, string, or boolean.
 
 Explicit types where they can be easily inferred may add unnecessary verbosity.
 
@@ -22,14 +24,59 @@ interface Options {
 
 The default options are:
 
-```JSON
+```json
 {
   "ignoreParameters": false,
-  "ignoreProperties": false,
+  "ignoreProperties": false
+}
+```
+
+With these options, the following patterns are:
+
+<!--tabs-->
+
+#### ❌ Incorrect
+
+```ts
+const a: bigint = 10n;
+const a: bigint = -10n;
+const a: bigint = BigInt(10);
+const a: bigint = -BigInt(10);
+const a: boolean = false;
+const a: boolean = true;
+const a: boolean = Boolean(null);
+const a: boolean = !0;
+const a: number = 10;
+const a: number = +10;
+const a: number = -10;
+const a: number = Number('1');
+const a: number = +Number('1');
+const a: number = -Number('1');
+const a: number = Infinity;
+const a: number = +Infinity;
+const a: number = -Infinity;
+const a: number = NaN;
+const a: number = +NaN;
+const a: number = -NaN;
+const a: null = null;
+const a: RegExp = /a/;
+const a: RegExp = RegExp('a');
+const a: RegExp = new RegExp('a');
+const a: string = 'str';
+const a: string = `str`;
+const a: string = String(1);
+const a: symbol = Symbol('a');
+const a: undefined = undefined;
+const a: undefined = void someValue;
+
+class Foo {
+  prop: number = 5;
 }
+
+function fn(a: number = 5, b: boolean = true) {}
 ```
 
-With these options, the following patterns are valid:
+#### ✅ Correct
 
 ```ts
 const a = 10n;
@@ -72,46 +119,7 @@ function fn(a = 5, b = true) {}
 function fn(a: number, b: boolean, c: string) {}
 ```
 
-The following are invalid:
-
-```ts
-const a: bigint = 10n;
-const a: bigint = -10n;
-const a: bigint = BigInt(10);
-const a: bigint = -BigInt(10);
-const a: boolean = false;
-const a: boolean = true;
-const a: boolean = Boolean(null);
-const a: boolean = !0;
-const a: number = 10;
-const a: number = +10;
-const a: number = -10;
-const a: number = Number('1');
-const a: number = +Number('1');
-const a: number = -Number('1');
-const a: number = Infinity;
-const a: number = +Infinity;
-const a: number = -Infinity;
-const a: number = NaN;
-const a: number = +NaN;
-const a: number = -NaN;
-const a: null = null;
-const a: RegExp = /a/;
-const a: RegExp = RegExp('a');
-const a: RegExp = new RegExp('a');
-const a: string = 'str';
-const a: string = `str`;
-const a: string = String(1);
-const a: symbol = Symbol('a');
-const a: undefined = undefined;
-const a: undefined = void someValue;
-
-class Foo {
-  prop: number = 5;
-}
-
-function fn(a: number = 5, b: boolean = true) {}
-```
+<!--/tabs-->
 
 ### `ignoreParameters`
 
@@ -141,12 +149,14 @@ If you do not want to enforce inferred types.
 
 TypeScript [Inference](https://www.typescriptlang.org/docs/handbook/type-inference.html)
 
-## Compatibility
+## Related To
 
 TSLint: [no-inferrable-types](https://palantir.github.io/tslint/rules/no-inferrable-types/)
 
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [x] 🔧 Fixable
 - [ ] 💭 Requires type information

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

@@ -1,11 +1,13 @@
-# Disallow `this` keywords outside of classes or class-like objects (`no-invalid-this`)
+# `no-invalid-this`
+
+Disallow `this` keywords outside of classes or class-like objects.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-invalid-this`](https://eslint.org/docs/rules/no-invalid-this) rule.
 It adds support for TypeScript's `this` parameters.
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -23,10 +25,16 @@ See [`eslint/no-invalid-this` options](https://eslint.org/docs/rules/no-invalid-
 
 When you are indifferent as to how your variables are initialized.
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-invalid-this.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-invalid-this.md)
+
+</sup>
 
 ## Attributes
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [ ] 🔒 Strict
 - [ ] 🔧 Fixable
 - [ ] 💭 Requires type information

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

@@ -1,4 +1,6 @@
-# Disallows usage of `void` type outside of generic or return types (`no-invalid-void-type`)
+# `no-invalid-void-type`
+
+Disallows usage of `void` type outside of generic or return types.
 
 Disallows usage of `void` type outside of return types or generic type arguments.
 If `void` is used as return type, it shouldn’t be a part of intersection/union type with most other types.
@@ -14,7 +16,11 @@ If you need this - use the `undefined` type instead.
 
 This rule aims to ensure that the `void` type is only used in valid places.
 
-The following patterns are considered warnings:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 type PossibleValues = string | number | void;
@@ -35,7 +41,7 @@ class MyClass {
 }
 ```
 
-The following patterns are not considered warnings:
+### ✅ Correct
 
 ```ts
 type NoOp = () => void;
@@ -49,7 +55,7 @@ async function promiseMeSomething(): Promise<void> {}
 type stillVoid = void | never;
 ```
 
-### Options
+## Options
 
 ```ts
 interface Options {
@@ -63,7 +69,7 @@ const defaultOptions: Options = {
 };
 ```
 
-#### `allowInGenericTypeArguments`
+### `allowInGenericTypeArguments`
 
 This option lets you control if `void` can be used as a valid value for generic type parameters.
 
@@ -99,7 +105,7 @@ type AllowedVoid = Ex.Mx.Tx<void>;
 type AllowedVoidUnion = void | Ex.Mx.Tx<void>;
 ```
 
-#### `allowAsThisParameter`
+### `allowAsThisParameter`
 
 This option allows specifying a `this` parameter of a function to be `void` when set to `true`.
 This pattern can be useful to explicitly label function types that do not use a `this` argument. [See the TypeScript docs for more information](https://www.typescriptlang.org/docs/handbook/functions.html#this-parameters-in-callbacks).
@@ -121,12 +127,14 @@ class Example {
 If you don't care about if `void` is used with other types,
 or in invalid places, then you don't need this rule.
 
-## Compatibility
+## Related To
 
 - TSLint: [invalid-void](https://palantir.github.io/tslint/rules/invalid-void/)
 
 ## Attributes
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [ ] 💭 Requires type information