feat: support workspaces

lib/utils/npm-utils.js

@@ -39,6 +39,23 @@ function findPackageJson(startDir) {
  return null;
 }
 
+/**
+ * Find the pnpm-workspace.yaml at package root.
+ * @param {string} [startDir=process.cwd()] Starting directory, default is process.cwd()
+ * @returns {boolean} Whether a pnpm-workspace.yaml is found in current path.
+ */
+function findPnpmWorkspaceYaml(startDir) {
+ const dir = path.resolve(startDir || process.cwd());
+
+ const yamlFile = path.join(dir, "pnpm-workspace.yaml");
+
+ if (!fs.existsSync(yamlFile) || !fs.statSync(yamlFile).isFile()) {
+ return false;
+ }
+
+ return true;
+}
+
 //------------------------------------------------------------------------------
 // Private
 //------------------------------------------------------------------------------
@@ -51,8 +68,10 @@ function findPackageJson(startDir) {
  */
 function installSyncSaveDev(packages, packageManager = "npm") {
  const packageList = Array.isArray(packages) ? packages : [packages];
- const installCmd = packageManager === "yarn" ? "add" : "install";
- const installProcess = spawn.sync(packageManager, [installCmd, "-D"].concat(packageList), { stdio: "inherit" });
+ const installCmd = packageManager === "npm" ? "install" : "add";
+
+ const pnpmWorkspaceRootOption = packageManager === "pnpm" && findPnpmWorkspaceYaml() ? "-w" : "";
+ const installProcess = spawn.sync(packageManager, [installCmd, "-D"].concat(packageList), pnpmWorkspaceRootOption, { stdio: "inherit" });
  const error = installProcess.error;
 
  if (error && error.code === "ENOENT") {
@@ -189,6 +208,7 @@ export {
  installSyncSaveDev,
  fetchPeerDependencies,
  findPackageJson,
+ findPnpmWorkspaceYaml,
  checkDeps,
  checkDevDeps,
  checkPackageJson,

tests/fixtures/pnpm-workspace-project/package.json

@@ -0,0 +1,13 @@
+{
+ "name": "pnpm-workspace-project",
+ "version": "1.0.0",
+ "description": "",
+ "main": "index.js",
+ "scripts": {
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "type": "module",
+ "keywords": [],
+ "author": "",
+ "license": "ISC"
+}

tests/fixtures/pnpm-workspace-project/packages/sub/package.json

@@ -0,0 +1,12 @@
+{
+ "name": "sub",
+ "version": "1.0.0",
+ "description": "",
+ "main": "index.js",
+ "scripts": {
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "keywords": [],
+ "author": "",
+ "license": "ISC"
+}

tests/pnpm-workspace.spec.js

@@ -0,0 +1,36 @@
+/**
+ * @fileoverview tests for pnpm workspace install packages at root
+ * @author Wataru Nishimura<[email protected]>
+ */
+
+import { describe, it, expect, assert, afterEach } from "vitest";
+import { fileURLToPath } from "node:url";
+import { join } from "path";
+import { findPnpmWorkspaceYaml, installSyncSaveDev } from "../lib/utils/npm-utils.js";
+import sinon from "sinon";
+import spawn from "cross-spawn";
+
+const __filename = fileURLToPath(import.meta.url); // eslint-disable-line no-underscore-dangle -- commonjs convention
+
+describe("pnpm workspace install packages at root", () => {
+ const pnpmWithWorkspaceDir = join(__filename, "../fixtures/pnpm-workspace-project");
+
+ afterEach(() => {
+ sinon.verifyAndRestore();
+ });
+
+ it("find pnpm-workspace.yaml", () => {
+ const pnpmWorkspaceYaml = findPnpmWorkspaceYaml(pnpmWithWorkspaceDir);
+
+ expect(pnpmWorkspaceYaml).toBeTruthy();
+ });
+
+ it("should invoke pnpm to install a single desired package", () => {
+ const stub = sinon.stub(spawn, "sync").returns({ stdout: 0 });
+
+ installSyncSaveDev("desired-package", "pnpm");
+ assert(stub.calledOnce);
+ assert.strictEqual(stub.firstCall.args[0], "pnpm");
+ assert.deepStrictEqual(stub.firstCall.args[1], ["add", "-D", "desired-package"]);
+ });
+});