eslint-plugin-node-dependencies 1.3.0 → 2.0.0

package/dist/rules/compat-engines.js

@@ -1,263 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const jsonc_eslint_parser_1 = require("jsonc-eslint-parser");
-const utils_1 = require("../utils");
-const semver_1 = __importDefault(require("semver"));
-const ast_utils_1 = require("../utils/ast-utils");
-const semver_2 = require("../utils/semver");
-const meta_1 = require("../utils/meta");
-const eslint_compat_utils_1 = require("eslint-compat-utils");
-class EnginesContext {
-    constructor(engineNames, validDependencies = new Set()) {
-        this.unprocessedEngines = new Set();
-        this.invalidEngines = new Map();
-        this.validEngines = new Set();
-        this.validDependencies = new Set();
-        this.engines = new Set(engineNames);
-        this.unprocessedEngines = new Set(this.engines);
-        this.validDependencies = validDependencies;
-    }
-    nextContext() {
-        return new EnginesContext(this.unprocessedEngines, this.validDependencies);
-    }
-    markAsProcessed(module) {
-        this.unprocessedEngines.delete(module);
-    }
-    isAllProcessed() {
-        return this.unprocessedEngines.size === 0;
-    }
-    markAsValid(module) {
-        this.validEngines.add(module);
-        this.invalidEngines.delete(module);
-    }
-    addInvalid(module, allowedVer) {
-        if (this.validEngines.has(module)) {
-            return;
-        }
-        const vers = this.invalidEngines.get(module);
-        if (vers) {
-            vers.set(allowedVer.raw, allowedVer);
-        }
-        else {
-            this.invalidEngines.set(module, new Map([[allowedVer.raw, allowedVer]]));
-        }
-    }
-    hasInvalid() {
-        return this.invalidEngines.size > 0;
-    }
-    getInvalid() {
-        return this.invalidEngines;
-    }
-    markAsValidDependency(name, ver) {
-        this.validDependencies.add(`${name}@${ver}`);
-    }
-    isValidDependency(name, ver) {
-        return this.validDependencies.has(`${name}@${ver}`);
-    }
-}
-function buildAdjustRangeForSelf(comparisonType, original) {
-    const adjustVers = [];
-    for (const cc of original.set) {
-        if (cc.length === 1) {
-            if (cc[0].operator === ">" || cc[0].operator === ">=") {
-                adjustVers.push(`${cc[0].value} <${semver_1.default.inc(cc[0].semver.version, "premajor")}`);
-                continue;
-            }
-        }
-        adjustVers.push(cc.map((c) => c.value).join(" "));
-    }
-    const range = new semver_1.default.Range(adjustVers.join("||"));
-    if (comparisonType === "normal") {
-        return range;
-    }
-    if (comparisonType === "major") {
-        return range;
-    }
-    throw new Error(`Illegal comparisonType: ${comparisonType}`);
-}
-function buildAdjustRangeForDeps(comparisonType, original) {
-    if (comparisonType === "normal") {
-        return original;
-    }
-    if (comparisonType === "major") {
-        const majorVers = [];
-        for (const cc of original.set) {
-            majorVers.push(cc
-                .map((c) => {
-                if (c.operator === ">" || c.operator === ">=") {
-                    return `${c.operator}${c.semver.major}`;
-                }
-                return c.value;
-            })
-                .join(" "));
-        }
-        return new semver_1.default.Range(majorVers.join("||"));
-    }
-    throw new Error(`Illegal comparisonType: ${comparisonType}`);
-}
-function extractDependencies(metaList) {
-    const dependencies = new Map();
-    for (const meta of metaList) {
-        for (const [m, v] of [
-            ...(0, meta_1.getDependencies)(meta, "dependencies"),
-            ...(0, meta_1.getDependencies)(meta, "peerDependencies"),
-        ]) {
-            const range = (0, semver_2.getSemverRange)(v);
-            if (!range) {
-                continue;
-            }
-            const ranges = dependencies.get(m);
-            if (ranges) {
-                ranges.push(range);
-            }
-            else {
-                dependencies.set(m, [range]);
-            }
-        }
-    }
-    return [...dependencies].sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0));
-}
-exports.default = (0, utils_1.createRule)("compat-engines", {
-    meta: {
-        docs: {
-            description: "enforce the versions of the engines of the dependencies to be compatible.",
-            category: "Possible Errors",
-            recommended: true,
-        },
-        schema: [
-            {
-                type: "object",
-                properties: {
-                    deep: { type: "boolean" },
-                    comparisonType: { enum: ["normal", "major"] },
-                },
-                additionalProperties: false,
-            },
-        ],
-        messages: {},
-        type: "problem",
-    },
-    create(context) {
-        var _a, _b, _c;
-        const sourceCode = (0, eslint_compat_utils_1.getSourceCode)(context);
-        if (!sourceCode.parserServices.isJSON) {
-            return {};
-        }
-        const deep = ((_a = context.options[0]) === null || _a === void 0 ? void 0 : _a.deep) !== false;
-        const comparisonType = (_c = (_b = context.options[0]) === null || _b === void 0 ? void 0 : _b.comparisonType) !== null && _c !== void 0 ? _c : "normal";
-        const selfEngines = new Map();
-        function processMeta(ctx, meta) {
-            const depEngines = (0, meta_1.getEngines)(meta);
-            for (const module of ctx.engines) {
-                const selfVer = selfEngines.get(module);
-                const engineValue = depEngines.get(module);
-                if (engineValue && engineValue !== "*") {
-                    ctx.markAsProcessed(module);
-                }
-                const depVer = (0, semver_2.getSemverRange)(engineValue || "*");
-                if (!depVer) {
-                    continue;
-                }
-                if (semver_1.default.subset(selfVer.adjust, buildAdjustRangeForDeps(comparisonType, depVer))) {
-                    ctx.markAsValid(module);
-                }
-                else {
-                    ctx.addInvalid(module, depVer);
-                }
-            }
-        }
-        function processDependencyModule(ctx, name, ver, modules, node) {
-            const currModules = [...modules, `${name}@${ver}`];
-            const nodeModulesMeta = (0, meta_1.getMetaFromNodeModules)(name, ver, { context });
-            if (nodeModulesMeta) {
-                processMeta(ctx, nodeModulesMeta);
-                if (!ctx.hasInvalid() && ctx.isAllProcessed()) {
-                    return;
-                }
-            }
-            const metaData = (0, meta_1.getMetaFromNpm)(name, ver);
-            for (const meta of metaData.cache) {
-                processMeta(ctx, meta);
-                if (!ctx.hasInvalid() && ctx.isAllProcessed()) {
-                    return;
-                }
-            }
-            const metaList = metaData.get();
-            if (!metaList) {
-                return;
-            }
-            for (const meta of metaList) {
-                processMeta(ctx, meta);
-                if (!ctx.hasInvalid() && ctx.isAllProcessed()) {
-                    return;
-                }
-            }
-            for (const [module, allowedVers] of ctx.getInvalid()) {
-                const selfVer = selfEngines.get(module);
-                const depVer = (0, semver_2.normalizeSemverRange)(...allowedVers.values()) ||
-                    [...allowedVers.values()].pop();
-                if (semver_1.default.subset(selfVer.adjust, buildAdjustRangeForDeps(comparisonType, depVer))) {
-                    continue;
-                }
-                context.report({
-                    loc: node.loc,
-                    message: `${currModules
-                        .map((m) => `"${m}"`)
-                        .join(" >> ")} is not compatible with "${module}@${(0, semver_2.normalizeVer)(selfVer.original)}". Allowed is: "${module}@${(0, semver_2.normalizeVer)(depVer)}"`,
-                });
-            }
-            if (ctx.isAllProcessed()) {
-                return;
-            }
-            ctx.markAsValidDependency(name, ver);
-            if (deep) {
-                for (const [n, ranges] of extractDependencies(metaList)) {
-                    const v = (0, semver_2.normalizeSemverRange)(...ranges);
-                    if (v && !ctx.isValidDependency(n, v.raw)) {
-                        processDependencyModule(ctx.nextContext(), n, v.raw, currModules, node);
-                    }
-                }
-            }
-        }
-        return (0, utils_1.compositingVisitors)({
-            JSONExpressionStatement(node) {
-                const expr = node.expression;
-                if (expr.type !== "JSONObjectExpression") {
-                    return;
-                }
-                const enginesNode = expr.properties.find((p) => (0, ast_utils_1.getKeyFromJSONProperty)(p) === "engines");
-                if (!enginesNode) {
-                    return;
-                }
-                for (const [key, val] of (0, meta_1.getEngines)({
-                    engines: (0, jsonc_eslint_parser_1.getStaticJSONValue)(enginesNode.value),
-                })) {
-                    const selfVer = (0, semver_2.getSemverRange)(val);
-                    if (!selfVer) {
-                        continue;
-                    }
-                    selfEngines.set(key, {
-                        adjust: buildAdjustRangeForSelf(comparisonType, selfVer),
-                        original: selfVer,
-                    });
-                }
-            },
-        }, (0, utils_1.defineJsonVisitor)({
-            "dependencies, peerDependencies"(node) {
-                if (selfEngines.size === 0) {
-                    return;
-                }
-                const name = (0, ast_utils_1.getKeyFromJSONProperty)(node);
-                const ver = (0, jsonc_eslint_parser_1.getStaticJSONValue)(node.value);
-                if (typeof name !== "string" || typeof ver !== "string") {
-                    return;
-                }
-                const ctx = new EnginesContext(selfEngines.keys());
-                processDependencyModule(ctx, name, ver, [], node);
-            },
-        }));
-    },
-});

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

