@depup/typescript-eslint__eslint-plugin 8.57.1-depup.0

package/dist/rules/no-restricted-imports.js

@@ -0,0 +1,243 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+const ignore_1 = __importDefault(require("ignore"));
+const util_1 = require("../util");
+const getESLintCoreRule_1 = require("../util/getESLintCoreRule");
+const baseRule = (0, getESLintCoreRule_1.getESLintCoreRule)('no-restricted-imports');
+// In some versions of eslint, the base rule has a completely incompatible schema
+// This helper function is to safely try to get parts of the schema. If it's not
+// possible, we'll fallback to less strict checks.
+const tryAccess = (getter, fallback) => {
+    try {
+        return getter();
+    }
+    catch {
+        return fallback;
+    }
+};
+const baseSchema = baseRule.meta.schema;
+const allowTypeImportsOptionSchema = {
+    allowTypeImports: {
+        type: 'boolean',
+        description: 'Whether to allow type-only imports for a path.',
+    },
+};
+const arrayOfStringsOrObjects = {
+    type: 'array',
+    items: {
+        anyOf: [
+            { type: 'string' },
+            {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    ...tryAccess(() => baseSchema.anyOf[1].items[0].properties.paths.items.anyOf[1]
+                        .properties, undefined),
+                    ...allowTypeImportsOptionSchema,
+                },
+                required: tryAccess(() => baseSchema.anyOf[1].items[0].properties.paths.items.anyOf[1]
+                    .required, undefined),
+            },
+        ],
+    },
+    uniqueItems: true,
+};
+const arrayOfStringsOrObjectPatterns = {
+    anyOf: [
+        {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+            uniqueItems: true,
+        },
+        {
+            type: 'array',
+            items: {
+                type: 'object',
+                additionalProperties: false,
+                properties: {
+                    ...tryAccess(() => baseSchema.anyOf[1].items[0].properties.patterns.anyOf[1].items
+                        .properties, undefined),
+                    ...allowTypeImportsOptionSchema,
+                },
+                required: tryAccess(() => baseSchema.anyOf[1].items[0].properties.patterns.anyOf[1].items
+                    .required, []),
+            },
+            uniqueItems: true,
+        },
+    ],
+};
+const schema = {
+    anyOf: [
+        arrayOfStringsOrObjects,
+        {
+            type: 'array',
+            additionalItems: false,
+            items: [
+                {
+                    type: 'object',
+                    additionalProperties: false,
+                    properties: {
+                        paths: arrayOfStringsOrObjects,
+                        patterns: arrayOfStringsOrObjectPatterns,
+                    },
+                },
+            ],
+        },
+    ],
+};
+function isObjectOfPaths(obj) {
+    return !!obj && Object.hasOwn(obj, 'paths');
+}
+function isObjectOfPatterns(obj) {
+    return !!obj && Object.hasOwn(obj, 'patterns');
+}
+function isOptionsArrayOfStringOrObject(options) {
+    if (isObjectOfPaths(options[0])) {
+        return false;
+    }
+    if (isObjectOfPatterns(options[0])) {
+        return false;
+    }
+    return true;
+}
+function getRestrictedPaths(options) {
+    if (isOptionsArrayOfStringOrObject(options)) {
+        return options;
+    }
+    if (isObjectOfPaths(options[0])) {
+        return options[0].paths;
+    }
+    return [];
+}
+function getRestrictedPatterns(options) {
+    if (isObjectOfPatterns(options[0])) {
+        return options[0].patterns;
+    }
+    return [];
+}
+function shouldCreateRule(baseRules, options) {
+    if (Object.keys(baseRules).length === 0 || options.length === 0) {
+        return false;
+    }
+    if (!isOptionsArrayOfStringOrObject(options)) {
+        return !!(options[0].paths?.length || options[0].patterns?.length);
+    }
+    return true;
+}
+exports.default = (0, util_1.createRule)({
+    name: 'no-restricted-imports',
+    meta: {
+        type: 'suggestion',
+        // defaultOptions, -- base rule does not use defaultOptions
+        docs: {
+            description: 'Disallow specified modules when loaded by `import`',
+            extendsBaseRule: true,
+        },
+        fixable: baseRule.meta.fixable,
+        messages: baseRule.meta.messages,
+        schema,
+    },
+    defaultOptions: [],
+    create(context) {
+        const rules = baseRule.create(context);
+        const { options } = context;
+        if (!shouldCreateRule(rules, options)) {
+            return {};
+        }
+        const restrictedPaths = getRestrictedPaths(options);
+        const allowedTypeImportPathNameSet = new Set();
+        for (const restrictedPath of restrictedPaths) {
+            if (typeof restrictedPath === 'object' &&
+                restrictedPath.allowTypeImports) {
+                allowedTypeImportPathNameSet.add(restrictedPath.name);
+            }
+        }
+        function isAllowedTypeImportPath(importSource) {
+            return allowedTypeImportPathNameSet.has(importSource);
+        }
+        const restrictedPatterns = getRestrictedPatterns(options);
+        const allowedImportTypeMatchers = [];
+        const allowedImportTypeRegexMatchers = [];
+        for (const restrictedPattern of restrictedPatterns) {
+            if (typeof restrictedPattern === 'object' &&
+                restrictedPattern.allowTypeImports) {
+                // Following how ignore is configured in the base rule
+                if (restrictedPattern.group) {
+                    allowedImportTypeMatchers.push((0, ignore_1.default)({
+                        allowRelativePaths: true,
+                        ignoreCase: !restrictedPattern.caseSensitive,
+                    }).add(restrictedPattern.group));
+                }
+                if (restrictedPattern.regex) {
+                    allowedImportTypeRegexMatchers.push(new RegExp(restrictedPattern.regex, restrictedPattern.caseSensitive ? 'u' : 'iu'));
+                }
+            }
+        }
+        function isAllowedTypeImportPattern(importSource) {
+            return (
+            // As long as there's one matching pattern that allows type import
+            allowedImportTypeMatchers.some(matcher => matcher.ignores(importSource)) ||
+                allowedImportTypeRegexMatchers.some(regex => regex.test(importSource)));
+        }
+        function checkImportNode(node) {
+            if (node.importKind === 'type' ||
+                (node.specifiers.length > 0 &&
+                    node.specifiers.every(specifier => specifier.type === utils_1.AST_NODE_TYPES.ImportSpecifier &&
+                        specifier.importKind === 'type'))) {
+                const importSource = node.source.value.trim();
+                if (!isAllowedTypeImportPath(importSource) &&
+                    !isAllowedTypeImportPattern(importSource)) {
+                    return rules.ImportDeclaration(node);
+                }
+            }
+            else {
+                return rules.ImportDeclaration(node);
+            }
+        }
+        return {
+            ExportAllDeclaration: rules.ExportAllDeclaration,
+            'ExportNamedDeclaration[source]'(node) {
+                if (node.exportKind === 'type' ||
+                    (node.specifiers.length > 0 &&
+                        node.specifiers.every(specifier => specifier.exportKind === 'type'))) {
+                    const importSource = node.source.value.trim();
+                    if (!isAllowedTypeImportPath(importSource) &&
+                        !isAllowedTypeImportPattern(importSource)) {
+                        return rules.ExportNamedDeclaration(node);
+                    }
+                }
+                else {
+                    return rules.ExportNamedDeclaration(node);
+                }
+            },
+            ImportDeclaration: checkImportNode,
+            TSImportEqualsDeclaration(node) {
+                if (node.moduleReference.type === utils_1.AST_NODE_TYPES.TSExternalModuleReference) {
+                    const synthesizedImport = {
+                        ...node,
+                        type: utils_1.AST_NODE_TYPES.ImportDeclaration,
+                        assertions: [],
+                        attributes: [],
+                        source: node.moduleReference.expression,
+                        specifiers: [
+                            {
+                                ...node.id,
+                                type: utils_1.AST_NODE_TYPES.ImportDefaultSpecifier,
+                                local: node.id,
+                                // @ts-expect-error -- parent types are incompatible but it's fine for the purposes of this extension
+                                parent: node.id.parent,
+                            },
+                        ],
+                    };
+                    return checkImportNode(synthesizedImport);
+                }
+            },
+        };
+    },
+});

