Support pnpm workspaces (#574)

Author: bmish

lib/package.ts

@@ -1,6 +1,7 @@
 import { existsSync, readFileSync } from 'node:fs';
 import { join, relative } from 'node:path';
 import { PackageJson } from 'type-fest';
+import { load } from 'js-yaml';
 
 // Class to represent all of the information we need to know about a package in a workspace.
 export class Package {
@@ -9,14 +10,27 @@ export class Package {
   pathPackageJson: string; // Absolute path to package.json.
   packageJson: PackageJson;
   packageJsonEndsInNewline: boolean;
+  pnpmWorkspacePackages?: string[];
 
   constructor(path: string, pathWorkspace: string) {
     this.path = path;
     this.pathWorkspace = pathWorkspace;
+
+    // package.json
     this.pathPackageJson = join(path, 'package.json');
     const packageJsonContents = readFileSync(this.pathPackageJson, 'utf8');
     this.packageJsonEndsInNewline = packageJsonContents.endsWith('\n');
     this.packageJson = JSON.parse(packageJsonContents);
+
+    // pnpm-workspace.yaml
+    const pnpmWorkspacePath = join(path, 'pnpm-workspace.yaml');
+    if (existsSync(pnpmWorkspacePath)) {
+      const pnpmWorkspaceContents = readFileSync(pnpmWorkspacePath, 'utf8');
+      const pnpmWorkspaceYaml = load(pnpmWorkspaceContents) as {
+        packages?: string[];
+      };
+      this.pnpmWorkspacePackages = pnpmWorkspaceYaml.packages;
+    }
   }
 
   get name() {
@@ -49,6 +63,16 @@ export class Package {
         throw new TypeError('package.json `workspaces` is not a string array.');
       }
     }
+
+    if (this.pnpmWorkspacePackages) {
+      if (!Array.isArray(this.pnpmWorkspacePackages)) {
+        throw new TypeError(
+          'pnpm-workspace.yaml `packages` is not a string array.'
+        );
+      }
+      return this.pnpmWorkspacePackages;
+    }
+
     return [];
   }
 

package.json

@@ -40,10 +40,12 @@
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --colors --coverage"
   },
   "dependencies": {
+    "@types/js-yaml": "^4.0.5",
     "chalk": "^5.0.1",
     "commander": "^9.0.0",
     "edit-json-file": "^1.7.0",
     "globby": "^13.1.1",
+    "js-yaml": "^4.1.0",
     "semver": "^7.3.5",
     "table": "^6.7.1",
     "type-fest": "^2.1.0"

test/fixtures/index.ts

@@ -64,6 +64,11 @@ export const FIXTURE_PATH_WORKSPACE_PACKAGE_NOT_AN_ARRAY = join(
   FIXTURE_PATH,
   'workspace-packages-not-an-array'
 );
+export const FIXTURE_PATH_WORKSPACE_PNPM = join(FIXTURE_PATH, 'workspace-pnpm');
+export const FIXTURE_PATH_WORKSPACE_PNPM_PACKAGES_WRONG_TYPE = join(
+  FIXTURE_PATH,
+  'workspace-pnpm-packages-wrong-type'
+);
 export const FIXTURE_PATH_NESTED_WORKSPACES = join(
   FIXTURE_PATH,
   'nested-workspaces'

test/fixtures/workspace-pnpm-packages-wrong-type/package.json

@@ -0,0 +1,3 @@
+{
+    "name": "foo"
+}

test/fixtures/workspace-pnpm-packages-wrong-type/packages/package1/package.json

@@ -0,0 +1,3 @@
+{
+    "name": "package1"
+}

test/fixtures/workspace-pnpm-packages-wrong-type/pnpm-workspace.yaml

@@ -0,0 +1 @@
+packages: 'foo'

test/fixtures/workspace-pnpm/package.json

@@ -0,0 +1,3 @@
+{
+    "name": "foo"
+}

test/fixtures/workspace-pnpm/packages/package1/package.json

@@ -0,0 +1,3 @@
+{
+    "name": "package1"
+}

test/fixtures/workspace-pnpm/pnpm-workspace.yaml

@@ -0,0 +1,7 @@
+packages:
+  # all packages in direct subdirs of packages/
+  - 'packages/*'
+  # all packages in subdirs of components/
+  - 'components/**'
+  # exclude packages that are inside test directories
+  - '!**/test/**'

test/lib/workspace-test.ts

@@ -8,6 +8,8 @@ import {
   FIXTURE_PATH_VALID_NOHOIST_WITH_NODE_MODULES,
   FIXTURE_PATH_WORKSPACE_NOT_AN_ARRAY,
   FIXTURE_PATH_WORKSPACE_PACKAGE_NOT_AN_ARRAY,
+  FIXTURE_PATH_WORKSPACE_PNPM,
+  FIXTURE_PATH_WORKSPACE_PNPM_PACKAGES_WRONG_TYPE,
   FIXTURE_PATH_NESTED_WORKSPACES,
 } from '../fixtures/index.js';
 
@@ -184,6 +186,18 @@ describe('Utils | workspace', function () {
       );
     });
 
+    it('behaves correctly with pnpm workspaces', function () {
+      expect(
+        getPackages(FIXTURE_PATH_WORKSPACE_PNPM, [], [], [], []).map(
+          (package_) => package_.path
+        )
+      ).toStrictEqual(
+        ['.', 'packages/package1'].map((path) =>
+          join(FIXTURE_PATH_WORKSPACE_PNPM, path)
+        )
+      );
+    });
+
     it('does not include packages in node_modules from nohoist usage (or crash from malformed package.json in node_modules test fixture)', function () {
       expect(
         getPackages(
@@ -231,5 +245,19 @@ describe('Utils | workspace', function () {
         '"package.json `workspaces.packages` is not a string array."'
       );
     });
+
+    it('throws with fixture that has pnpm-workspace.yaml but invalid type for packages', function () {
+      expect(() =>
+        getPackages(
+          FIXTURE_PATH_WORKSPACE_PNPM_PACKAGES_WRONG_TYPE,
+          [],
+          [],
+          [],
+          []
+        )
+      ).toThrowErrorMatchingInlineSnapshot(
+        '"pnpm-workspace.yaml `packages` is not a string array."'
+      );
+    });
   });
 });