feat: pnpm workspaces support (#3284)

.github/actions/install-node-and-dependencies/action.yml

@@ -31,3 +31,7 @@ runs:
     - name: Install dependencies
       run: npm ci
       shell: bash
+
+    - name: Install pnpm
+      run: npm install -g pnpm
+      shell: bash

commands/add/__tests__/__fixtures__/pnpm/lerna.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "node_modules/lerna/schemas/lerna-schema.json",
+  "useNx": false,
+  "useWorkspaces": true,
+  "version": "1.0.0",
+  "npmClient": "pnpm"
+}

commands/add/__tests__/__fixtures__/pnpm/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "root",
+  "private": true,
+  "workspaces": [
+    "packages/*"
+  ],
+  "devDependencies": {
+    "lerna": "^5.3.0"
+  }
+}

commands/add/__tests__/__fixtures__/pnpm/packages/package-1/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "package-1",
+  "version": "1.0.0",
+  "scripts": {
+    "fail": "exit 1",
+    "my-script": "echo package-1"
+  }
+}

commands/add/__tests__/__fixtures__/pnpm/packages/package-2/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "package-2",
+  "version": "1.0.0",
+  "scripts": {
+    "fail": "exit 1",
+    "my-script": "echo package-2"
+  },
+  "dependencies": {
+    "package-1": "^1.0.0"
+  }
+}

commands/add/__tests__/__fixtures__/pnpm/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+packages:
+  - "packages/*"

commands/add/__tests__/add-command.test.js

@@ -44,6 +44,15 @@ describe("AddCommand", () => {
     await expect(command).rejects.toThrow(/Requested package has no version:/);
   });
 
+  it("should throw when using pnpm", async () => {
+    const testDir = await initFixture("pnpm");
+    const command = lernaAdd(testDir)("@test/package-1");
+
+    await expect(command).rejects.toThrow(
+      "Add is not supported when using `pnpm` workspaces. Use `pnpm` directly to add dependencies to packages: https://pnpm.io/cli/add"
+    );
+  });
+
   it("should reference remote dependencies", async () => {
     const testDir = await initFixture("basic");
 

commands/add/index.js

@@ -36,6 +36,13 @@ class AddCommand extends Command {
   }
 
   initialize() {
+    if (this.options.npmClient === "pnpm") {
+      throw new ValidationError(
+        "EPNPMNOTSUPPORTED",
+        "Add is not supported when using `pnpm` workspaces. Use `pnpm` directly to add dependencies to packages: https://pnpm.io/cli/add"
+      );
+    }
+
     this.spec = npa(this.options.pkg);
     this.dirs = new Set(this.options.globs.map((fp) => path.resolve(this.project.rootPath, fp)));
     this.selfSatisfied = this.packageSatisfied();

commands/bootstrap/__tests__/__fixtures__/pnpm/lerna.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "node_modules/lerna/schemas/lerna-schema.json",
+  "useNx": true,
+  "useWorkspaces": true,
+  "version": "1.0.0",
+  "npmClient": "pnpm"
+}

commands/bootstrap/__tests__/__fixtures__/pnpm/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "root",
+  "private": true,
+  "workspaces": [
+    "packages/*"
+  ],
+  "devDependencies": {
+    "lerna": "^5.3.0"
+  }
+}

commands/bootstrap/__tests__/__fixtures__/pnpm/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+packages:
+  - "packages/*"

commands/bootstrap/__tests__/bootstrap-command.test.js

@@ -138,6 +138,17 @@ describe("BootstrapCommand", () => {
     });
   });
 
+  describe("with pnpm", () => {
+    it("should throw validation error", async () => {
+      const testDir = await initFixture("pnpm");
+      const command = lernaBootstrap(testDir)();
+
+      await expect(command).rejects.toThrow(
+        "Bootstrapping with pnpm is not supported. Use pnpm directly to manage dependencies: https://pnpm.io/cli/install"
+      );
+    });
+  });
+
   describe("with hoisting", () => {
     it("should hoist", async () => {
       const testDir = await initFixture("basic");

commands/bootstrap/index.js

@@ -38,6 +38,13 @@ class BootstrapCommand extends Command {
   initialize() {
     const { registry, npmClient = "npm", npmClientArgs = [], mutex, hoist, nohoist } = this.options;
 
+    if (npmClient === "pnpm") {
+      throw new ValidationError(
+        "EWORKSPACES",
+        "Bootstrapping with pnpm is not supported. Use pnpm directly to manage dependencies: https://pnpm.io/cli/install"
+      );
+    }
+
     if (npmClient === "yarn" && hoist) {
       throw new ValidationError(
         "EWORKSPACES",

commands/link/__tests__/__fixtures__/pnpm/lerna.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "node_modules/lerna/schemas/lerna-schema.json",
+  "useNx": true,
+  "useWorkspaces": true,
+  "version": "1.0.0",
+  "npmClient": "pnpm"
+}

commands/link/__tests__/__fixtures__/pnpm/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "root",
+  "private": true,
+  "workspaces": [
+    "packages/*"
+  ],
+  "devDependencies": {
+    "lerna": "^5.3.0"
+  }
+}

commands/link/__tests__/__fixtures__/pnpm/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+packages:
+  - "packages/*"