@@ -1,2 +0,0 @@
-declare const _default: import("../types").RuleModule;
-export default _default;

package/dist/rules/no-deprecated.js

@@ -1,63 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const jsonc_eslint_parser_1 = require("jsonc-eslint-parser");
-const utils_1 = require("../utils");
-const ast_utils_1 = require("../utils/ast-utils");
-const meta_1 = require("../utils/meta");
-const eslint_compat_utils_1 = require("eslint-compat-utils");
-exports.default = (0, utils_1.createRule)("no-deprecated", {
-    meta: {
-        docs: {
-            description: "disallow having dependencies on deprecate packages.",
-            category: "Best Practices",
-            recommended: false,
-        },
-        schema: [
-            {
-                type: "object",
-                properties: {
-                    devDependencies: { type: "boolean" },
-                    allows: {
-                        type: "array",
-                        items: { type: "string" },
-                        uniqueItems: true,
-                    },
-                },
-                additionalProperties: false,
-            },
-        ],
-        messages: {},
-        type: "suggestion",
-    },
-    create(context) {
-        var _a;
-        const sourceCode = (0, eslint_compat_utils_1.getSourceCode)(context);
-        if (!sourceCode.parserServices.isJSON) {
-            return {};
-        }
-        const devDependencies = Boolean((_a = context.options[0]) === null || _a === void 0 ? void 0 : _a.devDependencies);
-        return (0, utils_1.defineJsonVisitor)({
-            [devDependencies
-                ? "dependencies, peerDependencies, devDependencies"
-                : "dependencies, peerDependencies"](node) {
-                var _a, _b;
-                const name = (0, ast_utils_1.getKeyFromJSONProperty)(node);
-                const ver = (0, jsonc_eslint_parser_1.getStaticJSONValue)(node.value);
-                if (typeof name !== "string" || typeof ver !== "string" || !ver) {
-                    return;
-                }
-                if ((_b = (_a = context.options[0]) === null || _a === void 0 ? void 0 : _a.allows) === null || _b === void 0 ? void 0 : _b.includes(name)) {
-                    return;
-                }
-                const meta = (0, meta_1.getMetaFromNpm)(name, ver).get();
-                const deprecated = meta && meta.length && meta[meta.length - 1].deprecated;
-                if (deprecated) {
-                    context.report({
-                        loc: node.loc,
-                        message: `${deprecated}`,
-                    });
-                }
-            },
-        });
-    },
-});

