xo 0.54.2 → 0.55.1

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

@@ -1,87 +0,0 @@
----
-description: "Require private members to be marked as `readonly` if they're never modified outside of the constructor."
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/prefer-readonly** for documentation.
-
-Member variables with the privacy `private` are never permitted to be modified outside of their declaring class.
-If that class never modifies their value, they may safely be marked as `readonly`.
-
-This rule reports on private members are marked as `readonly` if they're never modified outside of the constructor.
-
-## Examples
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-class Container {
-  // These member variables could be marked as readonly
-  private neverModifiedMember = true;
-  private onlyModifiedInConstructor: number;
-
-  public constructor(
-    onlyModifiedInConstructor: number,
-    // Private parameter properties can also be marked as readonly
-    private neverModifiedParameter: string,
-  ) {
-    this.onlyModifiedInConstructor = onlyModifiedInConstructor;
-  }
-}
-```
-
-### ✅ Correct
-
-```ts
-class Container {
-  // Public members might be modified externally
-  public publicMember: boolean;
-
-  // Protected members might be modified by child classes
-  protected protectedMember: number;
-
-  // This is modified later on by the class
-  private modifiedLater = 'unchanged';
-
-  public mutate() {
-    this.modifiedLater = 'mutated';
-  }
-}
-```
-
-## Options
-
-### `onlyInlineLambdas`
-
-You may pass `"onlyInlineLambdas": true` as a rule option within an object to restrict checking only to members immediately assigned a lambda value.
-
-```jsonc
-{
-  "@typescript-eslint/prefer-readonly": ["error", { "onlyInlineLambdas": true }]
-}
-```
-
-Example of code for the `{ "onlyInlineLambdas": true }` options:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-class Container {
-  private onClick = () => {
-    /* ... */
-  };
-}
-```
-
-#### ✅ Correct
-
-```ts
-class Container {
-  private neverModifiedPrivate = 'unchanged';
-}
-```

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-reduce-type-parameter.md

@@ -1,58 +0,0 @@
----
-description: 'Enforce using type parameter when calling `Array#reduce` instead of casting.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/prefer-reduce-type-parameter** for documentation.
-
-It's common to call `Array#reduce` with a generic type, such as an array or object, as the initial value.
-Since these values are empty, their types are not usable:
-
-- `[]` has type `never[]`, which can't have items pushed into it as nothing is type `never`
-- `{}` has type `{}`, which doesn't have an index signature and so can't have properties added to it
-
-A common solution to this problem is to use an `as` assertion on the initial value.
-While this will work, it's not the most optimal solution as type assertions have subtle effects on the underlying types that can allow bugs to slip in.
-
-A better solution is to pass the type in as a generic type argument to `Array#reduce` explicitly.
-This means that TypeScript doesn't have to try to infer the type, and avoids the common pitfalls that come with casting.
-
-This rule looks for calls to `Array#reduce`, and reports if an initial value is being passed & asserted.
-It will suggest instead pass the asserted type to `Array#reduce` as a generic type argument.
-
-## Examples
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-[1, 2, 3].reduce((arr, num) => arr.concat(num * 2), [] as number[]);
-
-['a', 'b'].reduce(
-  (accum, name) => ({
-    ...accum,
-    [name]: true,
-  }),
-  {} as Record<string, boolean>,
-);
-```
-
-### ✅ Correct
-
-```ts
-[1, 2, 3].reduce<number[]>((arr, num) => arr.concat(num * 2), []);
-
-['a', 'b'].reduce<Record<string, boolean>>(
-  (accum, name) => ({
-    ...accum,
-    [name]: true,
-  }),
-  {},
-);
-```
-
-## When Not To Use It
-
-If you don't want to use typechecking in your linting, you can't use this rule.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-regexp-exec.md

@@ -1,46 +0,0 @@
----
-description: 'Enforce `RegExp#exec` over `String#match` if no global flag is provided.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/prefer-regexp-exec** for documentation.
-
-`String#match` is defined to work the same as `RegExp#exec` when the regular expression does not include the `g` flag.
-Keeping to consistently using one of the two can help improve code readability.
-
-This rule reports when a `String#match` call can be replaced with an equivalent `RegExp#exec`.
-
-> `RegExp#exec` may also be slightly faster than `String#match`; this is the reason to choose it as the preferred usage.
-
-## Examples
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-'something'.match(/thing/);
-
-'some things are just things'.match(/thing/);
-
-const text = 'something';
-const search = /thing/;
-text.match(search);
-```
-
-### ✅ Correct
-
-```ts
-/thing/.exec('something');
-
-'some things are just things'.match(/thing/g);
-
-const text = 'something';
-const search = /thing/;
-search.exec(text);
-```
-
-## When Not To Use It
-
-If you prefer consistent use of `String#match` for both with `g` flag and without it, you can turn this rule off.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-return-this-type.md

