xo 0.46.4 → 0.49.0

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

@@ -1,4 +1,6 @@
-# Disallows returning any from a function (`no-unsafe-return`)
+# `no-unsafe-return`
+
+Disallows returning any from a function.
 
 Despite your best intentions, the `any` type can sometimes leak into your codebase.
 Returned `any` typed values are not checked at all by TypeScript, so it creates a potential safety hole, and source of bugs in your codebase.
@@ -8,7 +10,11 @@ Returned `any` typed values are not checked at all by TypeScript, so it creates
 This rule disallows returning `any` or `any[]` from a function.
 This rule also compares the return type to the function's declared/inferred return type to ensure you don't return an unsafe `any` in a generic position to a receiver that's expecting a specific type. For example, it will error if you return `Set<any>` from a function declared as returning `Set<string>`.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 function foo1() {
@@ -49,7 +55,7 @@ type TAssign = () => Set<string>;
 const assignability2: TAssign = () => new Set<any>([true]);
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 function foo1() {
@@ -69,6 +75,8 @@ type TAssign = () => Set<string>;
 const assignability2: TAssign = () => new Set(['foo']);
 ```
 
+<!--/tabs-->
+
 There are cases where the rule allows to return `any` to `unknown`.
 
 Examples of `any` to `unknown` return that are allowed.
@@ -83,13 +91,28 @@ function foo2(): unknown[] {
 }
 ```
 
-## Related to
+## Options
+
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/no-unsafe-return": "error"
+  }
+}
+```
+
+This rule is not configurable.
+
+## Related To
 
 - [`no-explicit-any`](./no-explicit-any.md)
 - TSLint: [`no-unsafe-any`](https://palantir.github.io/tslint/rules/no-unsafe-any/)
 
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [x] 💭 Requires type information

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

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

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

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

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,10 +107,16 @@ 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
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [ ] 🔒 Strict
 - [ ] 🔧 Fixable
 - [ ] 💭 Requires type information

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,10 +25,21 @@ 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
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [ ] 💭 Requires type information

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

@@ -0,0 +1,60 @@
+# `no-useless-empty-export`
+
+Disallow empty exports that don't change anything in a module file.
+
+## Rule Details
+
+An empty `export {}` statement is sometimes useful in TypeScript code to turn a file that would otherwise be a script file into a module file.
+Per the TypeScript Handbook [Modules](https://www.typescriptlang.org/docs/handbook/modules.html) page:
+
+> In TypeScript, just as in ECMAScript 2015, any file containing a top-level import or export is considered a module.
+> Conversely, a file without any top-level import or export declarations is treated as a script whose contents are available in the global scope (and therefore to modules as well).
+
+However, an `export {}` statement does nothing if there are any other top-level import or export statements in a file.
+
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
+
+```ts
+export const value = 'Hello, world!';
+export {};
+```
+
+```ts
+import 'some-other-module';
+export {};
+```
+
+### ✅ Correct
+
+```ts
+export const value = 'Hello, world!';
+```
+
+```ts
+import 'some-other-module';
+```
+
+## Options
+
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/no-useless-empty-export": "warn"
+  }
+}
+```
+
+This rule is not configurable.
+
+## Attributes
+
+- Configs:
+  - [ ] ✅ Recommended
+  - [ ] 🔒 Strict
+- [x] 🔧 Fixable
+- [ ] 💭 Requires type information

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,16 +26,31 @@ 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/)
 
 ## Attributes
 
-- [x] ✅ Recommended
+- Configs:
+  - [x] ✅ Recommended
+  - [x] 🔒 Strict
 - [ ] 🔧 Fixable
 - [ ] 💭 Requires type information

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;
@@ -22,12 +28,27 @@ const definitely = maybe!;
 const alsoDefinitely = maybe!;
 ```
 
+## Options
+
+```jsonc
+// .eslintrc.json
+{
+  "rules": {
+    "@typescript-eslint/non-nullable-type-assertion-style": "warn"
+  }
+}
+```
+
+This rule is not configurable.
+
 ## When Not To Use It
 
 If you don't mind having unnecessarily verbose type casts, you can avoid this rule.
 
 ## Attributes
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [x] 🔒 Strict
 - [x] 🔧 Fixable
 - [x] 💭 Requires type information

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

@@ -1,13 +1,15 @@
-# 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
 
-```cjson
+```jsonc
 {
   // note you must disable the base rule as it can report incorrect errors
   "object-curly-spacing": "off",
@@ -19,10 +21,16 @@ 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
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [ ] 🔒 Strict
 - [x] 🔧 Fixable
 - [ ] 💭 Requires type information

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
 {
@@ -43,12 +45,20 @@ This rule extends the base [`eslint/padding-line-between-statements`](https://es
 
 See [`eslint/padding-line-between-statements` options](https://eslint.org/docs/rules/padding-line-between-statements#options).
 
-**Note** - In addition to options provided by ESLint, we have also added options for `interface` and `type`.
+In addition to options provided by ESLint, `interface` and `type` can be used as statement types.
+
+**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/main/docs/rules/padding-line-between-statements.md)
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/padding-line-between-statements.md)</sup>
+</sup>
 
 ## Attributes
 
-- [ ] ✅ Recommended
+- Configs:
+  - [ ] ✅ Recommended
+  - [ ] 🔒 Strict
 - [x] 🔧 Fixable
 - [ ] 💭 Requires type information