workspace-tools 0.17.0 → 0.18.0

package/CHANGELOG.json

@@ -2,7 +2,22 @@
   "name": "workspace-tools",
   "entries": [
     {
-      "date": "Thu, 02 Dec 2021 17:11:04 GMT",
+      "date": "Fri, 07 Jan 2022 00:04:25 GMT",
+      "tag": "workspace-tools_v0.18.0",
+      "version": "0.18.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "kchau@microsoft.com",
+            "package": "workspace-tools",
+            "comment": "speed up workspace-tools - reducing weight and adding caches - lazy load pkg mgr helpers",
+            "commit": "6105a8eb81e4972b9ffbdd18669a137f0f5d9400"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 02 Dec 2021 17:11:12 GMT",
       "tag": "workspace-tools_v0.17.0",
       "version": "0.17.0",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,20 @@
 # Change Log - workspace-tools
 
-This log was last generated on Thu, 02 Dec 2021 17:11:04 GMT and should not be manually modified.
+This log was last generated on Fri, 07 Jan 2022 00:04:25 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.18.0
+
+Fri, 07 Jan 2022 00:04:25 GMT
+
+### Minor changes
+
+- speed up workspace-tools - reducing weight and adding caches - lazy load pkg mgr helpers (kchau@microsoft.com)
+
 ## 0.17.0
 
-Thu, 02 Dec 2021 17:11:04 GMT
+Thu, 02 Dec 2021 17:11:12 GMT
 
 ### Minor changes
 

package/lib/getPackagePaths.js

@@ -5,25 +5,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
 const globby_1 = __importDefault(require("globby"));
+const packagePathsCache = {};
 function getPackagePaths(workspacesRoot, packages) {
-    const packagePaths = packages.map((glob) => {
-        const globbed = globby_1.default
-            .sync(path_1.default.join(glob, "package.json").replace(/\\/g, "/"), {
-            cwd: workspacesRoot,
-            absolute: true,
-            ignore: ["**/node_modules/**"],
-        })
-            .map((p) => path_1.default.dirname(p));
-        return globbed;
-    });
-    /*
-     * fast-glob returns unix style path,
-     * so we use path.join to align the path with the platform.
-     */
-    return packagePaths
-        .reduce((acc, cur) => {
-        return [...acc, ...cur];
+    if (packagePathsCache[workspacesRoot]) {
+        return packagePathsCache[workspacesRoot];
+    }
+    const packagePaths = globby_1.default
+        .sync(packages.map((glob) => path_1.default.join(glob, "package.json").replace(/\\/g, "/")), {
+        cwd: workspacesRoot,
+        absolute: true,
+        ignore: ["**/node_modules/**"],
+        stats: false,
     })
-        .map((p) => path_1.default.join(p));
+        .map((p) => path_1.default.dirname(p));
+    if (path_1.default.sep === "/") {
+        packagePathsCache[workspacesRoot] = packagePaths;
+    }
+    else {
+        packagePathsCache[workspacesRoot] = packagePaths.map((p) => p.replace(/\//g, path_1.default.sep));
+    }
+    return packagePathsCache[workspacesRoot];
 }
 exports.getPackagePaths = getPackagePaths;

package/lib/helpers/setupFixture.js

@@ -6,7 +6,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
 const find_up_1 = __importDefault(require("find-up"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
-const fs_extra_2 = __importDefault(require("fs-extra"));
 const tmp_1 = __importDefault(require("tmp"));
 const git_1 = require("../git");
 // tmp is supposed to be able to clean up automatically, but this doesn't always work within jest.
@@ -39,8 +38,8 @@ function setupFixture(fixtureName) {
     // ensure that the configuration for this repo does not collide
     // with any global configuration the user had made, so we have
     // a 'fixed' value for our tests, regardless of user configuration
-    git_1.gitFailFast(['symbolic-ref', 'HEAD', 'refs/heads/main'], { cwd });
-    git_1.gitFailFast(['config', 'init.defaultBranch', 'main'], { cwd });
+    git_1.gitFailFast(["symbolic-ref", "HEAD", "refs/heads/main"], { cwd });
+    git_1.gitFailFast(["config", "init.defaultBranch", "main"], { cwd });
     git_1.stageAndCommit(["."], "test", cwd);
     return cwd;
 }
@@ -59,9 +58,9 @@ function setupLocalRemote(cwd, remoteName, fixtureName) {
     git_1.gitFailFast(["remote", "add", remoteName, remoteUrl], { cwd });
     // Configure url in package.json
     const pkgJsonPath = path_1.default.join(cwd, "package.json");
-    const pkgJson = fs_extra_2.default.readJSONSync(pkgJsonPath);
-    fs_extra_2.default.writeJSONSync(pkgJsonPath, Object.assign(Object.assign({}, pkgJson), { repository: {
-            url: remoteUrl
-        } }));
+    const pkgJson = JSON.parse(fs_extra_1.default.readFileSync(pkgJsonPath, "utf-8"));
+    fs_extra_1.default.writeFileSync(pkgJsonPath, JSON.stringify(Object.assign(Object.assign({}, pkgJson), { repository: {
+            url: remoteUrl,
+        } }), null, 2));
 }
 exports.setupLocalRemote = setupLocalRemote;

package/lib/lockfile/index.js

@@ -12,8 +12,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 // NOTE: never place the import of lockfile implementation here, as it slows down the library as a whole
 const find_up_1 = __importDefault(require("find-up"));
-const fs_extra_1 = __importDefault(require("fs-extra"));
-const read_yaml_file_1 = __importDefault(require("read-yaml-file"));
+const fs_1 = __importDefault(require("fs"));
 const nameAtVersion_1 = require("./nameAtVersion");
 exports.nameAtVersion = nameAtVersion_1.nameAtVersion;
 const parsePnpmLock_1 = require("./parsePnpmLock");
@@ -27,7 +26,7 @@ async function parseLockFile(packageRoot) {
             return memoization[yarnLockPath];
         }
         const parseYarnLock = (await Promise.resolve().then(() => __importStar(require("@yarnpkg/lockfile")))).parse;
-        const yarnLock = fs_extra_1.default.readFileSync(yarnLockPath).toString();
+        const yarnLock = fs_1.default.readFileSync(yarnLockPath, 'utf-8');
         const parsed = parseYarnLock(yarnLock);
         memoization[yarnLockPath] = parsed;
         return parsed;
@@ -38,7 +37,8 @@ async function parseLockFile(packageRoot) {
         if (memoization[pnpmLockPath]) {
             return memoization[pnpmLockPath];
         }
-        const yaml = await read_yaml_file_1.default(pnpmLockPath);
+        const readYamlFile = require("read-yaml-file");
+        const yaml = (await readYamlFile(pnpmLockPath));
         const parsed = parsePnpmLock_1.parsePnpmLock(yaml);
         memoization[pnpmLockPath] = parsed;
         return memoization[pnpmLockPath];
@@ -51,7 +51,7 @@ async function parseLockFile(packageRoot) {
         }
         let npmLockJson;
         try {
-            npmLockJson = fs_extra_1.default.readFileSync(npmLockPath);
+            npmLockJson = fs_1.default.readFileSync(npmLockPath, 'utf-8');
         }
         catch (_a) {
             throw new Error("Couldn’t parse package-lock.json.");

package/lib/workspaces/getWorkspaceRoot.js

@@ -1,25 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const implementations_1 = require("./implementations");
-const pnpm_1 = require("./implementations/pnpm");
-const yarn_1 = require("./implementations/yarn");
-const rush_1 = require("./implementations/rush");
-const npm_1 = require("./implementations/npm");
-const lerna_1 = require("./implementations/lerna");
-const workspaceGetter = {
-    yarn: yarn_1.getYarnWorkspaceRoot,
-    pnpm: pnpm_1.getPnpmWorkspaceRoot,
-    rush: rush_1.getRushWorkspaceRoot,
-    npm: npm_1.getNpmWorkspaceRoot,
-    lerna: lerna_1.getLernaWorkspaceRoot,
-};
-const preferred = process.env
-    .PREFERRED_WORKSPACE_MANAGER;
+const preferred = process.env.PREFERRED_WORKSPACE_MANAGER;
 function getWorkspaceRoot(cwd) {
     const workspaceImplementation = preferred || implementations_1.getWorkspaceImplementation(cwd);
-    if (!workspaceImplementation || !workspaceGetter[workspaceImplementation]) {
+    if (!workspaceImplementation) {
         return;
     }
-    return workspaceGetter[workspaceImplementation](cwd);
+    switch (workspaceImplementation) {
+        case "yarn":
+            return require(`./implementations/yarn`).getYarnWorkspaceRoot(cwd);
+        case "pnpm":
+            return require(`./implementations/pnpm`).getPnpmWorkspaceRoot(cwd);
+        case "rush":
+            return require(`./implementations/rush`).getRushWorkspaceRoot(cwd);
+        case "npm":
+            return require(`./implementations/npm`).getNpmWorkspaceRoot(cwd);
+        case "lerna":
+            return require(`./implementations/lerna`).getLernaWorkspaceRoot(cwd);
+    }
 }
 exports.getWorkspaceRoot = getWorkspaceRoot;

package/lib/workspaces/getWorkspaces.js

@@ -1,25 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const implementations_1 = require("./implementations");
-const lerna_1 = require("./implementations/lerna");
-const npm_1 = require("./implementations/npm");
-const pnpm_1 = require("./implementations/pnpm");
-const rush_1 = require("./implementations/rush");
-const yarn_1 = require("./implementations/yarn");
-const workspaceGetter = {
-    yarn: yarn_1.getYarnWorkspaces,
-    pnpm: pnpm_1.getPnpmWorkspaces,
-    rush: rush_1.getRushWorkspaces,
-    npm: npm_1.getNpmWorkspaces,
-    lerna: lerna_1.getLernaWorkspaces,
-};
-const preferred = process.env
-    .PREFERRED_WORKSPACE_MANAGER;
+const preferred = process.env.PREFERRED_WORKSPACE_MANAGER;
 function getWorkspaces(cwd) {
     const workspaceImplementation = preferred || implementations_1.getWorkspaceImplementation(cwd);
-    if (!workspaceImplementation || !workspaceGetter[workspaceImplementation]) {
+    if (!workspaceImplementation) {
         return [];
     }
-    return workspaceGetter[workspaceImplementation](cwd);
+    switch (workspaceImplementation) {
+        case "yarn":
+            return require(`./implementations/yarn`).getYarnWorkspaces(cwd);
+        case "pnpm":
+            return require(`./implementations/pnpm`).getPnpmWorkspaces(cwd);
+        case "rush":
+            return require(`./implementations/rush`).getRushWorkspaces(cwd);
+        case "npm":
+            return require(`./implementations/npm`).getNpmWorkspaces(cwd);
+        case "lerna":
+            return require(`./implementations/lerna`).getLernaWorkspaces(cwd);
+    }
 }
 exports.getWorkspaces = getWorkspaces;

package/lib/workspaces/implementations/index.d.ts

@@ -1,2 +1,10 @@
-export declare type WorkspaceImplementations = "yarn" | "pnpm" | "rush" | "npm" | 'lerna';
+export declare type WorkspaceImplementations = "yarn" | "pnpm" | "rush" | "npm" | "lerna";
+export interface ImplementationAndLockFile {
+    implementation: WorkspaceImplementations | undefined;
+    lockFile: string;
+}
+export declare function getWorkspaceImplementationAndLockFile(cwd: string): {
+    implementation: WorkspaceImplementations | undefined;
+    lockFile: string;
+} | undefined;
 export declare function getWorkspaceImplementation(cwd: string): WorkspaceImplementations | undefined;

package/lib/workspaces/implementations/index.js

@@ -4,28 +4,55 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const find_up_1 = __importDefault(require("find-up"));
-function getWorkspaceImplementation(cwd) {
-    // This needs to come before Yarn and NPM because
-    // lerna can be used with either package manager
-    const lernaJsonPath = find_up_1.default.sync("lerna.json", { cwd });
-    if (lernaJsonPath) {
-        return "lerna";
-    }
-    const yarnLockPath = find_up_1.default.sync("yarn.lock", { cwd });
-    if (yarnLockPath) {
-        return "yarn";
-    }
-    const pnpmLockPath = find_up_1.default.sync("pnpm-workspace.yaml", { cwd });
-    if (pnpmLockPath) {
-        return "pnpm";
+const path_1 = __importDefault(require("path"));
+const cache = {};
+function getWorkspaceImplementationAndLockFile(cwd) {
+    if (cache[cwd]) {
+        return cache[cwd];
     }
-    const rushJsonPath = find_up_1.default.sync("rush.json", { cwd });
-    if (rushJsonPath) {
-        return "rush";
+    const lockFile = find_up_1.default.sync(["lerna.json", "yarn.lock", "pnpm-workspace.yaml", "rush.json", "package-lock.json"], {
+        cwd,
+    });
+    if (!lockFile) {
+        return;
     }
-    const npmLockPath = find_up_1.default.sync("package-lock.json", { cwd });
-    if (npmLockPath) {
-        return "npm";
+    switch (path_1.default.basename(lockFile)) {
+        case "lerna.json":
+            cache[cwd] = {
+                implementation: "lerna",
+                lockFile,
+            };
+            break;
+        case "yarn.lock":
+            cache[cwd] = {
+                implementation: "yarn",
+                lockFile,
+            };
+            break;
+        case "pnpm-workspace.yaml":
+            cache[cwd] = {
+                implementation: "pnpm",
+                lockFile,
+            };
+            break;
+        case "rush.json":
+            cache[cwd] = {
+                implementation: "rush",
+                lockFile,
+            };
+            break;
+        case "package-lock.json":
+            cache[cwd] = {
+                implementation: "npm",
+                lockFile,
+            };
+            break;
     }
+    return cache[cwd];
+}
+exports.getWorkspaceImplementationAndLockFile = getWorkspaceImplementationAndLockFile;
+function getWorkspaceImplementation(cwd) {
+    var _a;
+    return (_a = getWorkspaceImplementationAndLockFile(cwd)) === null || _a === void 0 ? void 0 : _a.implementation;
 }
 exports.getWorkspaceImplementation = getWorkspaceImplementation;

package/lib/workspaces/implementations/packageJsonWorkspaces.js

@@ -3,13 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const find_yarn_workspace_root_1 = __importDefault(require("find-yarn-workspace-root"));
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const _1 = require(".");
 const getPackagePaths_1 = require("../../getPackagePaths");
 const getWorkspacePackageInfo_1 = require("../getWorkspacePackageInfo");
 function getPackageJsonWorkspaceRoot(cwd) {
-    const packageJsonWorkspacesRoot = find_yarn_workspace_root_1.default(cwd);
+    var _a;
+    const lockFile = (_a = _1.getWorkspaceImplementationAndLockFile(cwd)) === null || _a === void 0 ? void 0 : _a.lockFile;
+    const packageJsonWorkspacesRoot = lockFile ? path_1.default.dirname(lockFile) : cwd;
     return packageJsonWorkspacesRoot;
 }
 exports.getPackageJsonWorkspaceRoot = getPackageJsonWorkspaceRoot;

package/lib/workspaces/implementations/pnpm.js

@@ -5,7 +5,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
 const find_up_1 = __importDefault(require("find-up"));
-const read_yaml_file_1 = require("read-yaml-file");
 const getPackagePaths_1 = require("../../getPackagePaths");
 const getWorkspacePackageInfo_1 = require("../getWorkspacePackageInfo");
 function getPnpmWorkspaceRoot(cwd) {
@@ -20,7 +19,8 @@ function getPnpmWorkspaces(cwd) {
     try {
         const pnpmWorkspacesRoot = getPnpmWorkspaceRoot(cwd);
         const pnpmWorkspacesFile = path_1.default.join(pnpmWorkspacesRoot, "pnpm-workspace.yaml");
-        const pnpmWorkspaces = read_yaml_file_1.sync(pnpmWorkspacesFile);
+        const readYaml = require("read-yaml-file").sync;
+        const pnpmWorkspaces = readYaml(pnpmWorkspacesFile);
         const packagePaths = getPackagePaths_1.getPackagePaths(pnpmWorkspacesRoot, pnpmWorkspaces.packages);
         const workspaceInfo = getWorkspacePackageInfo_1.getWorkspacePackageInfo(packagePaths);
         return workspaceInfo;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workspace-tools",
-  "version": "0.17.0",
+  "version": "0.18.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -19,8 +19,6 @@
   "dependencies": {
     "@yarnpkg/lockfile": "^1.1.0",
     "find-up": "^4.1.0",
-    "find-yarn-workspace-root": "^1.2.1",
-    "fs-extra": "^9.0.0",
     "git-url-parse": "^11.1.2",
     "globby": "^11.0.0",
     "jju": "^1.4.0",
@@ -28,7 +26,6 @@
     "read-yaml-file": "^2.0.0"
   },
   "devDependencies": {
-    "@types/fs-extra": "^8.1.0",
     "@types/git-url-parse": "^9.0.0",
     "@types/glob": "^7.1.1",
     "@types/jest": "^25.2.2",