@nr1e/commons 0.1.1 → 0.1.3-alpha.0

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/default-param-last.md

@@ -1,48 +0,0 @@
----
-description: 'Enforce default parameters to be last.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/default-param-last** for documentation.
-
-## Examples
-
-This rule extends the base [`eslint/default-param-last`](https://eslint.org/docs/rules/default-param-last) rule.
-It adds support for optional parameters.
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-/* eslint @typescript-eslint/default-param-last: "error" */
-
-function f(a = 0, b: number) {}
-function f(a: number, b = 0, c: number) {}
-function f(a: number, b?: number, c: number) {}
-class Foo {
-  constructor(public a = 10, private b: number) {}
-}
-class Foo {
-  constructor(public a?: number, private b: number) {}
-}
-```
-
-### ✅ Correct
-
-```ts
-/* eslint @typescript-eslint/default-param-last: "error" */
-
-function f(a = 0) {}
-function f(a: number, b = 0) {}
-function f(a: number, b?: number) {}
-function f(a: number, b?: number, c = 0) {}
-function f(a: number, b = 0, c?: number) {}
-class Foo {
-  constructor(public a, private b = 0) {}
-}
-class Foo {
-  constructor(public a, private b?: number) {}
-}
-```

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

@@ -1,77 +0,0 @@
----
-description: 'Enforce dot notation whenever possible.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/dot-notation** for documentation.
-
-## Examples
-
-This rule extends the base [`eslint/dot-notation`](https://eslint.org/docs/rules/dot-notation) rule.
-It adds:
-
-- Support for optionally ignoring computed `private` and/or `protected` member access.
-- Compatibility with TypeScript's `noPropertyAccessFromIndexSignature` option.
-
-## Options
-
-This rule adds the following options:
-
-```ts
-interface Options extends BaseDotNotationOptions {
-  allowPrivateClassPropertyAccess?: boolean;
-  allowProtectedClassPropertyAccess?: boolean;
-  allowIndexSignaturePropertyAccess?: boolean;
-}
-
-const defaultOptions: Options = {
-  ...baseDotNotationDefaultOptions,
-  allowPrivateClassPropertyAccess: false,
-  allowProtectedClassPropertyAccess: false,
-  allowIndexSignaturePropertyAccess: false,
-};
-```
-
-If the TypeScript compiler option `noPropertyAccessFromIndexSignature` is set to `true`, then this rule always allows the use of square bracket notation to access properties of types that have a `string` index signature, even if `allowIndexSignaturePropertyAccess` is `false`.
-
-### `allowPrivateClassPropertyAccess`
-
-Example of a correct code when `allowPrivateClassPropertyAccess` is set to `true`:
-
-```ts
-class X {
-  private priv_prop = 123;
-}
-
-const x = new X();
-x['priv_prop'] = 123;
-```
-
-### `allowProtectedClassPropertyAccess`
-
-Example of a correct code when `allowProtectedClassPropertyAccess` is set to `true`:
-
-```ts
-class X {
-  protected protected_prop = 123;
-}
-
-const x = new X();
-x['protected_prop'] = 123;
-```
-
-### `allowIndexSignaturePropertyAccess`
-
-Example of correct code when `allowIndexSignaturePropertyAccess` is set to `true`:
-
-```ts
-class X {
-  [key: string]: number;
-}
-
-const x = new X();
-x['hello'] = 123;
-```
-
-If the TypeScript compiler option `noPropertyAccessFromIndexSignature` is set to `true`, then the above code is always allowed, even if `allowIndexSignaturePropertyAccess` is `false`.

package/node_modules/@typescript-eslint/eslint-plugin/docs/rules/explicit-function-return-type.md

@@ -1,319 +0,0 @@
----
-description: 'Require explicit return types on functions and class methods.'
----
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/explicit-function-return-type** for documentation.
-
-Functions in TypeScript often don't need to be given an explicit return type annotation.
-Leaving off the return type is less code to read or write and allows the compiler to infer it from the contents of the function.
-
-However, explicit return types do make it visually more clear what type is returned by a function.
-They can also speed up TypeScript type checking performance in large codebases with many large functions.
-
-This rule enforces that functions do have an explicit return type annotation.
-
-## Examples
-
-<!--tabs-->
-
-### ❌ Incorrect
-
-```ts
-// Should indicate that no value is returned (void)
-function test() {
-  return;
-}
-
-// Should indicate that a number is returned
-var fn = function () {
-  return 1;
-};
-
-// Should indicate that a string is returned
-var arrowFn = () => 'test';
-
-class Test {
-  // Should indicate that no value is returned (void)
-  method() {
-    return;
-  }
-}
-```
-
-### ✅ Correct
-
-```ts
-// No return value should be expected (void)
-function test(): void {
-  return;
-}
-
-// A return value of type number
-var fn = function (): number {
-  return 1;
-};
-
-// A return value of type string
-var arrowFn = (): string => 'test';
-
-class Test {
-  // No return value should be expected (void)
-  method(): void {
-    return;
-  }
-}
-```
-
-## Options
-
-### Configuring in a mixed JS/TS codebase
-
-If you are working on a codebase within which you lint non-TypeScript code (i.e. `.js`/`.mjs`/`.cjs`/`.jsx`), you should ensure that you should use [ESLint `overrides`](https://eslint.org/docs/user-guide/configuring#disabling-rules-only-for-a-group-of-files) to only enable the rule on `.ts`/`.mts`/`.cts`/`.tsx` files. If you don't, then you will get unfixable lint errors reported within `.js`/`.mjs`/`.cjs`/`.jsx` files.
-
-```jsonc
-{
-  "rules": {
-    // disable the rule for all files
-    "@typescript-eslint/explicit-function-return-type": "off"
-  },
-  "overrides": [
-    {
-      // enable the rule specifically for TypeScript files
-      "files": ["*.ts", "*.mts", "*.cts", "*.tsx"],
-      "rules": {
-        "@typescript-eslint/explicit-function-return-type": "error"
-      }
-    }
-  ]
-}
-```
-
-### `allowExpressions`
-
-Examples of code for this rule with `{ allowExpressions: true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-function test() {}
-
-const fn = () => {};
-
-export default () => {};
-```
-
-#### ✅ Correct
-
-```ts
-node.addEventListener('click', () => {});
-
-node.addEventListener('click', function () {});
-
-const foo = arr.map(i => i * i);
-```
-
-### `allowTypedFunctionExpressions`
-
-Examples of code for this rule with `{ allowTypedFunctionExpressions: true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-let arrowFn = () => 'test';
-
-let funcExpr = function () {
-  return 'test';
-};
-
-let objectProp = {
-  foo: () => 1,
-};
-```
-
-#### ✅ Correct
-
-```ts
-type FuncType = () => string;
-
-let arrowFn: FuncType = () => 'test';
-
-let funcExpr: FuncType = function() {
-  return 'test';
-};
-
-let asTyped = (() => '') as () => string;
-let castTyped = <() => string>(() => '');
-
-interface ObjectType {
-  foo(): number;
-}
-let objectProp: ObjectType = {
-  foo: () => 1,
-};
-let objectPropAs = {
-  foo: () => 1,
-} as ObjectType;
-let objectPropCast = <ObjectType>{
-  foo: () => 1,
-};
-
-declare functionWithArg(arg: () => number);
-functionWithArg(() => 1);
-
-declare functionWithObjectArg(arg: { method: () => number });
-functionWithObjectArg({
-  method() {
-    return 1;
-  },
-});
-```
-
-### `allowHigherOrderFunctions`
-
-Examples of code for this rule with `{ allowHigherOrderFunctions: true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-var arrowFn = () => () => {};
-
-function fn() {
-  return function () {};
-}
-```
-
-#### ✅ Correct
-
-```ts
-var arrowFn = () => (): void => {};
-
-function fn() {
-  return function (): void {};
-}
-```
-
-### `allowDirectConstAssertionInArrowFunctions`
-
-Examples of code for this rule with `{ allowDirectConstAssertionInArrowFunctions: true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-const func = (value: number) => ({ type: 'X', value } as any);
-const func = (value: number) => ({ type: 'X', value } as Action);
-```
-
-#### ✅ Correct
-
-```ts
-const func = (value: number) => ({ foo: 'bar', value } as const);
-const func = () => x as const;
-```
-
-### `allowConciseArrowFunctionExpressionsStartingWithVoid`
-
-Examples of code for this rule with `{ allowConciseArrowFunctionExpressionsStartingWithVoid: true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-var join = (a: string, b: string) => `${a}${b}`;
-
-const log = (message: string) => {
-  console.log(message);
-};
-```
-
-#### ✅ Correct
-
-```ts
-var log = (message: string) => void console.log(message);
-```
-
-### `allowFunctionsWithoutTypeParameters`
-
-Examples of code for this rule with `{ allowFunctionsWithoutTypeParameters: true }`:
-
-<!--tabs-->
-
-#### ❌ Incorrect
-
-```ts
-function foo<T>(t: T) {
-  return t;
-}
-
-const bar = <T>(t: T) => t;
-```
-
-#### ✅ Correct
-
-```ts
-function foo<T>(t: T): T {
-  return t;
-}
-
-const bar = <T>(t: T): T => t;
-
-const allowedFunction(x: string) {
-  return x;
-}
-
-const allowedArrow = (x: string) => x;
-```
-
-### `allowedNames`
-
-You may pass function/method names you would like this rule to ignore, like so:
-
-```json
-{
-  "@typescript-eslint/explicit-function-return-type": [
-    "error",
-    {
-      "allowedNames": ["ignoredFunctionName", "ignoredMethodName"]
-    }
-  ]
-}
-```
-
-### `allowIIFE`
-
-Examples of code for this rule with `{ allowIIFE: true }`:
-
-#### ❌ Incorrect
-
-```ts
-var func = () => 'foo';
-```
-
-#### ✅ Correct
-
-```ts
-var foo = (() => 'foo')();
-
-var bar = (function () {
-  return 'bar';
-})();
-```
-
-## When Not To Use It
-
-If you don't wish to prevent calling code from using function return values in unexpected ways, then
-you will not need this rule.
-
-## Further Reading
-
-- TypeScript [Functions](https://www.typescriptlang.org/docs/handbook/functions.html#function-types)