package/dist/rules/no-dupe-deps.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("../types").RuleModule;
-export default _default;

package/dist/rules/no-dupe-deps.js

@@ -1,90 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("../utils");
-const ast_utils_1 = require("../utils/ast-utils");
-const eslint_compat_utils_1 = require("eslint-compat-utils");
-const DEPS = [
-    "dependencies",
-    "peerDependencies",
-    "optionalDependencies",
-    "devDependencies",
-];
-class AllowDuplicates {
-    constructor() {
-        this.edges = [];
-    }
-    add(d1, d2) {
-        this.edges.push([d1, d2]);
-    }
-    isAllowedDuplicate(dep1, dep2) {
-        return this.edges.some(([d1, d2]) => (d1 === dep1 && d2 === dep2) || (d2 === dep1 && d1 === dep2));
-    }
-}
-exports.default = (0, utils_1.createRule)("no-dupe-deps", {
-    meta: {
-        docs: {
-            description: "disallow duplicate dependencies.",
-            category: "Possible Errors",
-            recommended: true,
-        },
-        schema: [],
-        messages: {
-            duplicated: "Duplicated dependency '{{name}}'.",
-        },
-        type: "problem",
-    },
-    create(context) {
-        const sourceCode = (0, eslint_compat_utils_1.getSourceCode)(context);
-        if (!sourceCode.parserServices.isJSON) {
-            return {};
-        }
-        const allowDuplicates = new AllowDuplicates();
-        allowDuplicates.add("devDependencies", "peerDependencies");
-        allowDuplicates.add("devDependencies", "optionalDependencies");
-        const maps = {
-            dependencies: new Map(),
-            peerDependencies: new Map(),
-            optionalDependencies: new Map(),
-            devDependencies: new Map(),
-        };
-        const reported = new Set();
-        function report(name, node) {
-            if (reported.has(node)) {
-                return;
-            }
-            reported.add(node);
-            context.report({
-                loc: node.key.loc,
-                messageId: "duplicated",
-                data: {
-                    name,
-                },
-            });
-        }
-        function verify(depsName, name, node) {
-            for (const dep of DEPS) {
-                if (allowDuplicates.isAllowedDuplicate(dep, depsName)) {
-                    continue;
-                }
-                const dupeNode = maps[dep].get(name);
-                if (dupeNode) {
-                    report(name, dupeNode);
-                    report(name, node);
-                }
-            }
-        }
-        function defineVisitor(depsName) {
-            return (node) => {
-                const name = String((0, ast_utils_1.getKeyFromJSONProperty)(node));
-                verify(depsName, name, node);
-                maps[depsName].set(name, node);
-            };
-        }
-        return (0, utils_1.defineJsonVisitor)({
-            dependencies: defineVisitor("dependencies"),
-            peerDependencies: defineVisitor("peerDependencies"),
-            optionalDependencies: defineVisitor("optionalDependencies"),
-            devDependencies: defineVisitor("devDependencies"),
-        });
-    },
-});

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

