fix: publish --json (#8789)

zkochan · zkochan · commit 473cbc44db26 · 2024-11-20T11:44:19.000+01:00
close #8788
diff --git a/.changeset/witty-seahorses-cough.md b/.changeset/witty-seahorses-cough.md
@@ -0,0 +1,6 @@
+---
+"@pnpm/plugin-commands-publishing": patch
+"pnpm": patch
+---
+
+`pnpm publish --json` should work [#8788](https://github.com/pnpm/pnpm/issues/8788).
diff --git a/releasing/plugin-commands-publishing/src/pack.ts b/releasing/plugin-commands-publishing/src/pack.ts
@@ -64,17 +64,34 @@ export function help (): string {
   })
 }
 
-export async function handler (
-  opts: Pick<UniversalOptions, 'dir'> & Pick<Config, 'catalogs' | 'ignoreScripts' | 'rawConfig' | 'embedReadme' | 'packGzipLevel' | 'nodeLinker'> & Partial<Pick<Config, 'extraBinPaths' | 'extraEnv'>> & {
-    argv: {
-      original: string[]
-    }
-    engineStrict?: boolean
-    packDestination?: string
-    workspaceDir?: string
-    json?: boolean
+export type PackOptions = Pick<UniversalOptions, 'dir'> & Pick<Config, 'catalogs' | 'ignoreScripts' | 'rawConfig' | 'embedReadme' | 'packGzipLevel' | 'nodeLinker'> & Partial<Pick<Config, 'extraBinPaths' | 'extraEnv'>> & {
+  argv: {
+    original: string[]
+  }
+  engineStrict?: boolean
+  packDestination?: string
+  workspaceDir?: string
+  json?: boolean
+}
+
+export async function handler (opts: PackOptions): Promise<string> {
+  const { publishedManifest, tarballPath, contents } = await api(opts)
+  if (opts.json) {
+    return JSON.stringify({
+      name: publishedManifest.name,
+      version: publishedManifest.version,
+      filename: tarballPath,
+      files: contents.map((path) => ({ path })),
+    }, null, 2)
   }
-): Promise<string> {
+  return `${chalk.blueBright('Tarball Contents')}
+${contents.join('\n')}
+
+${chalk.blueBright('Tarball Details')}
+${tarballPath}`
+}
+
+export async function api (opts: PackOptions): Promise<PackResult> {
   const { manifest: entryManifest, fileName: manifestFileName } = await readProjectManifest(opts.dir, opts)
   preventBundledDependenciesWithoutHoistedNodeLinker(opts.nodeLinker, entryManifest)
   const _runScriptsIfPresent = runScriptsIfPresent.bind(null, {
@@ -152,19 +169,17 @@ export async function handler (
     packedTarballPath = path.relative(opts.dir, path.join(dir, tarballName))
   }
   const packedContents = files.sort((a, b) => a.localeCompare(b, 'en'))
-  if (opts.json) {
-    return JSON.stringify({
-      name: publishManifest.name,
-      version: publishManifest.version,
-      filename: packedTarballPath,
-      files: packedContents.map((path) => ({ path })),
-    }, null, 2)
+  return {
+    publishedManifest: publishManifest,
+    contents: packedContents,
+    tarballPath: packedTarballPath,
   }
-  return `${chalk.blueBright('Tarball Contents')}
-${packedContents.join('\n')}
+}
 
-${chalk.blueBright('Tarball Details')}
-${packedTarballPath}`
+export interface PackResult {
+  publishedManifest: ProjectManifest
+  contents: string[]
+  tarballPath: string
 }
 
 function preventBundledDependenciesWithoutHoistedNodeLinker (nodeLinker: Config['nodeLinker'], manifest: ProjectManifest): void {
diff --git a/releasing/plugin-commands-publishing/src/publish.ts b/releasing/plugin-commands-publishing/src/publish.ts
@@ -237,13 +237,13 @@ Do you want to continue?`,
   // from the current working directory, ignoring the package.json file
   // that was generated and packed to the tarball.
   const packDestination = tempy.directory()
-  const tarballName = await pack.handler({
+  const { tarballPath } = await pack.api({
     ...opts,
     dir,
     packDestination,
   })
   await copyNpmrc({ dir, workspaceDir: opts.workspaceDir, packDestination })
-  const { status } = runNpm(opts.npmPath, ['publish', '--ignore-scripts', path.basename(tarballName), ...args], {
+  const { status } = runNpm(opts.npmPath, ['publish', '--ignore-scripts', path.basename(tarballPath), ...args], {
     cwd: packDestination,
     env: getEnvWithTokens(opts),
   })