@@ -1,87 +0,0 @@
----
-description: 'Enforce that `this` is used when only `this` type is returned.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/prefer-return-this-type** for documentation.
-
-[Method chaining](https://en.wikipedia.org/wiki/Method_chaining) is a common pattern in OOP languages and TypeScript provides a special [polymorphic `this` type](https://www.typescriptlang.org/docs/handbook/2/classes.html#this-types) to facilitate it.
-Class methods that explicitly declare a return type of the class name instead of `this` make it harder for extending classes to call that method: the returned object will be typed as the base class, not the derived class.
-
-This rule reports when a class method declares a return type of that class name instead of `this`.
-
-```ts
-class Animal {
-  eat(): Animal {
-    //   ~~~~~~
-    // Either removing this type annotation or replacing
-    // it with `this` would remove the type error below.
-    console.log("I'm moving!");
-    return this;
-  }
-}
-
-class Cat extends Animal {
-  meow(): Cat {
-    console.log('Meow~');
-    return this;
-  }
-}
-
-const cat = new Cat();
-cat.eat().meow();
-//        ~~~~
-// Error: Property 'meow' does not exist on type 'Animal'.
-// because `eat` returns `Animal` and not all animals meow.
-```
-
-## Examples
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-class Foo {
-  f1(): Foo {
-    return this;
-  }
-  f2 = (): Foo => {
-    return this;
-  };
-  f3(): Foo | undefined {
-    return Math.random() > 0.5 ? this : undefined;
-  }
-}
-```
-
-### ✅ Correct
-
-```ts
-class Foo {
-  f1(): this {
-    return this;
-  }
-  f2() {
-    return this;
-  }
-  f3 = (): this => {
-    return this;
-  };
-  f4 = () => {
-    return this;
-  };
-}
-
-class Base {}
-class Derived extends Base {
-  f(): Base {
-    return this;
-  }
-}
-```
-
-## When Not To Use It
-
-If you don't use method chaining or explicit return values, you can safely turn this rule off.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-string-starts-ends-with.md

@@ -1,57 +0,0 @@
----
-description: 'Enforce using `String#startsWith` and `String#endsWith` over other equivalent methods of checking substrings.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/prefer-string-starts-ends-with** for documentation.
-
-There are multiple ways to verify if a string starts or ends with a specific string, such as `foo.indexOf('bar') === 0`.
-As of ES2015, the most common way in JavaScript is to use `String#startsWith` and `String#endsWith`.
-Keeping to those methods consistently helps with code readability.
-
-This rule reports when a string method can be replaced safely with `String#startsWith` or `String#endsWith`.
-
-## Examples
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-declare const foo: string;
-
-// starts with
-foo[0] === 'b';
-foo.charAt(0) === 'b';
-foo.indexOf('bar') === 0;
-foo.slice(0, 3) === 'bar';
-foo.substring(0, 3) === 'bar';
-foo.match(/^bar/) != null;
-/^bar/.test(foo);
-
-// ends with
-foo[foo.length - 1] === 'b';
-foo.charAt(foo.length - 1) === 'b';
-foo.lastIndexOf('bar') === foo.length - 3;
-foo.slice(-3) === 'bar';
-foo.substring(foo.length - 3) === 'bar';
-foo.match(/bar$/) != null;
-/bar$/.test(foo);
-```
-
-### ✅ Correct
-
-```ts
-declare const foo: string;
-
-// starts with
-foo.startsWith('bar');
-
-// ends with
-foo.endsWith('bar');
-```
-
-## When Not To Use It
-
-If you don't mind that style, you can turn this rule off safely.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/prefer-ts-expect-error.md

@@ -1,69 +0,0 @@
----
-description: 'Enforce using `@ts-expect-error` over `@ts-ignore`.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/prefer-ts-expect-error** for documentation.
-
-TypeScript allows you to suppress all errors on a line by placing a comment starting with `@ts-ignore` or `@ts-expect-error` immediately before the erroring line.
-The two directives work the same, except `@ts-expect-error` causes a type error if placed before a line that's not erroring in the first place.
-
-This means its easy for `@ts-ignore`s to be forgotten about, and remain in code even after the error they were suppressing is fixed.
-This is dangerous, as if a new error arises on that line it'll be suppressed by the forgotten about `@ts-ignore`, and so be missed.
-
-## Examples
-
-This rule reports any usage of `@ts-ignore`, including a fixer to replace with `@ts-expect-error`.
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-// @ts-ignore
-const str: string = 1;
-
-/**
- * Explaining comment
- *
- * @ts-ignore */
-const multiLine: number = 'value';
-
-/** @ts-ignore */
-const block: string = 1;
-
-const isOptionEnabled = (key: string): boolean => {
-  // @ts-ignore: if key isn't in globalOptions it'll be undefined which is false
-  return !!globalOptions[key];
-};
-```
-
-### ✅ Correct
-
-```ts
-// @ts-expect-error
-const str: string = 1;
-
-/**
- * Explaining comment
- *
- * @ts-expect-error */
-const multiLine: number = 'value';
-
-/** @ts-expect-error */
-const block: string = 1;
-
-const isOptionEnabled = (key: string): boolean => {
-  // @ts-expect-error: if key isn't in globalOptions it'll be undefined which is false
-  return !!globalOptions[key];
-};
-```
-
-## When Not To Use It
-
-If you are compiling against multiple versions of TypeScript and using `@ts-ignore` to ignore version-specific type errors, this rule might get in your way.
-
-## Further Reading
-
-- [Original Implementing PR](https://github.com/microsoft/TypeScript/pull/36014)

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/promise-function-async.md

@@ -1,59 +0,0 @@
----
-description: 'Require any function or method that returns a Promise to be marked async.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/promise-function-async** for documentation.
-
-Ensures that each function is only capable of:
-
-- returning a rejected promise, or
-- throwing an Error object.
-
-In contrast, non-`async`, `Promise`-returning functions are technically capable of either.
-Code that handles the results of those functions will often need to handle both cases, which can get complex.
-This rule's practice removes a requirement for creating code to handle both cases.
-
-> When functions return unions of `Promise` and non-`Promise` types implicitly, it is usually a mistake—this rule flags those cases. If it is intentional, make the return type explicitly to allow the rule to pass.
-
-## Examples
-
-Examples of code for this rule
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-const arrowFunctionReturnsPromise = () => Promise.resolve('value');
-
-function functionReturnsPromise() {
-  return Promise.resolve('value');
-}
-
-function functionReturnsUnionWithPromiseImplicitly(p: boolean) {
-  return p ? 'value' : Promise.resolve('value');
-}
-```
-
-### ✅ Correct
-
-```ts
-const arrowFunctionReturnsPromise = async () => Promise.resolve('value');
-
-async function functionReturnsPromise() {
-  return Promise.resolve('value');
-}
-
-// An explicit return type that is not Promise means this function cannot be made async, so it is ignored by the rule
-function functionReturnsUnionWithPromiseExplicitly(
-  p: boolean,
-): string | Promise<string> {
-  return p ? 'value' : Promise.resolve('value');
-}
-
-async function functionReturnsUnionWithPromiseImplicitly(p: boolean) {
-  return p ? 'value' : Promise.resolve('value');
-}
-```

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

@@ -1,12 +0,0 @@
----
-description: 'Enforce the consistent use of either backticks, double, or single quotes.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/quotes** for documentation.
-
-## Examples
-
-This rule extends the base [`eslint/quotes`](https://eslint.org/docs/rules/quotes) rule.
-It adds support for TypeScript features which allow quoted names, but not backtick quoted names.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/require-array-sort-compare.md

@@ -1,78 +0,0 @@
----
-description: 'Require `Array#sort` calls to always provide a `compareFunction`.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/require-array-sort-compare** for documentation.
-
-When called without a compare function, `Array#sort()` converts all non-undefined array elements into strings and then compares said strings based off their UTF-16 code units [[ECMA specification](https://www.ecma-international.org/ecma-262/9.0/#sec-sortcompare)].
-
-The result is that elements are sorted alphabetically, regardless of their type.
-For example, when sorting numbers, this results in a "10 before 2" order:
-
-```ts
-[1, 2, 3, 10, 20, 30].sort(); //→ [1, 10, 2, 20, 3, 30]
-```
-
-This rule reports on any call to the `Array#sort()` method that doesn't provide a `compare` argument.
-
-## Examples
-
-This rule aims to ensure all calls of the native `Array#sort` method provide a `compareFunction`, while ignoring calls to user-defined `sort` methods.
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-const array: any[];
-const stringArray: string[];
-
-array.sort();
-
-// String arrays should be sorted using `String#localeCompare`.
-stringArray.sort();
-```
-
-### ✅ Correct
-
-```ts
-const array: any[];
-const userDefinedType: { sort(): void };
-
-array.sort((a, b) => a - b);
-array.sort((a, b) => a.localeCompare(b));
-
-userDefinedType.sort();
-```
-
-## Options
-
-### `ignoreStringArrays`
-
-Examples of code for this rule with `{ ignoreStringArrays: true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-const one = 1;
-const two = 2;
-const three = 3;
-[one, two, three].sort();
-```
-
-#### ✅ Correct
-
-```ts
-const one = '1';
-const two = '2';
-const three = '3';
-[one, two, three].sort();
-```
-
-## When Not To Use It
-
-If you understand the language specification enough, and/or only ever sort arrays in a string-like manner, you can turn this rule off safely.

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

@@ -1,24 +0,0 @@
----
-description: 'Disallow async functions which have no `await` expression.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/require-await** for documentation.
-
-## Examples
-
-This rule extends the base [`eslint/require-await`](https://eslint.org/docs/rules/require-await) rule.
-It uses type information to add support for `async` functions that return a `Promise`.
-
-Examples of **correct** code for this rule:
-
-```ts
-async function returnsPromise1() {
-  return Promise.resolve(1);
-}
-
-const returnsPromise2 = () => returnsPromise1();
-```
-
-## How to Use

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/restrict-plus-operands.md

@@ -1,98 +0,0 @@
----
-description: 'Require both operands of addition to be the same type and be `bigint`, `number`, or `string`.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/restrict-plus-operands** for documentation.
-
-TypeScript allows `+` adding together two values of any type(s).
-However, adding values that are not the same type and/or are not the same primitive type is often a sign of programmer error.
-
-This rule reports when a `+` operation combines two values of different types, or a type that is not `bigint`, `number`, or `string`.
-
-## Examples
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-var foo = '5.5' + 5;
-var foo = 1n + 1;
-```
-
-### ✅ Correct
-
-```ts
-var foo = parseInt('5.5', 10) + 10;
-var foo = 1n + 1n;
-```
-
-## Options
-
-### `checkCompoundAssignments`
-
-Examples of code for this rule with `{ checkCompoundAssignments: true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-/*eslint @typescript-eslint/restrict-plus-operands: ["error", { "checkCompoundAssignments": true }]*/
-
-let foo: string | undefined;
-foo += 'some data';
-
-let bar: string = '';
-bar += 0;
-```
-
-#### ✅ Correct
-
-```ts
-/*eslint @typescript-eslint/restrict-plus-operands: ["error", { "checkCompoundAssignments": true }]*/
-
-let foo: number = 0;
-foo += 1;
-
-let bar = '';
-bar += 'test';
-```
-
-### `allowAny`
-
-Examples of code for this rule with `{ allowAny: true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-var fn = (a: any, b: boolean) => a + b;
-var fn = (a: any, b: []) => a + b;
-var fn = (a: any, b: {}) => a + b;
-```
-
-#### ✅ Correct
-
-```ts
-var fn = (a: any, b: any) => a + b;
-var fn = (a: any, b: string) => a + b;
-var fn = (a: any, b: bigint) => a + b;
-var fn = (a: any, b: number) => a + b;
-```
-
-## When Not To Use It
-
-If you don't mind `"[object Object]"` in your strings, then you will not need this rule.
-
-## Related To
-
-- [`no-base-to-string`](./no-base-to-string.md)
-- [`restrict-template-expressions`](./restrict-template-expressions.md)
-
-## Further Reading
-
-- [`Object.prototype.toString()` MDN documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/toString)