eslint-plugin-node-dependencies 1.3.0 → 2.0.0

package/dist/rules/prefer-caret-range-version.js

@@ -1,99 +0,0 @@
-"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");
-const eslint_compat_utils_1 = require("eslint-compat-utils");
-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) {
-        const sourceCode = (0, eslint_compat_utils_1.getSourceCode)(context);
-        if (!sourceCode.parserServices.isJSON) {
-            return {};
-        }
-        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);
-}

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

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

package/dist/rules/prefer-tilde-range-version.js

@@ -1,100 +0,0 @@
-"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");
-const eslint_compat_utils_1 = require("eslint-compat-utils");
-exports.default = (0, utils_1.createRule)("prefer-tilde-range-version", {
-    meta: {
-        docs: {
-            description: "require tilde(`~`) version instead of range version.",
-            category: "Stylistic Issues",
-            recommended: false,
-        },
-        fixable: "code",
-        schema: [],
-        messages: {},
-        type: "suggestion",
-    },
-    create(context) {
-        const sourceCode = (0, eslint_compat_utils_1.getSourceCode)(context);
-        if (!sourceCode.parserServices.isJSON) {
-            return {};
-        }
-        function convertToUseTilde(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 tildeRangeText = `~${start.semver.version}`;
-            const tildeRange = (0, semver_2.getSemverRange)(tildeRangeText);
-            if (!tildeRange) {
-                return null;
-            }
-            const tildeEnd = tildeRange.set[0].find((c) => c.operator === "<");
-            if (!tildeEnd) {
-                return null;
-            }
-            if (tildeEnd.semver.compare(end.semver) !== 0) {
-                const endPre = new semver_1.SemVer(`${end.semver.version}-0`);
-                if (tildeEnd.semver.compare(endPre) !== 0) {
-                    return null;
-                }
-            }
-            return tildeRangeText;
-        }
-        function verifyRange(range, node) {
-            const fixedRange = convertToUseTilde(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) ||
-                        /^\d+\.\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);
-}

package/dist/rules/require-provenance-deps.d.ts

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

package/dist/rules/require-provenance-deps.js

@@ -1,98 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("../utils");
-const jsonc_eslint_parser_1 = require("jsonc-eslint-parser");
-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)("require-provenance-deps", {
-    meta: {
-        docs: {
-            description: "Require provenance information for dependencies",
-            category: "Best Practices",
-            recommended: false,
-        },
-        schema: [
-            {
-                type: "object",
-                properties: {
-                    devDependencies: { type: "boolean" },
-                    allows: {
-                        type: "array",
-                        items: { type: "string" },
-                        uniqueItems: true,
-                    },
-                },
-                additionalProperties: false,
-            },
-        ],
-        messages: {
-            missingProvenance: 'Dependency "{{name}}" has versions without provenance information: {{versions}}.',
-        },
-        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);
-        function extractNoProvenanceRanges(meta) {
-            var _a, _b;
-            const noProvenanceRanges = [];
-            let prev = null;
-            for (let index = 0; index < meta.length; index++) {
-                const m = meta[index];
-                if ((_b = (_a = m.dist) === null || _a === void 0 ? void 0 : _a.attestations) === null || _b === void 0 ? void 0 : _b.provenance) {
-                    prev = null;
-                    continue;
-                }
-                if (prev == null) {
-                    prev = [m.version, m.version];
-                    noProvenanceRanges.push(prev);
-                }
-                else {
-                    prev[1] = m.version;
-                }
-            }
-            return noProvenanceRanges;
-        }
-        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();
-                if (!meta || !meta.length) {
-                    return;
-                }
-                const noProvenanceRanges = extractNoProvenanceRanges(meta);
-                if (noProvenanceRanges.length === 0) {
-                    return;
-                }
-                context.report({
-                    loc: node.loc,
-                    messageId: "missingProvenance",
-                    data: {
-                        name,
-                        versions: formatList(noProvenanceRanges.map(([from, to]) => from === to ? `${from}` : `${from} - ${to}`)),
-                    },
-                });
-            },
-        });
-        function formatList(items) {
-            return items.length <= 2
-                ? items.join(" and ")
-                : `${items.slice(0, -1).join(", ")}, and ${items[items.length - 1]}`;
-        }
-    },
-});

package/dist/rules/valid-engines.d.ts

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

package/dist/rules/valid-engines.js

@@ -1,11 +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 utils_1 = require("../utils");
-const compat_engines_1 = __importDefault(require("./compat-engines"));
-exports.default = (0, utils_1.createRule)("valid-engines", {
-    meta: Object.assign(Object.assign({}, compat_engines_1.default.meta), { docs: Object.assign({}, compat_engines_1.default.meta.docs), deprecated: true, replacedBy: ["compat-engines"] }),
-    create: compat_engines_1.default.create,
-});

