workspace-tools 0.22.0 → 0.23.2

package/CHANGELOG.json

@@ -2,7 +2,52 @@
   "name": "workspace-tools",
   "entries": [
     {
-      "date": "Wed, 13 Jul 2022 20:42:04 GMT",
+      "date": "Fri, 15 Jul 2022 05:05:45 GMT",
+      "tag": "workspace-tools_v0.23.2",
+      "version": "0.23.2",
+      "comments": {
+        "patch": [
+          {
+            "author": "ken@gizzar.com",
+            "package": "workspace-tools",
+            "comment": "fixing the dependent map results",
+            "commit": "6dff4d2ba6fe88ab0a0f60c7c62410393e4596ee"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Fri, 15 Jul 2022 03:59:39 GMT",
+      "tag": "workspace-tools_v0.23.1",
+      "version": "0.23.1",
+      "comments": {
+        "patch": [
+          {
+            "author": "ken@gizzar.com",
+            "package": "workspace-tools",
+            "comment": "fixing the missing getDependentMap API that lage uses",
+            "commit": "c37668d313891a5a0acd25f81a8b2476437335e1"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 14 Jul 2022 17:22:35 GMT",
+      "tag": "workspace-tools_v0.23.0",
+      "version": "0.23.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "workspace-tools",
+            "comment": "refactoring and cleaning up the createPackageGraph API to make it not repeat edges",
+            "commit": "4cd2ebcdc61bdd3c1bce6d1e09bedd13e739edd5"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Wed, 13 Jul 2022 20:42:07 GMT",
       "tag": "workspace-tools_v0.22.0",
       "version": "0.22.0",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,36 @@
 # Change Log - workspace-tools
 
-This log was last generated on Wed, 13 Jul 2022 20:42:04 GMT and should not be manually modified.
+This log was last generated on Fri, 15 Jul 2022 05:05:45 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.23.2
+
+Fri, 15 Jul 2022 05:05:45 GMT
+
+### Patches
+
+- fixing the dependent map results (ken@gizzar.com)
+
+## 0.23.1
+
+Fri, 15 Jul 2022 03:59:39 GMT
+
+### Patches
+
+- fixing the missing getDependentMap API that lage uses (ken@gizzar.com)
+
+## 0.23.0
+
+Thu, 14 Jul 2022 17:22:35 GMT
+
+### Minor changes
+
+- refactoring and cleaning up the createPackageGraph API to make it not repeat edges (kchau@microsoft.com)
+
 ## 0.22.0
 
-Wed, 13 Jul 2022 20:42:04 GMT
+Wed, 13 Jul 2022 20:42:07 GMT
 
 ### Minor changes
 

package/lib/dependencies/index.d.ts

@@ -0,0 +1,12 @@
+import { getTransitiveConsumers, getTransitiveProviders } from "./transitiveDeps";
+import { getPackageDependencies } from "../graph/getPackageDependencies";
+/** @deprecated Do not use */
+export declare const getTransitiveDependencies: typeof getTransitiveProviders;
+/** @deprecated Do not use */
+export { getTransitiveProviders };
+/** @deprecated Do not use */
+export declare const getTransitiveDependents: typeof getTransitiveConsumers;
+/** @deprecated Do not use */
+export { getTransitiveConsumers };
+/** @deprecated Do not use */
+export declare const getInternalDeps: typeof getPackageDependencies;

package/lib/dependencies/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getInternalDeps = exports.getTransitiveConsumers = exports.getTransitiveDependents = exports.getTransitiveProviders = exports.getTransitiveDependencies = void 0;
+const transitiveDeps_1 = require("./transitiveDeps");
+Object.defineProperty(exports, "getTransitiveConsumers", { enumerable: true, get: function () { return transitiveDeps_1.getTransitiveConsumers; } });
+Object.defineProperty(exports, "getTransitiveProviders", { enumerable: true, get: function () { return transitiveDeps_1.getTransitiveProviders; } });
+const getPackageDependencies_1 = require("../graph/getPackageDependencies");
+// Some deprecated functions below for backwards compatibility
+/** @deprecated Do not use */
+exports.getTransitiveDependencies = transitiveDeps_1.getTransitiveProviders;
+/** @deprecated Do not use */
+exports.getTransitiveDependents = transitiveDeps_1.getTransitiveConsumers;
+/** @deprecated Do not use */
+exports.getInternalDeps = getPackageDependencies_1.getPackageDependencies;

package/lib/{dependencies.d.ts → dependencies/transitiveDeps.d.ts}

@@ -1,4 +1,4 @@
-import { PackageInfo, PackageInfos } from "./types/PackageInfo";
+import { PackageInfos } from "../types/PackageInfo";
 export declare function getDependentMap(packages: PackageInfos): Map<string, Set<string>>;
 /**
  * @deprecated Do not use
@@ -17,9 +17,3 @@ export declare function getTransitiveConsumers(targets: string[], packages: Pack
  * @param packages
  */
 export declare function getTransitiveProviders(targets: string[], packages: PackageInfos): string[];
-/** @deprecated Do not use */
-export declare const getTransitiveDependencies: typeof getTransitiveProviders;
-/** @deprecated Do not use */
-export declare const getTransitiveDependents: typeof getTransitiveConsumers;
-/** @deprecated Do not use */
-export declare function getInternalDeps(info: PackageInfo, packages: PackageInfos): string[];

package/lib/{dependencies.js → dependencies/transitiveDeps.js}

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getInternalDeps = exports.getTransitiveDependents = exports.getTransitiveDependencies = exports.getTransitiveProviders = exports.getTransitiveConsumers = exports.getDependentMap = void 0;
+exports.getTransitiveProviders = exports.getTransitiveConsumers = exports.getDependentMap = void 0;
+const getPackageDependencies_1 = require("../graph/getPackageDependencies");
 const graphCache = new Map();
 function memoizedKey(packages, scope = []) {
     return JSON.stringify({ packages, scope });
@@ -20,7 +21,7 @@ function getPackageGraph(packages, scope = []) {
         }
         visited.add(pkg);
         const info = packages[pkg];
-        const deps = getInternalDeps(info, packages);
+        const deps = (0, getPackageDependencies_1.getPackageDependencies)(info, packages);
         if (deps.length > 0) {
             for (const dep of deps) {
                 stack.push(dep);
@@ -99,13 +100,3 @@ function getTransitiveProviders(targets, packages) {
     return [...visited].filter((pkg) => !targets.includes(pkg));
 }
 exports.getTransitiveProviders = getTransitiveProviders;
-/** @deprecated Do not use */
-exports.getTransitiveDependencies = getTransitiveProviders;
-/** @deprecated Do not use */
-exports.getTransitiveDependents = getTransitiveConsumers;
-/** @deprecated Do not use */
-function getInternalDeps(info, packages) {
-    const deps = Object.keys(Object.assign(Object.assign({}, info.dependencies), info.devDependencies));
-    return Object.keys(packages).filter((pkg) => deps.includes(pkg));
-}
-exports.getInternalDeps = getInternalDeps;

package/lib/{createDependencyMap.d.ts → graph/createDependencyMap.d.ts}

@@ -1,9 +1,7 @@
-import { PackageInfos } from "./types/PackageInfo";
+import { PackageDependenciesOptions } from "./getPackageDependencies";
+import { PackageInfos } from "../types/PackageInfo";
 export interface DependencyMap {
     dependencies: Map<string, Set<string>>;
     dependents: Map<string, Set<string>>;
 }
-export declare function createDependencyMap(packages: PackageInfos): {
-    dependencies: Map<string, Set<string>>;
-    dependents: Map<string, Set<string>>;
-};
+export declare function createDependencyMap(packages: PackageInfos, options?: PackageDependenciesOptions): DependencyMap;

package/lib/{createDependencyMap.js → graph/createDependencyMap.js}

@@ -1,14 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createDependencyMap = void 0;
+const getPackageDependencies_1 = require("./getPackageDependencies");
 // @internal
-function createDependencyMap(packages) {
+function createDependencyMap(packages, options = { withDevDependencies: true, withPeerDependencies: false }) {
     const map = {
         dependencies: new Map(),
         dependents: new Map(),
     };
     for (const [pkg, info] of Object.entries(packages)) {
-        const deps = Object.keys(Object.assign(Object.assign({}, info.dependencies), info.devDependencies));
+        const deps = (0, getPackageDependencies_1.getPackageDependencies)(info, packages, options);
         for (const dep of deps) {
             if (!map.dependencies.has(pkg)) {
                 map.dependencies.set(pkg, new Set());

package/lib/graph/createPackageGraph.d.ts

@@ -0,0 +1,10 @@
+import type { PackageInfos } from "../types/PackageInfo";
+import type { PackageGraph } from "../types/PackageGraph";
+export interface PackageGraphFilter {
+    namePatterns: string[];
+    includeDependencies?: boolean;
+    includeDependents?: boolean;
+    withDevDependencies?: boolean;
+    withPeerDependencies?: boolean;
+}
+export declare function createPackageGraph(packages: PackageInfos, filters?: PackageGraphFilter[] | PackageGraphFilter): PackageGraph;

package/lib/graph/createPackageGraph.js

@@ -0,0 +1,122 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPackageGraph = void 0;
+const createDependencyMap_1 = require("./createDependencyMap");
+const multimatch_1 = __importDefault(require("multimatch"));
+function createPackageGraph(packages, filters) {
+    /** packageSet is the set of packages being accumulated as the graph is filtered */
+    const packageSet = new Set();
+    /** edges is the array of package names & its dependency being accumulated as the graph is filtered */
+    const edges = [];
+    const edgeKeys = new Set();
+    let dependencyMapWithPeerDevDeps = undefined;
+    let dependencyMapWithPeerDeps = undefined;
+    let dependencyMapWithDevDeps = undefined;
+    let dependencyMapWithoutPeerDevDeps = undefined;
+    /** a visitor for a single filter,  */
+    function visitorForFilter(filter, pkg, dependencies, dependents) {
+        packageSet.add(pkg);
+        if (!filter || (filter.includeDependencies && dependencies)) {
+            for (const dep of dependencies) {
+                const key = edgeKey(pkg, dep);
+                if (!edgeKeys.has(key)) {
+                    edgeKeys.add(key);
+                    edges.push({ name: pkg, dependency: dep });
+                }
+                packageSet.add(dep);
+            }
+        }
+        if (!filter || (filter.includeDependents && dependents)) {
+            for (const dep of dependents) {
+                const key = edgeKey(dep, pkg);
+                if (!edgeKeys.has(key)) {
+                    edgeKeys.add(key);
+                    edges.push({ name: dep, dependency: pkg });
+                }
+                packageSet.add(dep);
+            }
+        }
+    }
+    if (filters) {
+        if (Array.isArray(filters)) {
+            for (const filter of filters) {
+                const dependencyMap = getDependencyMapForFilter(packages, filter);
+                const visitor = visitorForFilter.bind(undefined, filter);
+                visitPackageGraph(packages, dependencyMap, visitor, filter);
+            }
+        }
+        else {
+            const filter = filters;
+            const dependencyMap = getDependencyMapForFilter(packages, filter);
+            const visitor = visitorForFilter.bind(undefined, filter);
+            visitPackageGraph(packages, dependencyMap, visitor, filter);
+        }
+    }
+    else {
+        const visitor = visitorForFilter.bind(undefined, undefined);
+        const dependencyMap = getDependencyMapForFilter(packages);
+        visitPackageGraph(packages, dependencyMap, visitor);
+    }
+    return { packages: [...packageSet], dependencies: edges };
+    /** calculates a key, for looking up whether an edge is already added */
+    function edgeKey(name, dependency) {
+        return `${name}->${dependency}`;
+    }
+    /** gets the dependencyMap for a filter - with or without devDeps */
+    function getDependencyMapForFilter(packages, filter) {
+        if (!filter) {
+            return (0, createDependencyMap_1.createDependencyMap)(packages);
+        }
+        if (filter.withDevDependencies && filter.withPeerDependencies && !dependencyMapWithPeerDevDeps) {
+            dependencyMapWithPeerDevDeps = (0, createDependencyMap_1.createDependencyMap)(packages, { withDevDependencies: true, withPeerDependencies: true });
+        }
+        else if (filter.withDevDependencies && !filter.withPeerDependencies && !dependencyMapWithDevDeps) {
+            dependencyMapWithDevDeps = (0, createDependencyMap_1.createDependencyMap)(packages, { withDevDependencies: true, withPeerDependencies: false });
+        }
+        else if (!filter.withDevDependencies && filter.withPeerDependencies && !dependencyMapWithPeerDeps) {
+            dependencyMapWithPeerDeps = (0, createDependencyMap_1.createDependencyMap)(packages, { withDevDependencies: false, withPeerDependencies: true });
+        }
+        else {
+            dependencyMapWithoutPeerDevDeps = (0, createDependencyMap_1.createDependencyMap)(packages, { withDevDependencies: false, withPeerDependencies: false });
+        }
+        return ((filter.withDevDependencies && filter.withPeerDependencies) ? dependencyMapWithPeerDevDeps : (filter.withDevDependencies ? dependencyMapWithDevDeps : (filter.withPeerDependencies ? dependencyMapWithPeerDeps : dependencyMapWithoutPeerDevDeps)));
+    }
+}
+exports.createPackageGraph = createPackageGraph;
+function visitPackageGraph(packages, dependencyMap, visitor, filter) {
+    var _a, _b;
+    const visited = new Set();
+    const packageNames = Object.keys(packages);
+    const stack = filter ? (0, multimatch_1.default)(packageNames, filter.namePatterns) : packageNames;
+    while (stack.length > 0) {
+        const pkg = stack.pop();
+        if (visited.has(pkg)) {
+            continue;
+        }
+        const nextPkgs = new Set();
+        let dependencies = [];
+        let dependents = [];
+        if (!filter || filter.includeDependencies) {
+            dependencies = [...((_a = dependencyMap.dependencies.get(pkg)) !== null && _a !== void 0 ? _a : [])];
+            for (const dep of dependencies) {
+                nextPkgs.add(dep);
+            }
+        }
+        if (!filter || filter.includeDependents) {
+            dependents = [...((_b = dependencyMap.dependents.get(pkg)) !== null && _b !== void 0 ? _b : [])];
+            for (const dep of dependents) {
+                nextPkgs.add(dep);
+            }
+        }
+        visitor(pkg, dependencies, dependents);
+        visited.add(pkg);
+        if (nextPkgs.size > 0) {
+            for (const nextPkg of nextPkgs) {
+                stack.push(nextPkg);
+            }
+        }
+    }
+}

package/lib/graph/getPackageDependencies.d.ts

@@ -0,0 +1,6 @@
+import { PackageInfo, PackageInfos } from "../types/PackageInfo";
+export interface PackageDependenciesOptions {
+    withDevDependencies?: boolean;
+    withPeerDependencies?: boolean;
+}
+export declare function getPackageDependencies(info: PackageInfo, packages: PackageInfos, options?: PackageDependenciesOptions): string[];

package/lib/graph/getPackageDependencies.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPackageDependencies = void 0;
+function getPackageDependencies(info, packages, options = { withDevDependencies: true }) {
+    let deps = [];
+    if (options.withDevDependencies && options.withPeerDependencies) {
+        deps = Object.keys(Object.assign(Object.assign(Object.assign({}, info.dependencies), info.devDependencies), info.peerDependencies));
+    }
+    else if (options.withDevDependencies) {
+        deps = Object.keys(Object.assign(Object.assign({}, info.dependencies), info.devDependencies));
+    }
+    else if (options.withPeerDependencies) {
+        deps = Object.keys(Object.assign(Object.assign({}, info.dependencies), info.peerDependencies));
+    }
+    else {
+        deps = Object.keys(Object.assign({}, info.dependencies));
+    }
+    return Object.keys(packages).filter((pkg) => deps.includes(pkg));
+}
+exports.getPackageDependencies = getPackageDependencies;

package/lib/graph/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./createPackageGraph";
+import { PackageInfos } from "../types/PackageInfo";
+export declare function getDependentMap(packages: PackageInfos): Map<string, Set<string>>;

package/lib/graph/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDependentMap = void 0;
+__exportStar(require("./createPackageGraph"), exports);
+const createDependencyMap_1 = require("./createDependencyMap");
+// @deprecated - use createDependencyMap() instead
+function getDependentMap(packages) {
+    return (0, createDependencyMap_1.createDependencyMap)(packages).dependents;
+}
+exports.getDependentMap = getDependentMap;

package/lib/index.d.ts

@@ -1,7 +1,7 @@
-export * from "./dependencies";
+export * from "./dependencies/index";
 export * from "./getPackageInfos";
 export * from "./git";
-export * from "./graph";
+export * from "./graph/index";
 export * from "./lockfile";
 export * from "./paths";
 export * from "./scope";

package/lib/index.js

@@ -10,10 +10,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./dependencies"), exports);
+__exportStar(require("./dependencies/index"), exports);
 __exportStar(require("./getPackageInfos"), exports);
 __exportStar(require("./git"), exports);
-__exportStar(require("./graph"), exports);
+__exportStar(require("./graph/index"), exports);
 __exportStar(require("./lockfile"), exports);
 __exportStar(require("./paths"), exports);
 __exportStar(require("./scope"), exports);

package/lib/lockfile/index.js

@@ -42,7 +42,7 @@ async function parseLockFile(packageRoot) {
             return memoization[yarnLockPath];
         }
         const parseYarnLock = (await Promise.resolve().then(() => __importStar(require("@yarnpkg/lockfile")))).parse;
-        const yarnLock = fs_1.default.readFileSync(yarnLockPath, 'utf-8');
+        const yarnLock = fs_1.default.readFileSync(yarnLockPath, "utf-8");
         const parsed = parseYarnLock(yarnLock);
         memoization[yarnLockPath] = parsed;
         return parsed;
@@ -67,7 +67,7 @@ async function parseLockFile(packageRoot) {
         }
         let npmLockJson;
         try {
-            npmLockJson = fs_1.default.readFileSync(npmLockPath, 'utf-8');
+            npmLockJson = fs_1.default.readFileSync(npmLockPath, "utf-8");
         }
         catch (_a) {
             throw new Error("Couldn’t parse package-lock.json.");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workspace-tools",
-  "version": "0.22.0",
+  "version": "0.23.2",
   "license": "MIT",
   "repository": {
     "type": "git",

package/lib/graph.d.ts

@@ -1,8 +0,0 @@
-import type { PackageInfos } from "./types/PackageInfo";
-import type { PackageGraph } from "./types/PackageGraph";
-export interface PackageGraphScope {
-    namePatterns?: string[];
-    includeDependencies?: boolean;
-    includeDependents?: boolean;
-}
-export declare function createPackageGraph(packages: PackageInfos, scope?: PackageGraphScope): PackageGraph;

package/lib/graph.js

@@ -1,61 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createPackageGraph = void 0;
-const createDependencyMap_1 = require("./createDependencyMap");
-const multimatch_1 = __importDefault(require("multimatch"));
-function createPackageGraph(packages, scope = {}) {
-    const dependencyMap = (0, createDependencyMap_1.createDependencyMap)(packages);
-    const packageSet = new Set();
-    const edges = [];
-    const visitor = (pkg, dependencies, dependents) => {
-        packageSet.add(pkg);
-        if (scope.includeDependencies && dependencies) {
-            for (const dep of dependencies) {
-                edges.push({ name: pkg, dependency: dep });
-                packageSet.add(dep);
-            }
-        }
-        if (scope.includeDependents && dependents) {
-            for (const dep of dependents) {
-                edges.push({ name: dep, dependency: pkg });
-                packageSet.add(dep);
-            }
-        }
-    };
-    visitPackageGraph(packages, dependencyMap, visitor, scope);
-    return { packages: [...packageSet], dependencies: edges };
-}
-exports.createPackageGraph = createPackageGraph;
-function visitPackageGraph(packages, dependencyMap, visitor, scope) {
-    var _a, _b;
-    const visited = new Set();
-    const packageNames = Object.keys(packages);
-    const stack = scope && scope.namePatterns ? (0, multimatch_1.default)(packageNames, scope.namePatterns) : packageNames;
-    while (stack.length > 0) {
-        const pkg = stack.pop();
-        if (visited.has(pkg)) {
-            continue;
-        }
-        const nextPkgs = [];
-        let dependencies = [];
-        let dependents = [];
-        if (scope === null || scope === void 0 ? void 0 : scope.includeDependencies) {
-            dependencies = [...(_a = dependencyMap.dependencies.get(pkg)) !== null && _a !== void 0 ? _a : []];
-            nextPkgs.push(...dependencies);
-        }
-        if (scope === null || scope === void 0 ? void 0 : scope.includeDependents) {
-            dependents = [...(_b = dependencyMap.dependents.get(pkg)) !== null && _b !== void 0 ? _b : []];
-            nextPkgs.push(...dependents);
-        }
-        visitor(pkg, dependencies, dependents);
-        visited.add(pkg);
-        if (nextPkgs.length > 0) {
-            for (const nextPkg of nextPkgs) {
-                stack.push(nextPkg);
-            }
-        }
-    }
-}