skuba 7.1.1 → 7.3.0

package/lib/utils/error.js

@@ -1,9 +1,7 @@
 "use strict";
-var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __export = (target, all) => {
   for (var name in all)
@@ -17,35 +15,27 @@ var __copyProps = (to, from, except, desc) => {
   }
   return to;
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var error_exports = {};
 __export(error_exports, {
-  ConcurrentlyErrors: () => ConcurrentlyErrors,
+  concurrentlyErrorsSchema: () => concurrentlyErrorsSchema,
   createTerseError: () => createTerseError,
   handleCliError: () => handleCliError,
   isErrorWithCode: () => isErrorWithCode
 });
 module.exports = __toCommonJS(error_exports);
 var import_util = require("util");
-var t = __toESM(require("runtypes"));
+var import_zod = require("zod");
 var import_logging = require("./logging");
 var import_validation = require("./validation");
-const ConcurrentlyErrors = t.Array(
-  t.Record({
-    command: t.Record({
-      command: t.String,
-      name: t.String
+const concurrentlyErrorsSchema = import_zod.z.array(
+  import_zod.z.object({
+    command: import_zod.z.object({
+      command: import_zod.z.string(),
+      name: import_zod.z.string()
     }),
-    index: t.Number,
-    exitCode: t.Number
+    index: import_zod.z.number(),
+    exitCode: import_zod.z.number()
   })
 );
 const createTerseError = (message) => Object.assign(new Error(message), {
@@ -64,7 +54,7 @@ const handleCliError = (err) => {
 const isErrorWithCode = (err, code) => (0, import_validation.hasProp)(err, "code") && err.code === code;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ConcurrentlyErrors,
+  concurrentlyErrorsSchema,
   createTerseError,
   handleCliError,
   isErrorWithCode

package/lib/utils/error.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/utils/error.ts"],
-  "sourcesContent": ["/* eslint-disable new-cap */\n\nimport { inspect } from 'util';\n\nimport type { ExecaError } from 'execa';\nimport * as t from 'runtypes';\n\nimport { log } from './logging';\nimport { hasNumberProp, hasProp } from './validation';\n\nexport type ConcurrentlyErrors = t.Static<typeof ConcurrentlyErrors>;\n\nexport const ConcurrentlyErrors = t.Array(\n  t.Record({\n    command: t.Record({\n      command: t.String,\n      name: t.String,\n    }),\n    index: t.Number,\n    exitCode: t.Number,\n  }),\n);\n\n/**\n * Creates an error that returns its plain `message` rather than a full stack\n * trace when `util.inspect`ed.\n *\n * This can be useful for terser handling and logging of known error scenarios\n * that have descriptive messages.\n *\n * https://nodejs.org/api/util.html#custom-inspection-functions-on-objects\n */\nexport const createTerseError = (message?: string) =>\n  Object.assign(new Error(message), {\n    [inspect.custom]: () => message,\n  });\n\nconst isExecaError = (err: unknown): err is ExecaError =>\n  hasNumberProp(err, 'exitCode');\n\nexport const handleCliError = (err: unknown) => {\n  if (isExecaError(err)) {\n    process.exitCode = err.exitCode;\n    return;\n  }\n\n  log.err(inspect(err));\n  process.exitCode = 1;\n  return;\n};\n\nexport const isErrorWithCode = <T>(\n  err: unknown,\n  code: T,\n): err is Record<PropertyKey, unknown> & { code: T } =>\n  hasProp(err, 'code') && err.code === code;\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,kBAAwB;AAGxB,QAAmB;AAEnB,qBAAoB;AACpB,wBAAuC;AAIhC,MAAM,qBAAqB,EAAE;AAAA,EAClC,EAAE,OAAO;AAAA,IACP,SAAS,EAAE,OAAO;AAAA,MAChB,SAAS,EAAE;AAAA,MACX,MAAM,EAAE;AAAA,IACV,CAAC;AAAA,IACD,OAAO,EAAE;AAAA,IACT,UAAU,EAAE;AAAA,EACd,CAAC;AACH;AAWO,MAAM,mBAAmB,CAAC,YAC/B,OAAO,OAAO,IAAI,MAAM,OAAO,GAAG;AAAA,EAChC,CAAC,oBAAQ,MAAM,GAAG,MAAM;AAC1B,CAAC;AAEH,MAAM,eAAe,CAAC,YACpB,iCAAc,KAAK,UAAU;AAExB,MAAM,iBAAiB,CAAC,QAAiB;AAC9C,MAAI,aAAa,GAAG,GAAG;AACrB,YAAQ,WAAW,IAAI;AACvB;AAAA,EACF;AAEA,qBAAI,QAAI,qBAAQ,GAAG,CAAC;AACpB,UAAQ,WAAW;AACnB;AACF;AAEO,MAAM,kBAAkB,CAC7B,KACA,aAEA,2BAAQ,KAAK,MAAM,KAAK,IAAI,SAAS;",
+  "sourcesContent": ["import { inspect } from 'util';\n\nimport type { ExecaError } from 'execa';\nimport { z } from 'zod';\n\nimport { log } from './logging';\nimport { hasNumberProp, hasProp } from './validation';\n\nexport type ConcurrentlyErrors = z.infer<typeof concurrentlyErrorsSchema>;\n\nexport const concurrentlyErrorsSchema = z.array(\n  z.object({\n    command: z.object({\n      command: z.string(),\n      name: z.string(),\n    }),\n    index: z.number(),\n    exitCode: z.number(),\n  }),\n);\n\n/**\n * Creates an error that returns its plain `message` rather than a full stack\n * trace when `util.inspect`ed.\n *\n * This can be useful for terser handling and logging of known error scenarios\n * that have descriptive messages.\n *\n * https://nodejs.org/api/util.html#custom-inspection-functions-on-objects\n */\nexport const createTerseError = (message?: string) =>\n  Object.assign(new Error(message), {\n    [inspect.custom]: () => message,\n  });\n\nconst isExecaError = (err: unknown): err is ExecaError =>\n  hasNumberProp(err, 'exitCode');\n\nexport const handleCliError = (err: unknown) => {\n  if (isExecaError(err)) {\n    process.exitCode = err.exitCode;\n    return;\n  }\n\n  log.err(inspect(err));\n  process.exitCode = 1;\n  return;\n};\n\nexport const isErrorWithCode = <T>(\n  err: unknown,\n  code: T,\n): err is Record<PropertyKey, unknown> & { code: T } =>\n  hasProp(err, 'code') && err.code === code;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAwB;AAGxB,iBAAkB;AAElB,qBAAoB;AACpB,wBAAuC;AAIhC,MAAM,2BAA2B,aAAE;AAAA,EACxC,aAAE,OAAO;AAAA,IACP,SAAS,aAAE,OAAO;AAAA,MAChB,SAAS,aAAE,OAAO;AAAA,MAClB,MAAM,aAAE,OAAO;AAAA,IACjB,CAAC;AAAA,IACD,OAAO,aAAE,OAAO;AAAA,IAChB,UAAU,aAAE,OAAO;AAAA,EACrB,CAAC;AACH;AAWO,MAAM,mBAAmB,CAAC,YAC/B,OAAO,OAAO,IAAI,MAAM,OAAO,GAAG;AAAA,EAChC,CAAC,oBAAQ,MAAM,GAAG,MAAM;AAC1B,CAAC;AAEH,MAAM,eAAe,CAAC,YACpB,iCAAc,KAAK,UAAU;AAExB,MAAM,iBAAiB,CAAC,QAAiB;AAC9C,MAAI,aAAa,GAAG,GAAG;AACrB,YAAQ,WAAW,IAAI;AACvB;AAAA,EACF;AAEA,qBAAI,QAAI,qBAAQ,GAAG,CAAC;AACpB,UAAQ,WAAW;AACnB;AACF;AAEO,MAAM,kBAAkB,CAC7B,KACA,aAEA,2BAAQ,KAAK,MAAM,KAAK,IAAI,SAAS;",
   "names": []
 }

package/lib/utils/exec.js

@@ -116,11 +116,11 @@ const execConcurrently = async (commands, { maxProcesses, nameLength, outputStre
       }
     ).result;
   } catch (err) {
-    const result = import_error.ConcurrentlyErrors.validate(err);
+    const result = import_error.concurrentlyErrorsSchema.safeParse(err);
     if (!result.success) {
       throw err;
     }
-    const failed = result.value.filter(({ exitCode }) => exitCode !== 0).sort(({ index: indexA }, { index: indexB }) => indexA - indexB).map((subprocess) => subprocess.command.name);
+    const failed = result.data.filter(({ exitCode }) => exitCode !== 0).sort(({ index: indexA }, { index: indexB }) => indexA - indexB).map((subprocess) => subprocess.command.name);
     throw Error(
       `${failed.join(", ")} subprocess${failed.length === 1 ? "" : "es"} failed.`
     );

package/lib/utils/exec.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/utils/exec.ts"],
-  "sourcesContent": ["import { cpus } from 'os';\nimport stream from 'stream';\nimport util from 'util';\n\nimport type { Color } from 'chalk';\nimport concurrently from 'concurrently';\nimport execa, { type ExecaChildProcess } from 'execa';\nimport npmRunPath from 'npm-run-path';\nimport npmWhich from 'npm-which';\n\nimport { ConcurrentlyErrors, isErrorWithCode } from './error';\nimport { log } from './logging';\n\nclass YarnSpamFilter extends stream.Transform {\n  silenced = false;\n\n  _transform(\n    chunk: Uint8Array,\n    _encoding: BufferEncoding,\n    callback: stream.TransformCallback,\n  ) {\n    const str = Buffer.from(chunk).toString();\n\n    // Yarn spews the entire installed dependency tree after this message\n    if (str.startsWith('info Direct dependencies')) {\n      this.silenced = true;\n    }\n\n    if (\n      !this.silenced &&\n      // This isn't very useful given the command generates a lockfile\n      !str.startsWith('info No lockfile found')\n    ) {\n      this.push(chunk);\n    }\n\n    callback();\n  }\n}\n\nclass YarnWarningFilter extends stream.Transform {\n  _transform(\n    chunk: Uint8Array,\n    _encoding: BufferEncoding,\n    callback: stream.TransformCallback,\n  ) {\n    const str = Buffer.from(chunk).toString();\n\n    // Filter out annoying deprecation warnings that users can do little about\n    if (!str.startsWith('warning skuba >')) {\n      this.push(chunk);\n    }\n\n    callback();\n  }\n}\n\nexport type Exec = (\n  command: string,\n  ...args: string[]\n) => ExecaChildProcess<string>;\n\ninterface ExecConcurrentlyCommand {\n  command: string;\n  name: string;\n  prefixColor?: typeof Color;\n}\n\ninterface ExecConcurrentlyOptions {\n  /**\n   * The maximum number of processes that can execute concurrently.\n   *\n   * Defaults to the CPU core count.\n   */\n  maxProcesses?: number;\n\n  /**\n   * A set length to pad names to.\n   *\n   * Defaults to the length of the longest command name.\n   */\n  nameLength?: number;\n\n  /**\n   * The stream that logging output will be written to.\n   *\n   * Defaults to `process.stdout`.\n   */\n  outputStream?: stream.Writable;\n}\n\ntype ExecOptions = execa.Options & { streamStdio?: true | 'yarn' };\n\nconst envWithPath = {\n  PATH: npmRunPath({ cwd: __dirname }),\n};\n\nconst runCommand = (command: string, args: string[], opts?: ExecOptions) => {\n  const subprocess = execa(command, args, {\n    localDir: __dirname,\n    preferLocal: true,\n    stdio: 'inherit',\n    ...opts,\n  });\n\n  switch (opts?.streamStdio) {\n    case 'yarn':\n      const stderrFilter = new YarnWarningFilter();\n      const stdoutFilter = new YarnSpamFilter();\n\n      subprocess.stderr?.pipe(stderrFilter).pipe(process.stderr);\n      subprocess.stdout?.pipe(stdoutFilter).pipe(process.stdout);\n\n      break;\n\n    case true:\n      subprocess.stderr?.pipe(process.stderr);\n      subprocess.stdout?.pipe(process.stdout);\n\n      break;\n  }\n\n  return subprocess;\n};\n\nconst whichCallback = npmWhich(__dirname);\n\nconst which = util.promisify<string, string>(whichCallback);\n\nexport const createExec =\n  (opts: ExecOptions): Exec =>\n  (command, ...args) =>\n    runCommand(command, args, opts);\n\nexport const exec: Exec = (command, ...args) => runCommand(command, args);\n\nexport const execConcurrently = async (\n  commands: ExecConcurrentlyCommand[],\n  { maxProcesses, nameLength, outputStream }: ExecConcurrentlyOptions = {},\n) => {\n  const maxNameLength =\n    nameLength ??\n    commands.reduce(\n      (length, command) => Math.max(length, command.name.length),\n      0,\n    );\n\n  try {\n    await concurrently(\n      commands.map(({ command, name, prefixColor }) => ({\n        command,\n        env: envWithPath,\n        name: name.padEnd(maxNameLength),\n        prefixColor,\n      })),\n      {\n        maxProcesses: maxProcesses ?? cpus().length,\n\n        outputStream,\n\n        // Use a minimalist logging prefix.\n        prefix: '{name} \u2502',\n      },\n    ).result;\n  } catch (err) {\n    const result = ConcurrentlyErrors.validate(err);\n\n    if (!result.success) {\n      throw err;\n    }\n\n    const failed = result.value\n      .filter(({ exitCode }) => exitCode !== 0)\n      .sort(({ index: indexA }, { index: indexB }) => indexA - indexB)\n      .map((subprocess) => subprocess.command.name);\n\n    throw Error(\n      `${failed.join(', ')} subprocess${\n        failed.length === 1 ? '' : 'es'\n      } failed.`,\n    );\n  }\n};\n\nexport const ensureCommands = async (...names: string[]) => {\n  let success = true;\n\n  await Promise.all(\n    names.map(async (name) => {\n      const result = await hasCommand(name);\n\n      if (!result) {\n        success = false;\n\n        log.err(log.bold(name), 'needs to be installed.');\n      }\n    }),\n  );\n\n  if (!success) {\n    process.exit(1);\n  }\n};\n\nexport const hasCommand = async (name: string) => {\n  try {\n    await which(name);\n\n    return true;\n  } catch (err) {\n    if (isErrorWithCode(err, 'ENOENT')) {\n      return false;\n    }\n\n    throw err;\n  }\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAAqB;AACrB,oBAAmB;AACnB,kBAAiB;AAGjB,0BAAyB;AACzB,mBAA8C;AAC9C,0BAAuB;AACvB,uBAAqB;AAErB,mBAAoD;AACpD,qBAAoB;AAEpB,MAAM,uBAAuB,cAAAA,QAAO,UAAU;AAAA,EAC5C,WAAW;AAAA,EAEX,WACE,OACA,WACA,UACA;AACA,UAAM,MAAM,OAAO,KAAK,KAAK,EAAE,SAAS;AAGxC,QAAI,IAAI,WAAW,0BAA0B,GAAG;AAC9C,WAAK,WAAW;AAAA,IAClB;AAEA,QACE,CAAC,KAAK;AAAA,IAEN,CAAC,IAAI,WAAW,wBAAwB,GACxC;AACA,WAAK,KAAK,KAAK;AAAA,IACjB;AAEA,aAAS;AAAA,EACX;AACF;AAEA,MAAM,0BAA0B,cAAAA,QAAO,UAAU;AAAA,EAC/C,WACE,OACA,WACA,UACA;AACA,UAAM,MAAM,OAAO,KAAK,KAAK,EAAE,SAAS;AAGxC,QAAI,CAAC,IAAI,WAAW,iBAAiB,GAAG;AACtC,WAAK,KAAK,KAAK;AAAA,IACjB;AAEA,aAAS;AAAA,EACX;AACF;AAsCA,MAAM,cAAc;AAAA,EAClB,UAAM,oBAAAC,SAAW,EAAE,KAAK,UAAU,CAAC;AACrC;AAEA,MAAM,aAAa,CAAC,SAAiB,MAAgB,SAAuB;AAC1E,QAAM,iBAAa,aAAAC,SAAM,SAAS,MAAM;AAAA,IACtC,UAAU;AAAA,IACV,aAAa;AAAA,IACb,OAAO;AAAA,IACP,GAAG;AAAA,EACL,CAAC;AAED,UAAQ,MAAM,aAAa;AAAA,IACzB,KAAK;AACH,YAAM,eAAe,IAAI,kBAAkB;AAC3C,YAAM,eAAe,IAAI,eAAe;AAExC,iBAAW,QAAQ,KAAK,YAAY,EAAE,KAAK,QAAQ,MAAM;AACzD,iBAAW,QAAQ,KAAK,YAAY,EAAE,KAAK,QAAQ,MAAM;AAEzD;AAAA,IAEF,KAAK;AACH,iBAAW,QAAQ,KAAK,QAAQ,MAAM;AACtC,iBAAW,QAAQ,KAAK,QAAQ,MAAM;AAEtC;AAAA,EACJ;AAEA,SAAO;AACT;AAEA,MAAM,oBAAgB,iBAAAC,SAAS,SAAS;AAExC,MAAM,QAAQ,YAAAC,QAAK,UAA0B,aAAa;AAEnD,MAAM,aACX,CAAC,SACD,CAAC,YAAY,SACX,WAAW,SAAS,MAAM,IAAI;AAE3B,MAAM,OAAa,CAAC,YAAY,SAAS,WAAW,SAAS,IAAI;AAEjE,MAAM,mBAAmB,OAC9B,UACA,EAAE,cAAc,YAAY,aAAa,IAA6B,CAAC,MACpE;AACH,QAAM,gBACJ,cACA,SAAS;AAAA,IACP,CAAC,QAAQ,YAAY,KAAK,IAAI,QAAQ,QAAQ,KAAK,MAAM;AAAA,IACzD;AAAA,EACF;AAEF,MAAI;AACF,cAAM,oBAAAC;AAAA,MACJ,SAAS,IAAI,CAAC,EAAE,SAAS,MAAM,YAAY,OAAO;AAAA,QAChD;AAAA,QACA,KAAK;AAAA,QACL,MAAM,KAAK,OAAO,aAAa;AAAA,QAC/B;AAAA,MACF,EAAE;AAAA,MACF;AAAA,QACE,cAAc,oBAAgB,gBAAK,EAAE;AAAA,QAErC;AAAA;AAAA,QAGA,QAAQ;AAAA,MACV;AAAA,IACF,EAAE;AAAA,EACJ,SAAS,KAAK;AACZ,UAAM,SAAS,gCAAmB,SAAS,GAAG;AAE9C,QAAI,CAAC,OAAO,SAAS;AACnB,YAAM;AAAA,IACR;AAEA,UAAM,SAAS,OAAO,MACnB,OAAO,CAAC,EAAE,SAAS,MAAM,aAAa,CAAC,EACvC,KAAK,CAAC,EAAE,OAAO,OAAO,GAAG,EAAE,OAAO,OAAO,MAAM,SAAS,MAAM,EAC9D,IAAI,CAAC,eAAe,WAAW,QAAQ,IAAI;AAE9C,UAAM;AAAA,MACJ,GAAG,OAAO,KAAK,IAAI,CAAC,cAClB,OAAO,WAAW,IAAI,KAAK,IAC7B;AAAA,IACF;AAAA,EACF;AACF;AAEO,MAAM,iBAAiB,UAAU,UAAoB;AAC1D,MAAI,UAAU;AAEd,QAAM,QAAQ;AAAA,IACZ,MAAM,IAAI,OAAO,SAAS;AACxB,YAAM,SAAS,MAAM,WAAW,IAAI;AAEpC,UAAI,CAAC,QAAQ;AACX,kBAAU;AAEV,2BAAI,IAAI,mBAAI,KAAK,IAAI,GAAG,wBAAwB;AAAA,MAClD;AAAA,IACF,CAAC;AAAA,EACH;AAEA,MAAI,CAAC,SAAS;AACZ,YAAQ,KAAK,CAAC;AAAA,EAChB;AACF;AAEO,MAAM,aAAa,OAAO,SAAiB;AAChD,MAAI;AACF,UAAM,MAAM,IAAI;AAEhB,WAAO;AAAA,EACT,SAAS,KAAK;AACZ,YAAI,8BAAgB,KAAK,QAAQ,GAAG;AAClC,aAAO;AAAA,IACT;AAEA,UAAM;AAAA,EACR;AACF;",
+  "sourcesContent": ["import { cpus } from 'os';\nimport stream from 'stream';\nimport util from 'util';\n\nimport type { Color } from 'chalk';\nimport concurrently from 'concurrently';\nimport execa, { type ExecaChildProcess } from 'execa';\nimport npmRunPath from 'npm-run-path';\nimport npmWhich from 'npm-which';\n\nimport { concurrentlyErrorsSchema, isErrorWithCode } from './error';\nimport { log } from './logging';\n\nclass YarnSpamFilter extends stream.Transform {\n  silenced = false;\n\n  _transform(\n    chunk: Uint8Array,\n    _encoding: BufferEncoding,\n    callback: stream.TransformCallback,\n  ) {\n    const str = Buffer.from(chunk).toString();\n\n    // Yarn spews the entire installed dependency tree after this message\n    if (str.startsWith('info Direct dependencies')) {\n      this.silenced = true;\n    }\n\n    if (\n      !this.silenced &&\n      // This isn't very useful given the command generates a lockfile\n      !str.startsWith('info No lockfile found')\n    ) {\n      this.push(chunk);\n    }\n\n    callback();\n  }\n}\n\nclass YarnWarningFilter extends stream.Transform {\n  _transform(\n    chunk: Uint8Array,\n    _encoding: BufferEncoding,\n    callback: stream.TransformCallback,\n  ) {\n    const str = Buffer.from(chunk).toString();\n\n    // Filter out annoying deprecation warnings that users can do little about\n    if (!str.startsWith('warning skuba >')) {\n      this.push(chunk);\n    }\n\n    callback();\n  }\n}\n\nexport type Exec = (\n  command: string,\n  ...args: string[]\n) => ExecaChildProcess<string>;\n\ninterface ExecConcurrentlyCommand {\n  command: string;\n  name: string;\n  prefixColor?: typeof Color;\n}\n\ninterface ExecConcurrentlyOptions {\n  /**\n   * The maximum number of processes that can execute concurrently.\n   *\n   * Defaults to the CPU core count.\n   */\n  maxProcesses?: number;\n\n  /**\n   * A set length to pad names to.\n   *\n   * Defaults to the length of the longest command name.\n   */\n  nameLength?: number;\n\n  /**\n   * The stream that logging output will be written to.\n   *\n   * Defaults to `process.stdout`.\n   */\n  outputStream?: stream.Writable;\n}\n\ntype ExecOptions = execa.Options & { streamStdio?: true | 'yarn' };\n\nconst envWithPath = {\n  PATH: npmRunPath({ cwd: __dirname }),\n};\n\nconst runCommand = (command: string, args: string[], opts?: ExecOptions) => {\n  const subprocess = execa(command, args, {\n    localDir: __dirname,\n    preferLocal: true,\n    stdio: 'inherit',\n    ...opts,\n  });\n\n  switch (opts?.streamStdio) {\n    case 'yarn':\n      const stderrFilter = new YarnWarningFilter();\n      const stdoutFilter = new YarnSpamFilter();\n\n      subprocess.stderr?.pipe(stderrFilter).pipe(process.stderr);\n      subprocess.stdout?.pipe(stdoutFilter).pipe(process.stdout);\n\n      break;\n\n    case true:\n      subprocess.stderr?.pipe(process.stderr);\n      subprocess.stdout?.pipe(process.stdout);\n\n      break;\n  }\n\n  return subprocess;\n};\n\nconst whichCallback = npmWhich(__dirname);\n\nconst which = util.promisify<string, string>(whichCallback);\n\nexport const createExec =\n  (opts: ExecOptions): Exec =>\n  (command, ...args) =>\n    runCommand(command, args, opts);\n\nexport const exec: Exec = (command, ...args) => runCommand(command, args);\n\nexport const execConcurrently = async (\n  commands: ExecConcurrentlyCommand[],\n  { maxProcesses, nameLength, outputStream }: ExecConcurrentlyOptions = {},\n) => {\n  const maxNameLength =\n    nameLength ??\n    commands.reduce(\n      (length, command) => Math.max(length, command.name.length),\n      0,\n    );\n\n  try {\n    await concurrently(\n      commands.map(({ command, name, prefixColor }) => ({\n        command,\n        env: envWithPath,\n        name: name.padEnd(maxNameLength),\n        prefixColor,\n      })),\n      {\n        maxProcesses: maxProcesses ?? cpus().length,\n\n        outputStream,\n\n        // Use a minimalist logging prefix.\n        prefix: '{name} \u2502',\n      },\n    ).result;\n  } catch (err) {\n    const result = concurrentlyErrorsSchema.safeParse(err);\n\n    if (!result.success) {\n      throw err;\n    }\n\n    const failed = result.data\n      .filter(({ exitCode }) => exitCode !== 0)\n      .sort(({ index: indexA }, { index: indexB }) => indexA - indexB)\n      .map((subprocess) => subprocess.command.name);\n\n    throw Error(\n      `${failed.join(', ')} subprocess${\n        failed.length === 1 ? '' : 'es'\n      } failed.`,\n    );\n  }\n};\n\nexport const ensureCommands = async (...names: string[]) => {\n  let success = true;\n\n  await Promise.all(\n    names.map(async (name) => {\n      const result = await hasCommand(name);\n\n      if (!result) {\n        success = false;\n\n        log.err(log.bold(name), 'needs to be installed.');\n      }\n    }),\n  );\n\n  if (!success) {\n    process.exit(1);\n  }\n};\n\nexport const hasCommand = async (name: string) => {\n  try {\n    await which(name);\n\n    return true;\n  } catch (err) {\n    if (isErrorWithCode(err, 'ENOENT')) {\n      return false;\n    }\n\n    throw err;\n  }\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,gBAAqB;AACrB,oBAAmB;AACnB,kBAAiB;AAGjB,0BAAyB;AACzB,mBAA8C;AAC9C,0BAAuB;AACvB,uBAAqB;AAErB,mBAA0D;AAC1D,qBAAoB;AAEpB,MAAM,uBAAuB,cAAAA,QAAO,UAAU;AAAA,EAC5C,WAAW;AAAA,EAEX,WACE,OACA,WACA,UACA;AACA,UAAM,MAAM,OAAO,KAAK,KAAK,EAAE,SAAS;AAGxC,QAAI,IAAI,WAAW,0BAA0B,GAAG;AAC9C,WAAK,WAAW;AAAA,IAClB;AAEA,QACE,CAAC,KAAK;AAAA,IAEN,CAAC,IAAI,WAAW,wBAAwB,GACxC;AACA,WAAK,KAAK,KAAK;AAAA,IACjB;AAEA,aAAS;AAAA,EACX;AACF;AAEA,MAAM,0BAA0B,cAAAA,QAAO,UAAU;AAAA,EAC/C,WACE,OACA,WACA,UACA;AACA,UAAM,MAAM,OAAO,KAAK,KAAK,EAAE,SAAS;AAGxC,QAAI,CAAC,IAAI,WAAW,iBAAiB,GAAG;AACtC,WAAK,KAAK,KAAK;AAAA,IACjB;AAEA,aAAS;AAAA,EACX;AACF;AAsCA,MAAM,cAAc;AAAA,EAClB,UAAM,oBAAAC,SAAW,EAAE,KAAK,UAAU,CAAC;AACrC;AAEA,MAAM,aAAa,CAAC,SAAiB,MAAgB,SAAuB;AAC1E,QAAM,iBAAa,aAAAC,SAAM,SAAS,MAAM;AAAA,IACtC,UAAU;AAAA,IACV,aAAa;AAAA,IACb,OAAO;AAAA,IACP,GAAG;AAAA,EACL,CAAC;AAED,UAAQ,MAAM,aAAa;AAAA,IACzB,KAAK;AACH,YAAM,eAAe,IAAI,kBAAkB;AAC3C,YAAM,eAAe,IAAI,eAAe;AAExC,iBAAW,QAAQ,KAAK,YAAY,EAAE,KAAK,QAAQ,MAAM;AACzD,iBAAW,QAAQ,KAAK,YAAY,EAAE,KAAK,QAAQ,MAAM;AAEzD;AAAA,IAEF,KAAK;AACH,iBAAW,QAAQ,KAAK,QAAQ,MAAM;AACtC,iBAAW,QAAQ,KAAK,QAAQ,MAAM;AAEtC;AAAA,EACJ;AAEA,SAAO;AACT;AAEA,MAAM,oBAAgB,iBAAAC,SAAS,SAAS;AAExC,MAAM,QAAQ,YAAAC,QAAK,UAA0B,aAAa;AAEnD,MAAM,aACX,CAAC,SACD,CAAC,YAAY,SACX,WAAW,SAAS,MAAM,IAAI;AAE3B,MAAM,OAAa,CAAC,YAAY,SAAS,WAAW,SAAS,IAAI;AAEjE,MAAM,mBAAmB,OAC9B,UACA,EAAE,cAAc,YAAY,aAAa,IAA6B,CAAC,MACpE;AACH,QAAM,gBACJ,cACA,SAAS;AAAA,IACP,CAAC,QAAQ,YAAY,KAAK,IAAI,QAAQ,QAAQ,KAAK,MAAM;AAAA,IACzD;AAAA,EACF;AAEF,MAAI;AACF,cAAM,oBAAAC;AAAA,MACJ,SAAS,IAAI,CAAC,EAAE,SAAS,MAAM,YAAY,OAAO;AAAA,QAChD;AAAA,QACA,KAAK;AAAA,QACL,MAAM,KAAK,OAAO,aAAa;AAAA,QAC/B;AAAA,MACF,EAAE;AAAA,MACF;AAAA,QACE,cAAc,oBAAgB,gBAAK,EAAE;AAAA,QAErC;AAAA;AAAA,QAGA,QAAQ;AAAA,MACV;AAAA,IACF,EAAE;AAAA,EACJ,SAAS,KAAK;AACZ,UAAM,SAAS,sCAAyB,UAAU,GAAG;AAErD,QAAI,CAAC,OAAO,SAAS;AACnB,YAAM;AAAA,IACR;AAEA,UAAM,SAAS,OAAO,KACnB,OAAO,CAAC,EAAE,SAAS,MAAM,aAAa,CAAC,EACvC,KAAK,CAAC,EAAE,OAAO,OAAO,GAAG,EAAE,OAAO,OAAO,MAAM,SAAS,MAAM,EAC9D,IAAI,CAAC,eAAe,WAAW,QAAQ,IAAI;AAE9C,UAAM;AAAA,MACJ,GAAG,OAAO,KAAK,IAAI,CAAC,cAClB,OAAO,WAAW,IAAI,KAAK,IAC7B;AAAA,IACF;AAAA,EACF;AACF;AAEO,MAAM,iBAAiB,UAAU,UAAoB;AAC1D,MAAI,UAAU;AAEd,QAAM,QAAQ;AAAA,IACZ,MAAM,IAAI,OAAO,SAAS;AACxB,YAAM,SAAS,MAAM,WAAW,IAAI;AAEpC,UAAI,CAAC,QAAQ;AACX,kBAAU;AAEV,2BAAI,IAAI,mBAAI,KAAK,IAAI,GAAG,wBAAwB;AAAA,MAClD;AAAA,IACF,CAAC;AAAA,EACH;AAEA,MAAI,CAAC,SAAS;AACZ,YAAQ,KAAK,CAAC;AAAA,EAChB;AACF;AAEO,MAAM,aAAa,OAAO,SAAiB;AAChD,MAAI;AACF,UAAM,MAAM,IAAI;AAEhB,WAAO;AAAA,EACT,SAAS,KAAK;AACZ,YAAI,8BAAgB,KAAK,QAAQ,GAAG;AAClC,aAAO;AAAA,IACT;AAEA,UAAM;AAAA,EACR;AACF;",
   "names": ["stream", "npmRunPath", "execa", "npmWhich", "util", "concurrently"]
 }

package/lib/utils/manifest.d.ts

@@ -1,7 +1,7 @@
 import readPkgUp, { type NormalizedPackageJson } from 'read-pkg-up';
-import * as t from 'runtypes';
-export type ProjectType = t.Static<typeof ProjectType>;
-export declare const ProjectType: t.Union<[t.Literal<"application">, t.Literal<"package">]>;
+import { z } from 'zod';
+export type ProjectType = z.infer<typeof projectTypeSchema>;
+export declare const projectTypeSchema: z.ZodUnion<[z.ZodLiteral<"application">, z.ZodLiteral<"package">]>;
 export declare const PROJECT_TYPES: readonly ["application", "package"];
 export declare const getSkubaManifest: () => Promise<NormalizedPackageJson>;
 export declare const getConsumerManifest: () => Promise<readPkgUp.NormalizedReadResult | undefined>;

package/lib/utils/manifest.js

@@ -29,21 +29,21 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var manifest_exports = {};
 __export(manifest_exports, {
   PROJECT_TYPES: () => PROJECT_TYPES,
-  ProjectType: () => ProjectType,
   getConsumerManifest: () => getConsumerManifest,
   getEntryPointFromManifest: () => getEntryPointFromManifest,
   getPropFromConsumerManifest: () => getPropFromConsumerManifest,
   getSkubaManifest: () => getSkubaManifest,
-  getStringPropFromConsumerManifest: () => getStringPropFromConsumerManifest
+  getStringPropFromConsumerManifest: () => getStringPropFromConsumerManifest,
+  projectTypeSchema: () => projectTypeSchema
 });
 module.exports = __toCommonJS(manifest_exports);
 var import_read_pkg_up = __toESM(require("read-pkg-up"));
-var t = __toESM(require("runtypes"));
+var import_zod = require("zod");
 var import_validation = require("./validation");
-const ProjectType = t.Union(
-  t.Literal("application"),
-  t.Literal("package")
-);
+const projectTypeSchema = import_zod.z.union([
+  import_zod.z.literal("application"),
+  import_zod.z.literal("package")
+]);
 const PROJECT_TYPES = ["application", "package"];
 const DEFAULT_ENTRY_POINT = "src/app.ts";
 let skubaManifest;
@@ -73,11 +73,11 @@ const getEntryPointFromManifest = async () => {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   PROJECT_TYPES,
-  ProjectType,
   getConsumerManifest,
   getEntryPointFromManifest,
   getPropFromConsumerManifest,
   getSkubaManifest,
-  getStringPropFromConsumerManifest
+  getStringPropFromConsumerManifest,
+  projectTypeSchema
 });
 //# sourceMappingURL=manifest.js.map

package/lib/utils/manifest.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/utils/manifest.ts"],
-  "sourcesContent": ["/* eslint-disable new-cap */\n\nimport readPkgUp, { type NormalizedPackageJson } from 'read-pkg-up';\nimport * as t from 'runtypes';\n\nimport { hasProp } from './validation';\n\nexport type ProjectType = t.Static<typeof ProjectType>;\n\nexport const ProjectType = t.Union(\n  t.Literal('application'),\n  t.Literal('package'),\n);\n\nexport const PROJECT_TYPES = ['application', 'package'] as const;\n\nconst DEFAULT_ENTRY_POINT = 'src/app.ts';\n\nlet skubaManifest: NormalizedPackageJson | undefined;\n\nexport const getSkubaManifest = async (): Promise<NormalizedPackageJson> => {\n  if (skubaManifest !== undefined) {\n    return skubaManifest;\n  }\n\n  const result = await readPkgUp({ cwd: __dirname });\n\n  if (result === undefined) {\n    throw Error('skuba could not find its own manifest');\n  }\n\n  return (skubaManifest = result.packageJson);\n};\n\nexport const getConsumerManifest = () => readPkgUp();\n\nexport const getPropFromConsumerManifest = async <\n  T extends string,\n  V = unknown,\n>(\n  prop: T,\n): Promise<V | undefined> => {\n  const result = await getConsumerManifest();\n\n  return result !== undefined && hasProp<T, V>(result.packageJson.skuba, prop)\n    ? result.packageJson.skuba[prop]\n    : undefined;\n};\n\nexport const getStringPropFromConsumerManifest = async <T extends string>(\n  prop: T,\n): Promise<string | undefined> => {\n  const result = await getPropFromConsumerManifest(prop);\n\n  return typeof result === 'string' ? result : undefined;\n};\n\nexport const getEntryPointFromManifest = async (): Promise<string> => {\n  const entryPoint = await getStringPropFromConsumerManifest('entryPoint');\n\n  return entryPoint ?? DEFAULT_ENTRY_POINT;\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,yBAAsD;AACtD,QAAmB;AAEnB,wBAAwB;AAIjB,MAAM,cAAc,EAAE;AAAA,EAC3B,EAAE,QAAQ,aAAa;AAAA,EACvB,EAAE,QAAQ,SAAS;AACrB;AAEO,MAAM,gBAAgB,CAAC,eAAe,SAAS;AAEtD,MAAM,sBAAsB;AAE5B,IAAI;AAEG,MAAM,mBAAmB,YAA4C;AAC1E,MAAI,kBAAkB,QAAW;AAC/B,WAAO;AAAA,EACT;AAEA,QAAM,SAAS,UAAM,mBAAAA,SAAU,EAAE,KAAK,UAAU,CAAC;AAEjD,MAAI,WAAW,QAAW;AACxB,UAAM,MAAM,uCAAuC;AAAA,EACrD;AAEA,SAAQ,gBAAgB,OAAO;AACjC;AAEO,MAAM,sBAAsB,UAAM,mBAAAA,SAAU;AAE5C,MAAM,8BAA8B,OAIzC,SAC2B;AAC3B,QAAM,SAAS,MAAM,oBAAoB;AAEzC,SAAO,WAAW,cAAa,2BAAc,OAAO,YAAY,OAAO,IAAI,IACvE,OAAO,YAAY,MAAM,IAAI,IAC7B;AACN;AAEO,MAAM,oCAAoC,OAC/C,SACgC;AAChC,QAAM,SAAS,MAAM,4BAA4B,IAAI;AAErD,SAAO,OAAO,WAAW,WAAW,SAAS;AAC/C;AAEO,MAAM,4BAA4B,YAA6B;AACpE,QAAM,aAAa,MAAM,kCAAkC,YAAY;AAEvE,SAAO,cAAc;AACvB;",
+  "sourcesContent": ["import readPkgUp, { type NormalizedPackageJson } from 'read-pkg-up';\nimport { z } from 'zod';\n\nimport { hasProp } from './validation';\n\nexport type ProjectType = z.infer<typeof projectTypeSchema>;\n\nexport const projectTypeSchema = z.union([\n  z.literal('application'),\n  z.literal('package'),\n]);\n\nexport const PROJECT_TYPES = ['application', 'package'] as const;\n\nconst DEFAULT_ENTRY_POINT = 'src/app.ts';\n\nlet skubaManifest: NormalizedPackageJson | undefined;\n\nexport const getSkubaManifest = async (): Promise<NormalizedPackageJson> => {\n  if (skubaManifest !== undefined) {\n    return skubaManifest;\n  }\n\n  const result = await readPkgUp({ cwd: __dirname });\n\n  if (result === undefined) {\n    throw Error('skuba could not find its own manifest');\n  }\n\n  return (skubaManifest = result.packageJson);\n};\n\nexport const getConsumerManifest = () => readPkgUp();\n\nexport const getPropFromConsumerManifest = async <\n  T extends string,\n  V = unknown,\n>(\n  prop: T,\n): Promise<V | undefined> => {\n  const result = await getConsumerManifest();\n\n  return result !== undefined && hasProp<T, V>(result.packageJson.skuba, prop)\n    ? result.packageJson.skuba[prop]\n    : undefined;\n};\n\nexport const getStringPropFromConsumerManifest = async <T extends string>(\n  prop: T,\n): Promise<string | undefined> => {\n  const result = await getPropFromConsumerManifest(prop);\n\n  return typeof result === 'string' ? result : undefined;\n};\n\nexport const getEntryPointFromManifest = async (): Promise<string> => {\n  const entryPoint = await getStringPropFromConsumerManifest('entryPoint');\n\n  return entryPoint ?? DEFAULT_ENTRY_POINT;\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,yBAAsD;AACtD,iBAAkB;AAElB,wBAAwB;AAIjB,MAAM,oBAAoB,aAAE,MAAM;AAAA,EACvC,aAAE,QAAQ,aAAa;AAAA,EACvB,aAAE,QAAQ,SAAS;AACrB,CAAC;AAEM,MAAM,gBAAgB,CAAC,eAAe,SAAS;AAEtD,MAAM,sBAAsB;AAE5B,IAAI;AAEG,MAAM,mBAAmB,YAA4C;AAC1E,MAAI,kBAAkB,QAAW;AAC/B,WAAO;AAAA,EACT;AAEA,QAAM,SAAS,UAAM,mBAAAA,SAAU,EAAE,KAAK,UAAU,CAAC;AAEjD,MAAI,WAAW,QAAW;AACxB,UAAM,MAAM,uCAAuC;AAAA,EACrD;AAEA,SAAQ,gBAAgB,OAAO;AACjC;AAEO,MAAM,sBAAsB,UAAM,mBAAAA,SAAU;AAE5C,MAAM,8BAA8B,OAIzC,SAC2B;AAC3B,QAAM,SAAS,MAAM,oBAAoB;AAEzC,SAAO,WAAW,cAAa,2BAAc,OAAO,YAAY,OAAO,IAAI,IACvE,OAAO,YAAY,MAAM,IAAI,IAC7B;AACN;AAEO,MAAM,oCAAoC,OAC/C,SACgC;AAChC,QAAM,SAAS,MAAM,4BAA4B,IAAI;AAErD,SAAO,OAAO,WAAW,WAAW,SAAS;AAC/C;AAEO,MAAM,4BAA4B,YAA6B;AACpE,QAAM,aAAa,MAAM,kCAAkC,YAAY;AAEvE,SAAO,cAAc;AACvB;",
   "names": ["readPkgUp"]
 }

package/lib/utils/template.d.ts

@@ -1,4 +1,4 @@
-import * as t from 'runtypes';
+import { z } from 'zod';
 export declare const TEMPLATE_NAMES: readonly ["express-rest-api", "greeter", "koa-rest-api", "lambda-sqs-worker", "lambda-sqs-worker-cdk", "oss-npm-package", "private-npm-package"];
 export type TemplateName = (typeof TEMPLATE_NAMES)[number];
 export declare const TEMPLATE_NAMES_WITH_BYO: readonly ["express-rest-api", "greeter", "koa-rest-api", "lambda-sqs-worker", "lambda-sqs-worker-cdk", "oss-npm-package", "private-npm-package", "github →"];
@@ -17,18 +17,48 @@ interface TemplateDocumentationConfig {
     filename: string;
 }
 export declare const TEMPLATE_DOCUMENTATION_CONFIG: Record<TemplateName, TemplateDocumentationConfig>;
-export type TemplateConfig = t.Static<typeof TemplateConfig>;
-export declare const TemplateConfig: t.Record<{
-    fields: t.Array<t.Record<{
-        name: t.String;
-        message: t.String;
-        initial: t.String;
-        validate: t.Optional<t.Function>;
-    }, false>, false>;
-    entryPoint: t.Optional<t.String>;
-    noSkip: t.Optional<t.Boolean>;
-    type: t.Optional<t.Union<[t.Literal<"application">, t.Literal<"package">]>>;
-}, false>;
+export type TemplateConfig = z.infer<typeof templateConfigSchema>;
+export declare const templateConfigSchema: z.ZodObject<{
+    fields: z.ZodArray<z.ZodObject<{
+        name: z.ZodString;
+        message: z.ZodString;
+        initial: z.ZodString;
+        validate: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodString], null>, z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        name: string;
+        initial: string;
+        validate?: ((args_0: string) => boolean) | undefined;
+    }, {
+        message: string;
+        name: string;
+        initial: string;
+        validate?: ((args_0: string) => boolean) | undefined;
+    }>, "many">;
+    entryPoint: z.ZodOptional<z.ZodString>;
+    noSkip: z.ZodOptional<z.ZodBoolean>;
+    type: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"application">, z.ZodLiteral<"package">]>>;
+}, "strip", z.ZodTypeAny, {
+    fields: {
+        message: string;
+        name: string;
+        initial: string;
+        validate?: ((args_0: string) => boolean) | undefined;
+    }[];
+    entryPoint?: string | undefined;
+    noSkip?: boolean | undefined;
+    type?: "package" | "application" | undefined;
+}, {
+    fields: {
+        message: string;
+        name: string;
+        initial: string;
+        validate?: ((args_0: string) => boolean) | undefined;
+    }[];
+    entryPoint?: string | undefined;
+    noSkip?: boolean | undefined;
+    type?: "package" | "application" | undefined;
+}>;
 export declare const TEMPLATE_CONFIG_FILENAME = "skuba.template.js";
 export declare const TEMPLATE_DIR: string;
 export declare const BASE_TEMPLATE_DIR: string;

package/lib/utils/template.js

@@ -34,14 +34,14 @@ __export(template_exports, {
   TEMPLATE_DOCUMENTATION_CONFIG: () => TEMPLATE_DOCUMENTATION_CONFIG,
   TEMPLATE_NAMES: () => TEMPLATE_NAMES,
   TEMPLATE_NAMES_WITH_BYO: () => TEMPLATE_NAMES_WITH_BYO,
-  TemplateConfig: () => TemplateConfig,
   ensureTemplateConfigDeletion: () => ensureTemplateConfigDeletion,
-  readBaseTemplateFile: () => readBaseTemplateFile
+  readBaseTemplateFile: () => readBaseTemplateFile,
+  templateConfigSchema: () => templateConfigSchema
 });
 module.exports = __toCommonJS(template_exports);
 var import_path = __toESM(require("path"));
 var import_fs_extra = __toESM(require("fs-extra"));
-var t = __toESM(require("runtypes"));
+var import_zod = require("zod");
 var import_manifest = require("./manifest");
 const TEMPLATE_NAMES = [
   "express-rest-api",
@@ -83,18 +83,18 @@ const TEMPLATE_DOCUMENTATION_CONFIG = {
     filename: "package.md"
   }
 };
-const TemplateConfig = t.Record({
-  fields: t.Array(
-    t.Record({
-      name: t.String,
-      message: t.String,
-      initial: t.String,
-      validate: t.Function.optional()
+const templateConfigSchema = import_zod.z.object({
+  fields: import_zod.z.array(
+    import_zod.z.object({
+      name: import_zod.z.string(),
+      message: import_zod.z.string(),
+      initial: import_zod.z.string(),
+      validate: import_zod.z.function(import_zod.z.tuple([import_zod.z.string()]), import_zod.z.boolean()).optional()
     })
   ),
-  entryPoint: t.String.optional(),
-  noSkip: t.Boolean.optional(),
-  type: import_manifest.ProjectType.optional()
+  entryPoint: import_zod.z.string().optional(),
+  noSkip: import_zod.z.boolean().optional(),
+  type: import_manifest.projectTypeSchema.optional()
 });
 const TEMPLATE_CONFIG_FILENAME = "skuba.template.js";
 const TEMPLATE_DIR = import_path.default.join(__dirname, "..", "..", "template");
@@ -109,8 +109,8 @@ const readBaseTemplateFile = (src) => import_fs_extra.default.promises.readFile(
   TEMPLATE_DOCUMENTATION_CONFIG,
   TEMPLATE_NAMES,
   TEMPLATE_NAMES_WITH_BYO,
-  TemplateConfig,
   ensureTemplateConfigDeletion,
-  readBaseTemplateFile
+  readBaseTemplateFile,
+  templateConfigSchema
 });
 //# sourceMappingURL=template.js.map

package/lib/utils/template.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/utils/template.ts"],
-  "sourcesContent": ["/* eslint-disable new-cap */\n\nimport path from 'path';\n\nimport fs from 'fs-extra';\nimport * as t from 'runtypes';\n\nimport { ProjectType } from './manifest';\n\nexport const TEMPLATE_NAMES = [\n  'express-rest-api',\n  'greeter',\n  'koa-rest-api',\n  'lambda-sqs-worker',\n  'lambda-sqs-worker-cdk',\n  'oss-npm-package',\n  'private-npm-package',\n] as const;\n\nexport type TemplateName = (typeof TEMPLATE_NAMES)[number];\n\nexport const TEMPLATE_NAMES_WITH_BYO = [...TEMPLATE_NAMES, 'github \u2192'] as const;\n\ninterface TemplateDocumentationConfig {\n  /**\n   * The semantic version in which the template was first added.\n   *\n   * This is used to filter out historical changelogs.\n   */\n  added: string;\n\n  /**\n   * The Markdown file for the template in our `/docs`.\n   *\n   * This is used to compile per-template changelogs for our documentation site.\n   */\n  filename: string;\n}\n\nexport const TEMPLATE_DOCUMENTATION_CONFIG: Record<\n  TemplateName,\n  TemplateDocumentationConfig\n> = {\n  'express-rest-api': {\n    added: '3.8.0',\n    filename: 'api.md',\n  },\n  greeter: {\n    added: '3.4.1',\n    filename: 'barebones.md',\n  },\n  'koa-rest-api': {\n    added: '3.4.1',\n    filename: 'api.md',\n  },\n  'lambda-sqs-worker': {\n    added: '3.4.1',\n    filename: 'worker.md',\n  },\n  'lambda-sqs-worker-cdk': {\n    added: '3.13.0',\n    filename: 'worker.md',\n  },\n  'oss-npm-package': {\n    added: '3.7.0',\n    filename: 'package.md',\n  },\n  'private-npm-package': {\n    added: '3.6.0',\n    filename: 'package.md',\n  },\n};\n\nexport type TemplateConfig = t.Static<typeof TemplateConfig>;\n\nexport const TemplateConfig = t.Record({\n  fields: t.Array(\n    t.Record({\n      name: t.String,\n      message: t.String,\n      initial: t.String,\n      validate: t.Function.optional(),\n    }),\n  ),\n  entryPoint: t.String.optional(),\n  noSkip: t.Boolean.optional(),\n  type: ProjectType.optional(),\n});\n\nexport const TEMPLATE_CONFIG_FILENAME = 'skuba.template.js';\n\nexport const TEMPLATE_DIR = path.join(__dirname, '..', '..', 'template');\n\nexport const BASE_TEMPLATE_DIR = path.join(TEMPLATE_DIR, 'base');\n\nexport const ensureTemplateConfigDeletion = (dir: string): Promise<void> =>\n  fs.promises.rm(path.join(dir, TEMPLATE_CONFIG_FILENAME));\n\nexport const readBaseTemplateFile = (src: string): Promise<string> =>\n  fs.promises.readFile(path.join(BASE_TEMPLATE_DIR, src), 'utf8');\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,kBAAiB;AAEjB,sBAAe;AACf,QAAmB;AAEnB,sBAA4B;AAErB,MAAM,iBAAiB;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAIO,MAAM,0BAA0B,CAAC,GAAG,gBAAgB,eAAU;AAkB9D,MAAM,gCAGT;AAAA,EACF,oBAAoB;AAAA,IAClB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,SAAS;AAAA,IACP,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,gBAAgB;AAAA,IACd,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,qBAAqB;AAAA,IACnB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,yBAAyB;AAAA,IACvB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,mBAAmB;AAAA,IACjB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,uBAAuB;AAAA,IACrB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AACF;AAIO,MAAM,iBAAiB,EAAE,OAAO;AAAA,EACrC,QAAQ,EAAE;AAAA,IACR,EAAE,OAAO;AAAA,MACP,MAAM,EAAE;AAAA,MACR,SAAS,EAAE;AAAA,MACX,SAAS,EAAE;AAAA,MACX,UAAU,EAAE,SAAS,SAAS;AAAA,IAChC,CAAC;AAAA,EACH;AAAA,EACA,YAAY,EAAE,OAAO,SAAS;AAAA,EAC9B,QAAQ,EAAE,QAAQ,SAAS;AAAA,EAC3B,MAAM,4BAAY,SAAS;AAC7B,CAAC;AAEM,MAAM,2BAA2B;AAEjC,MAAM,eAAe,YAAAA,QAAK,KAAK,WAAW,MAAM,MAAM,UAAU;AAEhE,MAAM,oBAAoB,YAAAA,QAAK,KAAK,cAAc,MAAM;AAExD,MAAM,+BAA+B,CAAC,QAC3C,gBAAAC,QAAG,SAAS,GAAG,YAAAD,QAAK,KAAK,KAAK,wBAAwB,CAAC;AAElD,MAAM,uBAAuB,CAAC,QACnC,gBAAAC,QAAG,SAAS,SAAS,YAAAD,QAAK,KAAK,mBAAmB,GAAG,GAAG,MAAM;",
+  "sourcesContent": ["import path from 'path';\n\nimport fs from 'fs-extra';\nimport { z } from 'zod';\n\nimport { projectTypeSchema } from './manifest';\n\nexport const TEMPLATE_NAMES = [\n  'express-rest-api',\n  'greeter',\n  'koa-rest-api',\n  'lambda-sqs-worker',\n  'lambda-sqs-worker-cdk',\n  'oss-npm-package',\n  'private-npm-package',\n] as const;\n\nexport type TemplateName = (typeof TEMPLATE_NAMES)[number];\n\nexport const TEMPLATE_NAMES_WITH_BYO = [...TEMPLATE_NAMES, 'github \u2192'] as const;\n\ninterface TemplateDocumentationConfig {\n  /**\n   * The semantic version in which the template was first added.\n   *\n   * This is used to filter out historical changelogs.\n   */\n  added: string;\n\n  /**\n   * The Markdown file for the template in our `/docs`.\n   *\n   * This is used to compile per-template changelogs for our documentation site.\n   */\n  filename: string;\n}\n\nexport const TEMPLATE_DOCUMENTATION_CONFIG: Record<\n  TemplateName,\n  TemplateDocumentationConfig\n> = {\n  'express-rest-api': {\n    added: '3.8.0',\n    filename: 'api.md',\n  },\n  greeter: {\n    added: '3.4.1',\n    filename: 'barebones.md',\n  },\n  'koa-rest-api': {\n    added: '3.4.1',\n    filename: 'api.md',\n  },\n  'lambda-sqs-worker': {\n    added: '3.4.1',\n    filename: 'worker.md',\n  },\n  'lambda-sqs-worker-cdk': {\n    added: '3.13.0',\n    filename: 'worker.md',\n  },\n  'oss-npm-package': {\n    added: '3.7.0',\n    filename: 'package.md',\n  },\n  'private-npm-package': {\n    added: '3.6.0',\n    filename: 'package.md',\n  },\n};\n\nexport type TemplateConfig = z.infer<typeof templateConfigSchema>;\n\nexport const templateConfigSchema = z.object({\n  fields: z.array(\n    z.object({\n      name: z.string(),\n      message: z.string(),\n      initial: z.string(),\n      validate: z.function(z.tuple([z.string()]), z.boolean()).optional(),\n    }),\n  ),\n  entryPoint: z.string().optional(),\n  noSkip: z.boolean().optional(),\n  type: projectTypeSchema.optional(),\n});\n\nexport const TEMPLATE_CONFIG_FILENAME = 'skuba.template.js';\n\nexport const TEMPLATE_DIR = path.join(__dirname, '..', '..', 'template');\n\nexport const BASE_TEMPLATE_DIR = path.join(TEMPLATE_DIR, 'base');\n\nexport const ensureTemplateConfigDeletion = (dir: string): Promise<void> =>\n  fs.promises.rm(path.join(dir, TEMPLATE_CONFIG_FILENAME));\n\nexport const readBaseTemplateFile = (src: string): Promise<string> =>\n  fs.promises.readFile(path.join(BASE_TEMPLATE_DIR, src), 'utf8');\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AAEjB,sBAAe;AACf,iBAAkB;AAElB,sBAAkC;AAE3B,MAAM,iBAAiB;AAAA,EAC5B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;AAIO,MAAM,0BAA0B,CAAC,GAAG,gBAAgB,eAAU;AAkB9D,MAAM,gCAGT;AAAA,EACF,oBAAoB;AAAA,IAClB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,SAAS;AAAA,IACP,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,gBAAgB;AAAA,IACd,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,qBAAqB;AAAA,IACnB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,yBAAyB;AAAA,IACvB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,mBAAmB;AAAA,IACjB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,uBAAuB;AAAA,IACrB,OAAO;AAAA,IACP,UAAU;AAAA,EACZ;AACF;AAIO,MAAM,uBAAuB,aAAE,OAAO;AAAA,EAC3C,QAAQ,aAAE;AAAA,IACR,aAAE,OAAO;AAAA,MACP,MAAM,aAAE,OAAO;AAAA,MACf,SAAS,aAAE,OAAO;AAAA,MAClB,SAAS,aAAE,OAAO;AAAA,MAClB,UAAU,aAAE,SAAS,aAAE,MAAM,CAAC,aAAE,OAAO,CAAC,CAAC,GAAG,aAAE,QAAQ,CAAC,EAAE,SAAS;AAAA,IACpE,CAAC;AAAA,EACH;AAAA,EACA,YAAY,aAAE,OAAO,EAAE,SAAS;AAAA,EAChC,QAAQ,aAAE,QAAQ,EAAE,SAAS;AAAA,EAC7B,MAAM,kCAAkB,SAAS;AACnC,CAAC;AAEM,MAAM,2BAA2B;AAEjC,MAAM,eAAe,YAAAA,QAAK,KAAK,WAAW,MAAM,MAAM,UAAU;AAEhE,MAAM,oBAAoB,YAAAA,QAAK,KAAK,cAAc,MAAM;AAExD,MAAM,+BAA+B,CAAC,QAC3C,gBAAAC,QAAG,SAAS,GAAG,YAAAD,QAAK,KAAK,KAAK,wBAAwB,CAAC;AAElD,MAAM,uBAAuB,CAAC,QACnC,gBAAAC,QAAG,SAAS,SAAS,YAAAD,QAAK,KAAK,mBAAmB,GAAG,GAAG,MAAM;",
   "names": ["path", "fs"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skuba",
-  "version": "7.1.1",
+  "version": "7.3.0",
   "private": false,
   "description": "SEEK development toolkit for backend applications and packages",
   "homepage": "https://github.com/seek-oss/skuba#readme",
@@ -36,11 +36,11 @@
     "release": "yarn build && changeset publish",
     "skuba": "yarn build && node lib/skuba",
     "stage": "changeset version && yarn format",
-    "test": "yarn skuba test",
-    "test:ci": "yarn skuba test --config jest.config.int.ts --runInBand",
-    "test:int": "yarn skuba test --config jest.config.int.ts --runInBand",
+    "test": "yarn skuba test --selectProjects unit",
+    "test:ci": "yarn skuba test --runInBand",
+    "test:int": "yarn skuba test --selectProjects integration --runInBand",
     "test:template": "scripts/test-template.sh",
-    "test:watch": "yarn skuba test --config jest.config.int.ts --runInBand --watch"
+    "test:watch": "yarn skuba test --runInBand --watch"
   },
   "remarkConfig": {
     "plugins": [
@@ -73,7 +73,7 @@
     "@octokit/graphql": "^7.0.0",
     "@octokit/graphql-schema": "^14.5.0",
     "@octokit/rest": "^20.0.0",
-    "@octokit/types": "^11.0.0",
+    "@octokit/types": "^12.0.0",
     "@types/jest": "^29.0.0",
     "@types/node": ">=18.12",
     "chalk": "^4.1.0",
@@ -83,7 +83,7 @@
     "enquirer": "^2.3.6",
     "esbuild": "~0.19.0",
     "eslint": "^8.11.0",
-    "eslint-config-skuba": "3.0.2",
+    "eslint-config-skuba": "3.0.3",
     "execa": "^5.0.0",
     "fdir": "^6.0.0",
     "fs-extra": "^11.0.0",
@@ -95,20 +95,19 @@
     "isomorphic-git": "^1.11.1",
     "jest": "^29.0.1",
     "jest-watch-typeahead": "^2.1.1",
-    "libnpmsearch": "^6.0.0",
+    "libnpmsearch": "^7.0.0",
     "lodash.mergewith": "^4.6.2",
     "minimist": "^1.2.6",
-    "normalize-package-data": "^5.0.0",
+    "normalize-package-data": "^6.0.0",
     "npm-run-path": "^4.0.1",
     "npm-which": "^3.0.1",
     "picomatch": "^2.2.2",
-    "prettier": "~3.0.0",
+    "prettier": "~3.0.3",
+    "prettier-plugin-packagejson": "^2.4.6",
     "read-pkg-up": "^7.0.1",
-    "runtypes": "^6.0.0",
     "semantic-release": "^21.0.0",
     "serialize-error": "^8.0.1",
     "simple-git": "^3.5.0",
-    "sort-package-json": "^1.57.0",
     "strip-ansi": "^6.0.1",
     "ts-dedent": "^2.2.0",
     "ts-jest": "^29.1.0",
@@ -116,31 +115,32 @@
     "ts-node-dev": "^2.0.0",
     "tsconfig-paths": "^4.0.0",
     "tsconfig-seek": "2.0.0",
-    "typescript": "~5.1.5",
-    "validate-npm-package-name": "^5.0.0"
+    "typescript": "~5.2.0",
+    "validate-npm-package-name": "^5.0.0",
+    "zod": "^3.22.4"
   },
   "devDependencies": {
     "@changesets/cli": "2.26.2",
     "@changesets/get-github-info": "0.5.2",
-    "@jest/reporters": "29.6.2",
-    "@types/ejs": "3.1.2",
-    "@types/express": "4.17.17",
-    "@types/fs-extra": "11.0.1",
-    "@types/koa": "2.13.8",
-    "@types/libnpmsearch": "2.0.3",
-    "@types/lodash.mergewith": "4.6.7",
-    "@types/module-alias": "2.0.2",
-    "@types/npm-which": "3.0.1",
-    "@types/picomatch": "2.3.0",
-    "@types/supertest": "2.0.12",
-    "@types/validate-npm-package-name": "4.0.0",
+    "@jest/reporters": "29.7.0",
+    "@types/ejs": "3.1.4",
+    "@types/express": "4.17.20",
+    "@types/fs-extra": "11.0.3",
+    "@types/koa": "2.13.10",
+    "@types/libnpmsearch": "2.0.5",
+    "@types/lodash.mergewith": "4.6.8",
+    "@types/module-alias": "2.0.3",
+    "@types/npm-which": "3.0.2",
+    "@types/picomatch": "2.3.2",
+    "@types/supertest": "2.0.15",
+    "@types/validate-npm-package-name": "4.0.1",
     "enhanced-resolve": "5.15.0",
     "express": "4.18.2",
-    "fastify": "4.21.0",
+    "fastify": "4.24.3",
     "jsonfile": "6.1.0",
     "koa": "2.14.2",
-    "memfs": "4.2.1",
-    "remark-cli": "11.0.0",
+    "memfs": "4.6.0",
+    "remark-cli": "12.0.0",
     "remark-preset-lint-recommended": "6.1.3",
     "semver": "7.5.4",
     "supertest": "6.3.3",

package/template/express-rest-api/.buildkite/pipeline.yml

@@ -9,16 +9,17 @@ configs:
           NPM_READ_TOKEN: arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token
 
     - &docker-ecr-cache
-      seek-oss/docker-ecr-cache#v2.0.0:
+      seek-oss/docker-ecr-cache#v2.1.0: &docker-ecr-cache-defaults
         cache-on:
           - package.json
           - yarn.lock
         dockerfile: Dockerfile.dev-deps
-        secrets: id=npm,src=.npmrc
+        secrets: id=npm,src=tmp/.npmrc
 
     - &private-npm
       seek-oss/private-npm#v1.2.0:
         env: NPM_READ_TOKEN
+        output-path: tmp/
 
   base-steps:
     - &deploy
@@ -36,7 +37,9 @@ steps:
     plugins:
       - *aws-sm
       - *private-npm
-      - *docker-ecr-cache
+      - seek-oss/docker-ecr-cache#v2.1.0:
+          <<: *docker-ecr-cache-defaults
+          skip-pull-from-cache: true
 
   - label: 🧪 Test & Lint
     commands:
@@ -51,7 +54,7 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
     timeout_in_minutes: 10
 

package/template/express-rest-api/Dockerfile.dev-deps

@@ -7,5 +7,5 @@ WORKDIR /workdir
 COPY package.json yarn.lock ./
 
 RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  --mount=type=secret,id=npm,dst=/root/.npmrc \
   yarn install --frozen-lockfile --ignore-optional --non-interactive

package/template/express-rest-api/README.md

@@ -19,12 +19,12 @@ Next steps:
 6. [ ] Configure [GitHub repository settings].
 7. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
+[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
 [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 
-<%-repoName %> is a Node.js HTTP server built in line with our [technology strategy].
+<%-repoName %> is a Node.js HTTP server built in line with our [Technical Guidelines].
 It uses the [Express] middleware framework and common SEEK packages.
 Resource APIs enable synchronous interactions and serve as the backbone of SEEK's general service architecture.
 
@@ -100,7 +100,7 @@ TODO: add support links for the prod environment.
 - Splunk logs
 -->
 
-[codedeploy]: https://docs.aws.amazon.com/codedeploy
-[express]: https://expressjs.com
-[gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
-[technology strategy]: https://tech-strategy.ssod.skinfra.xyz
+[CodeDeploy]: https://docs.aws.amazon.com/codedeploy
+[Express]: https://expressjs.com
+[Gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
+[Technical Guidelines]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346017/

package/template/greeter/.buildkite/pipeline.yml

@@ -9,15 +9,16 @@ configs:
           NPM_READ_TOKEN: arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token
 
     - &docker-ecr-cache
-      seek-oss/docker-ecr-cache#v2.0.0:
+      seek-oss/docker-ecr-cache#v2.1.0:
         cache-on:
           - package.json
           - yarn.lock
-        secrets: id=npm,src=.npmrc
+        secrets: id=npm,src=tmp/.npmrc
 
     - &private-npm
       seek-oss/private-npm#v1.2.0:
         env: NPM_READ_TOKEN
+        output-path: tmp/
 
 steps:
   - label: 🧪 Test & Lint
@@ -32,6 +33,6 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
     timeout_in_minutes: 10

package/template/greeter/Dockerfile

@@ -7,5 +7,5 @@ WORKDIR /workdir
 COPY package.json yarn.lock ./
 
 RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
+  --mount=type=secret,id=npm,dst=/root/.npmrc \
   yarn install --frozen-lockfile --ignore-optional --non-interactive

package/template/greeter/README.md

@@ -17,13 +17,13 @@ Next steps:
 5. [ ] Configure [GitHub repository settings].
 6. [ ] Delete this checklist 😌.
 
-[builds at seek]: https://builds-at-seek.ssod.skinfra.xyz
+[builds at seek]: https://backstage.myseek.xyz/docs/default/component/builds-cicd-seek/
 [github repository settings]: https://github.com/<%-orgName%>/<%-repoName%>/settings
 
 ## Design
 
 The `greeter` template is the prototypical _hello world_ project.
-It can function as a playground for the TypeScript tooling prescribed by our [technology strategy],
+It can function as a playground for the TypeScript tooling prescribed by our [Technical Guidelines],
 or serve as a starting point for a backend project if the other built-in templates are not a good fit.
 
 It's a barebones Node.js application that comprises:
@@ -93,4 +93,4 @@ TODO: add support links for the prod environment.
 - Splunk logs
 -->
 
-[technology strategy]: https://tech-strategy.ssod.skinfra.xyz
+[Technical Guidelines]: https://myseek.atlassian.net/wiki/spaces/AA/pages/2358346017/