xo 0.54.2 → 0.55.0

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

@@ -1,320 +0,0 @@
----
-description: 'Require type annotations in certain places.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/typedef** for documentation.
-
-TypeScript cannot always infer types for all places in code.
-Some locations require type annotations for their types to be inferred.
-
-This rule can enforce type annotations in locations regardless of whether they're required.
-This is typically used to maintain consistency for element types that sometimes require them.
-
-```ts
-class ContainsText {
-  // There must be a type annotation here to infer the type
-  delayedText: string;
-
-  // `typedef` requires a type annotation here to maintain consistency
-  immediateTextExplicit: string = 'text';
-
-  // This is still a string type because of its initial value
-  immediateTextImplicit = 'text';
-}
-```
-
-> To enforce type definitions existing on call signatures, use [`explicit-function-return-type`](./explicit-function-return-type.md), or [`explicit-module-boundary-types`](./explicit-module-boundary-types.md).
-
-:::caution
-
-Requiring type annotations unnecessarily can be cumbersome to maintain and generally reduces code readability.
-TypeScript is often better at inferring types than easily written type annotations would allow.
-
-**Instead of enabling `typedef`, it is generally recommended to use the `--noImplicitAny` and `--strictPropertyInitialization` compiler options to enforce type annotations only when useful.**
-
-:::
-
-## Options
-
-For example, with the following configuration:
-
-```json
-{
-  "rules": {
-    "@typescript-eslint/typedef": [
-      "error",
-      {
-        "arrowParameter": true,
-        "variableDeclaration": true
-      }
-    ]
-  }
-}
-```
-
-- Type annotations on arrow function parameters are required
-- Type annotations on variables are required
-
-### `arrayDestructuring`
-
-Whether to enforce type annotations on variables declared using array destructuring.
-
-Examples of code with `{ "arrayDestructuring": true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-const [a] = [1];
-const [b, c] = [1, 2];
-```
-
-#### ✅ Correct
-
-```ts
-const [a]: number[] = [1];
-const [b]: [number] = [2];
-const [c, d]: [boolean, string] = [true, 'text'];
-
-for (const [key, val] of new Map([['key', 1]])) {
-}
-```
-
-### `arrowParameter`
-
-Whether to enforce type annotations for parameters of arrow functions.
-
-Examples of code with `{ "arrowParameter": true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-const logsSize = size => console.log(size);
-
-['hello', 'world'].map(text => text.length);
-
-const mapper = {
-  map: text => text + '...',
-};
-```
-
-#### ✅ Correct
-
-```ts
-const logsSize = (size: number) => console.log(size);
-
-['hello', 'world'].map((text: string) => text.length);
-
-const mapper = {
-  map: (text: string) => text + '...',
-};
-```
-
-### `memberVariableDeclaration`
-
-Whether to enforce type annotations on member variables of classes.
-
-Examples of code with `{ "memberVariableDeclaration": true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-class ContainsText {
-  delayedText;
-  immediateTextImplicit = 'text';
-}
-```
-
-#### ✅ Correct
-
-```ts
-class ContainsText {
-  delayedText: string;
-  immediateTextImplicit: string = 'text';
-}
-```
-
-### `objectDestructuring`
-
-Whether to enforce type annotations on variables declared using object destructuring.
-
-Examples of code with `{ "objectDestructuring": true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-const { length } = 'text';
-const [b, c] = Math.random() ? [1, 2] : [3, 4];
-```
-
-#### ✅ Correct
-
-```ts
-const { length }: { length: number } = 'text';
-const [b, c]: [number, number] = Math.random() ? [1, 2] : [3, 4];
-
-for (const { key, val } of [{ key: 'key', val: 1 }]) {
-}
-```
-
-### `parameter`
-
-Whether to enforce type annotations for parameters of functions and methods.
-
-Examples of code with `{ "parameter": true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-function logsSize(size): void {
-  console.log(size);
-}
-
-const doublesSize = function (size): number {
-  return size * 2;
-};
-
-const divider = {
-  curriesSize(size): number {
-    return size;
-  },
-  dividesSize: function (size): number {
-    return size / 2;
-  },
-};
-
-class Logger {
-  log(text): boolean {
-    console.log('>', text);
-    return true;
-  }
-}
-```
-
-#### ✅ Correct
-
-```ts
-function logsSize(size: number): void {
-  console.log(size);
-}
-
-const doublesSize = function (size: number): number {
-  return size * 2;
-};
-
-const divider = {
-  curriesSize(size: number): number {
-    return size;
-  },
-  dividesSize: function (size: number): number {
-    return size / 2;
-  },
-};
-
-class Logger {
-  log(text: boolean): boolean {
-    console.log('>', text);
-    return true;
-  }
-}
-```
-
-### `propertyDeclaration`
-
-Whether to enforce type annotations for properties of interfaces and types.
-
-Examples of code with `{ "propertyDeclaration": true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-type Members = {
-  member;
-  otherMember;
-};
-```
-
-#### ✅ Correct
-
-```ts
-type Members = {
-  member: boolean;
-  otherMember: string;
-};
-```
-
-### `variableDeclaration`
-
-Whether to enforce type annotations for variable declarations, excluding array and object destructuring.
-
-Examples of code with `{ "variableDeclaration": true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-const text = 'text';
-let initialText = 'text';
-let delayedText;
-```
-
-#### ✅ Correct
-
-```ts
-const text: string = 'text';
-let initialText: string = 'text';
-let delayedText: string;
-```
-
-### `variableDeclarationIgnoreFunction`
-
-Ignore variable declarations for non-arrow and arrow functions.
-
-Examples of code with `{ "variableDeclaration": true, "variableDeclarationIgnoreFunction": true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-const text = 'text';
-```
-
-#### ✅ Correct
-
-```ts
-const a = (): void => {};
-const b = function (): void => {};
-const c: () => void = (): void => {};
-
-class Foo {
-  a = (): void => {};
-  b = function (): void => {};
-  c = () => void = (): void => {};
-}
-```
-
-## When Not To Use It
-
-If you are using stricter TypeScript compiler options, particularly `--noImplicitAny` and/or `--strictPropertyInitialization`, you likely don't need this rule.
-
-In general, if you do not consider the cost of writing unnecessary type annotations reasonable, then do not use this rule.
-
-## Further Reading
-
-- [TypeScript Type System](https://basarat.gitbooks.io/typescript/docs/types/type-system.html)
-- [Type Inference](https://www.typescriptlang.org/docs/handbook/type-inference.html)

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

@@ -1,103 +0,0 @@
----
-description: 'Enforce unbound methods are called with their expected scope.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/unbound-method** for documentation.
-
-Class method functions don't preserve the class scope when passed as standalone variables ("unbound").
-If your function does not access `this`, [you can annotate it with `this: void`](https://www.typescriptlang.org/docs/handbook/2/functions.html#declaring-this-in-a-function), or consider using an arrow function instead.
-Otherwise, passing class methods around as values can remove type safety by failing to capture `this`.
-
-This rule reports when a class method is referenced in an unbound manner.
-
-:::note Tip
-If you're working with `jest`, you can use [`eslint-plugin-jest`'s version of this rule](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/unbound-method.md) to lint your test files, which knows when it's ok to pass an unbound method to `expect` calls.
-:::
-
-## Examples
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-class MyClass {
-  public log(): void {
-    console.log(this);
-  }
-}
-
-const instance = new MyClass();
-
-// This logs the global scope (`window`/`global`), not the class instance
-const myLog = instance.log;
-myLog();
-
-// This log might later be called with an incorrect scope
-const { log } = instance;
-
-// arith.double may refer to `this` internally
-const arith = {
-  double(x: number): number {
-    return x * 2;
-  },
-};
-const { double } = arith;
-```
-
-### ✅ Correct
-
-```ts
-class MyClass {
-  public logUnbound(): void {
-    console.log(this);
-  }
-
-  public logBound = () => console.log(this);
-}
-
-const instance = new MyClass();
-
-// logBound will always be bound with the correct scope
-const { logBound } = instance;
-logBound();
-
-// .bind and lambdas will also add a correct scope
-const dotBindLog = instance.logBound.bind(instance);
-const innerLog = () => instance.logBound();
-
-// arith.double explicitly declares that it does not refer to `this` internally
-const arith = {
-  double(this: void, x: number): number {
-    return x * 2;
-  },
-};
-const { double } = arith;
-```
-
-## Options
-
-### `ignoreStatic`
-
-Examples of **correct** code for this rule with `{ ignoreStatic: true }`:
-
-```ts
-class OtherClass {
-  static log() {
-    console.log(OtherClass);
-  }
-}
-
-// With `ignoreStatic`, statics are assumed to not rely on a particular scope
-const { log } = OtherClass;
-
-log();
-```
-
-## When Not To Use It
-
-If your code intentionally waits to bind methods after use, such as by passing a `scope: this` along with the method, you can disable this rule.
-
-If you're wanting to use `toBeCalled` and similar matches in `jest` tests, you can disable this rule for your test files in favor of [`eslint-plugin-jest`'s version of this rule](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/unbound-method.md).

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

@@ -1,70 +0,0 @@
----
-description: 'Disallow two overloads that could be unified into one with a union or an optional/rest parameter.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/unified-signatures** for documentation.
-
-Function overload signatures are a TypeScript way to define a function that can be called in multiple very different ways.
-Overload signatures add syntax and theoretical bloat, so it's generally best to avoid using them when possible.
-Switching to union types and/or optional or rest parameters can often avoid the need for overload signatures.
-
-This rule reports when function overload signatures can be replaced by a single function signature.
-
-## Examples
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-function x(x: number): void;
-function x(x: string): void;
-```
-
-```ts
-function y(): void;
-function y(...x: number[]): void;
-```
-
-### ✅ Correct
-
-```ts
-function x(x: number | string): void;
-```
-
-```ts
-function y(...x: number[]): void;
-```
-
-```ts
-// This rule won't check overload signatures with different rest parameter types.
-// See https://github.com/microsoft/TypeScript/issues/5077
-function f(...a: number[]): void;
-function f(...a: string[]): void;
-```
-
-## Options
-
-### `ignoreDifferentlyNamedParameters`
-
-Examples of code for this rule with `ignoreDifferentlyNamedParameters`:
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-function f(a: number): void;
-function f(a: string): void;
-```
-
-### ✅ Correct
-
-```ts
-function f(a: number): void;
-function f(b: string): void;
-```
-
-## Options

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

@@ -1,4 +0,0 @@
-import type { 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/package.json

@@ -1,88 +0,0 @@
-{
-  "name": "@typescript-eslint/eslint-plugin",
-  "version": "5.59.1",
-  "description": "TypeScript plugin for ESLint",
-  "keywords": [
-    "eslint",
-    "eslintplugin",
-    "eslint-plugin",
-    "typescript"
-  ],
-  "engines": {
-    "node": "^12.22.0 || ^14.17.0 || >=16.0.0"
-  },
-  "files": [
-    "dist",
-    "docs",
-    "index.d.ts",
-    "package.json",
-    "README.md",
-    "LICENSE"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/typescript-eslint/typescript-eslint.git",
-    "directory": "packages/eslint-plugin"
-  },
-  "bugs": {
-    "url": "https://github.com/typescript-eslint/typescript-eslint/issues"
-  },
-  "license": "MIT",
-  "main": "dist/index.js",
-  "types": "index.d.ts",
-  "scripts": {
-    "build": "tsc -b tsconfig.build.json",
-    "check-docs": "jest tests/docs.test.ts --runTestsByPath --silent --runInBand",
-    "check-configs": "jest tests/configs.test.ts --runTestsByPath --silent --runInBand",
-    "clean": "tsc -b tsconfig.build.json --clean",
-    "postclean": "rimraf dist && rimraf coverage",
-    "format": "prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
-    "generate:breaking-changes": "yarn tsx tools/generate-breaking-changes.ts",
-    "generate:configs": "yarn tsx tools/generate-configs.ts",
-    "lint": "nx lint",
-    "test": "jest --coverage",
-    "typecheck": "tsc -p tsconfig.json --noEmit"
-  },
-  "dependencies": {
-    "@eslint-community/regexpp": "^4.4.0",
-    "@typescript-eslint/scope-manager": "5.59.1",
-    "@typescript-eslint/type-utils": "5.59.1",
-    "@typescript-eslint/utils": "5.59.1",
-    "debug": "^4.3.4",
-    "grapheme-splitter": "^1.0.4",
-    "ignore": "^5.2.0",
-    "natural-compare-lite": "^1.4.0",
-    "semver": "^7.3.7",
-    "tsutils": "^3.21.0"
-  },
-  "devDependencies": {
-    "@types/debug": "*",
-    "@types/json-schema": "*",
-    "@types/marked": "*",
-    "@types/natural-compare-lite": "^1.4.0",
-    "@types/prettier": "*",
-    "chalk": "^5.0.1",
-    "cross-fetch": "^3.1.5",
-    "grapheme-splitter": "^1.0.4",
-    "json-schema": "*",
-    "markdown-table": "^3.0.2",
-    "marked": "^4.0.15",
-    "prettier": "*",
-    "title-case": "^3.0.3",
-    "typescript": "*"
-  },
-  "peerDependencies": {
-    "@typescript-eslint/parser": "^5.0.0",
-    "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0"
-  },
-  "peerDependenciesMeta": {
-    "typescript": {
-      "optional": true
-    }
-  },
-  "funding": {
-    "type": "opencollective",
-    "url": "https://opencollective.com/typescript-eslint"
-  },
-  "gitHead": "2f32472787f01545e58d74a1d1cd6248a17a8a9c"
-}

package/node_modules/@typescript-eslint/parser/LICENSE

@@ -1,22 +0,0 @@
-TypeScript ESLint Parser
-Copyright JS Foundation and other contributors, https://js.foundation
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-- Redistributions of source code must retain the above copyright
-  notice, this list of conditions and the following disclaimer.
-- Redistributions in binary form must reproduce the above copyright
-  notice, this list of conditions and the following disclaimer in the
-  documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
-THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/node_modules/@typescript-eslint/parser/README.md

@@ -1,10 +0,0 @@
-# `@typescript-eslint/parser`
-
-> An ESLint parser which leverages <a href="https://github.com/typescript-eslint/typescript-eslint/tree/main/packages/typescript-estree">TypeScript ESTree</a> to allow for ESLint to lint TypeScript source code.
-
-[![NPM Version](https://img.shields.io/npm/v/@typescript-eslint/parser.svg?style=flat-square)](https://www.npmjs.com/package/@typescript-eslint/parser)
-[![NPM Downloads](https://img.shields.io/npm/dm/@typescript-eslint/parser.svg?style=flat-square)](https://www.npmjs.com/package/@typescript-eslint/parser)
-
-👉 See **https://typescript-eslint.io/architecture/parser** for documentation on this package.
-
-> See https://typescript-eslint.io for general documentation on typescript-eslint, the tooling that allows you to run ESLint and Prettier on TypeScript code.

package/node_modules/@typescript-eslint/parser/_ts3.4/dist/index.d.ts

@@ -1,8 +0,0 @@
-export { parse, parseForESLint, ParserOptions } from './parser';
-export { ParserServices, clearCaches, createProgram, } from '@typescript-eslint/typescript-estree';
-export declare const version: string;
-export declare const meta: {
-    name: string;
-    version: string;
-};
-//# sourceMappingURL=index.d.ts.map

package/node_modules/@typescript-eslint/parser/_ts3.4/dist/parser.d.ts

@@ -1,22 +0,0 @@
-import { ScopeManager } from '@typescript-eslint/scope-manager';
-import { TSESTree } from '@typescript-eslint/types';
-import { ParserOptions } from '@typescript-eslint/types';
-import { ParserServices } from '@typescript-eslint/typescript-estree';
-import { visitorKeys } from '@typescript-eslint/typescript-estree';
-interface ParseForESLintResult {
-    ast: TSESTree.Program & {
-        range?: [
-            number,
-            number
-        ];
-        tokens?: TSESTree.Token[];
-        comments?: TSESTree.Comment[];
-    };
-    services: ParserServices;
-    visitorKeys: typeof visitorKeys;
-    scopeManager: ScopeManager;
-}
-declare function parse(code: string, options?: ParserOptions): ParseForESLintResult['ast'];
-declare function parseForESLint(code: string, options?: ParserOptions | null): ParseForESLintResult;
-export { parse, parseForESLint, ParserOptions };
-//# sourceMappingURL=parser.d.ts.map

package/node_modules/@typescript-eslint/parser/dist/index.d.ts

@@ -1,8 +0,0 @@
-export { parse, parseForESLint, ParserOptions } from './parser';
-export { ParserServices, clearCaches, createProgram, } from '@typescript-eslint/typescript-estree';
-export declare const version: string;
-export declare const meta: {
-    name: string;
-    version: string;
-};
-//# sourceMappingURL=index.d.ts.map

package/node_modules/@typescript-eslint/parser/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAChE,OAAO,EACL,cAAc,EACd,WAAW,EACX,aAAa,GACd,MAAM,sCAAsC,CAAC;AAI9C,eAAO,MAAM,OAAO,EAAE,MAA2C,CAAC;AAElE,eAAO,MAAM,IAAI;;;CAGhB,CAAC"}

package/node_modules/@typescript-eslint/parser/dist/index.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.meta = exports.version = exports.createProgram = exports.clearCaches = exports.parseForESLint = exports.parse = void 0;
-var parser_1 = require("./parser");
-Object.defineProperty(exports, "parse", { enumerable: true, get: function () { return parser_1.parse; } });
-Object.defineProperty(exports, "parseForESLint", { enumerable: true, get: function () { return parser_1.parseForESLint; } });
-var typescript_estree_1 = require("@typescript-eslint/typescript-estree");
-Object.defineProperty(exports, "clearCaches", { enumerable: true, get: function () { return typescript_estree_1.clearCaches; } });
-Object.defineProperty(exports, "createProgram", { enumerable: true, get: function () { return typescript_estree_1.createProgram; } });
-// note - cannot migrate this to an import statement because it will make TSC copy the package.json to the dist folder
-// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
-exports.version = require('../package.json').version;
-exports.meta = {
-    name: 'typescript-eslint/parser',
-    version: exports.version,
-};
-//# sourceMappingURL=index.js.map

package/node_modules/@typescript-eslint/parser/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAgE;AAAvD,+FAAA,KAAK,OAAA;AAAE,wGAAA,cAAc,OAAA;AAC9B,0EAI8C;AAF5C,gHAAA,WAAW,OAAA;AACX,kHAAA,aAAa,OAAA;AAGf,sHAAsH;AACtH,+GAA+G;AAClG,QAAA,OAAO,GAAW,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC;AAErD,QAAA,IAAI,GAAG;IAClB,IAAI,EAAE,0BAA0B;IAChC,OAAO,EAAP,eAAO;CACR,CAAC"}