package/dist/rules/no-restricted-types.d.ts

@@ -0,0 +1,16 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+type Types = Record<string, boolean | string | {
+    fixWith?: string;
+    message: string;
+    suggest?: readonly string[];
+} | null>;
+export type Options = [
+    {
+        types?: Types;
+    }
+];
+export type MessageIds = 'bannedTypeMessage' | 'bannedTypeReplacement';
+declare const _default: TSESLint.RuleModule<MessageIds, Options, import("../../rules").ESLintPluginDocs, TSESLint.RuleListener> & {
+    name: string;
+};
+export default _default;

package/dist/rules/no-restricted-types.js

@@ -0,0 +1,165 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+const util_1 = require("../util");
+function removeSpaces(str) {
+    return str.replaceAll(/\s/g, '');
+}
+function stringifyNode(node, sourceCode) {
+    return removeSpaces(sourceCode.getText(node));
+}
+function getCustomMessage(bannedType) {
+    if (!bannedType || bannedType === true) {
+        return '';
+    }
+    if (typeof bannedType === 'string') {
+        return ` ${bannedType}`;
+    }
+    if (bannedType.message) {
+        return ` ${bannedType.message}`;
+    }
+    return '';
+}
+const TYPE_KEYWORDS = {
+    bigint: utils_1.AST_NODE_TYPES.TSBigIntKeyword,
+    boolean: utils_1.AST_NODE_TYPES.TSBooleanKeyword,
+    never: utils_1.AST_NODE_TYPES.TSNeverKeyword,
+    null: utils_1.AST_NODE_TYPES.TSNullKeyword,
+    number: utils_1.AST_NODE_TYPES.TSNumberKeyword,
+    object: utils_1.AST_NODE_TYPES.TSObjectKeyword,
+    string: utils_1.AST_NODE_TYPES.TSStringKeyword,
+    symbol: utils_1.AST_NODE_TYPES.TSSymbolKeyword,
+    undefined: utils_1.AST_NODE_TYPES.TSUndefinedKeyword,
+    unknown: utils_1.AST_NODE_TYPES.TSUnknownKeyword,
+    void: utils_1.AST_NODE_TYPES.TSVoidKeyword,
+};
+exports.default = (0, util_1.createRule)({
+    name: 'no-restricted-types',
+    meta: {
+        type: 'suggestion',
+        docs: {
+            description: 'Disallow certain types',
+        },
+        fixable: 'code',
+        hasSuggestions: true,
+        messages: {
+            bannedTypeMessage: "Don't use `{{name}}` as a type.{{customMessage}}",
+            bannedTypeReplacement: 'Replace `{{name}}` with `{{replacement}}`.',
+        },
+        schema: [
+            {
+                type: 'object',
+                $defs: {
+                    banConfig: {
+                        oneOf: [
+                            {
+                                type: 'boolean',
+                                description: 'Bans the type with the default message.',
+                                enum: [true],
+                            },
+                            {
+                                type: 'string',
+                                description: 'Bans the type with a custom message.',
+                            },
+                            {
+                                type: 'object',
+                                additionalProperties: false,
+                                description: 'Bans a type.',
+                                properties: {
+                                    fixWith: {
+                                        type: 'string',
+                                        description: 'Type to autofix replace with. Note that autofixers can be applied automatically - so you need to be careful with this option.',
+                                    },
+                                    message: {
+                                        type: 'string',
+                                        description: 'Custom error message.',
+                                    },
+                                    suggest: {
+                                        type: 'array',
+                                        description: 'Types to suggest replacing with.',
+                                        items: { type: 'string' },
+                                    },
+                                },
+                            },
+                        ],
+                    },
+                },
+                additionalProperties: false,
+                properties: {
+                    types: {
+                        type: 'object',
+                        additionalProperties: {
+                            $ref: '#/items/0/$defs/banConfig',
+                        },
+                        description: 'An object whose keys are the types you want to ban, and the values are error messages.',
+                    },
+                },
+            },
+        ],
+    },
+    defaultOptions: [{}],
+    create(context, [{ types = {} }]) {
+        const bannedTypes = new Map(Object.entries(types).map(([type, data]) => [removeSpaces(type), data]));
+        function checkBannedTypes(typeNode, name = stringifyNode(typeNode, context.sourceCode)) {
+            const bannedType = bannedTypes.get(name);
+            if (bannedType == null || bannedType === false) {
+                return;
+            }
+            const customMessage = getCustomMessage(bannedType);
+            const fixWith = bannedType && typeof bannedType === 'object' && bannedType.fixWith;
+            const suggest = bannedType && typeof bannedType === 'object'
+                ? bannedType.suggest
+                : undefined;
+            context.report({
+                node: typeNode,
+                messageId: 'bannedTypeMessage',
+                data: {
+                    name,
+                    customMessage,
+                },
+                fix: fixWith
+                    ? (fixer) => fixer.replaceText(typeNode, fixWith)
+                    : null,
+                suggest: suggest?.map(replacement => ({
+                    messageId: 'bannedTypeReplacement',
+                    data: {
+                        name,
+                        replacement,
+                    },
+                    fix: (fixer) => fixer.replaceText(typeNode, replacement),
+                })),
+            });
+        }
+        const keywordSelectors = (0, util_1.objectReduceKey)(TYPE_KEYWORDS, (acc, keyword) => {
+            if (bannedTypes.has(keyword)) {
+                acc[TYPE_KEYWORDS[keyword]] = (node) => checkBannedTypes(node, keyword);
+            }
+            return acc;
+        }, {});
+        return {
+            ...keywordSelectors,
+            TSClassImplements(node) {
+                checkBannedTypes(node);
+            },
+            TSInterfaceHeritage(node) {
+                checkBannedTypes(node);
+            },
+            TSTupleType(node) {
+                if (!node.elementTypes.length) {
+                    checkBannedTypes(node);
+                }
+            },
+            TSTypeLiteral(node) {
+                if (!node.members.length) {
+                    checkBannedTypes(node);
+                }
+            },
+            TSTypeReference(node) {
+                checkBannedTypes(node.typeName);
+                if (node.typeArguments) {
+                    checkBannedTypes(node);
+                }
+            },
+        };
+    },
+});

package/dist/rules/no-shadow.d.ts

@@ -0,0 +1,16 @@
+import type { TSESLint } from '@typescript-eslint/utils';
+export type MessageIds = 'noShadow' | 'noShadowGlobal';
+export type Options = [
+    {
+        allow?: string[];
+        builtinGlobals?: boolean;
+        hoist?: 'all' | 'functions' | 'functions-and-types' | 'never' | 'types';
+        ignoreFunctionTypeParameterNameValueShadow?: boolean;
+        ignoreOnInitialization?: boolean;
+        ignoreTypeValueShadow?: boolean;
+    }
+];
+declare const _default: TSESLint.RuleModule<MessageIds, Options, import("../../rules").ESLintPluginDocs, TSESLint.RuleListener> & {
+    name: string;
+};
+export default _default;