package/dist/rules/valid-semver.d.ts

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

package/dist/rules/valid-semver.js

@@ -1,78 +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 semver_1 = require("../utils/semver");
-const eslint_compat_utils_1 = require("eslint-compat-utils");
-exports.default = (0, utils_1.createRule)("valid-semver", {
-    meta: {
-        docs: {
-            description: "enforce versions that is valid as a semantic version.",
-            category: "Possible Errors",
-            recommended: true,
-        },
-        schema: [],
-        messages: {},
-        type: "problem",
-    },
-    create(context) {
-        const sourceCode = (0, eslint_compat_utils_1.getSourceCode)(context);
-        if (!sourceCode.parserServices.isJSON) {
-            return {};
-        }
-        return (0, utils_1.defineJsonVisitor)({
-            engines(node) {
-                const ver = (0, jsonc_eslint_parser_1.getStaticJSONValue)(node.value);
-                if (typeof ver !== "string" || ver == null) {
-                    context.report({
-                        loc: node.value.loc,
-                        message: `\`${JSON.stringify(ver)}\` is invalid.`,
-                    });
-                    return;
-                }
-                if ((0, semver_1.getSemverRange)(ver) == null) {
-                    context.report({
-                        loc: node.value.loc,
-                        message: `"${ver}" is invalid.`,
-                    });
-                }
-            },
-            "dependencies, peerDependencies, devDependencies, optionalDependencies"(node) {
-                const name = (0, ast_utils_1.getKeyFromJSONProperty)(node);
-                if (typeof name !== "string") {
-                    return;
-                }
-                const ver = (0, jsonc_eslint_parser_1.getStaticJSONValue)(node.value);
-                if (typeof ver !== "string" || ver == null) {
-                    context.report({
-                        loc: node.value.loc,
-                        message: `\`${JSON.stringify(ver)}\` is invalid.`,
-                    });
-                    return;
-                }
-                if (maybeNotRange(ver)) {
-                    return;
-                }
-                if ((0, semver_1.getSemverRange)(ver) == null) {
-                    context.report({
-                        loc: node.value.loc,
-                        message: `"${ver}" is invalid.`,
-                    });
-                }
-            },
-        });
-    },
-});
-function maybeNotRange(ver) {
-    if (ver.startsWith(".") || ver.startsWith("~") || ver.includes("/")) {
-        return true;
-    }
-    if (ver.includes(":")) {
-        return true;
-    }
-    if (/^[-a-z]+$/.test(ver)) {
-        return true;
-    }
-    return false;
-}

package/dist/types.d.ts

@@ -1,51 +0,0 @@
-import type { JSONSchema4 } from "json-schema";
-import type { Rule } from "eslint";
-export interface RuleListener {
-    [key: string]: ((node: never) => void) | undefined;
-}
-export interface RuleModule {
-    meta: RuleMetaData;
-    create: (context: Rule.RuleContext) => RuleListener;
-}
-export type RuleCategory = "Possible Errors" | "Best Practices" | "Stylistic Issues";
-export interface RuleMetaData {
-    docs: {
-        description: string;
-        category: RuleCategory;
-        recommended: boolean;
-        url: string;
-        ruleId: string;
-        ruleName: string;
-        default?: "error" | "warn";
-    };
-    messages: {
-        [messageId: string]: string;
-    };
-    fixable?: "code" | "whitespace";
-    hasSuggestions?: boolean;
-    schema: JSONSchema4 | JSONSchema4[];
-    deprecated?: boolean;
-    replacedBy?: string[];
-    type: "problem" | "suggestion" | "layout";
-}
-export interface PartialRuleModule {
-    meta: PartialRuleMetaData;
-    create: (context: Rule.RuleContext) => RuleListener;
-}
-export interface PartialRuleMetaData {
-    docs: {
-        description: string;
-        category: RuleCategory;
-        recommended: boolean;
-        default?: "error" | "warn";
-    };
-    messages: {
-        [messageId: string]: string;
-    };
-    fixable?: "code" | "whitespace";
-    hasSuggestions?: boolean;
-    schema: JSONSchema4 | JSONSchema4[];
-    deprecated?: boolean;
-    replacedBy?: string[];
-    type: "problem" | "suggestion" | "layout";
-}

package/dist/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/ast-utils.d.ts

@@ -1,3 +0,0 @@
-import type { AST } from "jsonc-eslint-parser";
-export declare function getKeyFromJSONProperty(node: AST.JSONProperty): string | number;
-export declare function getKey(node: AST.JSONExpression): string | number | null;

