@typescript-eslint/eslint-plugin 8.0.0-alpha.6 → 8.0.0-alpha.60

package/dist/rules/no-useless-template-literals.js

@@ -1,153 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("@typescript-eslint/utils");
-const ts = __importStar(require("typescript"));
-const util_1 = require("../util");
-exports.default = (0, util_1.createRule)({
-    name: 'no-useless-template-literals',
-    meta: {
-        fixable: 'code',
-        type: 'suggestion',
-        docs: {
-            description: 'Disallow unnecessary template literals',
-            recommended: 'strict',
-            requiresTypeChecking: true,
-        },
-        messages: {
-            noUselessTemplateLiteral: 'Template literal expression is unnecessary and can be simplified.',
-        },
-        schema: [],
-    },
-    defaultOptions: [],
-    create(context) {
-        const services = (0, util_1.getParserServices)(context);
-        function isUnderlyingTypeString(expression) {
-            const type = (0, util_1.getConstrainedTypeAtLocation)(services, expression);
-            const isString = (t) => {
-                return (0, util_1.isTypeFlagSet)(t, ts.TypeFlags.StringLike);
-            };
-            if (type.isUnion()) {
-                return type.types.every(isString);
-            }
-            if (type.isIntersection()) {
-                return type.types.some(isString);
-            }
-            return isString(type);
-        }
-        function isLiteral(expression) {
-            return expression.type === utils_1.AST_NODE_TYPES.Literal;
-        }
-        function isTemplateLiteral(expression) {
-            return expression.type === utils_1.AST_NODE_TYPES.TemplateLiteral;
-        }
-        function isInfinityIdentifier(expression) {
-            return (expression.type === utils_1.AST_NODE_TYPES.Identifier &&
-                expression.name === 'Infinity');
-        }
-        function isNaNIdentifier(expression) {
-            return (expression.type === utils_1.AST_NODE_TYPES.Identifier &&
-                expression.name === 'NaN');
-        }
-        return {
-            TemplateLiteral(node) {
-                if (node.parent.type === utils_1.AST_NODE_TYPES.TaggedTemplateExpression) {
-                    return;
-                }
-                const hasSingleStringVariable = node.quasis.length === 2 &&
-                    node.quasis[0].value.raw === '' &&
-                    node.quasis[1].value.raw === '' &&
-                    node.expressions.length === 1 &&
-                    isUnderlyingTypeString(node.expressions[0]);
-                if (hasSingleStringVariable) {
-                    context.report({
-                        node: node.expressions[0],
-                        messageId: 'noUselessTemplateLiteral',
-                        fix(fixer) {
-                            const [prevQuasi, nextQuasi] = node.quasis;
-                            // Remove the quasis and backticks.
-                            return [
-                                fixer.removeRange([
-                                    prevQuasi.range[1] - 3,
-                                    node.expressions[0].range[0],
-                                ]),
-                                fixer.removeRange([
-                                    node.expressions[0].range[1],
-                                    nextQuasi.range[0] + 2,
-                                ]),
-                            ];
-                        },
-                    });
-                    return;
-                }
-                const fixableExpressions = node.expressions.filter(expression => isLiteral(expression) ||
-                    isTemplateLiteral(expression) ||
-                    (0, util_1.isUndefinedIdentifier)(expression) ||
-                    isInfinityIdentifier(expression) ||
-                    isNaNIdentifier(expression));
-                fixableExpressions.forEach(expression => {
-                    context.report({
-                        node: expression,
-                        messageId: 'noUselessTemplateLiteral',
-                        fix(fixer) {
-                            const index = node.expressions.indexOf(expression);
-                            const prevQuasi = node.quasis[index];
-                            const nextQuasi = node.quasis[index + 1];
-                            // Remove the quasis' parts that are related to the current expression.
-                            const fixes = [
-                                fixer.removeRange([
-                                    prevQuasi.range[1] - 2,
-                                    expression.range[0],
-                                ]),
-                                fixer.removeRange([
-                                    expression.range[1],
-                                    nextQuasi.range[0] + 1,
-                                ]),
-                            ];
-                            const stringValue = (0, util_1.getStaticStringValue)(expression);
-                            if (stringValue != null) {
-                                const escapedValue = stringValue.replace(/([`$\\])/g, '\\$1');
-                                fixes.push(fixer.replaceText(expression, escapedValue));
-                            }
-                            else if (isTemplateLiteral(expression)) {
-                                // Note that some template literals get handled in the previous branch too.
-                                // Remove the beginning and trailing backtick characters.
-                                fixes.push(fixer.removeRange([
-                                    expression.range[0],
-                                    expression.range[0] + 1,
-                                ]), fixer.removeRange([
-                                    expression.range[1] - 1,
-                                    expression.range[1],
-                                ]));
-                            }
-                            return fixes;
-                        },
-                    });
-                });
-            },
-        };
-    },
-});
-//# sourceMappingURL=no-useless-template-literals.js.map

package/dist/rules/no-useless-template-literals.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"no-useless-template-literals.js","sourceRoot":"","sources":["../../src/rules/no-useless-template-literals.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AACA,oDAA0D;AAC1D,+CAAiC;AAEjC,kCAOiB;AAIjB,kBAAe,IAAA,iBAAU,EAAgB;IACvC,IAAI,EAAE,8BAA8B;IACpC,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM;QACf,IAAI,EAAE,YAAY;QAClB,IAAI,EAAE;YACJ,WAAW,EAAE,wCAAwC;YACrD,WAAW,EAAE,QAAQ;YACrB,oBAAoB,EAAE,IAAI;SAC3B;QACD,QAAQ,EAAE;YACR,wBAAwB,EACtB,mEAAmE;SACtE;QACD,MAAM,EAAE,EAAE;KACX;IACD,cAAc,EAAE,EAAE;IAClB,MAAM,CAAC,OAAO;QACZ,MAAM,QAAQ,GAAG,IAAA,wBAAiB,EAAC,OAAO,CAAC,CAAC;QAE5C,SAAS,sBAAsB,CAC7B,UAA+B;YAE/B,MAAM,IAAI,GAAG,IAAA,mCAA4B,EAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YAEhE,MAAM,QAAQ,GAAG,CAAC,CAAU,EAAW,EAAE;gBACvC,OAAO,IAAA,oBAAa,EAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;YACnD,CAAC,CAAC;YAEF,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACpC,CAAC;YAED,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,CAAC;gBAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACnC,CAAC;YAED,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;QAED,SAAS,SAAS,CAAC,UAA+B;YAChD,OAAO,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,OAAO,CAAC;QACpD,CAAC;QAED,SAAS,iBAAiB,CAAC,UAA+B;YACxD,OAAO,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,eAAe,CAAC;QAC5D,CAAC;QAED,SAAS,oBAAoB,CAAC,UAA+B;YAC3D,OAAO,CACL,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU;gBAC7C,UAAU,CAAC,IAAI,KAAK,UAAU,CAC/B,CAAC;QACJ,CAAC;QAED,SAAS,eAAe,CAAC,UAA+B;YACtD,OAAO,CACL,UAAU,CAAC,IAAI,KAAK,sBAAc,CAAC,UAAU;gBAC7C,UAAU,CAAC,IAAI,KAAK,KAAK,CAC1B,CAAC;QACJ,CAAC;QAED,OAAO;YACL,eAAe,CAAC,IAA8B;gBAC5C,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,sBAAc,CAAC,wBAAwB,EAAE,CAAC;oBACjE,OAAO;gBACT,CAAC;gBAED,MAAM,uBAAuB,GAC3B,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;oBACxB,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE;oBAC/B,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,KAAK,EAAE;oBAC/B,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC;oBAC7B,sBAAsB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;gBAE9C,IAAI,uBAAuB,EAAE,CAAC;oBAC5B,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;wBACzB,SAAS,EAAE,0BAA0B;wBACrC,GAAG,CAAC,KAAK;4BACP,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;4BAE3C,mCAAmC;4BACnC,OAAO;gCACL,KAAK,CAAC,WAAW,CAAC;oCAChB,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;oCACtB,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;iCAC7B,CAAC;gCAEF,KAAK,CAAC,WAAW,CAAC;oCAChB,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;oCAC5B,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;iCACvB,CAAC;6BACH,CAAC;wBACJ,CAAC;qBACF,CAAC,CAAC;oBAEH,OAAO;gBACT,CAAC;gBAED,MAAM,kBAAkB,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,CAChD,UAAU,CAAC,EAAE,CACX,SAAS,CAAC,UAAU,CAAC;oBACrB,iBAAiB,CAAC,UAAU,CAAC;oBAC7B,IAAA,4BAAqB,EAAC,UAAU,CAAC;oBACjC,oBAAoB,CAAC,UAAU,CAAC;oBAChC,eAAe,CAAC,UAAU,CAAC,CAC9B,CAAC;gBAEF,kBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;oBACtC,OAAO,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,UAAU;wBAChB,SAAS,EAAE,0BAA0B;wBACrC,GAAG,CAAC,KAAK;4BACP,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;4BACnD,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;4BACrC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;4BAEzC,uEAAuE;4BACvE,MAAM,KAAK,GAAG;gCACZ,KAAK,CAAC,WAAW,CAAC;oCAChB,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;oCACtB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;iCACpB,CAAC;gCAEF,KAAK,CAAC,WAAW,CAAC;oCAChB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;oCACnB,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;iCACvB,CAAC;6BACH,CAAC;4BAEF,MAAM,WAAW,GAAG,IAAA,2BAAoB,EAAC,UAAU,CAAC,CAAC;4BAErD,IAAI,WAAW,IAAI,IAAI,EAAE,CAAC;gCACxB,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;gCAE9D,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC;4BAC1D,CAAC;iCAAM,IAAI,iBAAiB,CAAC,UAAU,CAAC,EAAE,CAAC;gCACzC,2EAA2E;gCAC3E,yDAAyD;gCACzD,KAAK,CAAC,IAAI,CACR,KAAK,CAAC,WAAW,CAAC;oCAChB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;oCACnB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;iCACxB,CAAC,EACF,KAAK,CAAC,WAAW,CAAC;oCAChB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;oCACvB,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;iCACpB,CAAC,CACH,CAAC;4BACJ,CAAC;4BAED,OAAO,KAAK,CAAC;wBACf,CAAC;qBACF,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;YACL,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}

package/docs/rules/ban-types.mdx

@@ -1,138 +0,0 @@
----
-description: 'Disallow certain types.'
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/ban-types** for documentation.
-
-Some built-in types have aliases, while some types are considered dangerous or harmful.
-It's often a good idea to ban certain types to help with consistency and safety.
-
-This rule bans specific types and can suggest alternatives.
-Note that it does not ban the corresponding runtime objects from being used.
-
-## Examples
-
-Examples of code with the default options:
-
-<Tabs>
-<TabItem value="❌ Incorrect">
-
-```ts
-// use lower-case primitives for consistency
-const str: String = 'foo';
-const bool: Boolean = true;
-const num: Number = 1;
-const symb: Symbol = Symbol('foo');
-const bigInt: BigInt = 1n;
-
-// use a proper function type
-const func: Function = () => 1;
-
-// use safer object types
-const lowerObj: Object = {};
-const capitalObj: Object = { a: 'string' };
-
-const curly1: {} = 1;
-const curly2: {} = { a: 'string' };
-```
-
-</TabItem>
-<TabItem value="✅ Correct">
-
-```ts
-// use lower-case primitives for consistency
-const str: string = 'foo';
-const bool: boolean = true;
-const num: number = 1;
-const symb: symbol = Symbol('foo');
-const bigInt: bigint = 1n;
-
-// use a proper function type
-const func: () => number = () => 1;
-
-// use safer object types
-const lowerObj: object = {};
-const capitalObj: { a: string } = { a: 'string' };
-
-const curly1: number = 1;
-const curly2: Record<'a', string> = { a: 'string' };
-```
-
-</TabItem>
-</Tabs>
-
-## Options
-
-The default options provide a set of "best practices", intended to provide safety and standardization in your codebase:
-
-- Don't use the upper-case primitive types, you should use the lower-case types for consistency.
-- Avoid the `Function` type, as it provides little safety for the following reasons:
-  - It provides no type safety when calling the value, which means it's easy to provide the wrong arguments.
-  - It accepts class declarations, which will fail when called, as they are called without the `new` keyword.
-- Avoid the `Object` and `{}` types, as they mean "any non-nullish value".
-  - This is a point of confusion for many developers, who think it means "any object type".
-  - See [this comment for more information](https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-675156492).
-
-<details>
-<summary>Default Options</summary>
-
-{/* Inject default options */}
-
-</details>
-
-### `types`
-
-An object whose keys are the types you want to ban, and the values are error messages.
-
-The type can either be a type name literal (`Foo`), a type name with generic parameter instantiation(s) (`Foo<Bar>`), the empty object literal (`{}`), or the empty tuple type (`[]`).
-
-The values can be:
-
-- A string, which is the error message to be reported; or
-- `false` to specifically un-ban this type (useful when you are using `extendDefaults`); or
-- An object with the following properties:
-  - `message: string` - the message to display when the type is matched.
-  - `fixWith?: string` - a string to replace the banned type with when the fixer is run. If this is omitted, no fix will be done.
-  - `suggest?: string[]` - a list of suggested replacements for the banned type.
-
-### `extendDefaults`
-
-If you're specifying custom `types`, you can set this to `true` to extend the default `types` configuration. This is a convenience option to save you copying across the defaults when adding another type.
-
-If this is `false`, the rule will _only_ use the types defined in your configuration.
-
-Example configuration:
-
-```jsonc
-{
-  "@typescript-eslint/ban-types": [
-    "error",
-    {
-      "types": {
-        // add a custom message to help explain why not to use it
-        "Foo": "Don't use Foo because it is unsafe",
-
-        // add a custom message, AND tell the plugin how to fix it
-        "OldAPI": {
-          "message": "Use NewAPI instead",
-          "fixWith": "NewAPI",
-        },
-
-        // un-ban a type that's banned by default
-        "{}": false,
-      },
-      "extendDefaults": true,
-    },
-  ],
-}
-```
-
-## When Not To Use It
-
-If your project is a rare one that intentionally deals with the class equivalents of primitives, it might not be worthwhile to enable the default `ban-types` options.
-You might consider using [ESLint disable comments](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1) for those specific situations instead of completely disabling this rule.

package/docs/rules/no-throw-literal.mdx

@@ -1,25 +0,0 @@
----
-description: 'Disallow throwing literals as exceptions.'
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-> 🛑 This file is source code, not the primary documentation location! 🛑
->
-> See **https://typescript-eslint.io/rules/no-throw-literal** for documentation.
-
-It is considered good practice to only `throw` the `Error` object itself or an object using the `Error` object as base objects for user-defined exceptions.
-The fundamental benefit of `Error` objects is that they automatically keep track of where they were built and originated.
-
-This rule restricts what can be thrown as an exception.
-
-:::warning
-This rule is being renamed to [`only-throw-error`](./only-throw-error.mdx).
-When it was first created, it only prevented literals from being thrown (hence the name), but it has now been expanded to only allow expressions which have a possibility of being an `Error` object.
-With the `allowThrowingAny` and `allowThrowingUnknown` options, it can be configured to only allow throwing values which are guaranteed to be an instance of `Error`.
-
-The current name `no-throw-literal` will be removed in a future major version of typescript-eslint.
-:::
-
-{/* Intentionally Omitted: When Not To Use It */}