fix(refactor): use output.buffer for easier json output in publish

Author: lukekarrys

lib/commands/pack.js

@@ -57,6 +57,8 @@ class Pack extends BaseCommand {
       tarballs.push(pkgContents)
     }
 
+    // XXX(BREAKING_CHANGE): publish outputs a json object with package
+    // names as keys. Pack should do the same here instead of an array
     if (json) {
       output.standard(JSON.stringify(tarballs, null, 2))
       return

lib/commands/publish.js

@@ -43,14 +43,34 @@ class Publish extends BaseCommand {
       throw this.usageError()
     }
 
+    await this.#publish(args)
+  }
+
+  async execWorkspaces () {
+    await this.setWorkspaces()
+
+    for (const [name, workspace] of this.workspaces.entries()) {
+      try {
+        await this.#publish([workspace], { workspace: name })
+      } catch (err) {
+        if (err.code !== 'EPRIVATE') {
+          throw err
+        }
+        // eslint-disable-next-line max-len
+        log.warn('publish', `Skipping workspace ${this.npm.chalk.cyan(name)}, marked as ${this.npm.chalk.bold('private')}`)
+      }
+    }
+  }
+
+  async #publish (args, { workspace } = {}) {
     log.verbose('publish', replaceInfo(args))
 
+    const { silent } = this.npm
     const unicode = this.npm.config.get('unicode')
     const dryRun = this.npm.config.get('dry-run')
     const json = this.npm.config.get('json')
     const defaultTag = this.npm.config.get('tag')
     const ignoreScripts = this.npm.config.get('ignore-scripts')
-    const { silent } = this.npm
 
     if (semver.validRange(defaultTag)) {
       throw new Error('Tag name must not be a valid SemVer range: ' + defaultTag.trim())
@@ -61,7 +81,7 @@ class Publish extends BaseCommand {
     // you can publish name@version, ./foo.tgz, etc.
     // even though the default is the 'file:.' cwd.
     const spec = npa(args[0])
-    let manifest = await this.getManifest(spec, opts)
+    let manifest = await this.#getManifest(spec, opts)
 
     // only run scripts for directory type publishes
     if (spec.type === 'directory' && !ignoreScripts) {
@@ -88,10 +108,11 @@ class Publish extends BaseCommand {
     // The purpose of re-reading the manifest is in case it changed,
     // so that we send the latest and greatest thing to the registry
     // note that publishConfig might have changed as well!
-    manifest = await this.getManifest(spec, opts, true)
+    manifest = await this.#getManifest(spec, opts, true)
 
-    // JSON already has the package contents
-    if (!json) {
+    if (json) {
+      output.buffer(workspace ? { [workspace]: pkgContents } : pkgContents)
+    } else {
       logTar(pkgContents, { unicode })
     }
 
@@ -142,62 +163,15 @@ class Publish extends BaseCommand {
       })
     }
 
-    if (!this.suppressOutput) {
-      if (!silent && json) {
-        output.standard(JSON.stringify(pkgContents, null, 2))
-      } else if (!silent) {
-        output.standard(`+ ${pkgContents.id}`)
-      }
-    }
-
-    return pkgContents
-  }
-
-  async execWorkspaces () {
-    // Suppresses JSON output in publish() so we can handle it here
-    this.suppressOutput = true
-
-    const results = {}
-    const json = this.npm.config.get('json')
-    const { silent } = this.npm
-    await this.setWorkspaces()
-
-    for (const [name, workspace] of this.workspaces.entries()) {
-      let pkgContents
-      try {
-        pkgContents = await this.exec([workspace])
-      } catch (err) {
-        if (err.code === 'EPRIVATE') {
-          log.warn(
-            'publish',
-            `Skipping workspace ${
-              this.npm.chalk.cyan(name)
-            }, marked as ${
-              this.npm.chalk.bold('private')
-            }`
-          )
-          continue
-        }
-        throw err
-      }
-      // This needs to be in-line w/ the rest of the output that non-JSON
-      // publish generates
-      if (!silent && !json) {
-        output.standard(`+ ${pkgContents.id}`)
-      } else {
-        results[name] = pkgContents
-      }
-    }
-
-    if (!silent && json) {
-      output.standard(JSON.stringify(results, null, 2))
+    if (!json && !silent) {
+      output.standard(`+ ${pkgContents.id}`)
     }
   }
 
   // if it's a directory, read it from the file system
   // otherwise, get the full metadata from whatever it is
   // XXX can't pacote read the manifest from a directory?
-  async getManifest (spec, opts, logWarnings = false) {
+  async #getManifest (spec, opts, logWarnings = false) {
     let manifest
     if (spec.type === 'directory') {
       const changes = []