feat(monorepo): prefix output with package name (#1378)

* feat(monorepo): prefix output with package name

* chore: move piping subprocess output to util fn

* chore: fix lint errors

* chore: revert releaseRc changes

* chore: apply changes to monorepo-only releaseRc

* chore: fix default noPrefix values

* chore: replace noPrefix with prefix

* chore: ensure prefix written on every newline

* test: add tests

* chore: refactor

* chore: fix tests

* chore: add dt types

* chore: windows is so broken

* chore: add dependency to monorepo test fixture

---------

Co-authored-by: achingbrain <[email protected]>

Author: wemeetagain

package.json

@@ -303,6 +303,7 @@
     "source-map-support": "^0.5.20",
     "strip-bom": "^5.0.0",
     "strip-json-comments": "^5.0.0",
+    "strong-log-transformer": "^2.1.0",
     "tempy": "^3.0.0",
     "typedoc": "^0.25.0",
     "typedoc-plugin-mdn-links": "^3.0.3",
@@ -330,6 +331,7 @@
     "@types/prompt": "^1.1.2",
     "@types/proper-lockfile": "^4.1.1",
     "@types/semver": "^7.3.4",
+    "@types/strong-log-transformer": "^1.0.2",
     "@types/update-notifier": "^6.0.1",
     "@types/yargs": "^17.0.0",
     "electron": "^27.0.2"

src/cmds/exec.js

@@ -29,6 +29,11 @@ export default {
           type: 'boolean',
           describe: '',
           default: userConfig.exec.bail
+        },
+        prefix: {
+          type: 'boolean',
+          describe: 'Prefix output with the package name',
+          default: userConfig.exec.prefix
         }
       })
   },

src/cmds/release-rc.js

@@ -35,6 +35,11 @@ export default {
           type: 'string',
           describe: 'Which tag to publish the version as',
           default: userConfig.releaseRc.tag
+        },
+        prefix: {
+          type: 'boolean',
+          describe: 'Prefix output with the package name',
+          default: userConfig.releaseRc.prefix
         }
       })
   },

src/cmds/run.js

