@lerna-lite/core 1.3.0 → 1.4.0

package/dist/package-graph/package-graph.js

@@ -1,277 +1,277 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PackageGraph = void 0;
-const npm_package_arg_1 = __importDefault(require("npm-package-arg"));
-const lib_1 = require("./lib");
-const validation_error_1 = require("../validation-error");
-/**
- * A graph of packages in the current project.
- *
- * @extends {Map<string, PackageGraphNode>}
- */
-class PackageGraph extends Map {
-    /**
-     * @param {import("@lerna/package").Package[]} packages An array of Packages to build the graph out of.
-     * @param {'allDependencies'|'dependencies'} [graphType]
-     *    Pass "dependencies" to create a graph of only dependencies,
-     *    excluding the devDependencies that would normally be included.
-     * @param {boolean|'auto'|'force'|'explicit'} [localDependencies] Treatment of local sibling dependencies, default "auto"
-     */
-    constructor(packages, graphType = 'allDependencies', localDependencies = 'auto') {
-        // For backward compatibility
-        if (localDependencies === true || localDependencies === 'forceLocal') {
-            localDependencies = 'force'; // eslint-disable-line
-        }
-        // @ts-ignore
-        super(packages.map((pkg) => { var _a; return [(_a = pkg === null || pkg === void 0 ? void 0 : pkg.name) !== null && _a !== void 0 ? _a : '', new lib_1.PackageGraphNode(pkg)]; }));
-        if (packages.length !== this.size) {
-            // weed out the duplicates
-            const seen = new Map();
-            for (const { name, location } of packages) {
-                if (seen.has(name)) {
-                    seen.get(name).push(location);
-                }
-                else {
-                    seen.set(name, [location]);
-                }
-            }
-            for (const [name, locations] of seen) {
-                if (locations.length > 1) {
-                    throw new validation_error_1.ValidationError('ENAME', [`Package name "${name}" used in multiple packages:`, ...locations].join('\n\t'));
-                }
-            }
-        }
-        this.forEach((currentNode, currentName) => {
-            const graphDependencies = graphType === 'dependencies'
-                ? Object.assign({}, currentNode.pkg.optionalDependencies, currentNode.pkg.dependencies)
-                : Object.assign({}, currentNode.pkg.devDependencies, currentNode.pkg.optionalDependencies, currentNode.pkg.dependencies);
-            Object.keys(graphDependencies).forEach((depName) => {
-                const depNode = this.get(depName);
-                // Yarn decided to ignore https://github.com/npm/npm/pull/15900 and implemented "link:"
-                // As they apparently have no intention of being compatible, we have to do it for them.
-                // @see https://github.com/yarnpkg/yarn/issues/4212
-                let spec = graphDependencies[depName].replace(/^link:/, 'file:');
-                // npa doesn't support the explicit workspace: protocol, supported by
-                // pnpm and Yarn.
-                const explicitWorkspace = /^workspace:/.test(spec);
-                let workspaceTarget;
-                if (explicitWorkspace) {
-                    workspaceTarget = spec;
-                    spec = spec.replace(/^workspace:/, '');
-                    // when dependency is defined as target workspace, like `workspace:*`,
-                    // we'll have to pull the version from its parent package version property
-                    // example with `1.5.0`, ws:* => "1.5.0", ws:^ => "^1.5.0", ws:~ => "~1.5.0", ws:^1.5.0 => "^1.5.0"
-                    if (spec === '*' || spec === '^' || spec === '~') {
-                        const depPkg = packages.find(pkg => pkg.name === depName);
-                        const version = depPkg === null || depPkg === void 0 ? void 0 : depPkg.version;
-                        const specTarget = spec === '*' ? '' : spec;
-                        spec = depPkg ? `${specTarget}${version}` : '';
-                    }
-                }
-                const resolved = npm_package_arg_1.default.resolve(depName, spec, currentNode.location);
-                resolved.explicitWorkspace = explicitWorkspace;
-                if (resolved.explicitWorkspace) {
-                    resolved.workspaceTarget = workspaceTarget;
-                }
-                if (!depNode) {
-                    // it's an external dependency, store the resolution and bail
-                    return currentNode.externalDependencies.set(depName, resolved);
-                }
-                if (explicitWorkspace ||
-                    localDependencies === 'force' ||
-                    resolved.fetchSpec === depNode.location ||
-                    (localDependencies !== 'explicit' && depNode.satisfies(resolved))) {
-                    // a local file: specifier, a matching semver or a workspace: version
-                    currentNode.localDependencies.set(depName, resolved);
-                    depNode.localDependents.set(currentName, currentNode);
-                }
-                else {
-                    // non-matching semver of a local dependency
-                    currentNode.externalDependencies.set(depName, resolved);
-                }
-            });
-        });
-    }
-    get rawPackageList() {
-        return Array.from(this.values()).map((node) => node.pkg);
-    }
-    /**
-     * Takes a list of Packages and returns a list of those same Packages with any Packages
-     * they depend on. i.e if packageA depended on packageB `graph.addDependencies([packageA])`
-     * would return [packageA, packageB].
-     *
-     * @param {import("@lerna/package").Package[]} filteredPackages The packages to include dependencies for.
-     */
-    addDependencies(filteredPackages) {
-        return this.extendList(filteredPackages, 'localDependencies');
-    }
-    /**
-     * Takes a list of Packages and returns a list of those same Packages with any Packages
-     * that depend on them. i.e if packageC depended on packageD `graph.addDependents([packageD])`
-     * would return [packageD, packageC].
-     *
-     * @param {import("@lerna/package").Package[]} filteredPackages The packages to include dependents for.
-     */
-    addDependents(filteredPackages) {
-        return this.extendList(filteredPackages, 'localDependents');
-    }
-    /**
-     * Extends a list of packages by traversing on a given property, which must refer to a
-     * `PackageGraphNode` property that is a collection of `PackageGraphNode`s.
-     * Returns input packages with any additional packages found by traversing `nodeProp`.
-     *
-     * @param {import("@lerna/package").Package[]} packageList The list of packages to extend
-     * @param {'localDependencies'|'localDependents'} nodeProp The property on `PackageGraphNode` used to traverse
-     */
-    extendList(packageList, nodeProp) {
-        // the current list of packages we are expanding using breadth-first-search
-        const search = new Set(packageList.map(({ name }) => this.get(name)));
-        // an intermediate list of matched PackageGraphNodes
-        /** @type {PackageGraphNode[]} */
-        const result = [];
-        search.forEach((currentNode) => {
-            // anything searched for is always a result
-            result.push(currentNode);
-            currentNode[nodeProp].forEach((meta, depName) => {
-                const depNode = this.get(depName);
-                if (depNode !== currentNode && !search.has(depNode)) {
-                    search.add(depNode);
-                }
-            });
-        });
-        // actual Package instances, not PackageGraphNodes
-        return result.map((node) => node.pkg);
-    }
-    /**
-     * Return a tuple of cycle paths and nodes.
-     *
-     * @deprecated Use collapseCycles instead.
-     *
-     * @param {boolean} rejectCycles Whether or not to reject cycles
-     * @returns {[Set<string[]>, Set<PackageGraphNode>]}
-     */
-    partitionCycles(rejectCycles) {
-        const cyclePaths = new Set();
-        const cycleNodes = new Set();
-        this.forEach((currentNode, currentName) => {
-            const seen = new Set();
-            const visits = (walk) => (dependentNode, dependentName, siblingDependents) => {
-                const step = walk.concat(dependentName);
-                if (seen.has(dependentNode)) {
-                    return;
-                }
-                seen.add(dependentNode);
-                if (dependentNode === currentNode) {
-                    // a direct cycle
-                    cycleNodes.add(currentNode);
-                    cyclePaths.add(step);
-                    return;
-                }
-                if (siblingDependents.has(currentName)) {
-                    // a transitive cycle
-                    const cycleDependentName = Array.from(dependentNode.localDependencies.keys()).find((key) => currentNode.localDependents.has(key));
-                    const pathToCycle = step.slice().reverse().concat(cycleDependentName);
-                    cycleNodes.add(dependentNode);
-                    cyclePaths.add(pathToCycle);
-                }
-                dependentNode.localDependents.forEach(visits(step));
-            };
-            currentNode.localDependents.forEach(visits([currentName]));
-        });
-        (0, lib_1.reportCycles)(Array.from(cyclePaths, (cycle) => cycle.join(' -> ')), rejectCycles);
-        return [cyclePaths, cycleNodes];
-    }
-    /**
-     * Returns the cycles of this graph. If two cycles share some elements, they will
-     * be returned as a single cycle.
-     *
-     * @param {boolean} rejectCycles Whether or not to reject cycles
-     * @returns {Set<CyclicPackageGraphNode>}
-     */
-    collapseCycles(rejectCycles) {
-        const cyclePaths = [];
-        const nodeToCycle = new Map();
-        const cycles = new Set();
-        const alreadyVisited = new Set();
-        const walkStack = [];
-        function visits(baseNode, dependentNode) {
-            if (nodeToCycle.has(baseNode)) {
-                return;
-            }
-            let topLevelDependent = dependentNode;
-            while (nodeToCycle.has(topLevelDependent)) {
-                topLevelDependent = nodeToCycle.get(topLevelDependent);
-            }
-            // Otherwise the same node is checked multiple times which is very wasteful in a large repository
-            if (alreadyVisited.has(topLevelDependent)) {
-                return;
-            }
-            alreadyVisited.add(topLevelDependent);
-            if (topLevelDependent === baseNode ||
-                (topLevelDependent.isCycle && topLevelDependent.has(baseNode.name))) {
-                const cycle = new lib_1.CyclicPackageGraphNode();
-                walkStack.forEach((nodeInCycle) => {
-                    nodeToCycle.set(nodeInCycle, cycle);
-                    cycle.insert(nodeInCycle);
-                    cycles.delete(nodeInCycle);
-                });
-                cycles.add(cycle);
-                // @ts-ignore
-                cyclePaths.push(cycle.toString());
-                return;
-            }
-            if (walkStack.indexOf(topLevelDependent) === -1) {
-                // eslint-disable-next-line no-use-before-define
-                visitWithStack(baseNode, topLevelDependent);
-            }
-        }
-        function visitWithStack(baseNode, currentNode = baseNode) {
-            walkStack.push(currentNode);
-            currentNode.localDependents.forEach(visits.bind(null, baseNode));
-            walkStack.pop();
-        }
-        this.forEach((currentNode) => visitWithStack(currentNode));
-        cycles.forEach((collapsedNode) => visitWithStack(collapsedNode));
-        (0, lib_1.reportCycles)(cyclePaths, rejectCycles);
-        return cycles;
-    }
-    /**
-     * Remove cycle nodes.
-     *
-     * @deprecated Spread set into prune() instead.
-     *
-     * @param {Set<PackageGraphNode>} cycleNodes
-     */
-    pruneCycleNodes(cycleNodes) {
-        return this.prune(...cycleNodes);
-    }
-    /**
-     * Remove all candidate nodes.
-     * @param {PackageGraphNode[]} candidates
-     */
-    prune(...candidates) {
-        if (candidates.length === this.size) {
-            return this.clear();
-        }
-        candidates.forEach((node) => this.remove(node));
-    }
-    /**
-     * Delete by value (instead of key), as well as removing pointers
-     * to itself in the other node's internal collections.
-     * @param {PackageGraphNode} candidateNode instance to remove
-     */
-    remove(candidateNode) {
-        this.delete(candidateNode.name);
-        this.forEach((node) => {
-            // remove incoming edges ("indegree")
-            node.localDependencies.delete(candidateNode.name);
-            // remove outgoing edges ("outdegree")
-            node.localDependents.delete(candidateNode.name);
-        });
-    }
-}
-exports.PackageGraph = PackageGraph;
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageGraph = void 0;
+const npm_package_arg_1 = __importDefault(require("npm-package-arg"));
+const lib_1 = require("./lib");
+const validation_error_1 = require("../validation-error");
+/**
+ * A graph of packages in the current project.
+ *
+ * @extends {Map<string, PackageGraphNode>}
+ */
+class PackageGraph extends Map {
+    /**
+     * @param {import("@lerna/package").Package[]} packages An array of Packages to build the graph out of.
+     * @param {'allDependencies'|'dependencies'} [graphType]
+     *    Pass "dependencies" to create a graph of only dependencies,
+     *    excluding the devDependencies that would normally be included.
+     * @param {boolean|'auto'|'force'|'explicit'} [localDependencies] Treatment of local sibling dependencies, default "auto"
+     */
+    constructor(packages, graphType = 'allDependencies', localDependencies = 'auto') {
+        // For backward compatibility
+        if (localDependencies === true || localDependencies === 'forceLocal') {
+            localDependencies = 'force'; // eslint-disable-line
+        }
+        // @ts-ignore
+        super(packages.map((pkg) => { var _a; return [(_a = pkg === null || pkg === void 0 ? void 0 : pkg.name) !== null && _a !== void 0 ? _a : '', new lib_1.PackageGraphNode(pkg)]; }));
+        if (packages.length !== this.size) {
+            // weed out the duplicates
+            const seen = new Map();
+            for (const { name, location } of packages) {
+                if (seen.has(name)) {
+                    seen.get(name).push(location);
+                }
+                else {
+                    seen.set(name, [location]);
+                }
+            }
+            for (const [name, locations] of seen) {
+                if (locations.length > 1) {
+                    throw new validation_error_1.ValidationError('ENAME', [`Package name "${name}" used in multiple packages:`, ...locations].join('\n\t'));
+                }
+            }
+        }
+        this.forEach((currentNode, currentName) => {
+            const graphDependencies = graphType === 'dependencies'
+                ? Object.assign({}, currentNode.pkg.optionalDependencies, currentNode.pkg.dependencies)
+                : Object.assign({}, currentNode.pkg.devDependencies, currentNode.pkg.optionalDependencies, currentNode.pkg.dependencies);
+            Object.keys(graphDependencies).forEach((depName) => {
+                const depNode = this.get(depName);
+                // Yarn decided to ignore https://github.com/npm/npm/pull/15900 and implemented "link:"
+                // As they apparently have no intention of being compatible, we have to do it for them.
+                // @see https://github.com/yarnpkg/yarn/issues/4212
+                let spec = graphDependencies[depName].replace(/^link:/, 'file:');
+                // npa doesn't support the explicit workspace: protocol, supported by
+                // pnpm and Yarn.
+                const explicitWorkspace = /^workspace:/.test(spec);
+                let workspaceTarget;
+                if (explicitWorkspace) {
+                    workspaceTarget = spec;
+                    spec = spec.replace(/^workspace:/, '');
+                    // when dependency is defined as target workspace, like `workspace:*`,
+                    // we'll have to pull the version from its parent package version property
+                    // example with `1.5.0`, ws:* => "1.5.0", ws:^ => "^1.5.0", ws:~ => "~1.5.0", ws:^1.5.0 => "^1.5.0"
+                    if (spec === '*' || spec === '^' || spec === '~') {
+                        const depPkg = packages.find(pkg => pkg.name === depName);
+                        const version = depPkg === null || depPkg === void 0 ? void 0 : depPkg.version;
+                        const specTarget = spec === '*' ? '' : spec;
+                        spec = depPkg ? `${specTarget}${version}` : '';
+                    }
+                }
+                const resolved = npm_package_arg_1.default.resolve(depName, spec, currentNode.location);
+                resolved.explicitWorkspace = explicitWorkspace;
+                if (resolved.explicitWorkspace) {
+                    resolved.workspaceTarget = workspaceTarget;
+                }
+                if (!depNode) {
+                    // it's an external dependency, store the resolution and bail
+                    return currentNode.externalDependencies.set(depName, resolved);
+                }
+                if (explicitWorkspace ||
+                    localDependencies === 'force' ||
+                    resolved.fetchSpec === depNode.location ||
+                    (localDependencies !== 'explicit' && depNode.satisfies(resolved))) {
+                    // a local file: specifier, a matching semver or a workspace: version
+                    currentNode.localDependencies.set(depName, resolved);
+                    depNode.localDependents.set(currentName, currentNode);
+                }
+                else {
+                    // non-matching semver of a local dependency
+                    currentNode.externalDependencies.set(depName, resolved);
+                }
+            });
+        });
+    }
+    get rawPackageList() {
+        return Array.from(this.values()).map((node) => node.pkg);
+    }
+    /**
+     * Takes a list of Packages and returns a list of those same Packages with any Packages
+     * they depend on. i.e if packageA depended on packageB `graph.addDependencies([packageA])`
+     * would return [packageA, packageB].
+     *
+     * @param {import("@lerna/package").Package[]} filteredPackages The packages to include dependencies for.
+     */
+    addDependencies(filteredPackages) {
+        return this.extendList(filteredPackages, 'localDependencies');
+    }
+    /**
+     * Takes a list of Packages and returns a list of those same Packages with any Packages
+     * that depend on them. i.e if packageC depended on packageD `graph.addDependents([packageD])`
+     * would return [packageD, packageC].
+     *
+     * @param {import("@lerna/package").Package[]} filteredPackages The packages to include dependents for.
+     */
+    addDependents(filteredPackages) {
+        return this.extendList(filteredPackages, 'localDependents');
+    }
+    /**
+     * Extends a list of packages by traversing on a given property, which must refer to a
+     * `PackageGraphNode` property that is a collection of `PackageGraphNode`s.
+     * Returns input packages with any additional packages found by traversing `nodeProp`.
+     *
+     * @param {import("@lerna/package").Package[]} packageList The list of packages to extend
+     * @param {'localDependencies'|'localDependents'} nodeProp The property on `PackageGraphNode` used to traverse
+     */
+    extendList(packageList, nodeProp) {
+        // the current list of packages we are expanding using breadth-first-search
+        const search = new Set(packageList.map(({ name }) => this.get(name)));
+        // an intermediate list of matched PackageGraphNodes
+        /** @type {PackageGraphNode[]} */
+        const result = [];
+        search.forEach((currentNode) => {
+            // anything searched for is always a result
+            result.push(currentNode);
+            currentNode[nodeProp].forEach((meta, depName) => {
+                const depNode = this.get(depName);
+                if (depNode !== currentNode && !search.has(depNode)) {
+                    search.add(depNode);
+                }
+            });
+        });
+        // actual Package instances, not PackageGraphNodes
+        return result.map((node) => node.pkg);
+    }
+    /**
+     * Return a tuple of cycle paths and nodes.
+     *
+     * @deprecated Use collapseCycles instead.
+     *
+     * @param {boolean} rejectCycles Whether or not to reject cycles
+     * @returns {[Set<string[]>, Set<PackageGraphNode>]}
+     */
+    partitionCycles(rejectCycles) {
+        const cyclePaths = new Set();
+        const cycleNodes = new Set();
+        this.forEach((currentNode, currentName) => {
+            const seen = new Set();
+            const visits = (walk) => (dependentNode, dependentName, siblingDependents) => {
+                const step = walk.concat(dependentName);
+                if (seen.has(dependentNode)) {
+                    return;
+                }
+                seen.add(dependentNode);
+                if (dependentNode === currentNode) {
+                    // a direct cycle
+                    cycleNodes.add(currentNode);
+                    cyclePaths.add(step);
+                    return;
+                }
+                if (siblingDependents.has(currentName)) {
+                    // a transitive cycle
+                    const cycleDependentName = Array.from(dependentNode.localDependencies.keys()).find((key) => currentNode.localDependents.has(key));
+                    const pathToCycle = step.slice().reverse().concat(cycleDependentName);
+                    cycleNodes.add(dependentNode);
+                    cyclePaths.add(pathToCycle);
+                }
+                dependentNode.localDependents.forEach(visits(step));
+            };
+            currentNode.localDependents.forEach(visits([currentName]));
+        });
+        (0, lib_1.reportCycles)(Array.from(cyclePaths, (cycle) => cycle.join(' -> ')), rejectCycles);
+        return [cyclePaths, cycleNodes];
+    }
+    /**
+     * Returns the cycles of this graph. If two cycles share some elements, they will
+     * be returned as a single cycle.
+     *
+     * @param {boolean} rejectCycles Whether or not to reject cycles
+     * @returns {Set<CyclicPackageGraphNode>}
+     */
+    collapseCycles(rejectCycles) {
+        const cyclePaths = [];
+        const nodeToCycle = new Map();
+        const cycles = new Set();
+        const alreadyVisited = new Set();
+        const walkStack = [];
+        function visits(baseNode, dependentNode) {
+            if (nodeToCycle.has(baseNode)) {
+                return;
+            }
+            let topLevelDependent = dependentNode;
+            while (nodeToCycle.has(topLevelDependent)) {
+                topLevelDependent = nodeToCycle.get(topLevelDependent);
+            }
+            // Otherwise the same node is checked multiple times which is very wasteful in a large repository
+            if (alreadyVisited.has(topLevelDependent)) {
+                return;
+            }
+            alreadyVisited.add(topLevelDependent);
+            if (topLevelDependent === baseNode ||
+                (topLevelDependent.isCycle && topLevelDependent.has(baseNode.name))) {
+                const cycle = new lib_1.CyclicPackageGraphNode();
+                walkStack.forEach((nodeInCycle) => {
+                    nodeToCycle.set(nodeInCycle, cycle);
+                    cycle.insert(nodeInCycle);
+                    cycles.delete(nodeInCycle);
+                });
+                cycles.add(cycle);
+                // @ts-ignore
+                cyclePaths.push(cycle.toString());
+                return;
+            }
+            if (walkStack.indexOf(topLevelDependent) === -1) {
+                // eslint-disable-next-line no-use-before-define
+                visitWithStack(baseNode, topLevelDependent);
+            }
+        }
+        function visitWithStack(baseNode, currentNode = baseNode) {
+            walkStack.push(currentNode);
+            currentNode.localDependents.forEach(visits.bind(null, baseNode));
+            walkStack.pop();
+        }
+        this.forEach((currentNode) => visitWithStack(currentNode));
+        cycles.forEach((collapsedNode) => visitWithStack(collapsedNode));
+        (0, lib_1.reportCycles)(cyclePaths, rejectCycles);
+        return cycles;
+    }
+    /**
+     * Remove cycle nodes.
+     *
+     * @deprecated Spread set into prune() instead.
+     *
+     * @param {Set<PackageGraphNode>} cycleNodes
+     */
+    pruneCycleNodes(cycleNodes) {
+        return this.prune(...cycleNodes);
+    }
+    /**
+     * Remove all candidate nodes.
+     * @param {PackageGraphNode[]} candidates
+     */
+    prune(...candidates) {
+        if (candidates.length === this.size) {
+            return this.clear();
+        }
+        candidates.forEach((node) => this.remove(node));
+    }
+    /**
+     * Delete by value (instead of key), as well as removing pointers
+     * to itself in the other node's internal collections.
+     * @param {PackageGraphNode} candidateNode instance to remove
+     */
+    remove(candidateNode) {
+        this.delete(candidateNode.name);
+        this.forEach((node) => {
+            // remove incoming edges ("indegree")
+            node.localDependencies.delete(candidateNode.name);
+            // remove outgoing edges ("outdegree")
+            node.localDependents.delete(candidateNode.name);
+        });
+    }
+}
+exports.PackageGraph = PackageGraph;
 //# sourceMappingURL=package-graph.js.map