xo 0.47.0 → 0.48.0

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,7 +132,7 @@ 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/)
 

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" */

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.

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

@@ -1,10 +1,16 @@
-# Disallows non-null assertions using the `!` postfix operator (`no-non-null-assertion`)
+# `no-non-null-assertion`
+
+Disallows non-null assertions using the `!` postfix operator.
 
 ## Rule Details
 
 Using non-null assertions cancels the benefits of the strict null-checking mode.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 interface Foo {
@@ -15,7 +21,7 @@ const foo: Foo = getFoo();
 const includesBaz: boolean = foo.bar!.includes('baz');
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 interface Foo {
@@ -26,6 +32,19 @@ const foo: Foo = getFoo();
 const includesBaz: boolean = foo.bar?.includes('baz') ?? false;
 ```
 
+## Options
+
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/no-non-null-assertion": "warn"
+  }
+}
+```
+
+This rule is not configurable.
+
 ## When Not To Use It
 
 If you don't care about strict null-checking, then you will not need this rule.

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

@@ -1,4 +1,6 @@
-# Disallow the use of parameter properties in class constructors (`no-parameter-properties`)
+# `no-parameter-properties`
+
+Disallow the use of parameter properties in class constructors.
 
 Parameter properties can be confusing to those new to TypeScript as they are less explicit than other ways
 of declaring and initializing class members.
@@ -24,7 +26,11 @@ If you would like to allow certain types of parameter properties then you may pa
 
 ### default
 
-Examples of **incorrect** code for this rule with no options at all:
+Examples of code for this rule with no options at all:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 class Foo {
@@ -56,7 +62,7 @@ class Foo {
 }
 ```
 
-Examples of **correct** code for this rule with no options at all:
+#### ✅ Correct
 
 ```ts
 class Foo {
@@ -66,7 +72,11 @@ class Foo {
 
 ### readonly
 
-Examples of **incorrect** code for the `{ "allows": ["readonly"] }` options:
+Examples of code for the `{ "allows": ["readonly"] }` options:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 class Foo {
@@ -94,7 +104,7 @@ class Foo {
 }
 ```
 
-Examples of **correct** code for the `{ "allows": ["readonly"] }` options:
+#### ✅ Correct
 
 ```ts
 class Foo {
@@ -108,7 +118,11 @@ class Foo {
 
 ### private
 
-Examples of **incorrect** code for the `{ "allows": ["private"] }` options:
+Examples of code for the `{ "allows": ["private"] }` options:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 class Foo {
@@ -136,7 +150,7 @@ class Foo {
 }
 ```
 
-Examples of **correct** code for the `{ "allows": ["private"] }` options:
+#### ✅ Correct
 
 ```ts
 class Foo {
@@ -150,7 +164,11 @@ class Foo {
 
 ### protected
 
-Examples of **incorrect** code for the `{ "allows": ["protected"] }` options:
+Examples of code for the `{ "allows": ["protected"] }` options:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 class Foo {
@@ -178,7 +196,7 @@ class Foo {
 }
 ```
 
-Examples of **correct** code for the `{ "allows": ["protected"] }` options:
+#### ✅ Correct
 
 ```ts
 class Foo {
@@ -192,7 +210,11 @@ class Foo {
 
 ### public
 
-Examples of **incorrect** code for the `{ "allows": ["public"] }` options:
+Examples of code for the `{ "allows": ["public"] }` options:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 class Foo {
@@ -220,7 +242,7 @@ class Foo {
 }
 ```
 
-Examples of **correct** code for the `{ "allows": ["public"] }` options:
+#### ✅ Correct
 
 ```ts
 class Foo {
@@ -234,7 +256,11 @@ class Foo {
 
 ### private readonly
 
-Examples of **incorrect** code for the `{ "allows": ["private readonly"] }` options:
+Examples of code for the `{ "allows": ["private readonly"] }` options:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 class Foo {
@@ -262,7 +288,7 @@ class Foo {
 }
 ```
 
-Examples of **correct** code for the `{ "allows": ["private readonly"] }` options:
+#### ✅ Correct
 
 ```ts
 class Foo {
@@ -276,7 +302,11 @@ class Foo {
 
 ### protected readonly
 
-Examples of **incorrect** code for the `{ "allows": ["protected readonly"] }` options:
+Examples of code for the `{ "allows": ["protected readonly"] }` options:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 class Foo {
@@ -304,7 +334,7 @@ class Foo {
 }
 ```
 
-Examples of **correct** code for the `{ "allows": ["protected readonly"] }` options:
+#### ✅ Correct
 
 ```ts
 class Foo {
@@ -318,7 +348,11 @@ class Foo {
 
 ### public readonly
 
-Examples of **incorrect** code for the `{ "allows": ["public readonly"] }` options:
+Examples of code for the `{ "allows": ["public readonly"] }` options:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 class Foo {
@@ -346,7 +380,7 @@ class Foo {
 }
 ```
 
-Examples of **correct** code for the `{ "allows": ["public readonly"] }` options:
+#### ✅ Correct
 
 ```ts
 class Foo {
@@ -362,7 +396,7 @@ class Foo {
 
 If you don't care about the using parameter properties in constructors, then you will not need this rule.
 
-## Compatibility
+## Related To
 
 - TSLint: [no-parameter-properties](https://palantir.github.io/tslint/rules/no-parameter-properties/)
 

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

@@ -1,11 +1,13 @@
-# Disallow variable redeclaration (`no-redeclare`)
+# `no-redeclare`
+
+Disallow variable redeclaration.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-redeclare`](https://eslint.org/docs/rules/no-redeclare) rule.
 It adds support for TypeScript function overloads, and declaration merging.
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -77,7 +79,11 @@ type something = string;
 const something = 2;
 ```
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-redeclare.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-redeclare.md)
+
+</sup>
 
 ## Attributes
 

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

@@ -1,10 +1,16 @@
-# Disallows invocation of `require()` (`no-require-imports`)
+# `no-require-imports`
+
+Disallows invocation of `require()`.
 
 Prefer the newer ES6-style imports over `require()`.
 
 ## Rule Details
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 var lib = require('lib');
@@ -14,7 +20,7 @@ var lib5 = require('lib5'),
 import lib8 = require('lib8');
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 import { l } from 'lib';
@@ -29,7 +35,7 @@ import lib10 from 'lib10';
 
 If you don't care about TypeScript module syntax, then you will not need this rule.
 
-## Compatibility
+## Related To
 
 - TSLint: [no-require-imports](https://palantir.github.io/tslint/rules/no-require-imports/)
 

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

@@ -1,16 +1,18 @@
-# Disallow specified modules when loaded by `import` (`no-restricted-imports`)
+# `no-restricted-imports`
+
+Disallow specified modules when loaded by `import`.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-restricted-imports`](https://eslint.org/docs/rules/no-restricted-imports) rule.
 
-## How to use
+## How to Use
 
 ```jsonc
 {
   // note you must disable the base rule as it can report incorrect errors
   "no-restricted-imports": "off",
-  "@typescript-eslint/no-restricted-imports": "off"
+  "@typescript-eslint/no-restricted-imports": ["error"]
 }
 ```
 
@@ -41,19 +43,11 @@ You can specify this option for a specific path or pattern as follows:
 
 When set to `true`, the rule will allow [Type-Only Imports](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html#type-only-imports-and-export).
 
-Examples of **correct** code with the above config:
+Examples of code with the above config:
 
-```ts
-import { foo } from 'other-module';
+<!--tabs-->
 
-import type foo from 'import-foo';
-export type { Foo } from 'import-foo';
-
-import type baz from 'import-baz';
-export type { Baz } from 'import-baz';
-```
-
-Example of **incorrect** code with the above config:
+#### ❌ Incorrect
 
 ```ts
 import foo from 'import-foo';
@@ -63,6 +57,18 @@ import baz from 'import-baz';
 export { Baz } from 'import-baz';
 ```
 
+#### ✅ Correct
+
+```ts
+import { foo } from 'other-module';
+
+import type foo from 'import-foo';
+export type { Foo } from 'import-foo';
+
+import type baz from 'import-baz';
+export type { Baz } from 'import-baz';
+```
+
 ## Attributes
 
 - [ ] ✅ Recommended

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

@@ -1,11 +1,13 @@
-# Disallow variable declarations from shadowing variables declared in the outer scope (`no-shadow`)
+# `no-shadow`
+
+Disallow variable declarations from shadowing variables declared in the outer scope.
 
 ## Rule Details
 
 This rule extends the base [`eslint/no-shadow`](https://eslint.org/docs/rules/no-shadow) rule.
 It adds support for TypeScript's `this` parameters and global augmentation, and adds options for TypeScript features.
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -84,7 +86,11 @@ const test = 1;
 type Func = (test: string) => typeof test;
 ```
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-shadow.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-shadow.md)
+
+</sup>
 
 ## Attributes
 

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

@@ -1,4 +1,6 @@
-# Disallow aliasing `this` (`no-this-alias`)
+# `no-this-alias`
+
+Disallow aliasing `this`.
 
 This rule prohibits assigning variables to `this`.
 
@@ -35,7 +37,7 @@ Examples of **correct** code for this rule:
 
 (see the rationale above)
 
-### Options
+## Options
 
 You can pass an object option:
 
@@ -55,7 +57,7 @@ You can pass an object option:
 
 If you need to assign `this` to variables, you shouldn’t use this rule.
 
-## Related to
+## Related To
 
 - TSLint: [`no-this-assignment`](https://palantir.github.io/tslint/rules/no-this-assignment/)
 

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

@@ -1,15 +1,21 @@
-# Disallow throwing literals as exceptions (`no-throw-literal`)
+# `no-throw-literal`
+
+Disallow throwing literals as exceptions.
 
 It is considered good practice to only `throw` the `Error` object itself or an object using the `Error` object as base objects for user-defined exceptions.
 The fundamental benefit of `Error` objects is that they automatically keep track of where they were built and originated.
 
-This rule restricts what can be thrown as an exception. When it was first created, it only prevented literals from being thrown (hence the name), but it has now been expanded to only allow expressions which have a possibility of being an `Error` object.
+This rule restricts what can be thrown as an exception. When it was first created, it only prevented literals from being thrown (hence the name), but it has now been expanded to only allow expressions which have a possibility of being an `Error` object. With the `allowThrowingAny` and `allowThrowingUnknown`, it can be configured to only allow throwing values which are guaranteed to be an instance of `Error`.
 
 ## Rule Details
 
 This rule is aimed at maintaining consistency when throwing exception by disallowing to throw literals and other expressions which cannot possibly be an `Error` object.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 /*eslint @typescript-eslint/no-throw-literal: "error"*/
@@ -42,7 +48,7 @@ const foo = {
 throw foo.bar;
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 /*eslint @typescript-eslint/no-throw-literal: "error"*/
@@ -79,7 +85,7 @@ class CustomError extends Error {
 throw new CustomError();
 ```
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -89,9 +95,27 @@ throw new CustomError();
 }
 ```
 
+### Options
+
+```jsonc
+{
+  "@typescript-eslint/no-throw-literal": [
+    "error",
+    {
+      "allowThrowingAny": true, // Default is to allow throwing values of type any
+      "allowThrowingUnknown": true // Default is to allow throwing values of type unknown
+    }
+  ]
+}
+```
+
 ---
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/no-throw-literal.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-throw-literal.md)
+
+</sup>
 
 ## Attributes
 

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

@@ -1,4 +1,6 @@
-# Disallow the use of type aliases (`no-type-alias`)
+# `no-type-alias`
+
+Disallow the use of type aliases.
 
 In TypeScript, type aliases serve three purposes:
 
@@ -591,7 +593,7 @@ callback, etc. that would cause the code to be unreadable or impractical.
 
 - [Advance Types](https://www.typescriptlang.org/docs/handbook/advanced-types.html)
 
-## Related to
+## Related To
 
 - TSLint: [interface-over-type-literal](https://palantir.github.io/tslint/rules/interface-over-type-literal/)