package/dist/utils/ast-utils.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getKeyFromJSONProperty = getKeyFromJSONProperty;
-exports.getKey = getKey;
-function getKeyFromJSONProperty(node) {
-    if (node.key.type === "JSONIdentifier") {
-        return node.key.name;
-    }
-    return node.key.value;
-}
-function getKey(node) {
-    let parent = node.parent;
-    while (parent.type === "JSONUnaryExpression" ||
-        parent.type === "JSONBinaryExpression") {
-        parent = parent.parent;
-    }
-    if (parent.type === "JSONExpressionStatement") {
-        return null;
-    }
-    if (parent.type === "JSONArrayExpression") {
-        return parent.elements.indexOf(node);
-    }
-    return getKeyFromJSONProperty(parent);
-}

package/dist/utils/index.d.ts

@@ -1,5 +0,0 @@
-import type { RuleModule, PartialRuleModule, RuleListener } from "../types";
-import type { AST } from "jsonc-eslint-parser";
-export declare function createRule(ruleName: string, rule: PartialRuleModule): RuleModule;
-export declare function defineJsonVisitor(visitor: Record<string, ((node: AST.JSONProperty) => void) | undefined>): RuleListener;
-export declare function compositingVisitors(visitor: RuleListener, ...visitors: RuleListener[]): RuleListener;

package/dist/utils/index.js

@@ -1,72 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRule = createRule;
-exports.defineJsonVisitor = defineJsonVisitor;
-exports.compositingVisitors = compositingVisitors;
-const ast_utils_1 = require("./ast-utils");
-function createRule(ruleName, rule) {
-    return {
-        meta: Object.assign(Object.assign({}, rule.meta), { docs: Object.assign(Object.assign({}, rule.meta.docs), { url: `https://ota-meshi.github.io/eslint-plugin-node-dependencies/rules/${ruleName}.html`, ruleId: `node-dependencies/${ruleName}`, ruleName }) }),
-        create: rule.create,
-    };
-}
-function defineJsonVisitor(visitor) {
-    let stack = null;
-    const visitors = [];
-    for (const [selector, visit] of Object.entries(visitor)) {
-        if (visit) {
-            for (const sel of selector.split(",").map((s) => s.trim())) {
-                visitors.push({
-                    test: (s) => {
-                        if (!s.key ||
-                            !s.upper ||
-                            s.upper.key != null) {
-                            return false;
-                        }
-                        return s.key === sel;
-                    },
-                    visit,
-                });
-            }
-        }
-    }
-    return {
-        "JSONObjectExpression, JSONArrayExpression"(node) {
-            stack = {
-                node,
-                upper: stack,
-                key: (0, ast_utils_1.getKey)(node),
-            };
-        },
-        "JSONObjectExpression, JSONArrayExpression:exit"() {
-            stack = stack && stack.upper;
-        },
-        JSONProperty(node) {
-            if (!stack) {
-                return;
-            }
-            for (const v of visitors) {
-                if (v.test(stack)) {
-                    v.visit(node);
-                }
-            }
-        },
-    };
-}
-function compositingVisitors(visitor, ...visitors) {
-    for (const v of visitors) {
-        for (const key in v) {
-            const orig = visitor[key];
-            if (orig) {
-                visitor[key] = (...args) => {
-                    orig(...args);
-                    v[key](...args);
-                };
-            }
-            else {
-                visitor[key] = v[key];
-            }
-        }
-    }
-    return visitor;
-}

package/dist/utils/meta.d.ts

@@ -1,30 +0,0 @@
-import type { Rule } from "eslint";
-export type PackageMeta = {
-    engines: Record<string, string | undefined> | undefined;
-    dependencies: Record<string, string | undefined> | undefined;
-    peerDependencies: Record<string, string | undefined> | undefined;
-    optionalDependencies: Record<string, string | undefined> | undefined;
-    version: string | undefined;
-    _where?: string;
-};
-export type NpmPackageMeta = PackageMeta & {
-    deprecated: string | undefined;
-    "dist-tags": {
-        [key: string]: string | void;
-    } | undefined;
-    dist?: {
-        attestations?: {
-            provenance?: Record<string, unknown>;
-        };
-    };
-};
-export declare function getMetaFromNodeModules(name: string, ver: string, options: {
-    context: Rule.RuleContext;
-    ownerPackageJsonPath?: string;
-}): PackageMeta | null;
-export declare function getMetaFromNpm(name: string, ver: string): {
-    cache: NpmPackageMeta[];
-    get: () => NpmPackageMeta[] | null;
-};
-export declare function getEngines(meta: unknown): Map<string, string>;
-export declare function getDependencies(meta: unknown, kind: "dependencies" | "peerDependencies" | "optionalDependencies"): Map<string, string>;