xo 0.47.0 → 0.50.0

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`
+
+Disallows 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,12 +396,6 @@ 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/)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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

@@ -1,11 +1,13 @@
-# Disallow variable redeclaration (`no-redeclare`)
+# `no-redeclare`
+
+Disallows 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,10 +79,8 @@ 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>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-redeclare.md)
 
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information
+</sup>

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

@@ -0,0 +1,92 @@
+# `no-redundant-type-constituents`
+
+Disallows members of unions and intersections that do nothing or override type information.
+
+## Rule Details
+
+Some types can override some other types ("constituents") in a union or intersection and/or be overridden by some other types.
+TypeScript's set theory of types includes cases where a constituent type might be useless in the parent union or intersection.
+
+Within `|` unions:
+
+- `any` and `unknown` "override" all other union members
+- `never` is dropped from unions in any position except when in a return type position
+- primitive types such as `string` "override" any of their literal types such as `""`
+
+Within `&` intersections:
+
+- `any` and `never` "override" all other intersection members
+- `unknown` is dropped from intersections
+- literal types "override" any primitive types in an intersection
+- literal types such as `""` "override" any of their primitive types such as `string`
+
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
+
+```ts
+type UnionAny = any | 'foo';
+type UnionUnknown = unknown | 'foo';
+type UnionNever = never | 'foo';
+
+type UnionBooleanLiteral = boolean | false;
+type UnionNumberLiteral = number | 1;
+type UnionStringLiteral = string | 'foo';
+
+type IntersectionAny = any & 'foo';
+type IntersectionUnknown = string & unknown;
+type IntersectionNever = string | never;
+
+type IntersectionBooleanLiteral = boolean & false;
+type IntersectionNumberLiteral = number & 1;
+type IntersectionStringLiteral = string & 'foo';
+```
+
+### ✅ Correct
+
+```ts
+type UnionAny = any;
+type UnionUnknown = unknown;
+type UnionNever = never;
+
+type UnionBooleanLiteral = boolean;
+type UnionNumberLiteral = number;
+type UnionStringLiteral = string;
+
+type IntersectionAny = any;
+type IntersectionUnknown = string;
+type IntersectionNever = string;
+
+type IntersectionBooleanLiteral = false;
+type IntersectionNumberLiteral = 1;
+type IntersectionStringLiteral = 'foo';
+
+type ReturnUnionNever = () => string | never;
+```
+
+## Options
+
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/no-redundant-type-constituents": "warn"
+  }
+}
+```
+
+This rule is not configurable.
+
+## Limitations
+
+This rule plays it safe and only works with bottom types, top types, and comparing literal types to primitive types.
+It also does not provide an auto-fixer just yet.
+
+## Further Reading
+
+- [Union Types](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types)
+- [Intersection Types](https://www.typescriptlang.org/docs/handbook/2/objects.html#intersection-types)
+- [Bottom Types](https://en.wikipedia.org/wiki/Bottom_type)
+- [Top Types](https://en.wikipedia.org/wiki/Top_type)

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';
@@ -25,16 +31,23 @@ import lib9 = lib2.anotherSubImport;
 import lib10 from 'lib10';
 ```
 
+## Options
+
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/no-require-imports": "warn"
+  }
+}
+```
+
+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-require-imports](https://palantir.github.io/tslint/rules/no-require-imports/)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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`
+
+Disallows 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:
-
-```ts
-import { foo } from 'other-module';
-
-import type foo from 'import-foo';
-export type { Foo } from 'import-foo';
+Examples of code with the above config:
 
-import type baz from 'import-baz';
-export type { Baz } from 'import-baz';
-```
+<!--tabs-->
 
-Example of **incorrect** code with the above config:
+#### ❌ Incorrect
 
 ```ts
 import foo from 'import-foo';
@@ -63,8 +57,14 @@ import baz from 'import-baz';
 export { Baz } from 'import-baz';
 ```
 
-## Attributes
+#### ✅ Correct
 
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information
+```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';
+```

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`
+
+Disallows 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,10 +86,8 @@ 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>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-shadow.md)
 
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information
+</sup>

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`
+
+Disallows 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,12 +57,6 @@ 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/)
-
-## Attributes
-
-- [x] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information

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`
+
+Disallows 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,12 +95,24 @@ 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>
 
-## Attributes
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/no-throw-literal.md)
 
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information
+</sup>

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`
+
+Disallows type aliases.
 
 In TypeScript, type aliases serve three purposes:
 
@@ -116,6 +118,8 @@ type Foo = string | string[];
 
 type Foo = string & string[];
 
+type Foo = `foo-${number}`;
+
 // reference types
 interface Bar {}
 class Baz implements Bar {}
@@ -137,6 +141,8 @@ type Foo = string;
 
 type Foo = string & string[];
 
+type Foo = `foo-${number}`;
+
 // reference types
 interface Bar {}
 class Baz implements Bar {}
@@ -154,6 +160,8 @@ type Foo = 'a' | 'b';
 
 type Foo = string | string[];
 
+type Foo = `a-${number}` | `b-${number}`;
+
 // reference types
 interface Bar {}
 class Baz implements Bar {}
@@ -173,6 +181,8 @@ type Foo = string;
 
 type Foo = string | string[];
 
+type Foo = `a-${number}` | `b-${number}`;
+
 // reference types
 interface Bar {}
 class Baz implements Bar {}
@@ -188,6 +198,8 @@ Examples of **correct** code for the `{ "allowAliases": "in-intersections" }` op
 // primitives
 type Foo = string & string[];
 
+type Foo = `a-${number}` & `b-${number}`;
+
 // reference types
 interface Bar {}
 class Baz implements Bar {}
@@ -203,6 +215,8 @@ type Foo = 'a';
 
 type Foo = string;
 
+type Foo = `foo-${number}`;
+
 // reference types
 interface Bar {}
 class Baz implements Bar {}
@@ -220,6 +234,10 @@ type Foo = string | string[];
 
 type Foo = string & string[];
 
+type Foo = `a-${number}` & `b-${number}`;
+
+type Foo = `a-${number}` | `b-${number}`;
+
 // reference types
 interface Bar {}
 class Baz implements Bar {}
@@ -589,14 +607,8 @@ callback, etc. that would cause the code to be unreadable or impractical.
 
 ## Further Reading
 
-- [Advance Types](https://www.typescriptlang.org/docs/handbook/advanced-types.html)
+- [Advanced 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/)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [ ] 💭 Requires type information