@@ -1,2 +0,0 @@
-declare const _default: import("../types").RuleModule;
-export default _default;

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

@@ -1,259 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("../utils");
-const regexp_1 = require("../utils/regexp");
-const semver_1 = require("semver");
-const semver_2 = require("../utils/semver");
-const ast_utils_1 = require("../utils/ast-utils");
-const jsonc_eslint_parser_1 = require("jsonc-eslint-parser");
-const meta_1 = require("../utils/meta");
-const eslint_compat_utils_1 = require("eslint-compat-utils");
-const DEPS = [
-    "dependencies",
-    "peerDependencies",
-    "optionalDependencies",
-];
-class Deps {
-    constructor() {
-        this.map = Object.create(null);
-        this.list = [];
-    }
-    push(name, ver, ownerPackageJsonPath) {
-        const range = (0, semver_2.getSemverRange)(ver);
-        if (range) {
-            const data = this.map[name];
-            if (data) {
-                const newRange = (0, semver_2.normalizeSemverRange)(data.range, range);
-                this.map[name] = {
-                    range: newRange,
-                    ownerPackageJsonPath: ownerPackageJsonPath || data.ownerPackageJsonPath,
-                };
-            }
-            else {
-                this.map[name] = {
-                    range,
-                    ownerPackageJsonPath,
-                };
-            }
-            return;
-        }
-        this.list.push({ name, ver, ownerPackageJsonPath });
-    }
-    pop() {
-        const resultForList = this.list.shift();
-        if (resultForList) {
-            return resultForList;
-        }
-        const [key] = Object.keys(this.map);
-        if (key) {
-            const data = this.map[key];
-            delete this.map[key];
-            return {
-                name: key,
-                ver: (0, semver_2.normalizeVer)(data.range),
-                ownerPackageJsonPath: data.ownerPackageJsonPath,
-            };
-        }
-        return null;
-    }
-}
-class DeepValidateContext {
-    constructor(context, validator) {
-        this.deepValidatedCache = new Map();
-        this.context = context;
-        this.validator = validator;
-    }
-    buildDeepValidator(deepOption) {
-        return (n, v) => this.deepDepsValidate(n, v, deepOption);
-    }
-    deepDepsValidate(packageName, version, deepOption) {
-        const { validator: validate, context } = this;
-        const depsQueue = new Deps();
-        depsQueue.push(packageName, version);
-        let dep;
-        while ((dep = depsQueue.pop())) {
-            const key = `${dep.name}@${dep.ver}`;
-            if (this.deepValidatedCache.has(key)) {
-                const result = this.deepValidatedCache.get(key);
-                if (result) {
-                    return result;
-                }
-            }
-            else {
-                const result = validateWithoutCache(dep.name, dep.ver, dep.ownerPackageJsonPath);
-                this.deepValidatedCache.set(key, result);
-                if (result) {
-                    return result;
-                }
-            }
-        }
-        return null;
-        function validateWithoutCache(name, ver, ownerPackageJsonPath) {
-            const result = validate(name, ver);
-            if (result) {
-                return result;
-            }
-            for (const { name: n, ver: v, packageJsonPath } of iterateDeps(name, ver, ownerPackageJsonPath)) {
-                const r = validate(n, v);
-                if (r) {
-                    return r;
-                }
-                depsQueue.push(n, v, packageJsonPath);
-            }
-            return null;
-        }
-        function* iterateDeps(name, ver, ownerPackageJsonPath) {
-            yield* iterateDepsForMeta((0, meta_1.getMetaFromNodeModules)(name, ver, {
-                context,
-                ownerPackageJsonPath,
-            }));
-            if (deepOption === "server") {
-                const metaData = (0, meta_1.getMetaFromNpm)(name, ver);
-                for (const meta of metaData.cache) {
-                    yield* iterateDepsForMeta(meta);
-                }
-                const metaList = metaData.get();
-                if (metaList) {
-                    for (const meta of metaList) {
-                        yield* iterateDepsForMeta(meta);
-                    }
-                }
-            }
-        }
-        function* iterateDepsForMeta(meta) {
-            if (!meta) {
-                return;
-            }
-            for (const depName of DEPS) {
-                const deps = meta[depName];
-                if (!deps) {
-                    continue;
-                }
-                for (const [n, v] of Object.entries(deps)) {
-                    if (typeof v === "string") {
-                        yield { name: n, ver: v, packageJsonPath: meta._where };
-                    }
-                }
-            }
-        }
-    }
-}
-exports.default = (0, utils_1.createRule)("no-restricted-deps", {
-    meta: {
-        docs: {
-            description: "Disallows dependence on the specified package.",
-            category: "Best Practices",
-            recommended: false,
-        },
-        schema: {
-            type: "array",
-            items: {
-                oneOf: [
-                    {
-                        type: "string",
-                    },
-                    {
-                        type: "object",
-                        properties: {
-                            package: { type: "string" },
-                            version: { type: "string" },
-                            message: { type: "string" },
-                            deep: { enum: ["local", "server"] },
-                        },
-                        required: ["package"],
-                        additionalProperties: false,
-                    },
-                ],
-            },
-            uniqueItems: true,
-            minItems: 0,
-        },
-        messages: {
-            restricted: "{{message}}",
-        },
-        type: "suggestion",
-    },
-    create(context) {
-        const sourceCode = (0, eslint_compat_utils_1.getSourceCode)(context);
-        if (!sourceCode.parserServices.isJSON) {
-            return {};
-        }
-        const validateForPackage = parseOptions(context.options);
-        function defineVisitor(_depsName) {
-            return (node) => {
-                const name = String((0, ast_utils_1.getKeyFromJSONProperty)(node));
-                const ver = String((0, jsonc_eslint_parser_1.getStaticJSONValue)(node.value));
-                const result = validateForPackage(name, ver);
-                if (!result) {
-                    return;
-                }
-                context.report({
-                    loc: node.loc,
-                    messageId: "restricted",
-                    data: result,
-                });
-            };
-        }
-        return (0, utils_1.defineJsonVisitor)({
-            dependencies: defineVisitor("dependencies"),
-            peerDependencies: defineVisitor("peerDependencies"),
-            optionalDependencies: defineVisitor("optionalDependencies"),
-            devDependencies: defineVisitor("devDependencies"),
-        });
-        function matchVersions(version, optionVersion) {
-            if (!optionVersion) {
-                return true;
-            }
-            const range = (0, semver_2.getSemverRange)(version);
-            return Boolean(range && (0, semver_1.intersects)(range, optionVersion));
-        }
-        function parseOption(option) {
-            if (typeof option === "string") {
-                const regexp = (0, regexp_1.toRegExp)(option);
-                return (n, _v) => {
-                    if (regexp.test(n)) {
-                        return {
-                            message: `Depend on '${option}' is not allowed.`,
-                        };
-                    }
-                    return null;
-                };
-            }
-            const regexp = (0, regexp_1.toRegExp)(option.package);
-            const version = option.version ? (0, semver_2.getSemverRange)(option.version) : null;
-            const validator = (n, v) => {
-                if (regexp.test(n) && matchVersions(v, version)) {
-                    return {
-                        message: option.message || buildDefaultMessage(option),
-                    };
-                }
-                return null;
-            };
-            if (!option.deep) {
-                return validator;
-            }
-            const deepValidateContext = new DeepValidateContext(context, validator);
-            return deepValidateContext.buildDeepValidator(option.deep);
-            function buildDefaultMessage(objectOption) {
-                const versionForMessage = objectOption.version
-                    ? `@${objectOption.version}`
-                    : "";
-                if (objectOption.package.startsWith("/") && versionForMessage) {
-                    return `Depend on '${objectOption.package} ${versionForMessage}' is not allowed.`;
-                }
-                return `Depend on '${objectOption.package}${versionForMessage}' is not allowed.`;
-            }
-        }
-        function parseOptions(options) {
-            const validators = options.map(parseOption);
-            return (packageName, version) => {
-                for (const validator of validators) {
-                    const result = validator(packageName, version);
-                    if (result)
-                        return result;
-                }
-                return null;
-            };
-        }
-    },
-});

package/dist/rules/prefer-caret-range-version.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("../types").RuleModule;
-export default _default;