Use minimalist logging prefix with concurrently (#535)

Author: 72636c

.changeset/stale-numbers-carry.md

@@ -0,0 +1,5 @@
+---
+'skuba': patch
+---
+
+**build-package, lint:** Use minimalist logging prefix

docs/cli/build.md

@@ -61,12 +61,12 @@ This is useful for building isomorphic npm packages, and serves as a replacement
 ```shell
 skuba build-package
 
-# [commonjs] TSFILE: ...
-# [commonjs] tsc exited with code 0
-# [es2015  ] TSFILE: ...
-# [es2015  ] tsc exited with code 0
-# [types   ] TSFILE: ...
-# [types   ] tsc exited with code 0
+# commonjs | TSFILE: ...
+# commonjs | tsc exited with code 0
+# es2015   | TSFILE: ...
+# es2015   | tsc exited with code 0
+# types    | TSFILE: ...
+# types    | tsc exited with code 0
 ```
 
 `skuba lint` runs concurrent processes by default.

docs/cli/lint.md

@@ -43,12 +43,12 @@ This command should be run in CI to verify that [`skuba format`] was applied and
 ```shell
 skuba lint
 
-# [Prettier] Checking formatting...
-# [Prettier] All matched files use Prettier code style!
-# [Prettier] prettier --check . exited with code 0
-# [ESLint  ] eslint --ext=js,ts,tsx --report-unused-disable-directives . exited with code 0
-# [tsc     ] TSFILE: /Users/rling/Code/seek-jobs/indie-ryanair-service/lib/tsconfig.tsbuildinfo
-# [tsc     ] tsc --noEmit exited with code 0
+# Prettier | Checking formatting...
+# Prettier | All matched files use Prettier code style!
+# Prettier | prettier --check . exited with code 0
+# ESLint   | eslint --ext=js,ts,tsx --report-unused-disable-directives . exited with code 0
+# tsc      | TSFILE: /Users/rling/Code/seek-jobs/indie-ryanair-service/lib/tsconfig.tsbuildinfo
+# tsc      | tsc --noEmit exited with code 0
 ```
 
 `skuba lint` runs concurrent processes by default.

package.json

@@ -21,13 +21,13 @@
   "sideEffects": false,
   "license": "MIT",
   "scripts": {
-    "build": "yarn skuba build && scripts/postbuild.sh",
+    "build": "ts-node --transpile-only src/skuba build && scripts/postbuild.sh",
     "deploy": "scripts/deploy.sh",
     "format": "yarn skuba format",
     "lint": "yarn skuba lint",
     "release": "yarn build && changeset publish",
     "stage": "changeset version && yarn format",
-    "skuba": "ts-node src/skuba",
+    "skuba": "ts-node --transpile-only src/skuba build && node lib/skuba",
     "test": "yarn skuba test",
     "test:watch": "yarn skuba test --watch",
     "test:template": "scripts/test-template.sh"
@@ -57,7 +57,7 @@
   "dependencies": {
     "@types/jest": "^27.0.1",
     "chalk": "^4.1.0",
-    "concurrently": "^6.0.0",
+    "concurrently": "^6.2.1",
     "ejs": "^3.1.6",
     "enquirer": "^2.3.6",
     "eslint": "^7.27.0",

src/cli/lint.test.ts

@@ -49,6 +49,7 @@ describe('lint', () => {
         },
         Object {
           "maxProcesses": "REDACTED",
+          "prefix": "{name} |",
         },
       ]
     `);
@@ -81,6 +82,7 @@ describe('lint', () => {
         },
         Object {
           "maxProcesses": "REDACTED",
+          "prefix": "{name} |",
         },
       ]
     `);

src/utils/exec.ts

@@ -110,11 +110,22 @@ export const createExec =
 
 export const exec: Exec = (command, ...args) => runCommand(command, args);
 
-export const execConcurrently = async (commands: ExecConcurrentlyCommand[]) => {
-  const maxNameLength = commands.reduce(
-    (length, command) => Math.max(length, command.name.length),
-    0,
-  );
+export const execConcurrently = async (
+  commands: ExecConcurrentlyCommand[],
+  /**
+   * A set length to pad names to.
+   *
+   * If this argument is not supplied, the length will be inferred from the
+   * longest name in `commands`.
+   */
+  nameLength?: number,
+) => {
+  const maxNameLength =
+    nameLength ??
+    commands.reduce(
+      (length, command) => Math.max(length, command.name.length),
+      0,
+    );
 
   try {
     await concurrently(
@@ -127,6 +138,8 @@ export const execConcurrently = async (commands: ExecConcurrentlyCommand[]) => {
       {
         // Run serially on Buildkite, where we often use puny agents.
         maxProcesses: process.env.BUILDKITE ? 1 : 0,
+        // Use a minimalist logging prefix.
+        prefix: '{name} |',
       },
     );
   } catch (err: unknown) {

yarn.lock

@@ -2440,7 +2440,7 @@ [email protected]:
   resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
   integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=
 
-concurrently@^6.0.0:
+concurrently@^6.2.1:
   version "6.2.1"
   resolved "https://registry.yarnpkg.com/concurrently/-/concurrently-6.2.1.tgz#d880fc1d77559084732fa514092a3d5109a0d5bf"
   integrity sha512-emgwhH+ezkuYKSHZQ+AkgEpoUZZlbpPVYCVv7YZx0r+T7fny1H03r2nYRebpi2DudHR4n1Rgbo2YTxKOxVJ4+g==