eslint-plugin-node-dependencies 0.6.0 → 0.9.0

package/README.md

@@ -33,7 +33,7 @@ npm install --save-dev eslint eslint-plugin-node-dependencies
 > **Requirements**
 >
 > - ESLint v6.0.0 and above
-> - Node.js v12.x, v14.x and above
+> - Node.js v14.16.0 and above
 
 <!--DOCS_IGNORE_END-->
 
@@ -119,13 +119,23 @@ The rules with the following star :star: are included in the `plugin:node-depend
 | Rule ID | Description |    |
 |:--------|:------------|:---|
 | [node-dependencies/compat-engines](https://ota-meshi.github.io/eslint-plugin-node-dependencies/rules/compat-engines.html) | enforce the versions of the engines of the dependencies to be compatible. | :star: |
+| [node-dependencies/no-dupe-deps](https://ota-meshi.github.io/eslint-plugin-node-dependencies/rules/no-dupe-deps.html) | disallow duplicate dependencies. | :star: |
 | [node-dependencies/valid-semver](https://ota-meshi.github.io/eslint-plugin-node-dependencies/rules/valid-semver.html) | enforce versions that is valid as a semantic version. | :star: |
 
 ### Best Practices
 
 | Rule ID | Description |    |
 |:--------|:------------|:---|
+| [node-dependencies/absolute-version](https://ota-meshi.github.io/eslint-plugin-node-dependencies/rules/absolute-version.html) | require or disallow absolute version of dependency. |  |
 | [node-dependencies/no-deprecated](https://ota-meshi.github.io/eslint-plugin-node-dependencies/rules/no-deprecated.html) | disallow having dependencies on deprecate packages. |  |
+| [node-dependencies/no-restricted-deps](https://ota-meshi.github.io/eslint-plugin-node-dependencies/rules/no-restricted-deps.html) | Disallows dependence on the specified package. |  |
+
+### Stylistic Issues
+
+| Rule ID | Description |    |
+|:--------|:------------|:---|
+| [node-dependencies/prefer-caret-range-version](https://ota-meshi.github.io/eslint-plugin-node-dependencies/rules/prefer-caret-range-version.html) | require caret(`^`) version instead of range version. | :wrench: |
+| [node-dependencies/prefer-tilde-range-version](https://ota-meshi.github.io/eslint-plugin-node-dependencies/rules/prefer-tilde-range-version.html) | require tilde(`~`) version instead of range version. | :wrench: |
 
 ### Deprecated
 

package/dist/configs/recommended.js

@@ -7,6 +7,7 @@ module.exports = {
             parser: require.resolve("jsonc-eslint-parser"),
             rules: {
                 "node-dependencies/compat-engines": "error",
+                "node-dependencies/no-dupe-deps": "error",
                 "node-dependencies/valid-semver": "error",
             },
         },

package/dist/rules/absolute-version.js

@@ -0,0 +1,159 @@
+"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 regexp_1 = require("../utils/regexp");
+const semver_1 = require("../utils/semver");
+const PREFERS = ["always", "never", "ignore"];
+const SCHEMA_FOR_DEPS_PROPERTIES = {
+    dependencies: { enum: PREFERS },
+    peerDependencies: { enum: PREFERS },
+    optionalDependencies: { enum: PREFERS },
+    devDependencies: { enum: PREFERS },
+};
+const DEFAULT = {
+    dependencies: "ignore",
+    peerDependencies: "ignore",
+    optionalDependencies: "ignore",
+    devDependencies: "always",
+};
+function stringToOption(option) {
+    return {
+        dependencies: option,
+        peerDependencies: option,
+        optionalDependencies: option,
+        devDependencies: option,
+    };
+}
+function objectToOption(option, defaults) {
+    return {
+        dependencies: option.dependencies || defaults.dependencies,
+        peerDependencies: option.peerDependencies || defaults.peerDependencies,
+        optionalDependencies: option.optionalDependencies || defaults.optionalDependencies,
+        devDependencies: option.devDependencies || defaults.devDependencies,
+    };
+}
+function parseOption(option) {
+    if (!option) {
+        return () => DEFAULT;
+    }
+    if (typeof option === "string") {
+        const objectOption = stringToOption(option);
+        return () => objectOption;
+    }
+    const baseOption = objectToOption(option, DEFAULT);
+    if (!option.overridePackages) {
+        return () => baseOption;
+    }
+    const overridePackages = Object.entries(option.overridePackages).map(([packageName, opt]) => {
+        const regexp = (0, regexp_1.toRegExp)(packageName);
+        return Object.assign({ test: (s) => regexp.test(s) }, (typeof opt === "string"
+            ? stringToOption(opt)
+            : objectToOption(opt, baseOption)));
+    });
+    return (name) => {
+        for (const overridePackage of overridePackages) {
+            if (overridePackage.test(name)) {
+                return overridePackage;
+            }
+        }
+        return baseOption;
+    };
+}
+exports.default = (0, utils_1.createRule)("absolute-version", {
+    meta: {
+        docs: {
+            description: "require or disallow absolute version of dependency.",
+            category: "Best Practices",
+            recommended: false,
+        },
+        schema: [
+            {
+                oneOf: [
+                    { enum: PREFERS.filter((p) => p !== "ignore") },
+                    {
+                        type: "object",
+                        properties: Object.assign(Object.assign({}, SCHEMA_FOR_DEPS_PROPERTIES), { overridePackages: {
+                                type: "object",
+                                patternProperties: {
+                                    "^(?:\\S+)$": {
+                                        oneOf: [
+                                            { enum: PREFERS },
+                                            {
+                                                type: "object",
+                                                properties: SCHEMA_FOR_DEPS_PROPERTIES,
+                                                additionalProperties: false,
+                                            },
+                                        ],
+                                    },
+                                },
+                                minProperties: 1,
+                                additionalProperties: false,
+                            } }),
+                        additionalProperties: false,
+                    },
+                ],
+            },
+        ],
+        messages: {},
+        type: "suggestion",
+    },
+    create(context) {
+        if (!context.parserServices.isJSON) {
+            return {};
+        }
+        const getOption = parseOption(context.options[0]);
+        function defineVisitor(visitName) {
+            return (node) => {
+                const ver = (0, jsonc_eslint_parser_1.getStaticJSONValue)(node.value);
+                if (typeof ver !== "string" || ver == null) {
+                    return;
+                }
+                const name = String((0, ast_utils_1.getKeyFromJSONProperty)(node));
+                const option = getOption(name)[visitName];
+                const semver = (0, semver_1.getSemverRange)(ver);
+                if (semver == null) {
+                    return;
+                }
+                if (option === "always") {
+                    if (isAbsoluteVersion(semver)) {
+                        return;
+                    }
+                    context.report({
+                        loc: node.value.loc,
+                        message: "Use the absolute version instead.",
+                    });
+                }
+                else if (option === "never") {
+                    if (!isAbsoluteVersion(semver)) {
+                        return;
+                    }
+                    context.report({
+                        loc: node.value.loc,
+                        message: "Do not use the absolute version.",
+                    });
+                }
+            };
+        }
+        return (0, utils_1.defineJsonVisitor)({
+            dependencies: defineVisitor("dependencies"),
+            peerDependencies: defineVisitor("peerDependencies"),
+            optionalDependencies: defineVisitor("optionalDependencies"),
+            devDependencies: defineVisitor("devDependencies"),
+        });
+    },
+});
+function isAbsoluteVersion(semver) {
+    for (const comparators of semver.set) {
+        for (const comparator of comparators) {
+            if ((0, semver_1.isAnyComparator)(comparator)) {
+                return false;
+            }
+            if (comparator.operator !== "=" && comparator.operator !== "") {
+                return false;
+            }
+        }
+    }
+    return true;
+}

package/dist/rules/compat-engines.js

@@ -160,7 +160,7 @@ exports.default = (0, utils_1.createRule)("compat-engines", {
         }
         function processDependencyModule(ctx, name, ver, modules, node) {
             const currModules = [...modules, `${name}@${ver}`];
-            processMeta(ctx, (0, meta_1.getMetaFromNodeModules)(name, ver, context));
+            processMeta(ctx, (0, meta_1.getMetaFromNodeModules)(name, ver, { context }));
             if (!ctx.hasInvalid() && ctx.isAllProcessed()) {
                 return;
             }

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

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../utils");
+const ast_utils_1 = require("../utils/ast-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) {
+        if (!context.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.js

@@ -0,0 +1,259 @@
+"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 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) {
+        if (!context.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.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const semver_1 = require("semver");
+const utils_1 = require("../utils");
+const semver_2 = require("../utils/semver");
+const semver_range_1 = require("../utils/semver-range");
+exports.default = (0, utils_1.createRule)("prefer-caret-range-version", {
+    meta: {
+        docs: {
+            description: "require caret(`^`) version instead of range version.",
+            category: "Stylistic Issues",
+            recommended: false,
+        },
+        fixable: "code",
+        schema: [],
+        messages: {},
+        type: "suggestion",
+    },
+    create(context) {
+        if (!context.parserServices.isJSON) {
+            return {};
+        }
+        const sourceCode = context.getSourceCode();
+        function convertToUseCaret(range) {
+            if (range.comparators.length !== 2) {
+                return null;
+            }
+            const start = range.comparators.find((c) => c.operator === ">=");
+            const end = range.comparators.find((c) => c.operator === "<");
+            if (!start || !end) {
+                return null;
+            }
+            const caretRangeText = `^${start.semver.version}`;
+            const caretRange = (0, semver_2.getSemverRange)(caretRangeText);
+            if (!caretRange) {
+                return null;
+            }
+            const caretEnd = caretRange.set[0].find((c) => c.operator === "<");
+            if (!caretEnd) {
+                return null;
+            }
+            if (caretEnd.semver.compare(end.semver) !== 0) {
+                const endPre = new semver_1.SemVer(`${end.semver.version}-0`);
+                if (caretEnd.semver.compare(endPre) !== 0) {
+                    return null;
+                }
+            }
+            return caretRangeText;
+        }
+        function verifyRange(range, node) {
+            const fixedRange = convertToUseCaret(range);
+            if (!fixedRange) {
+                return;
+            }
+            context.report({
+                loc: {
+                    start: sourceCode.getLocFromIndex(node.range[0] + range.range[0]),
+                    end: sourceCode.getLocFromIndex(node.range[0] + range.range[1]),
+                },
+                message: `Use '${fixedRange}' syntax instead.`,
+                fix(fixer) {
+                    return fixer.replaceTextRange(node.range, JSON.stringify(node.value.slice(0, range.range[0]) +
+                        fixedRange +
+                        node.value.slice(range.range[1])));
+                },
+            });
+        }
+        function verifyVersion(node) {
+            if (maybeDepId(node.value)) {
+                return;
+            }
+            for (const range of (0, semver_range_1.iterateSemverRanges)(node.value)) {
+                const lowerRange = range.value.toLowerCase();
+                if (!lowerRange.startsWith("~")) {
+                    if (lowerRange.startsWith("^") ||
+                        /^\d+$/u.test(range.value) ||
+                        ((range.value.endsWith(".x") ||
+                            range.value.endsWith(".*")) &&
+                            !/\s+-\s+/u.test(range.value)))
+                        continue;
+                }
+                verifyRange(range, node);
+            }
+        }
+        return (0, utils_1.defineJsonVisitor)({
+            "engines, dependencies, peerDependencies, devDependencies, optionalDependencies"(node) {
+                if (isJSONStringLiteral(node.value)) {
+                    verifyVersion(node.value);
+                }
+            },
+        });
+    },
+});
+function isJSONStringLiteral(node) {
+    return node.type === "JSONLiteral" && typeof node.value === "string";
+}
+function maybeDepId(ver) {
+    return ver.includes("/") || ver.includes(":") || /^[-a-z]+$/.test(ver);
+}