xo 0.46.1 → 0.46.2

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

@@ -1,263 +0,0 @@
-# Requires that function parameters are typed as readonly to prevent accidental mutation of inputs (`prefer-readonly-parameter-types`)
-
-Mutating function arguments can lead to confusing, hard to debug behavior.
-Whilst it's easy to implicitly remember to not modify function arguments, explicitly typing arguments as readonly provides clear contract to consumers.
-This contract makes it easier for a consumer to reason about if a function has side-effects.
-
-## Rule Details
-
-This rule allows you to enforce that function parameters resolve to readonly types.
-A type is considered readonly if:
-
-- it is a primitive type (`string`, `number`, `boolean`, `symbol`, or an enum),
-- it is a function signature type,
-- it is a readonly array type whose element type is considered readonly.
-- it is a readonly tuple type whose elements are all considered readonly.
-- it is an object type whose properties are all marked as readonly, and whose values are all considered readonly.
-
-Examples of **incorrect** code for this rule:
-
-```ts
-function array1(arg: string[]) {} // array is not readonly
-function array2(arg: readonly string[][]) {} // array element is not readonly
-function array3(arg: [string, number]) {} // tuple is not readonly
-function array4(arg: readonly [string[], number]) {} // tuple element is not readonly
-// the above examples work the same if you use ReadonlyArray<T> instead
-
-function object1(arg: { prop: string }) {} // property is not readonly
-function object2(arg: { readonly prop: string; prop2: string }) {} // not all properties are readonly
-function object3(arg: { readonly prop: { prop2: string } }) {} // nested property is not readonly
-// the above examples work the same if you use Readonly<T> instead
-
-interface CustomArrayType extends ReadonlyArray<string> {
-  prop: string; // note: this property is mutable
-}
-function custom1(arg: CustomArrayType) {}
-
-interface CustomFunction {
-  (): void;
-  prop: string; // note: this property is mutable
-}
-function custom2(arg: CustomFunction) {}
-
-function union(arg: string[] | ReadonlyArray<number[]>) {} // not all types are readonly
-
-// rule also checks function types
-interface Foo {
-  (arg: string[]): void;
-}
-interface Foo {
-  new (arg: string[]): void;
-}
-const x = { foo(arg: string[]): void; };
-function foo(arg: string[]);
-type Foo = (arg: string[]) => void;
-interface Foo {
-  foo(arg: string[]): void;
-}
-```
-
-Examples of **correct** code for this rule:
-
-```ts
-function array1(arg: readonly string[]) {}
-function array2(arg: readonly (readonly string[])[]) {}
-function array3(arg: readonly [string, number]) {}
-function array4(arg: readonly [readonly string[], number]) {}
-// the above examples work the same if you use ReadonlyArray<T> instead
-
-function object1(arg: { readonly prop: string }) {}
-function object2(arg: { readonly prop: string; readonly prop2: string }) {}
-function object3(arg: { readonly prop: { readonly prop2: string } }) {}
-// the above examples work the same if you use Readonly<T> instead
-
-interface CustomArrayType extends ReadonlyArray<string> {
-  readonly prop: string;
-}
-function custom1(arg: Readonly<CustomArrayType>) {}
-// interfaces that extend the array types are not considered arrays, and thus must be made readonly.
-
-interface CustomFunction {
-  (): void;
-  readonly prop: string;
-}
-function custom2(arg: CustomFunction) {}
-
-function union(arg: readonly string[] | ReadonlyArray<number[]>) {}
-
-function primitive1(arg: string) {}
-function primitive2(arg: number) {}
-function primitive3(arg: boolean) {}
-function primitive4(arg: unknown) {}
-function primitive5(arg: null) {}
-function primitive6(arg: undefined) {}
-function primitive7(arg: any) {}
-function primitive8(arg: never) {}
-function primitive9(arg: string | number | undefined) {}
-
-function fnSig(arg: () => void) {}
-
-enum Foo { a, b }
-function enum(arg: Foo) {}
-
-function symb1(arg: symbol) {}
-const customSymbol = Symbol('a');
-function symb2(arg: typeof customSymbol) {}
-
-// function types
-interface Foo {
-  (arg: readonly string[]): void;
-}
-interface Foo {
-  new (arg: readonly string[]): void;
-}
-const x = { foo(arg: readonly string[]): void; };
-function foo(arg: readonly string[]);
-type Foo = (arg: readonly string[]) => void;
-interface Foo {
-  foo(arg: readonly string[]): void;
-}
-```
-
-## Options
-
-```ts
-interface Options {
-  checkParameterProperties?: boolean;
-  ignoreInferredTypes?: boolean;
-}
-
-const defaultOptions: Options = {
-  checkParameterProperties: true,
-  ignoreInferredTypes: false,
-  treatMethodsAsReadonly: false,
-};
-```
-
-### `checkParameterProperties`
-
-This option allows you to enable or disable the checking of parameter properties.
-Because parameter properties create properties on the class, it may be undesirable to force them to be readonly.
-
-Examples of **incorrect** code for this rule with `{checkParameterProperties: true}`:
-
-```ts
-class Foo {
-  constructor(private paramProp: string[]) {}
-}
-```
-
-Examples of **correct** code for this rule with `{checkParameterProperties: true}`:
-
-```ts
-class Foo {
-  constructor(private paramProp: readonly string[]) {}
-}
-```
-
-Examples of **correct** code for this rule with `{checkParameterProperties: false}`:
-
-```ts
-class Foo {
-  constructor(
-    private paramProp1: string[],
-    private paramProp2: readonly string[],
-  ) {}
-}
-```
-
-### `ignoreInferredTypes`
-
-This option allows you to ignore parameters which don't explicitly specify a type. This may be desirable in cases where an external dependency specifies a callback with mutable parameters, and manually annotating the callback's parameters is undesirable.
-
-Examples of **incorrect** code for this rule with `{ignoreInferredTypes: true}`:
-
-```ts
-import { acceptsCallback, CallbackOptions } from 'external-dependency';
-
-acceceptsCallback((options: CallbackOptions) => {});
-```
-
-<details>
-<summary>external-dependency.d.ts</summary>
-
-```ts
-export interface CallbackOptions {
-  prop: string;
-}
-type Callback = (options: CallbackOptions) => void;
-type AcceptsCallback = (callback: Callback) => void;
-
-export const acceptsCallback: AcceptsCallback;
-```
-
-</details>
-
-Examples of **correct** code for this rule with `{ignoreInferredTypes: true}`:
-
-```ts
-import { acceptsCallback } from 'external-dependency';
-
-acceceptsCallback(options => {});
-```
-
-<details>
-<summary>external-dependency.d.ts</summary>
-
-```ts
-export interface CallbackOptions {
-  prop: string;
-}
-type Callback = (options: CallbackOptions) => void;
-type AcceptsCallback = (callback: Callback) => void;
-
-export const acceptsCallback: AcceptsCallback;
-```
-
-</details>
-
-### `treatMethodsAsReadonly`
-
-This option allows you to treat all mutable methods as though they were readonly. This may be desirable in when you are never reassigning methods.
-
-Examples of **incorrect** code for this rule with `{treatMethodsAsReadonly: false}`:
-
-```ts
-type MyType = {
-  readonly prop: string;
-  method(): string; // note: this method is mutable
-};
-function foo(arg: MyType) {}
-```
-
-Examples of **correct** code for this rule with `{treatMethodsAsReadonly: false}`:
-
-```ts
-type MyType = Readonly<{
-  prop: string;
-  method(): string;
-}>;
-function foo(arg: MyType) {}
-
-type MyOtherType = {
-  readonly prop: string;
-  readonly method: () => string;
-};
-function bar(arg: MyOtherType) {}
-```
-
-Examples of **correct** code for this rule with `{treatMethodsAsReadonly: true}`:
-
-```ts
-type MyType = {
-  readonly prop: string;
-  method(): string; // note: this method is mutable
-};
-function foo(arg: MyType) {}
-```
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [ ] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,87 +0,0 @@
-# Requires that private members are marked as `readonly` if they're never modified outside of the constructor (`prefer-readonly`)
-
-This rule enforces that private members are marked as `readonly` if they're never modified outside of the constructor.
-
-## Rule Details
-
-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`.
-
-Examples of **incorrect** code for this rule:
-
-```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;
-  }
-}
-```
-
-Examples of **correct** code for this rule:
-
-```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
-
-This rule, in its default state, does not require any argument.
-
-### `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 **correct** code for the `{ "onlyInlineLambdas": true }` options:
-
-```ts
-class Container {
-  private neverModifiedPrivate = 'unchanged';
-}
-```
-
-Example of **incorrect** code for the `{ "onlyInlineLambdas": true }` options:
-
-```ts
-class Container {
-  private onClick = () => {
-    /* ... */
-  };
-}
-```
-
-## Related to
-
-- TSLint: ['prefer-readonly'](https://palantir.github.io/tslint/rules/prefer-readonly)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,60 +0,0 @@
-# Prefer using type parameter when calling `Array#reduce` instead of casting (`prefer-reduce-type-parameter`)
-
-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 cast the initial value. While this will work, it's not the most optimal
-solution as casting has subtle effects on the underlying types that can allow bugs to slip in.
-
-A better (and lesser known) solution is to pass the type in as a generic parameter 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.
-
-## Rule Details
-
-This rule looks for calls to `Array#reduce`, and warns if an initial value is being passed & casted,
-suggesting instead to pass the cast type to `Array#reduce` as its generic parameter.
-
-Examples of **incorrect** code for this rule:
-
-```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>,
-);
-```
-
-Examples of **correct** code for this rule:
-
-```ts
-[1, 2, 3].reduce<number[]>((arr, num) => arr.concat(num * 2), []);
-
-['a', 'b'].reduce<Record<string, boolean>>(
-  (accum, name) => ({
-    ...accum,
-    [name]: true,
-  }),
-  {},
-);
-```
-
-## Options
-
-There are no options.
-
-## When Not To Use It
-
-If you don't want to use typechecking in your linting, you can't use this rule.
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,57 +0,0 @@
-# Enforce that `RegExp#exec` is used instead of `String#match` if no global flag is provided (`prefer-regexp-exec`)
-
-As `String#match` is defined to be the same as `RegExp#exec` when the regular expression does not include the `g` flag, prefer a consistent usage.
-
-## Rule Details
-
-This rule is aimed at enforcing a consistent way to apply regular expressions to strings.
-
-From [`String#match` on MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/match):
-
-> If the regular expression does not include the g flag, returns the same result as `RegExp.exec()`.
-
-`RegExp#exec` may also be slightly faster than `String#match`; this is the reason to choose it as the preferred usage.
-
-Examples of **incorrect** code for this rule:
-
-```ts
-'something'.match(/thing/);
-
-'some things are just things'.match(/thing/);
-
-const text = 'something';
-const search = /thing/;
-text.match(search);
-```
-
-Examples of **correct** code for this rule:
-
-```ts
-/thing/.exec('something');
-
-'some things are just things'.match(/thing/g);
-
-const text = 'something';
-const search = /thing/;
-search.exec(text);
-```
-
-## Options
-
-There are no options.
-
-```json
-{
-  "@typescript-eslint/prefer-regexp-exec": "error"
-}
-```
-
-## 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.
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,96 +0,0 @@
-# Enforce that `this` is used when only `this` type is returned (`prefer-return-this-type`)
-
-[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).
-If any type other than `this` is specified as the return type of these chaining methods, TypeScript will fail to cast it when invoking in subclass.
-
-```ts
-class Animal {
-  eat(): Animal {
-    console.log("I'm moving!");
-    return this;
-  }
-}
-
-class Cat extends Animal {
-  meow(): Cat {
-    console.log('Meow~');
-    return this;
-  }
-}
-
-const cat = new Cat();
-// Error: Property 'meow' does not exist on type 'Animal'.
-// because `eat` returns `Animal` and not all animals meow.
-cat.eat().meow();
-
-// the error can be fixed by removing the return type of `eat` or use `this` as the return type.
-class Animal {
-  eat(): this {
-    console.log("I'm moving!");
-    return this;
-  }
-}
-
-class Cat extends Animal {
-  meow(): this {
-    console.log('Meow~');
-    return this;
-  }
-}
-
-const cat = new Cat();
-// no errors. Because `eat` returns `Cat` now
-cat.eat().meow();
-```
-
-Examples of **incorrect** code for this rule:
-
-```ts
-class Foo {
-  f1(): Foo {
-    return this;
-  }
-  f2 = (): Foo => {
-    return this;
-  };
-  f3(): Foo | undefined {
-    return Math.random() > 0.5 ? this : undefined;
-  }
-}
-```
-
-Examples of **correct** code for this rule:
-
-```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.
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,60 +0,0 @@
-# Enforce the use of `String#startsWith` and `String#endsWith` instead of other equivalent methods of checking substrings (`prefer-string-starts-ends-with`)
-
-There are multiple ways to verify if a string starts or ends with a specific string, such as `foo.indexOf('bar') === 0`.
-
-Since ES2015 has added `String#startsWith` and `String#endsWith`, this rule reports other ways to be consistent.
-
-## Rule Details
-
-This rule is aimed at enforcing a consistent way to check whether a string starts or ends with a specific string.
-
-Examples of **incorrect** code for this rule:
-
-```ts
-let 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);
-```
-
-Examples of **correct** code for this rule:
-
-```ts
-foo.startsWith('bar');
-foo.endsWith('bar');
-```
-
-## Options
-
-There are no options.
-
-```JSON
-{
-    "@typescript-eslint/prefer-string-starts-ends-with": "error"
-}
-```
-
-## When Not To Use It
-
-If you don't mind that style, you can turn this rule off safely.
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [x] 💭 Requires type information

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

@@ -1,71 +0,0 @@
-# Recommends using `@ts-expect-error` over `@ts-ignore` (`prefer-ts-expect-error`)
-
-TypeScript allows you to suppress all errors on a line by placing a single-line comment or a comment block line starting with `@ts-ignore` immediately before the erroring line.
-While powerful, there is no way to know if a `@ts-ignore` is actually suppressing an error without manually investigating what happens when the `@ts-ignore` is removed.
-
-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.
-
-To address this, TS3.9 ships with a new single-line comment directive: `// @ts-expect-error`.
-
-This directive operates in the same manner as `@ts-ignore`, but will error if the line it's meant to be suppressing doesn't actually contain an error, making it a lot safer.
-
-## Rule Details
-
-This rule looks for usages of `@ts-ignore`, and flags them to be replaced with `@ts-expect-error`.
-
-Examples of **incorrect** code for this rule:
-
-```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];
-};
-```
-
-Examples of **correct** code for this rule:
-
-```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 **NOT** using TypeScript 3.9 (or greater), then you will not be able to use this rule, as the directive is not supported
-
-## Further Reading
-
-- [Original Implementing PR](https://github.com/microsoft/TypeScript/pull/36014)
-
-## Attributes
-
-- [ ] ✅ Recommended
-- [x] 🔧 Fixable
-- [ ] 💭 Requires type information