workspace-tools 0.16.2 → 0.17.0

package/CHANGELOG.json

@@ -2,7 +2,37 @@
   "name": "workspace-tools",
   "entries": [
     {
-      "date": "Thu, 03 Jun 2021 20:23:16 GMT",
+      "date": "Thu, 02 Dec 2021 17:11:04 GMT",
+      "tag": "workspace-tools_v0.17.0",
+      "version": "0.17.0",
+      "comments": {
+        "minor": [
+          {
+            "author": "riacarmin@microsoft.com",
+            "package": "workspace-tools",
+            "comment": "Implements NPM workspaces support to parseLockFile utility.",
+            "commit": "0d9b3bd5c091e238d302f4a6912692e2eda95385"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 21 Oct 2021 20:01:33 GMT",
+      "tag": "workspace-tools_v0.16.2",
+      "version": "0.16.2",
+      "comments": {
+        "none": [
+          {
+            "author": "elcraig@microsoft.com",
+            "package": "workspace-tools",
+            "comment": "Update beachball and add ignorePatterns",
+            "commit": "1aca866df2443581ce221c08b8e783a7054fcd7d"
+          }
+        ]
+      }
+    },
+    {
+      "date": "Thu, 03 Jun 2021 20:23:22 GMT",
       "tag": "workspace-tools_v0.16.2",
       "version": "0.16.2",
       "comments": {

package/CHANGELOG.md

@@ -1,12 +1,20 @@
 # Change Log - workspace-tools
 
-This log was last generated on Thu, 03 Jun 2021 20:23:16 GMT and should not be manually modified.
+This log was last generated on Thu, 02 Dec 2021 17:11:04 GMT and should not be manually modified.
 
 <!-- Start content -->
 
+## 0.17.0
+
+Thu, 02 Dec 2021 17:11:04 GMT
+
+### Minor changes
+
+- Implements NPM workspaces support to parseLockFile utility. (riacarmin@microsoft.com)
+
 ## 0.16.2
 
-Thu, 03 Jun 2021 20:23:16 GMT
+Thu, 03 Jun 2021 20:23:22 GMT
 
 ### Patches
 

package/README.md

@@ -2,10 +2,11 @@
 
 A collection of tools that are useful in a git-controlled monorepo that is managed by one of these software:
 
+- lerna
+- npm workspaces
+- pnpm workspaces
 - rush
 - yarn workspaces
-- pnpm workspaces
-- lerna
 
 # Environment Variables
 
@@ -17,7 +18,7 @@ default node.js maxBuffer of 1MB)
 ## PREFERRED_WORKSPACE_MANAGER
 
 Sometimes multiple package manager files are checked in. It is necessary to hint to `workspace-tools` which manager
-is used: `yarn`, `pnpm`, `rush`, or `lerna`
+is used: `npm`, `yarn`, `pnpm`, `rush`, or `lerna`
 
 # Contributing
 

package/beachball.config.js

@@ -1,3 +1,12 @@
 module.exports = {
   scope: ["!src/__fixtures__/**/*"],
+  ignorePatterns: [
+    ".github/**",
+    ".prettierrc",
+    "jest.config.js",
+    "src/__fixtures__/**",
+    "src/__tests__/**",
+    // This prevents dependabot from being blocked by change file requirements for lock file-only changes
+    "yarn.lock",
+  ],
 };

package/lib/__tests__/lockfile.test.js

@@ -2,22 +2,39 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const setupFixture_1 = require("../helpers/setupFixture");
 const lockfile_1 = require("../lockfile");
+const ERROR_MESSAGES = {
+    NO_LOCK: "You do not have yarn.lock, pnpm-lock.yaml or package-lock.json. Please use one of these package managers.",
+    UNSUPPORTED: "Your package-lock.json version is not supported: lockfileVersion is 1. You need npm version 7 or above and package-lock version 2 or above. Please, upgrade npm or choose a different package manager.",
+};
 describe("parseLockFile()", () => {
+    // General
+    it("throws if it cannot find lock file", async () => {
+        const packageRoot = await setupFixture_1.setupFixture("basic-without-lock-file");
+        await expect(lockfile_1.parseLockFile(packageRoot)).rejects.toThrow(ERROR_MESSAGES.NO_LOCK);
+    });
+    // NPM
+    it("parses package-lock.json file when it is found", async () => {
+        const packageRoot = await setupFixture_1.setupFixture("monorepo-npm");
+        const parsedLockeFile = await lockfile_1.parseLockFile(packageRoot);
+        expect(parsedLockeFile).toHaveProperty("type", "success");
+    });
+    it("throws if npm version is unsupported", async () => {
+        const packageRoot = await setupFixture_1.setupFixture("monorepo-npm-unsupported");
+        await expect(lockfile_1.parseLockFile(packageRoot)).rejects.toThrow(ERROR_MESSAGES.UNSUPPORTED);
+    });
+    // Yarn
     it("parses yarn.lock file when it is found", async () => {
         const packageRoot = await setupFixture_1.setupFixture("basic");
         const parsedLockeFile = await lockfile_1.parseLockFile(packageRoot);
         expect(parsedLockeFile).toHaveProperty("type", "success");
     });
-    it("throws if it cannot find a yarn.lock file", async () => {
-        const packageRoot = await setupFixture_1.setupFixture("basic-without-lock-file");
-        await expect(lockfile_1.parseLockFile(packageRoot)).rejects.toThrow("You do not have either yarn.lock nor pnpm-lock.yaml. Please use one of these package managers");
-    });
     it("parses combined ranges in yarn.lock", async () => {
         const packageRoot = await setupFixture_1.setupFixture("basic-yarn");
         const parsedLockeFile = await lockfile_1.parseLockFile(packageRoot);
         expect(parsedLockeFile.object["@babel/code-frame@^7.0.0"].version).toBe(parsedLockeFile.object["@babel/code-frame@^7.8.3"].version);
     });
-    it("parses pnpm-lock.yaml properly", async () => {
+    // PNPM
+    it("parses pnpm-lock.yaml file when it is found", async () => {
         const packageRoot = await setupFixture_1.setupFixture("basic-pnpm");
         const parsedLockeFile = await lockfile_1.parseLockFile(packageRoot);
         expect(Object.keys(parsedLockeFile.object["yargs@16.2.0"].dependencies)).toContain("cliui");

package/lib/lockfile/index.d.ts

@@ -3,4 +3,4 @@ import { nameAtVersion } from "./nameAtVersion";
 export declare function parseLockFile(packageRoot: string): Promise<ParsedLock>;
 export { nameAtVersion };
 export { queryLockFile } from "./queryLockFile";
-export * from './types';
+export * from "./types";

package/lib/lockfile/index.js

@@ -10,12 +10,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 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 nameAtVersion_1 = require("./nameAtVersion");
 exports.nameAtVersion = nameAtVersion_1.nameAtVersion;
 const parsePnpmLock_1 = require("./parsePnpmLock");
+const parseNpmLock_1 = require("./parseNpmLock");
 const memoization = {};
 async function parseLockFile(packageRoot) {
     const yarnLockPath = await find_up_1.default(["yarn.lock", "common/config/rush/yarn.lock"], { cwd: packageRoot });
@@ -41,7 +43,27 @@ async function parseLockFile(packageRoot) {
         memoization[pnpmLockPath] = parsed;
         return memoization[pnpmLockPath];
     }
-    throw new Error("You do not have either yarn.lock nor pnpm-lock.yaml. Please use one of these package managers");
+    // Third, try for npm workspaces
+    let npmLockPath = await find_up_1.default(["package-lock.json"], { cwd: packageRoot });
+    if (npmLockPath) {
+        if (memoization[npmLockPath]) {
+            return memoization[npmLockPath];
+        }
+        let npmLockJson;
+        try {
+            npmLockJson = fs_extra_1.default.readFileSync(npmLockPath);
+        }
+        catch (_a) {
+            throw new Error("Couldn’t parse package-lock.json.");
+        }
+        const npmLock = JSON.parse(npmLockJson.toString());
+        if (!(npmLock === null || npmLock === void 0 ? void 0 : npmLock.lockfileVersion) || npmLock.lockfileVersion < 2) {
+            throw new Error(`Your package-lock.json version is not supported: lockfileVersion is ${npmLock.lockfileVersion}. You need npm version 7 or above and package-lock version 2 or above. Please, upgrade npm or choose a different package manager.`);
+        }
+        memoization[npmLockPath] = parseNpmLock_1.parseNpmLock(npmLock);
+        return memoization[npmLockPath];
+    }
+    throw new Error("You do not have yarn.lock, pnpm-lock.yaml or package-lock.json. Please use one of these package managers.");
 }
 exports.parseLockFile = parseLockFile;
 var queryLockFile_1 = require("./queryLockFile");

package/lib/lockfile/parseNpmLock.d.ts

@@ -0,0 +1,2 @@
+import { ParsedLock, NpmLockFile } from "./types";
+export declare const parseNpmLock: (lock: NpmLockFile) => ParsedLock;

package/lib/lockfile/parseNpmLock.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseNpmLock = (lock) => {
+    var _a;
+    return ({
+        object: (_a = lock.dependencies) !== null && _a !== void 0 ? _a : {},
+        type: "success",
+    });
+};

package/lib/lockfile/types.d.ts

@@ -16,3 +16,34 @@ export interface PnpmLockFile {
         [name: string]: any;
     };
 }
+export interface NpmWorkspacesInfo {
+    version: string;
+    workspaces: {
+        packages: string[];
+    };
+}
+export interface NpmSymlinkInfo {
+    resolved: string;
+    link: boolean;
+    integrity?: "sha512" | "sha1";
+    dev?: boolean;
+    optional?: boolean;
+    devOptional?: boolean;
+    dependencies?: {
+        [key: string]: LockDependency;
+    };
+}
+export interface NpmLockFile {
+    name: string;
+    version: string;
+    lockfileVersion?: 1 | 2 | 3;
+    requires?: boolean;
+    packages?: {
+        ""?: NpmWorkspacesInfo;
+    } & {
+        [key: string]: NpmSymlinkInfo | LockDependency;
+    };
+    dependencies?: {
+        [key: string]: LockDependency;
+    };
+}

package/lib/workspaces/getWorkspaces.js

@@ -1,11 +1,11 @@
 "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 yarn_1 = require("./implementations/yarn");
 const rush_1 = require("./implementations/rush");
-const npm_1 = require("./implementations/npm");
-const lerna_1 = require("./implementations/lerna");
+const yarn_1 = require("./implementations/yarn");
 const workspaceGetter = {
     yarn: yarn_1.getYarnWorkspaces,
     pnpm: pnpm_1.getPnpmWorkspaces,

package/lib/workspaces/implementations/npm.js

@@ -10,7 +10,7 @@ function getNpmWorkspaceRoot(cwd) {
 }
 exports.getNpmWorkspaceRoot = getNpmWorkspaceRoot;
 function getNpmWorkspaces(cwd) {
-    const yarnWorkspacesRoot = getNpmWorkspaceRoot(cwd);
-    return packageJsonWorkspaces_1.getWorkspaceInfoFromWorkspaceRoot(yarnWorkspacesRoot);
+    const npmWorkspacesRoot = getNpmWorkspaceRoot(cwd);
+    return packageJsonWorkspaces_1.getWorkspaceInfoFromWorkspaceRoot(npmWorkspacesRoot);
 }
 exports.getNpmWorkspaces = getNpmWorkspaces;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workspace-tools",
-  "version": "0.16.2",
+  "version": "0.17.0",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -37,7 +37,7 @@
     "@types/node": ">=12.0.0",
     "@types/tmp": "^0.2.0",
     "@types/yarnpkg__lockfile": "^1.1.3",
-    "beachball": "^2.2.0",
+    "beachball": "^2.17.0",
     "jest": "^25.0.0",
     "tmp": "^0.2.1",
     "ts-jest": "^25.5.1",