diff --git a/.tool-versions b/.tool-versions index 52e118f..557ea46 100644 --- a/.tool-versions +++ b/.tool-versions @@ -1 +1 @@ -nodejs lts +nodejs 20.11.0 diff --git a/docs/index.md b/docs/index.md index d79b1bd..316e7a2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -153,7 +153,7 @@ Refer to [setup instructions in README](../README.md#๐Ÿ—๏ธ-setup). | [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [default-param-last](https://typescript-eslint.io/rules/default-param-last)
Enforce default parameters to be last | | | | | [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [max-params](https://typescript-eslint.io/rules/max-params)
Enforce a maximum number of parameters in function definitions |
max: 4
{
  "max": 4
}
| | | | [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [method-signature-style](https://typescript-eslint.io/rules/method-signature-style)
Enforce using a particular method signature syntax | | ๐Ÿ”ง | | -| [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [no-magic-numbers](https://typescript-eslint.io/rules/no-magic-numbers)
Disallow magic numbers |
ignore: -1, 0, 1, 2, 7, 10,...
{
  "ignore": [
    -1,
    0,
    1,
    2,
    7,
    10,
    24,
    60,
    100,
    1000,
    3600
  ],
  "ignoreClassFieldInitialValues": true,
  "ignoreDefaultValues": true,
  "ignoreEnums": true,
  "ignoreNumericLiteralTypes": true,
  "ignoreReadonlyClassProperties": true,
  "ignoreTypeIndexes": true,
  "enforceConst": true,
  "detectObjects": true,
  "ignoreArrayIndexes": false
}
| | | +| [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [no-magic-numbers](https://typescript-eslint.io/rules/no-magic-numbers)
Disallow magic numbers |
ignore: -1, 0, 1, 2, 7, 10,...
{
  "ignore": [
    -1,
    0,
    1,
    2,
    7,
    10,
    24,
    60,
    100,
    1000,
    3600
  ],
  "ignoreClassFieldInitialValues": true,
  "ignoreDefaultValues": true,
  "ignoreEnums": true,
  "ignoreNumericLiteralTypes": true,
  "ignoreReadonlyClassProperties": true,
  "ignoreTypeIndexes": true,
  "enforceConst": true,
  "detectObjects": true,
  "ignoreArrayIndexes": false
}
| | ๐Ÿงช๐Ÿšซ | | [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [no-shadow](https://typescript-eslint.io/rules/no-shadow)
Disallow variable declarations from shadowing variables declared in the outer scope | | | | | [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [no-unused-expressions](https://typescript-eslint.io/rules/no-unused-expressions)
Disallow unused expressions | | | | | [![functional](./icons/icons8/lambda.png)](https://github.com/eslint-functional/eslint-plugin-functional#readme) | [no-let](https://github.com/eslint-functional/eslint-plugin-functional/blob/v6.0.0/docs/rules/no-let.md)
Disallow mutable variables. | | | ๐Ÿงช๐Ÿšซ | diff --git a/docs/typescript.md b/docs/typescript.md index f5579ac..a077a7e 100644 --- a/docs/typescript.md +++ b/docs/typescript.md @@ -101,7 +101,7 @@ Config for strict **TypeScript** projects. | [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [prefer-ts-expect-error](https://typescript-eslint.io/rules/prefer-ts-expect-error)
Enforce using `@ts-expect-error` over `@ts-ignore` | | ๐Ÿ”ง | | | [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [require-await](https://typescript-eslint.io/rules/require-await)
Disallow async functions which have no `await` expression | | | ๐Ÿงชโš ๏ธ | | [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [restrict-plus-operands](https://typescript-eslint.io/rules/restrict-plus-operands)
Require both operands of addition to be the same type and be `bigint`, `number`, or `string` |
allowAny: false, allowBoole...
{
  "allowAny": false,
  "allowBoolean": false,
  "allowNullish": false,
  "allowNumberAndString": false,
  "allowRegExp": false
}
| | | -| [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [restrict-template-expressions](https://typescript-eslint.io/rules/restrict-template-expressions)
Enforce template literal expressions to be of `string` type |
allowAny: false, allowBoole...
{
  "allowAny": false,
  "allowBoolean": false,
  "allowNullish": false,
  "allowNumber": false,
  "allowRegExp": false,
  "allowNever": false
}
| | ๐Ÿงช๐Ÿšซ | +| [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [restrict-template-expressions](https://typescript-eslint.io/rules/restrict-template-expressions)
Enforce template literal expressions to be of `string` type |
allowBoolean: true, allowNu...
{
  "allowBoolean": true,
  "allowNumber": true
}
| | ๐Ÿงช๐Ÿšซ | | [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [unified-signatures](https://typescript-eslint.io/rules/unified-signatures)
Disallow two overloads that could be unified into one with a union or an optional/rest parameter | | | | | [![@typescript-eslint](./icons/material/typescript.png)](https://typescript-eslint.io/) | [use-unknown-in-catch-callback-variable](https://typescript-eslint.io/rules/use-unknown-in-catch-callback-variable)
Enforce typing arguments in `.catch()` callbacks as `unknown` | | ๐Ÿ”ง, ๐Ÿ’ก | | | [![deprecation](./icons/icons8/expired.png)](https://github.com/gund/eslint-plugin-deprecation#readme) | [deprecation](https://github.com/gund/eslint-plugin-deprecation)
Do not use deprecated APIs. | | | |