xo 0.46.4 → 0.49.0

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-loop-func.md

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

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-loss-of-precision.md

@@ -1,4 +1,6 @@
-# Disallow literal numbers that lose precision (`no-loss-of-precision`)
+# `no-loss-of-precision`
+
+Disallow literal numbers that lose precision.
 
 ## Rule Details
 
@@ -6,7 +8,7 @@ This rule extends the base [`eslint/no-loss-of-precision`](https://eslint.org/do
 It adds support for [numeric separators](https://github.com/tc39/proposal-numeric-separator).
 Note that this rule requires ESLint v7.
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -16,10 +18,16 @@ Note that this rule requires ESLint v7.
 }
 ```
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-loss-of-precision.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-loss-of-precision.md)
+
+</sup>
 
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [ ] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-magic-numbers.md

@@ -1,4 +1,6 @@
-# Disallow magic numbers (`no-magic-numbers`)
+# `no-magic-numbers`
+
+Disallow magic numbers.
 
 ## Rule Details
 
@@ -9,7 +11,7 @@ It adds support for:
 - `enum` members (`enum Foo { bar = 1 }`),
 - `readonly` class properties (`class Foo { readonly bar = 1 }`).
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -34,6 +36,7 @@ interface Options extends BaseNoMagicNumbersOptions {
   ignoreEnums?: boolean;
   ignoreNumericLiteralTypes?: boolean;
   ignoreReadonlyClassProperties?: boolean;
+  ignoreTypeIndexes?: boolean;
 }
 
 const defaultOptions: Options = {
@@ -41,6 +44,7 @@ const defaultOptions: Options = {
   ignoreEnums: false,
   ignoreNumericLiteralTypes: false,
   ignoreReadonlyClassProperties: false,
+  ignoreTypeIndexes: false,
 };
 ```
 
@@ -116,10 +120,38 @@ class Foo {
 }
 ```
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-magic-numbers.md)</sup>
+### `ignoreTypeIndexes`
+
+A boolean to specify if numbers used to index types are okay. `false` by default.
+
+Examples of **incorrect** code for the `{ "ignoreTypeIndexes": false }` option:
+
+```ts
+/*eslint @typescript-eslint/no-magic-numbers: ["error", { "ignoreTypeIndexes": false }]*/
+
+type Foo = Bar[0];
+type Baz = Parameters<Foo>[2];
+```
+
+Examples of **correct** code for the `{ "ignoreTypeIndexes": true }` option:
+
+```ts
+/*eslint @typescript-eslint/no-magic-numbers: ["error", { "ignoreTypeIndexes": true }]*/
+
+type Foo = Bar[0];
+type Baz = Parameters<Foo>[2];
+```
+
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-magic-numbers.md)
+
+</sup>
 
 ## Attributes
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [ ] 🔒 Strict
 - [ ] 🔧 Fixable
 - [ ] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-meaningless-void-operator.md

@@ -1,4 +1,6 @@
-# Disallow the `void` operator except when used to discard a value (`no-meaningless-void-operator`)
+# `no-meaningless-void-operator`
+
+Disallow the `void` operator except when used to discard a value.
 
 Disallow the `void` operator when its argument is already of type `void` or `undefined`.
 
@@ -8,7 +10,11 @@ The `void` operator is a useful tool to convey the programmer's intent to discar
 
 This rule helps an author catch API changes where previously a value was being discarded at a call site, but the callee changed so it no longer returns a value. When combined with [no-unused-expressions](https://eslint.org/docs/rules/no-unused-expressions), it also helps _readers_ of the code by ensuring consistency: a statement that looks like `void foo();` is **always** discarding a return value, and a statement that looks like `foo();` is **never** discarding a return value.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 void (() => {})();
@@ -17,7 +23,7 @@ function foo() {}
 void foo();
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 (() => {})();
@@ -32,7 +38,7 @@ function bar(x: number) {
 void bar(); // discarding a number
 ```
 
-### Options
+## Options
 
 This rule accepts a single object option with the following default configuration:
 
@@ -51,6 +57,8 @@ This rule accepts a single object option with the following default configuratio
 
 ## Attributes
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [x] 🔒 Strict
 - [x] 🔧 Fixable
 - [x] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-misused-new.md

@@ -1,10 +1,16 @@
-# Enforce valid definition of `new` and `constructor` (`no-misused-new`)
+# `no-misused-new`
+
+Enforce valid definition of `new` and `constructor`.
 
 Warns on apparent attempts to define constructors for interfaces or `new` for classes.
 
 ## Rule Details
 
-Examples of **incorrect** code for this rule.
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 class C {
@@ -17,7 +23,7 @@ interface I {
 }
 ```
 
-Examples of **correct** code for this rule.
+### ✅ Correct
 
 ```ts
 class C {
@@ -30,18 +36,25 @@ interface I {
 
 ## Options
 
-```json
+```jsonc
+// .eslintrc.json
 {
-  "@typescript-eslint/no-misused-new": "error"
+  "rules": {
+    "@typescript-eslint/no-misused-new": "error"
+  }
 }
 ```
 
-## Compatibility
+This rule is not configurable.
+
+## Related To
 
 - TSLint: [no-misused-new](https://palantir.github.io/tslint/rules/no-misused-new/)
 
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [ ] 💭 Requires type information

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

@@ -1,13 +1,113 @@
-# Avoid using promises in places not designed to handle them (`no-misused-promises`)
+# `no-misused-promises`
 
-This rule forbids using promises in places where the TypeScript compiler
-allows them but they are not handled properly. These situations can often arise
-due to a missing `await` keyword or just a misunderstanding of the way async
+Avoid using Promises in places not designed to handle them.
+
+This rule forbids providing Promises to logical locations such as if statements in places where the TypeScript compiler allows them but they are not handled properly.
+These situations can often arise due to a missing `await` keyword or just a misunderstanding of the way async
 functions are handled/awaited.
 
+:::tip
+`no-misused-promises` only detects code that provides Promises to incorrect _logical_ locations.
+See [`no-floating-promises`](./no-floating-promises.md) for detecting unhandled Promise _statements_.
+:::
+
 ## Rule Details
 
-Examples of **incorrect** code for this rule with `checksConditionals: true`:
+This rule accepts a single option which is an object with `checksConditionals`
+and `checksVoidReturn` properties indicating which types of misuse to flag.
+Both are enabled by default.
+
+## Options
+
+```ts
+type Options = [
+  {
+    checksConditionals?: boolean;
+    checksVoidReturn?: boolean | ChecksVoidReturnOptions;
+  },
+];
+
+interface ChecksVoidReturnOptions {
+  arguments?: boolean;
+  attributes?: boolean;
+  properties?: boolean;
+  returns?: boolean;
+  variables?: boolean;
+}
+
+const defaultOptions: Options = [
+  {
+    checksConditionals: true,
+    checksVoidReturn: true,
+  },
+];
+```
+
+### `"checksConditionals"`
+
+If you don't want to check conditionals, you can configure the rule with `"checksConditionals": false`:
+
+```json
+{
+  "@typescript-eslint/no-misused-promises": [
+    "error",
+    {
+      "checksConditionals": false
+    }
+  ]
+}
+```
+
+Doing so prevents the rule from looking at code like `if (somePromise)`.
+
+### `"checksVoidReturn"`
+
+Likewise, if you don't want functions that return promises where a void return is
+expected to be checked, your configuration will look like this:
+
+```json
+{
+  "@typescript-eslint/no-misused-promises": [
+    "error",
+    {
+      "checksVoidReturn": false
+    }
+  ]
+}
+```
+
+You can disable selective parts of the `checksVoidReturn` option by providing an object that disables specific checks.
+The following options are supported:
+
+- `arguments`: Disables checking an asynchronous function passed as argument where the parameter type expects a function that returns `void`
+- `attributes`: Disables checking an asynchronous function passed as a JSX attribute expected to be a function that returns `void`
+- `properties`: Disables checking an asynchronous function passed as an object property expected to be a function that returns `void`
+- `returns`: Disables checking an asynchronous function returned in a function whose return type is a function that returns `void`
+- `variables`: Disables checking an asynchronous function used as a variable whose return type is a function that returns `void`
+
+For example, if you don't mind that passing a `() => Promise<void>` to a `() => void` parameter or JSX attribute can lead to a floating unhandled Promise:
+
+```json
+{
+  "@typescript-eslint/no-misused-promises": [
+    "error",
+    {
+      "checksVoidReturn": {
+        "arguments": false,
+        "attributes": false
+      }
+    }
+  ]
+}
+```
+
+### `checksConditionals: true`
+
+Examples of code for this rule with `checksConditionals: true`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 const promise = Promise.resolve('value');
@@ -23,7 +123,7 @@ while (promise) {
 }
 ```
 
-Examples of **correct** code with `checksConditionals: true`:
+#### ✅ Correct
 
 ```ts
 const promise = Promise.resolve('value');
@@ -40,9 +140,15 @@ while (await promise) {
 }
 ```
 
----
+<!--/tabs-->
+
+### `checksVoidReturn: true`
+
+Examples of code for this rule with `checksVoidReturn: true`:
+
+<!--tabs-->
 
-Examples of **incorrect** code for this rule with `checksVoidReturn: true`:
+#### ❌ Incorrect
 
 ```ts
 [1, 2, 3].forEach(async value => {
@@ -62,7 +168,7 @@ eventEmitter.on('some-event', async () => {
 });
 ```
 
-Examples of **correct** code with `checksVoidReturn: true`:
+#### ✅ Correct
 
 ```ts
 // for-of puts `await` in outer context
@@ -104,55 +210,25 @@ eventEmitter.on('some-event', () => {
 });
 ```
 
-## Options
-
-This rule accepts a single option which is an object with `checksConditionals`
-and `checksVoidReturn` properties indicating which types of misuse to flag.
-Both are enabled by default
-
-If you don't want functions that return promises where a void return is
-expected to be checked, your configuration will look like this:
-
-```json
-{
-  "@typescript-eslint/no-misused-promises": [
-    "error",
-    {
-      "checksVoidReturn": false
-    }
-  ]
-}
-```
-
-Likewise, if you don't want to check conditionals, you can configure the rule
-like this:
-
-```json
-{
-  "@typescript-eslint/no-misused-promises": [
-    "error",
-    {
-      "checksConditionals": false
-    }
-  ]
-}
-```
+<!--/tabs-->
 
 ## When Not To Use It
 
 If you do not use Promises in your codebase or are not concerned with possible
 misuses of them outside of what the TypeScript compiler will check.
 
-## Related to
-
-- [`no-floating-promises`](./no-floating-promises.md)
-
 ## Further Reading
 
 - [TypeScript void function assignability](https://github.com/Microsoft/TypeScript/wiki/FAQ#why-are-functions-returning-non-void-assignable-to-function-returning-void)
 
+## Related To
+
+- [`no-floating-promises`](./no-floating-promises.md)
+
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [x] 💭 Requires type information

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

@@ -1,4 +1,6 @@
-# Disallow the use of custom TypeScript modules and namespaces (`no-namespace`)
+# `no-namespace`
+
+Disallow the use of custom TypeScript modules and namespaces.
 
 Custom TypeScript modules (`module foo {}`) and namespaces (`namespace foo {}`) are considered outdated
 ways to organize TypeScript code. ES2015 module syntax is now preferred (`import`/`export`).
@@ -18,7 +20,11 @@ or more of the following you may pass an object with the options set as follows:
 - `allowDefinitionFiles` set to `true` will allow you to `declare` and use custom TypeScript modules and namespaces
   inside definition files (Default: `true`).
 
-Examples of **incorrect** code for the default `{ "allowDeclarations": false, "allowDefinitionFiles": true }` options:
+Examples of code for the default `{ "allowDeclarations": false, "allowDefinitionFiles": true }` options:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 module foo {}
@@ -28,7 +34,7 @@ declare module foo {}
 declare namespace foo {}
 ```
 
-Examples of **correct** code for the default `{ "allowDeclarations": false, "allowDefinitionFiles": true }` options:
+### ✅ Correct
 
 ```ts
 declare module 'foo' {}
@@ -36,16 +42,22 @@ declare module 'foo' {}
 // anything inside a d.ts file
 ```
 
+<!--/tabs-->
+
 ### `allowDeclarations`
 
-Examples of **incorrect** code for the `{ "allowDeclarations": true }` option:
+Examples of code for the `{ "allowDeclarations": true }` option:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 module foo {}
 namespace foo {}
 ```
 
-Examples of **correct** code for the `{ "allowDeclarations": true }` option:
+#### ✅ Correct
 
 ```ts
 declare module 'foo' {}
@@ -61,7 +73,13 @@ declare module foo {
 }
 ```
 
-Examples of **incorrect** code for the `{ "allowDeclarations": false }` option:
+<!--/tabs-->
+
+Examples of code for the `{ "allowDeclarations": false }` option:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 module foo {}
@@ -70,7 +88,7 @@ declare module foo {}
 declare namespace foo {}
 ```
 
-Examples of **correct** code for the `{ "allowDeclarations": false }` option:
+#### ✅ Correct
 
 ```ts
 declare module 'foo' {}
@@ -78,7 +96,11 @@ declare module 'foo' {}
 
 ### `allowDefinitionFiles`
 
-Examples of **incorrect** code for the `{ "allowDefinitionFiles": true }` option:
+Examples of code for the `{ "allowDefinitionFiles": true }` option:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 // if outside a d.ts file
@@ -92,7 +114,7 @@ declare module foo {}
 declare namespace foo {}
 ```
 
-Examples of **correct** code for the `{ "allowDefinitionFiles": true }` option:
+#### ✅ Correct
 
 ```ts
 declare module 'foo' {}
@@ -110,12 +132,14 @@ If you are using the ES2015 module syntax, then you will not need this rule.
 - [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-namespace](https://palantir.github.io/tslint/rules/no-namespace/)
 
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [ ] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-non-null-asserted-nullish-coalescing.md

@@ -1,11 +1,17 @@
-# Disallows using a non-null assertion in the left operand of the nullish coalescing operator (`no-non-null-asserted-nullish-coalescing`)
+# `no-non-null-asserted-nullish-coalescing`
+
+Disallows using a non-null assertion in the left operand of the nullish coalescing operator.
 
 ## Rule Details
 
 The nullish coalescing operator is designed to provide a default value when dealing with `null` or `undefined`.
 Using non-null assertions in the left operand of the nullish coalescing operator is redundant.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 /* eslint @typescript-eslint/no-non-null-asserted-nullish-coalescing: "error" */
@@ -23,7 +29,7 @@ x = foo();
 x! ?? '';
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 /* eslint @typescript-eslint/no-non-null-asserted-nullish-coalescing: "error" */
@@ -39,6 +45,19 @@ let x: string;
 x! ?? '';
 ```
 
+## Options
+
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/no-non-null-asserted-nullish-coalescing": "warn"
+  }
+}
+```
+
+This rule is not configurable.
+
 ## When Not To Use It
 
 If you are not using TypeScript 3.7 (or greater), then you will not need to use this rule, as the nullish coalescing operator is not supported.
@@ -50,6 +69,8 @@ If you are not using TypeScript 3.7 (or greater), then you will not need to use
 
 ## Attributes
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [ ] 💭 Requires type information

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/no-non-null-asserted-optional-chain.md

@@ -1,11 +1,17 @@
-# Disallows using a non-null assertion after an optional chain expression (`no-non-null-asserted-optional-chain`)
+# `no-non-null-asserted-optional-chain`
+
+Disallows using a non-null assertion after an optional chain expression.
 
 ## Rule Details
 
 Optional chain expressions are designed to return `undefined` if the optional property is nullish.
 Using non-null assertions after an optional chain expression is wrong, and introduces a serious type safety hole into your code.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 /* eslint @typescript-eslint/no-non-null-asserted-optional-chain: "error" */
@@ -21,7 +27,7 @@ foo?.bar!();
 foo?.bar!().baz;
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 /* eslint @typescript-eslint/no-non-null-asserted-optional-chain: "error" */
@@ -38,6 +44,19 @@ foo?.bar!();
 foo?.bar!().baz;
 ```
 
+## Options
+
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/no-non-null-asserted-optional-chain": "error"
+  }
+}
+```
+
+This rule is not configurable.
+
 ## When Not To Use It
 
 If you are not using TypeScript 3.7 (or greater), then you will not need to use this rule, as the operator is not supported.
@@ -49,6 +68,8 @@ If you are not using TypeScript 3.7 (or greater), then you will not need to use
 
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [ ] 💭 Requires type information