@pnpm/releasing.commands 1100.7.1 → 1100.8.0

package/CHANGELOG.md

@@ -1,5 +1,40 @@
 # @pnpm/releasing.commands
 
+## 1100.8.0
+
+### Minor Changes
+
+- Added support for `publishConfig.name`, which publishes a package under a different name than the one its manifest carries in the workspace. It is for a project whose published name is already taken by a sibling project, which otherwise has to be renamed by a build step just before publishing. Only the published artifact is renamed — dependents, `pnpm-lock.yaml`, and release tooling keep addressing the project by its manifest name — and the new name reaches the packed manifest, the tarball filename, and everything that addresses the package at the registry: the already-published check of `pnpm publish -r`, its registry selection, and the release-planning probes of `pnpm change status` and `pnpm version -r` [#13345](https://github.com/pnpm/pnpm/issues/13345).
+
+### Patch Changes
+
+- Updated dependencies:
+  - @pnpm/bins.resolver@1100.0.12
+  - @pnpm/cli.utils@1101.0.20
+  - @pnpm/config.pick-registry-for-package@1100.0.13
+  - @pnpm/config.reader@1101.15.0
+  - @pnpm/deps.path@1100.0.12
+  - @pnpm/engine.runtime.commands@1100.1.17
+  - @pnpm/engine.runtime.node-resolver@1101.1.19
+  - @pnpm/exec.lifecycle@1100.1.9
+  - @pnpm/fetching.directory-fetcher@1100.0.26
+  - @pnpm/fs.indexed-pkg-importer@1100.0.22
+  - @pnpm/installing.client@1100.3.0
+  - @pnpm/installing.commands@1100.12.1
+  - @pnpm/lockfile.fs@1100.1.15
+  - @pnpm/lockfile.types@1100.0.17
+  - @pnpm/network.auth-header@1101.1.7
+  - @pnpm/network.fetch@1100.1.9
+  - @pnpm/releasing.exportable-manifest@1100.2.0
+  - @pnpm/releasing.versioning@1100.2.2
+  - @pnpm/resolving.npm-resolver@1102.1.9
+  - @pnpm/resolving.registry.types@1100.1.7
+  - @pnpm/resolving.resolver-base@1100.5.5
+  - @pnpm/types@1101.7.0
+  - @pnpm/workspace.projects-filter@1100.0.33
+  - @pnpm/workspace.projects-sorter@1100.0.12
+  - @pnpm/workspace.workspace-manifest-writer@1100.0.19
+
 ## 1100.7.1
 
 ### Patch Changes

package/lib/change/index.js

@@ -5,6 +5,7 @@ import { getChangedProjects } from '@pnpm/workspace.projects-filter';
 import { safeExeca as execa } from 'execa';
 import { renderHelp } from 'render-help';
 import { valid } from 'semver';
+import { publishedNameByManifestName } from '../publishedNames.js';
 import { resolveUnpublishedDirs } from '../resolveUnpublishedDirs.js';
 export function rcOptionsTypes() {
     return {};
@@ -192,7 +193,8 @@ async function renderStatus(workspaceDir, opts) {
         ledger,
         versioning: opts.versioning,
     };
-    const unpublishedDirs = await resolveUnpublishedDirs(assembleReleasePlan(baseArgs), opts);
+    const publishedNames = publishedNameByManifestName(baseArgs.projects);
+    const unpublishedDirs = await resolveUnpublishedDirs(assembleReleasePlan(baseArgs), { ...opts, publishedNames });
     const plan = assembleReleasePlan({ ...baseArgs, unpublishedDirs });
     if (plan.releases.length === 0) {
         return 'No pending changes.';

package/lib/publish/pack.js

@@ -19,6 +19,7 @@ import { renderHelp } from 'render-help';
 import tar from 'tar-stream';
 import { glob } from 'tinyglobby';
 import validateNpmPackageName from 'validate-npm-package-name';
+import { normalizePackageName } from '../tarball/safeTarballFilename.js';
 import { fetchPreviousChangelog } from './previousChangelog.js';
 import { runScriptsIfPresent } from './publish.js';
 const LICENSE_GLOB = 'LICEN{S,C}E{,.*}'; // cspell:disable-line
@@ -202,7 +203,17 @@ export async function api(opts) {
     publishManifest.version = stripBuildMetadata(publishManifest.version);
     let tarballName;
     let packDestination;
-    const normalizedName = manifest.name.replace('@', '').replace('/', '-');
+    // Read back off the publish manifest so a `publishConfig.name` rename reaches
+    // the filename too — the tarball name, the packed manifest, and the registry
+    // metadata all name one artifact. The rename never went through the check on
+    // `manifest.name` above, so it is validated here: it lands in the tarball
+    // filename, where a separator would smuggle path components into the join and
+    // write outside the pack destination.
+    const publishedName = publishManifest.name || manifest.name;
+    if (!validateNpmPackageName(publishedName).validForOldPackages) {
+        throw new PnpmError('INVALID_PACKAGE_NAME', `Invalid package name "${publishedName}".`);
+    }
+    const normalizedName = normalizePackageName(publishedName);
     if (opts.out) {
         if (opts.packDestination) {
             throw new PnpmError('INVALID_OPTION', 'Cannot use --pack-destination and --out together');
@@ -241,7 +252,7 @@ export async function api(opts) {
     // composed here on top of the previously published version's changelog and
     // packed in. A composed entry supersedes any stale committed CHANGELOG.md.
     const injectedEntries = {};
-    const composedChangelog = await composeRegistryChangelog(opts, manifest.name, manifest.version);
+    const composedChangelog = await composeRegistryChangelog(opts, manifest.name, publishedName, manifest.version);
     if (composedChangelog != null) {
         delete filesMap['package/CHANGELOG.md'];
         injectedEntries['package/CHANGELOG.md'] = composedChangelog;
@@ -334,16 +345,22 @@ function isManifestEntry(name) {
  * `repository`, there is no workspace, or the release has no parked section
  * (an ordinary `pnpm pack` of a package that is not mid-release).
  */
-async function composeRegistryChangelog(opts, pkgName, version) {
+/**
+ * `pkgName` keys the parked section — the workspace, the ledger, and every
+ * intent address the project by its manifest name. `publishedName` is the only
+ * name the registry knows, so it selects the previous changelog to build on and
+ * titles the composed one.
+ */
+async function composeRegistryChangelog(opts, pkgName, publishedName, version) {
     if (changelogStorage(opts.versioning) !== 'registry' || opts.workspaceDir == null)
         return undefined;
     const section = await readPendingChangelog(opts.workspaceDir, pkgName, version);
     if (section == null)
         return undefined;
     const previous = opts.registries != null
-        ? await fetchPreviousChangelog(opts, pkgName, version)
+        ? await fetchPreviousChangelog(opts, publishedName, version)
         : undefined;
-    return renderChangelog(previous ?? null, pkgName, section);
+    return renderChangelog(previous ?? null, publishedName, section);
 }
 function stripBuildMetadata(version) {
     const plusIndex = version.indexOf('+');

package/lib/publish/recursivePublish.js

@@ -6,6 +6,7 @@ import { sortFilteredProjects } from '@pnpm/workspace.projects-sorter';
 import pFilter from 'p-filter';
 import { pick } from 'ramda';
 import { writeJsonFile } from 'write-json-file';
+import { publishedName } from '../publishedNames.js';
 import { batchPublishPackages } from './batchPublish.js';
 import { publish } from './publish.js';
 export async function recursivePublish(opts) {
@@ -31,7 +32,7 @@ export async function recursivePublish(opts) {
             lockfileDir: opts.lockfileDir ?? pkg.rootDir,
             registries: opts.registries,
             resolve,
-        }, pkg.manifest.name, pkg.manifest.version));
+        }, publishedName(pkg.manifest), pkg.manifest.version));
     });
     const publishedPkgDirs = new Set(pkgsToPublish.map(({ rootDir }) => rootDir));
     const publishedPackages = [];
@@ -75,7 +76,9 @@ export async function recursivePublish(opts) {
                     if (!publishedPkgDirs.has(pkgDir))
                         continue;
                     const pkg = opts.selectedProjectsGraph[pkgDir].package;
-                    const registry = pkg.manifest.publishConfig?.registry ?? pickRegistryForPackage(opts.registries, pkg.manifest.name);
+                    // The registry is picked by scope, so a `publishConfig.name` that
+                    // moves the package to another scope has to route by the new one.
+                    const registry = pkg.manifest.publishConfig?.registry ?? pickRegistryForPackage(opts.registries, publishedName(pkg.manifest));
                     // eslint-disable-next-line no-await-in-loop
                     const publishResult = await publish({
                         ...opts,

package/lib/publishedNames.d.ts

@@ -0,0 +1,18 @@
+import type { WorkspaceProject } from '@pnpm/releasing.versioning';
+import type { BaseManifest } from '@pnpm/types';
+/**
+ * The name a manifest publishes under — its `publishConfig.name` rename, or
+ * the name it carries in the workspace.
+ *
+ * The workspace — and so every parked changelog section, the ledger, every
+ * intent, and every dependent — keys on the manifest name, while the registry
+ * only ever sees the published one. Anything that addresses a project *at the
+ * registry* has to resolve the name through here first.
+ */
+export declare function publishedName(manifest: Pick<BaseManifest, 'name' | 'publishConfig'>): string | undefined;
+/**
+ * Manifest name → published name, for every project that renames itself.
+ * Projects that publish under their manifest name are absent, so a lookup miss
+ * means "no rename". For call sites that hold a name rather than a manifest.
+ */
+export declare function publishedNameByManifestName(projects: WorkspaceProject[]): Map<string, string>;

package/lib/publishedNames.js

@@ -0,0 +1,29 @@
+/**
+ * The name a manifest publishes under — its `publishConfig.name` rename, or
+ * the name it carries in the workspace.
+ *
+ * The workspace — and so every parked changelog section, the ledger, every
+ * intent, and every dependent — keys on the manifest name, while the registry
+ * only ever sees the published one. Anything that addresses a project *at the
+ * registry* has to resolve the name through here first.
+ */
+export function publishedName(manifest) {
+    const renamed = manifest.publishConfig?.name;
+    return typeof renamed === 'string' && renamed !== '' ? renamed : manifest.name;
+}
+/**
+ * Manifest name → published name, for every project that renames itself.
+ * Projects that publish under their manifest name are absent, so a lookup miss
+ * means "no rename". For call sites that hold a name rather than a manifest.
+ */
+export function publishedNameByManifestName(projects) {
+    const renames = new Map();
+    for (const { manifest } of projects) {
+        const published = publishedName(manifest);
+        if (manifest.name && published != null && published !== manifest.name) {
+            renames.set(manifest.name, published);
+        }
+    }
+    return renames;
+}
+//# sourceMappingURL=publishedNames.js.map

package/lib/resolveUnpublishedDirs.d.ts

@@ -5,6 +5,14 @@ export type UnpublishedProbeOptions = PreviousChangelogOptions & {
     /** Overridable for tests; production probes the registry. */
     checkVersionPublished?: CheckVersionPublished;
     networkConcurrency?: number;
+    /** Manifest name → published name, from `publishedNameByManifestName`. */
+    publishedNames?: ReadonlyMap<string, string>;
 };
-/** The releases in `plan` whose current version the registry does not have — {@link assembleReleasePlan}'s `unpublishedDirs`. */
+/**
+ * The releases in `plan` whose current version the registry does not have — {@link assembleReleasePlan}'s `unpublishedDirs`.
+ *
+ * A release is keyed by its manifest name, so `publishedNames` translates it
+ * for the probe; without that a renamed project reads as never published and
+ * debuts at its manifest version on every release.
+ */
 export declare function resolveUnpublishedDirs(plan: ReleasePlan, opts: UnpublishedProbeOptions): Promise<Set<string>>;

package/lib/resolveUnpublishedDirs.js

@@ -1,13 +1,19 @@
 import pLimit from 'p-limit';
 import { createVersionPublishedChecker } from './publish/previousChangelog.js';
 const DEFAULT_NETWORK_CONCURRENCY = 16;
-/** The releases in `plan` whose current version the registry does not have — {@link assembleReleasePlan}'s `unpublishedDirs`. */
+/**
+ * The releases in `plan` whose current version the registry does not have — {@link assembleReleasePlan}'s `unpublishedDirs`.
+ *
+ * A release is keyed by its manifest name, so `publishedNames` translates it
+ * for the probe; without that a renamed project reads as never published and
+ * debuts at its manifest version on every release.
+ */
 export async function resolveUnpublishedDirs(plan, opts) {
     const checkVersionPublished = opts.checkVersionPublished ?? createVersionPublishedChecker(opts);
     const limit = pLimit(opts.networkConcurrency ?? DEFAULT_NETWORK_CONCURRENCY);
     const probed = await Promise.all(plan.releases.map((release) => limit(async () => ({
         dir: release.dir,
-        published: await checkVersionPublished(release.name, release.currentVersion),
+        published: await checkVersionPublished(opts.publishedNames?.get(release.name) ?? release.name, release.currentVersion),
     }))));
     return new Set(probed.filter(({ published }) => !published).map(({ dir }) => dir));
 }

package/lib/version/index.js

@@ -11,6 +11,7 @@ import { renderHelp } from 'render-help';
 import { inc, valid } from 'semver';
 import { renderReleasePlan, toWorkspaceProjects } from '../change/index.js';
 import { changelogHasSection, fetchPublishedChangelog } from '../publish/previousChangelog.js';
+import { publishedNameByManifestName } from '../publishedNames.js';
 import { resolveUnpublishedDirs } from '../resolveUnpublishedDirs.js';
 export function rcOptionsTypes() {
     return pick([
@@ -182,14 +183,15 @@ async function releaseFromIntents(opts) {
         filter,
         enforceWorkspaceProtocol: true,
     };
-    const unpublishedDirs = await resolveUnpublishedDirs(assembleReleasePlan(baseArgs), opts);
+    const publishedNames = publishedNameByManifestName(projects);
+    const unpublishedDirs = await resolveUnpublishedDirs(assembleReleasePlan(baseArgs), { ...opts, publishedNames });
     const plan = assembleReleasePlan({ ...baseArgs, unpublishedDirs });
     const applyOpts = {
         workspaceDir,
         projects,
         allIntents: intents,
         versioning: opts.versioning,
-        verifyPublished: buildVerifyPublished(opts),
+        verifyPublished: buildVerifyPublished(opts, publishedNames),
     };
     if (plan.releases.length === 0) {
         // A full (unfiltered) run garbage-collects the intent files an empty plan
@@ -223,12 +225,14 @@ async function releaseFromIntents(opts) {
  * is kept. `undefined` in `repository` storage, where the committed changelog
  * makes the ledger alone sufficient.
  */
-function buildVerifyPublished(opts) {
+function buildVerifyPublished(opts, publishedNames) {
     if (changelogStorage(opts.versioning) !== 'registry')
         return undefined;
     return async (name, version, section) => {
         try {
-            const changelog = await fetchPublishedChangelog(opts, name, version);
+            // The parked section is keyed by the manifest name, which is what the
+            // ledger joins on; the registry only knows the published one.
+            const changelog = await fetchPublishedChangelog(opts, publishedNames.get(name) ?? name, version);
             return changelog != null && changelogHasSection(changelog, section);
         }
         catch {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnpm/releasing.commands",
-  "version": "1100.7.1",
+  "version": "1100.8.0",
   "description": "Commands for deploy, pack, and publish",
   "keywords": [
     "pnpm",
@@ -27,46 +27,46 @@
     "!*.map"
   ],
   "dependencies": {
-    "@inquirer/prompts": "^8.4.3",
-    "@pnpm/bins.resolver": "1100.0.11",
+    "@inquirer/prompts": "^8.5.2",
+    "@pnpm/bins.resolver": "1100.0.12",
     "@pnpm/catalogs.types": "1100.0.1",
     "@pnpm/cli.common-cli-options-help": "1100.0.3",
-    "@pnpm/cli.utils": "1101.0.19",
-    "@pnpm/config.pick-registry-for-package": "1100.0.12",
-    "@pnpm/config.reader": "1101.14.0",
+    "@pnpm/cli.utils": "1101.0.20",
+    "@pnpm/config.pick-registry-for-package": "1100.0.13",
+    "@pnpm/config.reader": "1101.15.0",
     "@pnpm/constants": "1100.0.1",
-    "@pnpm/deps.path": "1100.0.11",
-    "@pnpm/engine.runtime.commands": "1100.1.16",
-    "@pnpm/engine.runtime.node-resolver": "1101.1.18",
+    "@pnpm/deps.path": "1100.0.12",
+    "@pnpm/engine.runtime.commands": "1100.1.17",
+    "@pnpm/engine.runtime.node-resolver": "1101.1.19",
     "@pnpm/error": "1100.1.0",
-    "@pnpm/exec.lifecycle": "1100.1.8",
+    "@pnpm/exec.lifecycle": "1100.1.9",
     "@pnpm/exec.pnpm-cli-runner": "1100.0.2",
-    "@pnpm/fetching.directory-fetcher": "1100.0.25",
+    "@pnpm/fetching.directory-fetcher": "1100.0.26",
     "@pnpm/fetching.types": "1100.0.3",
-    "@pnpm/fs.indexed-pkg-importer": "1100.0.21",
+    "@pnpm/fs.indexed-pkg-importer": "1100.0.22",
     "@pnpm/fs.is-empty-dir-or-nothing": "1100.0.1",
     "@pnpm/fs.packlist": "1100.0.4",
-    "@pnpm/installing.client": "1100.2.20",
-    "@pnpm/installing.commands": "1100.12.0",
-    "@pnpm/lockfile.fs": "1100.1.14",
-    "@pnpm/lockfile.types": "1100.0.16",
-    "@pnpm/network.auth-header": "1101.1.6",
-    "@pnpm/network.fetch": "1100.1.8",
+    "@pnpm/installing.client": "1100.3.0",
+    "@pnpm/installing.commands": "1100.12.1",
+    "@pnpm/lockfile.fs": "1100.1.15",
+    "@pnpm/lockfile.types": "1100.0.17",
+    "@pnpm/network.auth-header": "1101.1.7",
+    "@pnpm/network.fetch": "1100.1.9",
     "@pnpm/network.git-utils": "1100.0.3",
     "@pnpm/network.web-auth": "1101.3.0",
     "@pnpm/npm-package-arg": "^2.0.0",
-    "@pnpm/releasing.exportable-manifest": "1100.1.15",
-    "@pnpm/releasing.versioning": "1100.2.1",
-    "@pnpm/resolving.npm-resolver": "1102.1.8",
-    "@pnpm/resolving.registry.types": "1100.1.6",
-    "@pnpm/resolving.resolver-base": "1100.5.4",
-    "@pnpm/types": "1101.6.0",
-    "@pnpm/workspace.projects-filter": "1100.0.32",
-    "@pnpm/workspace.projects-sorter": "1100.0.11",
-    "@pnpm/workspace.workspace-manifest-writer": "1100.0.18",
+    "@pnpm/releasing.exportable-manifest": "1100.2.0",
+    "@pnpm/releasing.versioning": "1100.2.2",
+    "@pnpm/resolving.npm-resolver": "1102.1.9",
+    "@pnpm/resolving.registry.types": "1100.1.7",
+    "@pnpm/resolving.resolver-base": "1100.5.5",
+    "@pnpm/types": "1101.7.0",
+    "@pnpm/workspace.projects-filter": "1100.0.33",
+    "@pnpm/workspace.projects-sorter": "1100.0.12",
+    "@pnpm/workspace.workspace-manifest-writer": "1100.0.19",
     "@types/normalize-path": "^3.0.2",
     "@zkochan/rimraf": "^4.0.0",
-    "chalk": "^5.6.2",
+    "chalk": "^6.0.0",
     "ci-info": "^4.4.0",
     "detect-libc": "^2.1.2",
     "execa": "npm:safe-execa@0.3.0",
@@ -76,14 +76,14 @@
     "normalize-registry-url": "2.0.1",
     "npm-registry-fetch": "^19.0.0",
     "p-filter": "^4.1.0",
-    "p-limit": "^7.3.0",
+    "p-limit": "^7.3.1",
     "ramda": "npm:@pnpm/ramda@0.28.1",
     "realpath-missing": "^2.0.0",
     "render-help": "^2.0.0",
-    "semver": "^7.8.4",
+    "semver": "^7.8.5",
     "tar-stream": "^3.2.0",
     "tempy": "3.0.0",
-    "tinyglobby": "^0.2.16",
+    "tinyglobby": "^0.2.17",
     "validate-npm-package-name": "7.0.2",
     "write-json-file": "^7.0.0",
     "write-yaml-file": "^6.0.0"
@@ -93,12 +93,12 @@
   },
   "devDependencies": {
     "@jest/globals": "30.4.1",
-    "@pnpm/assert-project": "1100.0.22",
+    "@pnpm/assert-project": "1100.0.23",
     "@pnpm/catalogs.config": "1100.0.3",
-    "@pnpm/hooks.pnpmfile": "1100.0.22",
+    "@pnpm/hooks.pnpmfile": "1100.0.23",
     "@pnpm/logger": "1100.0.0",
-    "@pnpm/prepare": "1100.0.22",
-    "@pnpm/releasing.commands": "1100.7.1",
+    "@pnpm/prepare": "1100.0.23",
+    "@pnpm/releasing.commands": "1100.8.0",
     "@pnpm/test-fixtures": "1100.0.1",
     "@pnpm/test-ipc-server": "1100.0.0",
     "@pnpm/testing.command-defaults": "1100.0.11",
@@ -108,7 +108,7 @@
     "@types/libnpmpublish": "^11.2.0",
     "@types/npm-registry-fetch": "^8.0.9",
     "@types/proxyquire": "^1.3.31",
-    "@types/ramda": "0.31.1",
+    "@types/ramda": "0.32.0",
     "@types/semver": "7.7.1",
     "@types/tar-stream": "^3.1.4",
     "@types/validate-npm-package-name": "^4.0.2",
@@ -116,7 +116,7 @@
     "cross-spawn": "^7.0.6",
     "is-windows": "^1.0.2",
     "load-json-file": "^7.0.1",
-    "tar": "^7.5.15",
+    "tar": "^7.5.22",
     "undici": "^7.27.2",
     "write-yaml-file": "^6.0.0"
   },