xo 0.47.0 → 0.48.0

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/space-infix-ops.md

@@ -1,4 +1,6 @@
-# This rule is aimed at ensuring there are spaces around infix operators. (`space-infix-ops`)
+# `space-infix-ops`
+
+This rule is aimed at ensuring there are spaces around infix operators..
 
 This rule extends the base [`eslint/space-infix-ops`](https://eslint.org/docs/rules/space-infix-ops) rule.
 
@@ -10,7 +12,7 @@ enum MyEnum {
 }
 ```
 
-## How to use
+## How to Use
 
 ```jsonc
 {
@@ -23,7 +25,11 @@ enum MyEnum {
 
 See [`eslint/space-infix-ops` options](https://eslint.org/docs/rules/space-infix-ops#options).
 
-<sup>Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/master/docs/rules/space-infix-ops.md)</sup>
+<sup>
+
+Taken with ❤️ [from ESLint core](https://github.com/eslint/eslint/blob/main/docs/rules/space-infix-ops.md)
+
+</sup>
 
 ## Attributes
 

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/strict-boolean-expressions.md

@@ -1,4 +1,6 @@
-# Restricts the types allowed in boolean expressions (`strict-boolean-expressions`)
+# `strict-boolean-expressions`
+
+Restricts the types allowed in boolean expressions.
 
 Forbids usage of non-boolean types in expressions where a boolean is expected.
 `boolean` and `never` types are always allowed.
@@ -15,7 +17,11 @@ The following nodes are considered boolean expressions and their type is checked
 
 ## Examples
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 // nullable numbers are considered unsafe by default
@@ -47,7 +53,7 @@ while (obj) {
 }
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```tsx
 // Using logical operator short-circuiting is allowed
@@ -155,7 +161,7 @@ You should be using `strictNullChecks` to ensure complete type-safety in your co
 
 If for some reason you cannot turn on `strictNullChecks`, but still want to use this rule - you can use this option to allow it - but know that the behavior of this rule is _undefined_ with the compiler option turned off. We will not accept bug reports if you are using this option.
 
-## Fixes and suggestions
+## Fixes and Suggestions
 
 This rule provides following fixes and suggestions for particular types in boolean context:
 
@@ -190,7 +196,6 @@ This rule provides following fixes and suggestions for particular types in boole
 ## Related To
 
 - TSLint: [strict-boolean-expressions](https://palantir.github.io/tslint/rules/strict-boolean-expressions)
-
 - [no-unnecessary-condition](./no-unnecessary-condition.md) - Similar rule which reports always-truthy and always-falsy values in conditions
 
 ## Attributes

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/switch-exhaustiveness-check.md

@@ -1,8 +1,16 @@
-# Exhaustiveness checking in switch with union type (`switch-exhaustiveness-check`)
+# `switch-exhaustiveness-check`
+
+Exhaustiveness checking in switch with union type.
 
 Union type may have a lot of parts. It's easy to forget to consider all cases in switch. This rule reminds which parts are missing. If domain of the problem requires to have only a partial switch, developer may _explicitly_ add a default clause.
 
-Examples of **incorrect** code for this rule:
+## Rule Details
+
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 type Day =
@@ -25,7 +33,7 @@ switch (day) {
 }
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
 type Day =
@@ -72,7 +80,7 @@ switch (day) {
 }
 ```
 
-or
+### ✅ Correct
 
 ```ts
 type Day =

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/triple-slash-reference.md

@@ -1,4 +1,6 @@
-# Sets preference level for triple slash directives versus ES6-style import declarations (`triple-slash-reference`)
+# `triple-slash-reference`
+
+Sets preference level for triple slash directives versus ES6-style import declarations.
 
 Use of triple-slash reference type directives is discouraged in favor of the newer `import` style. This rule allows you to ban use of `/// <reference path="" />`, `/// <reference types="" />`, or `/// <reference lib="" />` directives.
 
@@ -50,7 +52,7 @@ If you want to ban use of one or all of the triple slash reference directives, o
 
 If you want to use all flavors of triple slash reference directives.
 
-## Compatibility
+## Related To
 
 - TSLint: [no-reference](http://palantir.github.io/tslint/rules/no-reference/)
 - TSLint: [no-reference-import](https://palantir.github.io/tslint/rules/no-reference-import/)

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/type-annotation-spacing.md

@@ -1,4 +1,6 @@
-# Require consistent spacing around type annotations (`type-annotation-spacing`)
+# `type-annotation-spacing`
+
+Require consistent spacing around type annotations.
 
 Spacing around type annotations improves readability of the code. Although the most commonly used style guideline for type annotations in TypeScript prescribes adding a space after the colon, but not before it, it is subjective to the preferences of a project. For example:
 
@@ -45,7 +47,11 @@ This rule has an object option:
 
 ### defaults
 
-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
 
 <!-- prettier-ignore -->
 ```ts
@@ -74,7 +80,7 @@ type Foo = () =>{};
 type Foo = ()=> {};
 ```
 
-Examples of **correct** code for this rule with no options at all:
+#### ✅ Correct
 
 <!-- prettier-ignore -->
 ```ts
@@ -91,7 +97,11 @@ type Foo = () => {};
 
 ### after
 
-Examples of **incorrect** code for this rule with `{ "before": false, "after": true }`:
+Examples of code for this rule with `{ "before": false, "after": true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 <!-- prettier-ignore -->
 ```ts
@@ -120,7 +130,7 @@ type Foo = () =>{};
 type Foo = () => {};
 ```
 
-Examples of **correct** code for this rule with `{ "before": false, "after": true }`:
+#### ✅ Correct
 
 <!-- prettier-ignore -->
 ```ts
@@ -137,7 +147,11 @@ type Foo = ()=> {};
 
 ### before
 
-Examples of **incorrect** code for this rule with `{ "before": true, "after": true }` options:
+Examples of code for this rule with `{ "before": true, "after": true }` options:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 <!-- prettier-ignore -->
 ```ts
@@ -166,7 +180,7 @@ type Foo = () =>{};
 type Foo = ()=> {};
 ```
 
-Examples of **correct** code for this rule with `{ "before": true, "after": true }` options:
+#### ✅ Correct
 
 <!-- prettier-ignore -->
 ```ts
@@ -183,7 +197,11 @@ type Foo = () => {};
 
 ### overrides - colon
 
-Examples of **incorrect** code for this rule with `{ "before": false, "after": false, overrides: { colon: { before: true, after: true }} }` options:
+Examples of code for this rule with `{ "before": false, "after": false, overrides: { colon: { before: true, after: true }} }` options:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 <!-- prettier-ignore -->
 ```ts
@@ -212,7 +230,7 @@ type Foo = ()=> {};
 type Foo = () => {};
 ```
 
-Examples of **correct** code for this rule with `{ "before": false, "after": false, overrides: { colon: { before: true, after: true }} }` options:
+#### ✅ Correct
 
 <!-- prettier-ignore -->
 ```ts
@@ -233,7 +251,11 @@ type Foo = ()=>{};
 
 ### overrides - arrow
 
-Examples of **incorrect** code for this rule with `{ "before": false, "after": false, overrides: { arrow: { before: true, after: true }} }` options:
+Examples of code for this rule with `{ "before": false, "after": false, overrides: { arrow: { before: true, after: true }} }` options:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 <!-- prettier-ignore -->
 ```ts
@@ -262,7 +284,7 @@ type Foo = () =>{};
 type Foo = ()=> {};
 ```
 
-Examples of **correct** code for this rule with `{ "before": false, "after": false, overrides: { arrow: { before: true, after: true }} }` options:
+#### ✅ Correct
 
 <!-- prettier-ignore -->
 ```ts
@@ -286,7 +308,7 @@ If you don't want to enforce spacing for your type annotations, you can safely t
 - [TypeScript Type System](https://basarat.gitbooks.io/typescript/docs/types/type-system.html)
 - [Type Inference](https://www.typescriptlang.org/docs/handbook/type-inference.html)
 
-## Compatibility
+## Related To
 
 - TSLint: [`typedef-whitespace`](https://palantir.github.io/tslint/rules/typedef-whitespace/)
 

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

@@ -1,4 +1,6 @@
-# Requires type annotations to exist (`typedef`)
+# `typedef`
+
+Requires type annotations to exist.
 
 TypeScript cannot always infer types for all places in code.
 Some locations require type annotations for their types to be inferred.
@@ -77,14 +79,18 @@ For example, with the following configuration:
 
 Whether to enforce type annotations on variables declared using array destructuring.
 
-Examples of **incorrect** code with `{ "arrayDestructuring": true }`:
+Examples of code with `{ "arrayDestructuring": true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 const [a] = [1];
 const [b, c] = [1, 2];
 ```
 
-Examples of **correct** code with `{ "arrayDestructuring": true }`:
+#### ✅ Correct
 
 ```ts
 const [a]: number[] = [1];
@@ -99,7 +105,11 @@ for (const [key, val] of new Map([['key', 1]])) {
 
 Whether to enforce type annotations for parameters of arrow functions.
 
-Examples of **incorrect** code with `{ "arrowParameter": true }`:
+Examples of code with `{ "arrowParameter": true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 const logsSize = size => console.log(size);
@@ -111,7 +121,7 @@ const mapper = {
 };
 ```
 
-Examples of **correct** code with `{ "arrowParameter": true }`:
+#### ✅ Correct
 
 ```ts
 const logsSize = (size: number) => console.log(size);
@@ -127,7 +137,11 @@ const mapper = {
 
 Whether to enforce type annotations on member variables of classes.
 
-Examples of **incorrect** code with `{ "memberVariableDeclaration": true }`:
+Examples of code with `{ "memberVariableDeclaration": true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 class ContainsText {
@@ -136,7 +150,7 @@ class ContainsText {
 }
 ```
 
-Examples of **correct** code with `{ "memberVariableDeclaration": true }`:
+#### ✅ Correct
 
 ```ts
 class ContainsText {
@@ -149,14 +163,18 @@ class ContainsText {
 
 Whether to enforce type annotations on variables declared using object destructuring.
 
-Examples of **incorrect** code with `{ "objectDestructuring": true }`:
+Examples of code with `{ "objectDestructuring": true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 const { length } = 'text';
 const [b, c] = Math.random() ? [1, 2] : [3, 4];
 ```
 
-Examples of **correct** code with `{ "objectDestructuring": true }`:
+#### ✅ Correct
 
 ```ts
 const { length }: { length: number } = 'text';
@@ -170,7 +188,11 @@ for (const { key, val } of [{ key: 'key', val: 1 }]) {
 
 Whether to enforce type annotations for parameters of functions and methods.
 
-Examples of **incorrect** code with `{ "parameter": true }`:
+Examples of code with `{ "parameter": true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 function logsSize(size): void {
@@ -198,7 +220,7 @@ class Logger {
 }
 ```
 
-Examples of **correct** code with `{ "parameter": true }`:
+#### ✅ Correct
 
 ```ts
 function logsSize(size: number): void {
@@ -230,7 +252,11 @@ class Logger {
 
 Whether to enforce type annotations for properties of interfaces and types.
 
-Examples of **incorrect** code with `{ "propertyDeclaration": true }`:
+Examples of code with `{ "propertyDeclaration": true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 type Members = {
@@ -239,7 +265,7 @@ type Members = {
 };
 ```
 
-Examples of **correct** code with `{ "propertyDeclaration": true }`:
+#### ✅ Correct
 
 ```ts
 type Members = {
@@ -252,7 +278,11 @@ type Members = {
 
 Whether to enforce type annotations for variable declarations, excluding array and object destructuring.
 
-Examples of **incorrect** code with `{ "variableDeclaration": true }`:
+Examples of code with `{ "variableDeclaration": true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 const text = 'text';
@@ -260,7 +290,7 @@ let initialText = 'text';
 let delayedText;
 ```
 
-Examples of **correct** code with `{ "variableDeclaration": true }`:
+#### ✅ Correct
 
 ```ts
 const text: string = 'text';
@@ -272,13 +302,17 @@ let delayedText: string;
 
 Ignore variable declarations for non-arrow and arrow functions.
 
-Examples of **incorrect** code with `{ "variableDeclaration": true, "variableDeclarationIgnoreFunction": true }`:
+Examples of code with `{ "variableDeclaration": true, "variableDeclarationIgnoreFunction": true }`:
+
+<!--tabs-->
+
+#### ❌ Incorrect
 
 ```ts
 const text = 'text';
 ```
 
-Examples of **correct** code with `{ "variableDeclaration": true, "variableDeclarationIgnoreFunction": true }`:
+#### ✅ Correct
 
 ```ts
 const a = (): void => {};
@@ -303,7 +337,7 @@ In general, if you do not consider the cost of writing unnecessary type annotati
 - [TypeScript Type System](https://basarat.gitbooks.io/typescript/docs/types/type-system.html)
 - [Type Inference](https://www.typescriptlang.org/docs/handbook/type-inference.html)
 
-## Compatibility
+## Related To
 
 - TSLint: [`typedef`](https://palantir.github.io/tslint/rules/typedef)
 

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/unbound-method.md

@@ -1,4 +1,6 @@
-# Enforces unbound methods are called with their expected scope (`unbound-method`)
+# `unbound-method`
+
+Enforces unbound methods are called with their expected scope.
 
 Warns when a method is used outside of a method call.
 
@@ -10,7 +12,11 @@ If you're working with `jest`, you can use [`eslint-plugin-jest`'s version of th
 
 ## Rule Details
 
-Examples of **incorrect** code for this rule
+Examples of code for this rule
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
 class MyClass {
@@ -37,7 +43,7 @@ const arith = {
 const { double } = arith;
 ```
 
-Examples of **correct** code for this rule
+### ✅ Correct
 
 ```ts
 class MyClass {
@@ -90,7 +96,7 @@ const { log } = OtherClass;
 log();
 ```
 
-### Example
+## Example
 
 ```json
 {

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/unified-signatures.md

@@ -1,4 +1,4 @@
-# Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter (`unified-signatures`)
+# `unified-signatures`
 
 Warns for any two overloads that could be unified into one by using a union or an optional/rest parameter.
 
@@ -6,29 +6,33 @@ Warns for any two overloads that could be unified into one by using a union or a
 
 This rule aims to keep the source code as maintainable as possible by reducing the amount of overloads.
 
-Examples of **incorrect** code for this rule:
+Examples of code for this rule:
+
+<!--tabs-->
+
+### ❌ Incorrect
 
 ```ts
-function f(x: number): void;
-function f(x: string): void;
+function x(x: number): void;
+function x(x: string): void;
 ```
 
 ```ts
-f(): void;
-f(...x: number[]): void;
+function y(): void;
+function y(...x: number[]): void;
 ```
 
-Examples of **correct** code for this rule:
+### ✅ Correct
 
 ```ts
-function f(x: number | string): void;
+function x(x: number | string): void;
 ```
 
 ```ts
-function f(x?: ...number[]): void;
+function y(...x: number[]): void;
 ```
 
-## Related to
+## Related To
 
 - TSLint: [`unified-signatures`](https://palantir.github.io/tslint/rules/unified-signatures/)
 

package/node_modules/@typescript-eslint/eslint-plugin/index.d.ts

@@ -1,4 +1,4 @@
-import { TSESLint } from '@typescript-eslint/experimental-utils';
+import { TSESLint } from '@typescript-eslint/utils';
 
 export const rules: Record<string, TSESLint.RuleModule<string, unknown[]>>;
 export const configs: Record<string, TSESLint.Linter.Config>;

package/node_modules/@typescript-eslint/eslint-plugin/node_modules/ignore/README.md

@@ -298,7 +298,19 @@ interface TestResult {
 - `{ignored: false, unignored: true}`: the `pathname` is unignored
 - `{ignored: false, unignored: false}`: the `pathname` is never matched by any ignore rules.
 
-## `options.ignorecase` since 4.0.0
+## static `ignore.isPathValid(pathname): boolean` since 5.0.0
+
+Check whether the `pathname` is an valid `path.relative()`d path according to the [convention](#1-pathname-should-be-a-pathrelatived-pathname).
+
+This method is **NOT** used to check if an ignore pattern is valid.
+
+```js
+ignore.isPathValid('./foo')  // false
+```
+
+## ignore(options)
+
+### `options.ignorecase` since 4.0.0
 
 Similar as the `core.ignorecase` option of [git-config](https://git-scm.com/docs/git-config), `node-ignore` will be case insensitive if `options.ignorecase` is set to `true` (the default value), otherwise case sensitive.
 
@@ -312,14 +324,20 @@ ig.add('*.png')
 ig.ignores('*.PNG')  // false
 ```
 
-## static `ignore.isPathValid(pathname): boolean` since 5.0.0
+### `options.ignoreCase?: boolean` since 5.2.0
 
-Check whether the `pathname` is an valid `path.relative()`d path according to the [convention](#1-pathname-should-be-a-pathrelatived-pathname).
+Which is alternative to `options.ignoreCase`
 
-This method is **NOT** used to check if an ignore pattern is valid.
+### `options.allowRelativePaths?: boolean` since 5.2.0
+
+This option brings backward compatibility with projects which based on `ignore@4.x`. If `options.allowRelativePaths` is `true`, `ignore` will not check whether the given path to be tested is [`path.relative()`d](#pathname-conventions).
+
+However, passing a relative path, such as `'./foo'` or `'../foo'`, to test if it is ignored or not is not a good practise, which might lead to unexpected behavior
 
 ```js
-ignore.isPathValid('./foo')  // false
+ignore({
+  allowRelativePaths: true
+}).ignores('../foo/bar.js') // And it will not throw
 ```
 
 ****
@@ -328,7 +346,9 @@ ignore.isPathValid('./foo')  // false
 
 ## Upgrade 4.x -> 5.x
 
-Since `5.0.0`, if an invalid `Pathname` passed into `ig.ignores()`, an error will be thrown, while `ignore < 5.0.0` did not make sure what the return value was, as well as
+Since `5.0.0`, if an invalid `Pathname` passed into `ig.ignores()`, an error will be thrown, unless `options.allowRelative = true` is passed to the `Ignore` factory.
+
+While `ignore < 5.0.0` did not make sure what the return value was, as well as
 
 ```ts
 .ignores(pathname: Pathname): boolean

package/node_modules/@typescript-eslint/eslint-plugin/node_modules/ignore/index.d.ts

@@ -7,17 +7,11 @@ interface TestResult {
 
 export interface Ignore {
   /**
-   * Adds a rule rules to the current manager.
-   * @param  {string | Ignore} pattern
-   * @returns IgnoreBase
-   */
-  add(pattern: string | Ignore): this
-  /**
-   * Adds several rules to the current manager.
+   * Adds one or several rules to the current manager.
    * @param  {string[]} patterns
    * @returns IgnoreBase
    */
-  add(patterns: (string | Ignore)[]): this
+  add(patterns: string | Ignore | readonly (string | Ignore)[]): this
 
   /**
    * Filters the given array of pathnames, and returns the filtered array.
@@ -25,7 +19,8 @@ export interface Ignore {
    * @param paths the array of paths to be filtered.
    * @returns The filtered array of paths
    */
-  filter(pathnames: Pathname[]): Pathname[]
+  filter(pathnames: readonly Pathname[]): Pathname[]
+
   /**
    * Creates a filter function which could filter
    * an array of paths with Array.prototype.filter.
@@ -49,6 +44,9 @@ export interface Ignore {
 
 interface Options {
   ignorecase?: boolean
+  // For compatibility
+  ignoreCase?: boolean
+  allowRelativePaths?: boolean
 }
 
 /**