feat(npm): support pnpm publish for npm_package

Author: luciomartinez

npm/private/BUILD.bazel

@@ -11,6 +11,12 @@ js_library(
     visibility = ["//visibility:public"],
 )
 
+js_library(
+    name = "npm_publish_with_tool_mjs",
+    srcs = ["npm_publish_with_tool.mjs"],
+    visibility = ["//visibility:public"],
+)
+
 bzl_library(
     name = "npm_package",
     srcs = ["npm_package.bzl"],

npm/private/npm_package.bzl

@@ -140,15 +140,31 @@ def npm_package(
         include_runfiles = False,
         hardlink = "auto",
         publishable = False,
+        publish_tool = "npm",
+        pnpm_binary = "@pnpm//:pnpm",
         verbose = False,
         **kwargs):
     """A macro that packages sources into a directory (a tree artifact) and provides an `NpmPackageInfo`.
 
     This target can be used as the `src` attribute to `npm_link_package`.
 
     With `publishable = True` the macro also produces a target `[name].publish`, that can be run to publish to an npm registry.
-    Under the hood, this target runs `npm publish`. You can pass arguments to npm by escaping them from Bazel using a double-hyphen,
-    for example: `bazel run //path/to:my_package.publish -- --tag=next`
+    Under the hood, this target runs `npm publish` by default. You can pass arguments to npm by escaping them from Bazel using a double-hyphen,
+    for example: `bazel run //path/to:my_package.publish -- --tag=next`.
+
+    To publish with pnpm instead, use `publish_tool = "pnpm"`:
+
+    ```python
+    npm_package(
+        name = "pkg",
+        srcs = [...],
+        publishable = True,
+        publish_tool = "pnpm",
+    )
+    ```
+
+    pnpm publishing uses the configured `pnpm_binary` and can resolve pnpm workspace settings such as `catalog` entries from
+    `pnpm-workspace.yaml`. Workspace protocol dependencies follow pnpm's own resolution requirements.
 
     Files and directories can be arranged as needed in the output directory using
     the `root_paths`, `include_srcs_patterns`, `exclude_srcs_patterns` and `replace_prefixes` attributes.
@@ -210,7 +226,7 @@ def npm_package(
 
         srcs: Files and/or directories or targets that provide `DirectoryPathInfo` to copy into the output directory.
 
-        args: Arguments that are passed down to `<name>.publish` target and `npm publish` command.
+        args: Arguments that are passed down to `<name>.publish` target and the publish command.
 
         data: Runtime / linktime npm dependencies of this npm package.
 
@@ -409,11 +425,19 @@ def npm_package(
 
         publishable: When True, enable generation of `{name}.publish` target
 
+        publish_tool: Package manager to use for the `{name}.publish` target. Allowed values are `"npm"` and `"pnpm"`.
+
+        pnpm_binary: Label of the pnpm binary used when `publish_tool = "pnpm"`. This is typically `@pnpm//:pnpm`
+            from the `pnpm` extension in `@aspect_rules_js//npm:extensions.bzl`.
+
         verbose: If true, prints out verbose logs to stdout
 
         **kwargs: Additional attributes such as `tags` and `visibility`
     """
 
+    if publish_tool not in ["npm", "pnpm"]:
+        fail("publish_tool must be one of 'npm' or 'pnpm', got '{}'".format(publish_tool))
+
     if include_sources or include_transitive_sources or include_types or include_transitive_types or include_runfiles:
         files_target = "{}_files".format(name)
         _npm_package_files(
@@ -433,20 +457,37 @@ def npm_package(
         srcs = srcs + [files_target]
 
     if publishable:
-        js_binary(
-            name = "{}.publish".format(name),
-            entry_point = Label("@aspect_rules_js//npm/private:npm_publish_mjs"),
-            fixed_args = [
-                "./$(rootpath :{})".format(name),
-            ],
-            data = [name],
-            # required to make npm to be available in PATH
-            include_npm = True,
-            args = args,
-            tags = kwargs.get("tags", []) + ["manual"],
-            testonly = kwargs.get("testonly", False),
-            visibility = kwargs.get("visibility", None),
-        )
+        if publish_tool == "pnpm":
+            js_binary(
+                name = "{}.publish".format(name),
+                entry_point = Label("@aspect_rules_js//npm/private:npm_publish_with_tool_mjs"),
+                fixed_args = [
+                    "$(rootpath {})".format(pnpm_binary),
+                    "./$(rootpath :{})".format(name),
+                ],
+                data = [name, pnpm_binary],
+                # required to make npm available because pnpm may delegate registry operations to npm
+                include_npm = True,
+                args = args,
+                tags = kwargs.get("tags", []) + ["manual"],
+                testonly = kwargs.get("testonly", False),
+                visibility = kwargs.get("visibility", None),
+            )
+        else:
+            js_binary(
+                name = "{}.publish".format(name),
+                entry_point = Label("@aspect_rules_js//npm/private:npm_publish_mjs"),
+                fixed_args = [
+                    "./$(rootpath :{})".format(name),
+                ],
+                data = [name],
+                # required to make npm to be available in PATH
+                include_npm = True,
+                args = args,
+                tags = kwargs.get("tags", []) + ["manual"],
+                testonly = kwargs.get("testonly", False),
+                visibility = kwargs.get("visibility", None),
+            )
 
     _npm_package(
         name = name,

npm/private/npm_publish_with_tool.mjs

@@ -0,0 +1,28 @@
+import { spawnSync } from 'node:child_process'
+import path from 'node:path'
+
+const [toolPath, packageDir, ...restArgs] = process.argv.slice(2)
+
+if (!toolPath || !packageDir) {
+    console.error(
+        'Expected publish tool path and package directory arguments.',
+    )
+    process.exit(1)
+}
+
+const publishCwd = process.env.BUILD_WORKSPACE_DIRECTORY || process.cwd()
+
+const spawn = spawnSync(
+    path.resolve(toolPath),
+    ['publish', path.resolve(packageDir), ...restArgs],
+    {
+        cwd: publishCwd,
+        env: {
+            ...process.env,
+            BAZEL_BINDIR: process.env.BAZEL_BINDIR || '.',
+        },
+        stdio: 'inherit',
+    },
+)
+
+process.exit(spawn.status ?? 1)

npm/private/test/npm_package_publish/BUILD.bazel

@@ -20,16 +20,29 @@ npm_package(
     publishable = True,
 )
 
+npm_package(
+    name = "pkg_pnpm",
+    srcs = [
+        "pnpm_catalog/index.js",
+        "pnpm_catalog/package.json",
+    ],
+    publish_tool = "pnpm",
+    publishable = True,
+    root_paths = [package_name() + "/pnpm_catalog"],
+)
+
 sh_test(
     name = "test",
     srcs = ["test.sh"],
     args = [
         "$(locations :pkg_a.publish)",
         "$(locations :pkg_b.publish)",
+        "$(locations :pkg_pnpm.publish)",
     ],
     data = [
         ":pkg_a.publish",
         ":pkg_b.publish",
+        ":pkg_pnpm.publish",
     ],
     tags = [
         "no-remote-exec",

npm/private/test/npm_package_publish/pnpm_catalog/index.js

@@ -0,0 +1 @@
+export const value = 1

npm/private/test/npm_package_publish/pnpm_catalog/package.json

@@ -0,0 +1,7 @@
+{
+    "name": "@mycorp/pkg-to-publish-pnpm",
+    "version": "1.0.0",
+    "dependencies": {
+        "typescript": "catalog:"
+    }
+}

npm/private/test/npm_package_publish/test.sh

@@ -2,6 +2,7 @@
 
 readonly PUBLISH_A="$1"
 readonly PUBLISH_B="$2"
+readonly PUBLISH_PNPM="$3"
 
 # assert that it prints package name from package.json to stderr,
 # to ensure package directory is properly passed and npm can read it.
@@ -26,3 +27,32 @@ if [ $? != 0 ]; then
     echo "FAIL: expected 'npm error enoent Could not read package.json:' error, GOT: $(cat pub_b.log)"
     exit 1
 fi
+
+readonly TMP_WORKSPACE="$(mktemp -d)"
+trap 'rm -rf "${TMP_WORKSPACE}"' EXIT
+
+cat >"${TMP_WORKSPACE}/pnpm-workspace.yaml" <<'EOF'
+packages:
+    - packages/*
+catalog:
+    typescript: 5.9.3
+EOF
+
+# Ensure pnpm publish can read workspace-level catalog settings when publishing
+# a generated package directory.
+BUILD_WORKSPACE_DIRECTORY="${TMP_WORKSPACE}" \
+    "$PUBLISH_PNPM" --dry-run --json --no-git-checks >pub_pnpm.log 2>pub_pnpm.err
+
+# shellcheck disable=SC2181
+if [ $? != 0 ]; then
+    echo "FAIL: expected pnpm publish dry-run to pass, GOT stdout: $(cat pub_pnpm.log), stderr: $(cat pub_pnpm.err)"
+    exit 1
+fi
+
+cat pub_pnpm.log | grep '"name": "@mycorp/pkg-to-publish-pnpm"'
+
+# shellcheck disable=SC2181
+if [ $? != 0 ]; then
+    echo "FAIL: expected pnpm publish dry-run output to include package name, GOT: $(cat pub_pnpm.log)"
+    exit 1
+fi