@@ -29,6 +29,11 @@ export default {
           type: 'boolean',
           describe: '',
           default: userConfig.run.bail
+        },
+        prefix: {
+          type: 'boolean',
+          describe: 'Prefix output with the package name',
+          default: userConfig.run.prefix
         }
       })
       .positional('script', {

src/config/user.js

@@ -108,18 +108,21 @@ const defaults = {
   },
   releaseRc: {
     retries: 5,
-    tag: 'next'
+    tag: 'next',
+    prefix: true
   },
   // dependency check cmd options
   dependencyCheck: {
     unused: false,
     ignore: []
   },
   exec: {
-    bail: true
+    bail: true,
+    prefix: true
   },
   run: {
-    bail: true
+    bail: true,
+    prefix: true
   }
 }
 

src/exec.js

@@ -1,6 +1,6 @@
 import { execa } from 'execa'
 import kleur from 'kleur'
-import { everyMonorepoProject } from './utils.js'
+import { everyMonorepoProject, pipeOutput } from './utils.js'
 
 /**
  * @typedef {import("./types").GlobalOptions} GlobalOptions
@@ -12,18 +12,18 @@ export default {
    * @param {GlobalOptions & ExecOptions & { command: string }} ctx
    */
   async run (ctx) {
-    const forwardOptions = ctx['--'] ? ctx['--'] : []
+    const forwardArgs = ctx['--'] ? ctx['--'] : []
 
     await everyMonorepoProject(process.cwd(), async (project) => {
       console.info('') // eslint-disable-line no-console
-      console.info(kleur.grey(`${project.manifest.name} > ${ctx.command} ${forwardOptions.join(' ')}`)) // eslint-disable-line no-console
+      console.info(kleur.grey(`${project.manifest.name}:`), `> ${ctx.command}${forwardArgs.length > 0 ? ` ${forwardArgs.join(' ')}` : ''}`) // eslint-disable-line no-console
 
       try {
-        await execa(ctx.command, forwardOptions, {
-          cwd: project.dir,
-          stderr: 'inherit',
-          stdout: 'inherit'
+        const subprocess = execa(ctx.command, forwardArgs, {
+          cwd: project.dir
         })
+        pipeOutput(subprocess, project.manifest.name, ctx.prefix)
+        await subprocess
       } catch (/** @type {any} */ err) {
         if (ctx.bail !== false) {
           throw err

src/release-rc.js

@@ -5,7 +5,7 @@ import { execa } from 'execa'
 import fs from 'fs-extra'
 import Listr from 'listr'
 import retry from 'p-retry'
-import { isMonorepoParent, pkg, everyMonorepoProject } from './utils.js'
+import { isMonorepoParent, pkg, everyMonorepoProject, pipeOutput } from './utils.js'
 
 /**
  * @typedef {import("./types").GlobalOptions} GlobalOptions
@@ -78,12 +78,11 @@ async function releaseMonorepoRcs (commit, ctx) {
       console.info(`npm publish --tag ${ctx.tag} --dry-run ${!process.env.CI}`)
 
       try {
-        await execa('npm', ['publish', '--tag', ctx.tag, '--dry-run', `${!process.env.CI}`], {
-          stdout: 'inherit',
-          stderr: 'inherit',
-          cwd: project.dir,
-          all: true
+        const subprocess = execa('npm', ['publish', '--tag', ctx.tag, '--dry-run', `${!process.env.CI}`], {
+          cwd: project.dir
         })
+        pipeOutput(subprocess, project.manifest.name, ctx.prefix)
+        await subprocess
       } catch (/** @type {any} */ err) {
         if (err.all?.includes('You cannot publish over the previously published versions')) {
           // this appears to be a bug in npm, sometimes you publish successfully but it also

src/run.js

@@ -1,6 +1,6 @@
 import { execa } from 'execa'
 import kleur from 'kleur'
-import { everyMonorepoProject } from './utils.js'
+import { everyMonorepoProject, pipeOutput } from './utils.js'
 
 /**
  * @typedef {import("./types").GlobalOptions} GlobalOptions
@@ -27,14 +27,15 @@ export default {
         }
 
         console.info('') // eslint-disable-line no-console
-        console.info(kleur.grey(`${project.manifest.name} > npm run ${script} ${forwardArgs.join(' ')}`)) // eslint-disable-line no-console
+        console.info(kleur.grey(`${project.manifest.name}:`), `npm run ${script}${forwardArgs.length > 0 ? ` ${forwardArgs.join(' ')}` : ''}`) // eslint-disable-line no-console
 
         try {
-          await execa('npm', ['run', script, ...forwardArgs], {
+          const subprocess = execa('npm', ['run', script, ...forwardArgs], {
             cwd: project.dir,
-            stderr: 'inherit',
-            stdout: 'inherit'
+            stdio: ['ignore', 'pipe', 'pipe']
           })
+          pipeOutput(subprocess, project.manifest.name, ctx.prefix)
+          await subprocess
         } catch (/** @type {any} */ err) {
           if (ctx.bail !== false) {
             throw err

src/types.ts

@@ -336,6 +336,11 @@ interface ReleaseRcOptions {
    * Which tag to publish the rc as
    */
   tag: string
+
+  /**
+   * Prefix output with the package name
+   */
+  prefix?: boolean
 }
 
 interface DependencyCheckOptions {
@@ -355,13 +360,23 @@ interface ExecOptions {
    * If false, the command will continue to be run in other packages
    */
   bail?: boolean
+
+  /**
+   * Prefix output with the package name
+   */
+  prefix?: boolean
 }
 
 interface RunOptions {
   /**
    * If false, the command will continue to be run in other packages
    */
   bail?: boolean
+
+  /**
+   * Prefix output with the package name
+   */
+  prefix?: boolean
 }
 
 export type {

src/utils.js

@@ -22,6 +22,7 @@ import lockfile from 'proper-lockfile'
 import { readPackageUpSync } from 'read-pkg-up'
 import stripBom from 'strip-bom'
 import stripComments from 'strip-json-comments'
+import logTransformer from 'strong-log-transformer'
 
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 const EnvPaths = envPaths('aegir', { suffix: '' })
@@ -575,3 +576,30 @@ export const formatCode = (code, errorLines) => {
   })
   return '    ' + lines.join('\n    ')
 }
+
+/**
+ * Pipe subprocess output to stdio
+ *
+ * @param {import('execa').ExecaChildProcess} subprocess
+ * @param {string} prefix
+ * @param {boolean} [shouldPrefix]
+ */
+export function pipeOutput (subprocess, prefix, shouldPrefix) {
+  if (shouldPrefix === false) {
+    subprocess.stdout?.pipe(process.stdout)
+    subprocess.stderr?.pipe(process.stderr)
+
+    return
+  }
+
+  const stdoutOpts = {
+    tag: kleur.gray(`${prefix}:`)
+  }
+
+  const stderrOpts = {
+    tag: kleur.gray(`${prefix}:`)
+  }
+
+  subprocess.stdout?.pipe(logTransformer(stdoutOpts)).pipe(process.stdout)
+  subprocess.stderr?.pipe(logTransformer(stderrOpts)).pipe(process.stderr)
+}

test/exec.js

@@ -0,0 +1,87 @@
+/* eslint-env mocha */
+
+import { createRequire } from 'module'
+import os from 'os'
+import { execa } from 'execa'
+import { expect } from '../utils/chai.js'
+import { setUpProject } from './utils/set-up-project.js'
+
+const require = createRequire(import.meta.url)
+const bin = require.resolve('../src/index.js')
+
+describe('exec', () => {
+  if (os.platform() === 'win32') {
+    describe.skip('Skipping tests on windows because commands are different', () => {})
+
+    return
+  }
+
+  let projectDir = ''
+
+  before(async () => {
+    projectDir = await setUpProject('a-monorepo')
+  })
+
+  it('should prefix monorepo output with the project name', async function () {
+    this.timeout(120 * 1000) // slow ci is slow
+
+    const result = await execa(bin, ['exec', 'ls'], {
+      cwd: projectDir
+    })
+
+    expect(result.stdout).to.equal(`
+another-workspace-project: > ls
+another-workspace-project: package.json
+another-workspace-project: src
+another-workspace-project: tsconfig.json
+another-workspace-project: typedoc.json
+
+a-workspace-project: > ls
+a-workspace-project: package.json
+a-workspace-project: src
+a-workspace-project: tsconfig.json
+a-workspace-project: typedoc.json`)
+  })
+
+  it('should not prefix monorepo output with the project name with --no-prefix', async function () {
+    this.timeout(120 * 1000) // slow ci is slow
+
+    const result = await execa(bin, ['exec', '--no-prefix', 'ls'], {
+      cwd: projectDir
+    })
+
+    expect(result.stdout).to.equal(`
+another-workspace-project: > ls
+package.json
+src
+tsconfig.json
+typedoc.json
+
+a-workspace-project: > ls
+package.json
+src
+tsconfig.json
+typedoc.json`)
+  })
+
+  it('should not prefix monorepo output with the project name with --prefix=false', async function () {
+    this.timeout(120 * 1000) // slow ci is slow
+
+    const result = await execa(bin, ['exec', '--prefix=false', 'ls'], {
+      cwd: projectDir
+    })
+
+    expect(result.stdout).to.equal(`
+another-workspace-project: > ls
+package.json
+src
+tsconfig.json
+typedoc.json
+
+a-workspace-project: > ls
+package.json
+src
+tsconfig.json
+typedoc.json`)
+  })
+})

test/fixtures/projects/a-monorepo/packages/a-workspace-project/package.json

@@ -8,6 +8,12 @@
       "import": "./src/index.js"
     }
   },
+  "dependencies": {
+    "another-workspace-project": "1.0.0"
+  },
+  "scripts": {
+    "test": "echo very test"
+  },
   "type": "module",
   "author": "",
   "license": "ISC"

test/fixtures/projects/a-monorepo/packages/another-workspace-project/package.json

@@ -8,6 +8,9 @@
       "import": "./src/index.js"
     }
   },
+  "scripts": {
+    "test": "echo very test"
+  },
   "type": "module",
   "author": "",
   "license": "ISC"

test/node.js

@@ -5,6 +5,8 @@ import './fixtures.js'
 import './dependants.js'
 import './document-check.js'
 import './dependency-check.js'
+import './exec.js'
+import './run.js'
 import './utils/echo-server.js'
 import './utils/get-port.js'
 import './config/user.js'