fix(refactor): use output.buffer for easier json output in run-script

Author: lukekarrys

lib/commands/run-script.js

@@ -2,6 +2,18 @@ const { log, output } = require('proc-log')
 const pkgJson = require('@npmcli/package-json')
 const BaseCommand = require('../base-cmd.js')
 
+// TODO this is missing things like prepare, prepublishOnly, and dependencies
+const cmdList = [
+  'preinstall', 'install', 'postinstall',
+  'prepublish', 'publish', 'postpublish',
+  'prerestart', 'restart', 'postrestart',
+  'prestart', 'start', 'poststart',
+  'prestop', 'stop', 'poststop',
+  'pretest', 'test', 'posttest',
+  'preuninstall', 'uninstall', 'postuninstall',
+  'preversion', 'version', 'postversion',
+]
+
 class RunScript extends BaseCommand {
   static description = 'Run arbitrary package scripts'
   static params = [
@@ -34,27 +46,39 @@ class RunScript extends BaseCommand {
 
   async exec (args) {
     if (args.length) {
-      return this.run(args)
+      await this.#run(args, { path: this.npm.localPrefix })
     } else {
-      return this.list(args)
+      await this.#list(this.npm.localPrefix)
     }
   }
 
   async execWorkspaces (args) {
-    if (args.length) {
-      return this.runWorkspaces(args)
-    } else {
-      return this.listWorkspaces(args)
+    await this.setWorkspaces()
+
+    for (const [name, path] of this.workspaces.entries()) {
+      if (!args.length) {
+        await this.#list(path, { workspace: name })
+        continue
+      }
+
+      const pkg = await pkgJson.normalize(path).then(p => p.content)
+      try {
+        await this.#run(args, { path, pkg })
+      } catch (err) {
+        log.error(`Lifecycle script \`${args[0]}\` failed with error:`)
+        log.error(err)
+        log.error(`  in workspace: ${pkg._id || pkg.name}`)
+        log.error(`  at location: ${path}`)
+        process.exitCode = 1
+      }
     }
   }
 
-  async run ([event, ...args], { path = this.npm.localPrefix, pkg } = {}) {
+  async #run ([event, ...args], { path, pkg } = {}) {
     const runScript = require('@npmcli/run-script')
 
-    if (!pkg) {
-      const { content } = await pkgJson.normalize(path)
-      pkg = content
-    }
+    pkg ??= await pkgJson.normalize(path).then(p => p.content)
+
     const { scripts = {} } = pkg
 
     if (event === 'restart' && !scripts.restart) {
@@ -109,49 +133,39 @@ class RunScript extends BaseCommand {
     }
   }
 
-  async list (args, path) {
-    /* eslint-disable-next-line max-len */
-    const { content: { scripts, name, _id } } = await pkgJson.normalize(path || this.npm.localPrefix)
+  async #list (path, { workspace } = {}) {
+    const { scripts = {}, name, _id } = await pkgJson.normalize(path).then(p => p.content)
     const pkgid = _id || name
 
-    if (!scripts) {
-      return []
-    }
-
-    const allScripts = Object.keys(scripts)
     if (this.npm.silent) {
-      return allScripts
+      return
     }
 
     if (this.npm.config.get('json')) {
-      output.standard(JSON.stringify(scripts, null, 2))
-      return allScripts
+      output.buffer(workspace ? { [workspace]: scripts } : scripts)
+      return
     }
 
     if (this.npm.config.get('parseable')) {
-      for (const [script, cmd] of Object.entries(scripts)) {
-        output.standard(`${script}:${cmd}`)
+      const msg = Object.entries(scripts)
+        .map(([script, cmd]) => `${workspace ? `${workspace}:` : ''}${script}:${cmd}`)
+        .join('\n')
+        .trim()
+      if (msg) {
+        output.standard(msg)
       }
+      return
+    }
 
-      return allScripts
+    if (!Object.keys(scripts).length) {
+      return
     }
 
-    // TODO this is missing things like prepare, prepublishOnly, and dependencies
-    const cmdList = [
-      'preinstall', 'install', 'postinstall',
-      'prepublish', 'publish', 'postpublish',
-      'prerestart', 'restart', 'postrestart',
-      'prestart', 'start', 'poststart',
-      'prestop', 'stop', 'poststop',
-      'pretest', 'test', 'posttest',
-      'preuninstall', 'uninstall', 'postuninstall',
-      'preversion', 'version', 'postversion',
-    ]
     const indent = '\n    '
     const prefix = '  '
     const cmds = []
     const runScripts = []
-    for (const script of allScripts) {
+    for (const script of Object.keys(scripts)) {
       const list = cmdList.includes(script) ? cmds : runScripts
       list.push(script)
     }
@@ -184,59 +198,6 @@ class RunScript extends BaseCommand {
     }
 
     output.standard('')
-    return allScripts
-  }
-
-  async runWorkspaces (args) {
-    const res = []
-    await this.setWorkspaces()
-
-    for (const workspacePath of this.workspacePaths) {
-      const { content: pkg } = await pkgJson.normalize(workspacePath)
-      const runResult = await this.run(args, {
-        path: workspacePath,
-        pkg,
-      }).catch(err => {
-        log.error(`Lifecycle script \`${args[0]}\` failed with error:`)
-        log.error(err)
-        log.error(`  in workspace: ${pkg._id || pkg.name}`)
-        log.error(`  at location: ${workspacePath}`)
-        process.exitCode = 1
-      })
-      res.push(runResult)
-    }
-  }
-
-  async listWorkspaces (args) {
-    await this.setWorkspaces()
-
-    if (this.npm.silent) {
-      return
-    }
-
-    if (this.npm.config.get('json')) {
-      const res = {}
-      for (const workspacePath of this.workspacePaths) {
-        const { content: { scripts, name } } = await pkgJson.normalize(workspacePath)
-        res[name] = { ...scripts }
-      }
-      output.standard(JSON.stringify(res, null, 2))
-      return
-    }
-
-    if (this.npm.config.get('parseable')) {
-      for (const workspacePath of this.workspacePaths) {
-        const { content: { scripts, name } } = await pkgJson.normalize(workspacePath)
-        for (const [script, cmd] of Object.entries(scripts || {})) {
-          output.standard(`${name}:${script}:${cmd}`)
-        }
-      }
-      return
-    }
-
-    for (const workspacePath of this.workspacePaths) {
-      await this.list(args, workspacePath)
-    }
   }
 }
 

mock-registry/package.json

@@ -11,7 +11,8 @@
     "template-oss-apply": "template-oss-apply --force",
     "lintfix": "npm run lint -- --fix",
     "snap": "tap",
-    "posttest": "npm run lint"
+    "posttest": "npm run lint",
+    "exit1": "exit 1"
   },
   "repository": {
     "type": "git",

package.json

@@ -228,7 +228,8 @@
     "resetdeps": "node scripts/resetdeps.js",
     "rp-pull-request": "node scripts/update-authors.js",
     "postlint": "template-oss-check",
-    "template-oss-apply": "template-oss-apply --force"
+    "template-oss-apply": "template-oss-apply --force",
+    "exit1": "exit 1"
   },
   "tap": {
     "test-env": [