skuba 0.0.0-master-20231002013336 → 0.0.0-master-20240206001217

package/lib/utils/packageManager.js

@@ -0,0 +1,97 @@
+"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)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  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 packageManager_exports = {};
+__export(packageManager_exports, {
+  DEFAULT_PACKAGE_MANAGER: () => DEFAULT_PACKAGE_MANAGER,
+  configForPackageManager: () => configForPackageManager,
+  detectPackageManager: () => detectPackageManager,
+  packageManagerSchema: () => packageManagerSchema
+});
+module.exports = __toCommonJS(packageManager_exports);
+var import_detect_package_manager = require("detect-package-manager");
+var import_is_installed_globally = __toESM(require("is-installed-globally"));
+var import_zod = require("zod");
+var import_logging = require("./logging");
+const DEFAULT_PACKAGE_MANAGER = "yarn";
+const PACKAGE_MANAGERS = {
+  pnpm: {
+    exec: "pnpm exec",
+    install: "pnpm install",
+    runSilent: "pnpm --silent run",
+    update: import_is_installed_globally.default ? "pnpm update --global" : "pnpm update"
+  },
+  yarn: {
+    exec: "yarn",
+    install: "yarn install",
+    runSilent: "yarn -s",
+    update: import_is_installed_globally.default ? "yarn global upgrade" : "yarn upgrade"
+  }
+};
+const configForPackageManager = (packageManager) => ({
+  ...PACKAGE_MANAGERS[packageManager],
+  command: packageManager
+});
+const detectPackageManager = async (cwd) => {
+  let packageManager = DEFAULT_PACKAGE_MANAGER;
+  let raw;
+  try {
+    raw = await (0, import_detect_package_manager.detect)({ cwd, includeGlobalBun: false });
+    packageManager = packageManagerSchema.parse(raw);
+  } catch (err) {
+    import_logging.log.warn(
+      `Failed to detect package manager; defaulting to ${import_logging.log.bold(
+        DEFAULT_PACKAGE_MANAGER
+      )}.`
+    );
+    import_logging.log.subtle(
+      (() => {
+        switch (true) {
+          case err instanceof import_zod.ZodError:
+            return `Expected ${Object.keys(PACKAGE_MANAGERS).join(
+              "|"
+            )}, received ${raw}`;
+          case err instanceof Error:
+            return err.message;
+          default:
+            return String(err);
+        }
+      })()
+    );
+  }
+  return configForPackageManager(packageManager);
+};
+const packageManagerSchema = import_zod.z.enum(["pnpm", "yarn"]).default(DEFAULT_PACKAGE_MANAGER);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DEFAULT_PACKAGE_MANAGER,
+  configForPackageManager,
+  detectPackageManager,
+  packageManagerSchema
+});
+//# sourceMappingURL=packageManager.js.map

package/lib/utils/packageManager.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/utils/packageManager.ts"],
+  "sourcesContent": ["import { detect } from 'detect-package-manager';\nimport isInstalledGlobally from 'is-installed-globally';\nimport { ZodError, z } from 'zod';\n\nimport { log } from './logging';\n\n// TODO: consider changing to this to `pnpm` in a future major version.\nexport const DEFAULT_PACKAGE_MANAGER = 'yarn';\n\nexport type PackageManagerConfig =\n  (typeof PACKAGE_MANAGERS)[keyof typeof PACKAGE_MANAGERS] & {\n    command: PackageManager;\n  };\n\nconst PACKAGE_MANAGERS = {\n  pnpm: {\n    exec: 'pnpm exec',\n    install: 'pnpm install',\n    runSilent: 'pnpm --silent run',\n    update: isInstalledGlobally ? 'pnpm update --global' : 'pnpm update',\n  },\n  yarn: {\n    exec: 'yarn',\n    install: 'yarn install',\n    runSilent: 'yarn -s',\n    update: isInstalledGlobally ? 'yarn global upgrade' : 'yarn upgrade',\n  },\n};\n\nexport const configForPackageManager = (\n  packageManager: PackageManager,\n): PackageManagerConfig => ({\n  ...PACKAGE_MANAGERS[packageManager],\n  command: packageManager,\n});\n\nexport const detectPackageManager = async (\n  cwd?: string,\n): Promise<PackageManagerConfig> => {\n  let packageManager: PackageManager = DEFAULT_PACKAGE_MANAGER;\n\n  let raw: string | undefined;\n  try {\n    raw = await detect({ cwd, includeGlobalBun: false });\n\n    packageManager = packageManagerSchema.parse(raw);\n  } catch (err) {\n    log.warn(\n      `Failed to detect package manager; defaulting to ${log.bold(\n        DEFAULT_PACKAGE_MANAGER,\n      )}.`,\n    );\n    log.subtle(\n      (() => {\n        switch (true) {\n          case err instanceof ZodError:\n            return `Expected ${Object.keys(PACKAGE_MANAGERS).join(\n              '|',\n            )}, received ${raw}`;\n\n          case err instanceof Error:\n            return err.message;\n\n          default:\n            return String(err);\n        }\n      })(),\n    );\n  }\n\n  return configForPackageManager(packageManager);\n};\n\nexport type PackageManager = z.infer<typeof packageManagerSchema>;\n\nexport const packageManagerSchema = z\n  .enum(['pnpm', 'yarn'])\n  .default(DEFAULT_PACKAGE_MANAGER);\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oCAAuB;AACvB,mCAAgC;AAChC,iBAA4B;AAE5B,qBAAoB;AAGb,MAAM,0BAA0B;AAOvC,MAAM,mBAAmB;AAAA,EACvB,MAAM;AAAA,IACJ,MAAM;AAAA,IACN,SAAS;AAAA,IACT,WAAW;AAAA,IACX,QAAQ,6BAAAA,UAAsB,yBAAyB;AAAA,EACzD;AAAA,EACA,MAAM;AAAA,IACJ,MAAM;AAAA,IACN,SAAS;AAAA,IACT,WAAW;AAAA,IACX,QAAQ,6BAAAA,UAAsB,wBAAwB;AAAA,EACxD;AACF;AAEO,MAAM,0BAA0B,CACrC,oBAC0B;AAAA,EAC1B,GAAG,iBAAiB,cAAc;AAAA,EAClC,SAAS;AACX;AAEO,MAAM,uBAAuB,OAClC,QACkC;AAClC,MAAI,iBAAiC;AAErC,MAAI;AACJ,MAAI;AACF,UAAM,UAAM,sCAAO,EAAE,KAAK,kBAAkB,MAAM,CAAC;AAEnD,qBAAiB,qBAAqB,MAAM,GAAG;AAAA,EACjD,SAAS,KAAK;AACZ,uBAAI;AAAA,MACF,mDAAmD,mBAAI;AAAA,QACrD;AAAA,MACF,CAAC;AAAA,IACH;AACA,uBAAI;AAAA,OACD,MAAM;AACL,gBAAQ,MAAM;AAAA,UACZ,KAAK,eAAe;AAClB,mBAAO,YAAY,OAAO,KAAK,gBAAgB,EAAE;AAAA,cAC/C;AAAA,YACF,CAAC,cAAc,GAAG;AAAA,UAEpB,KAAK,eAAe;AAClB,mBAAO,IAAI;AAAA,UAEb;AACE,mBAAO,OAAO,GAAG;AAAA,QACrB;AAAA,MACF,GAAG;AAAA,IACL;AAAA,EACF;AAEA,SAAO,wBAAwB,cAAc;AAC/C;AAIO,MAAM,uBAAuB,aACjC,KAAK,CAAC,QAAQ,MAAM,CAAC,EACrB,QAAQ,uBAAuB;",
+  "names": ["isInstalledGlobally"]
+}

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,51 @@ 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], z.ZodUnknown>, z.ZodUnion<[z.ZodBoolean, z.ZodString]>>>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        name: string;
+        initial: string;
+        validate?: ((args_0: string, ...args_1: unknown[]) => string | boolean) | undefined;
+    }, {
+        message: string;
+        name: string;
+        initial: string;
+        validate?: ((args_0: string, ...args_1: unknown[]) => string | boolean) | undefined;
+    }>, "many">;
+    entryPoint: z.ZodOptional<z.ZodString>;
+    noSkip: z.ZodOptional<z.ZodBoolean>;
+    packageManager: z.ZodDefault<z.ZodEnum<["pnpm", "yarn"]>>;
+    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, ...args_1: unknown[]) => string | boolean) | undefined;
+    }[];
+    packageManager: "yarn" | "pnpm";
+    entryPoint?: string | undefined;
+    noSkip?: boolean | undefined;
+    type?: "package" | "application" | undefined;
+}, {
+    fields: {
+        message: string;
+        name: string;
+        initial: string;
+        validate?: ((args_0: string, ...args_1: unknown[]) => string | boolean) | undefined;
+    }[];
+    entryPoint?: string | undefined;
+    noSkip?: boolean | undefined;
+    packageManager?: "yarn" | "pnpm" | 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,15 +34,16 @@ __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");
+var import_packageManager = require("./packageManager");
 const TEMPLATE_NAMES = [
   "express-rest-api",
   "greeter",
@@ -83,18 +84,19 @@ 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().args(import_zod.z.string()).returns(import_zod.z.union([import_zod.z.boolean(), import_zod.z.string()])).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(),
+  packageManager: import_packageManager.packageManagerSchema,
+  type: import_manifest.projectTypeSchema.optional()
 });
 const TEMPLATE_CONFIG_FILENAME = "skuba.template.js";
 const TEMPLATE_DIR = import_path.default.join(__dirname, "..", "..", "template");
@@ -109,8 +111,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';\nimport { packageManagerSchema } from './packageManager';\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\n        .function()\n        .args(z.string())\n        .returns(z.union([z.boolean(), z.string()]))\n        .optional(),\n    }),\n  ),\n  entryPoint: z.string().optional(),\n  noSkip: z.boolean().optional(),\n  packageManager: packageManagerSchema,\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;AAClC,4BAAqC;AAE9B,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,aACP,SAAS,EACT,KAAK,aAAE,OAAO,CAAC,EACf,QAAQ,aAAE,MAAM,CAAC,aAAE,QAAQ,GAAG,aAAE,OAAO,CAAC,CAAC,CAAC,EAC1C,SAAS;AAAA,IACd,CAAC;AAAA,EACH;AAAA,EACA,YAAY,aAAE,OAAO,EAAE,SAAS;AAAA,EAChC,QAAQ,aAAE,QAAQ,EAAE,SAAS;AAAA,EAC7B,gBAAgB;AAAA,EAChB,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/lib/utils/worker.d.ts

@@ -8,6 +8,7 @@ export declare const execWorkerThread: <Input, Output>(filepath: string, input:
  */
 export declare const postWorkerOutput: <Input, Output>(fn: (input: Input) => Promise<Output>, logger?: {
     bold: import("chalk").Chalk;
+    dim: import("chalk").Chalk;
     formatSubtle: import("chalk").Chalk;
     timing: (start: bigint, end: bigint) => string;
     debug: (...message: unknown[]) => void;

package/lib/wrapper/http.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import http from 'http';
 /**
  * Create an HTTP request listener based on the supplied function.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skuba",
-  "version": "0.0.0-master-20231002013336",
+  "version": "0.0.0-master-20240206001217",
   "private": false,
   "description": "SEEK development toolkit for backend applications and packages",
   "homepage": "https://github.com/seek-oss/skuba#readme",
@@ -27,21 +27,6 @@
     "template/**/*",
     "jest-preset.js"
   ],
-  "scripts": {
-    "build": "scripts/build.sh",
-    "deploy": "scripts/deploy.sh",
-    "format": "yarn skuba format",
-    "lint": "yarn skuba lint && yarn lint:md",
-    "lint:md": "remark --frail --quiet .",
-    "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:template": "scripts/test-template.sh",
-    "test:watch": "yarn skuba test --config jest.config.int.ts --runInBand --watch"
-  },
   "remarkConfig": {
     "plugins": [
       "remark-preset-lint-recommended",
@@ -64,9 +49,6 @@
       ]
     ]
   },
-  "resolutions": {
-    "**/@types/node": ">=18.12"
-  },
   "dependencies": {
     "@esbuild-plugins/tsconfig-paths": "^0.1.0",
     "@jest/types": "^29.0.0",
@@ -78,12 +60,13 @@
     "@types/node": ">=18.12",
     "chalk": "^4.1.0",
     "concurrently": "^8.0.0",
+    "detect-package-manager": "^3.0.1",
     "dotenv": "^16.0.0",
     "ejs": "^3.1.6",
     "enquirer": "^2.3.6",
-    "esbuild": "~0.19.0",
+    "esbuild": "~0.20.0",
     "eslint": "^8.11.0",
-    "eslint-config-skuba": "3.0.3",
+    "eslint-config-skuba": "3.1.0",
     "execa": "^5.0.0",
     "fdir": "^6.0.0",
     "fs-extra": "^11.0.0",
@@ -101,49 +84,51 @@
     "normalize-package-data": "^6.0.0",
     "npm-run-path": "^4.0.1",
     "npm-which": "^3.0.1",
-    "picomatch": "^2.2.2",
-    "prettier": "~3.0.3",
-    "prettier-plugin-packagejson": "^2.4.6",
+    "picomatch": "^3.0.0",
+    "prettier": "~3.2.5",
+    "prettier-plugin-packagejson": "^2.4.10",
     "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",
     "strip-ansi": "^6.0.1",
     "ts-dedent": "^2.2.0",
     "ts-jest": "^29.1.0",
-    "ts-node": "^10.7.0",
+    "ts-node": "^10.9.2",
     "ts-node-dev": "^2.0.0",
     "tsconfig-paths": "^4.0.0",
     "tsconfig-seek": "2.0.0",
-    "typescript": "~5.2.0",
-    "validate-npm-package-name": "^5.0.0"
+    "typescript": "~5.3.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",
+    "@changesets/cli": "2.27.1",
+    "@changesets/get-github-info": "0.6.0",
     "@jest/reporters": "29.7.0",
-    "@types/ejs": "3.1.3",
-    "@types/express": "4.17.18",
-    "@types/fs-extra": "11.0.2",
-    "@types/koa": "2.13.9",
-    "@types/libnpmsearch": "2.0.4",
-    "@types/lodash.mergewith": "4.6.7",
-    "@types/module-alias": "2.0.2",
-    "@types/npm-which": "3.0.1",
-    "@types/picomatch": "2.3.1",
-    "@types/supertest": "2.0.12",
-    "@types/validate-npm-package-name": "4.0.0",
+    "@jest/test-result": "29.7.0",
+    "@types/ejs": "3.1.5",
+    "@types/express": "4.17.21",
+    "@types/fs-extra": "11.0.4",
+    "@types/koa": "2.14.0",
+    "@types/libnpmsearch": "2.0.7",
+    "@types/lodash.mergewith": "4.6.9",
+    "@types/module-alias": "2.0.4",
+    "@types/npm-which": "3.0.3",
+    "@types/picomatch": "2.3.3",
+    "@types/supertest": "6.0.2",
+    "@types/validate-npm-package-name": "4.0.2",
     "enhanced-resolve": "5.15.0",
     "express": "4.18.2",
-    "fastify": "4.23.2",
+    "fastify": "4.25.2",
+    "jest-diff": "29.7.0",
     "jsonfile": "6.1.0",
-    "koa": "2.14.2",
-    "memfs": "4.4.0",
+    "koa": "2.15.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",
+    "supertest": "6.3.4",
     "type-fest": "2.19.0"
   },
   "peerDependencies": {
@@ -154,6 +139,7 @@
       "optional": true
     }
   },
+  "packageManager": "pnpm@8.15.1",
   "engines": {
     "node": ">=18.12"
   },
@@ -165,6 +151,23 @@
     "entryPoint": "src/index.ts",
     "template": null,
     "type": "package",
-    "version": "4.0.0"
+    "version": "7.3.1"
+  },
+  "scripts": {
+    "build": "scripts/build.sh",
+    "changeset": "changeset",
+    "deploy": "scripts/deploy.sh",
+    "format": "pnpm run --silent skuba format",
+    "lint": "pnpm run --silent skuba lint && pnpm run --silent lint:md",
+    "lint:md": "remark --frail --quiet .",
+    "release": "pnpm run --silent build && changeset publish",
+    "skuba": "pnpm run --silent build && pnpm run --silent skuba:exec",
+    "skuba:exec": "node --env-file=.env lib/skuba",
+    "stage": "changeset version && node ./.changeset/inject.js && pnpm run format",
+    "test": "pnpm run --silent skuba test --selectProjects unit",
+    "test:ci": "pnpm run --silent skuba test --runInBand",
+    "test:int": "pnpm run --silent skuba test --runInBand --selectProjects integration",
+    "test:template": "scripts/test-template.sh",
+    "test:watch": "pnpm run --silent skuba test --runInBand --watch"
   }
-}
+}

package/template/base/_.dockerignore

@@ -12,7 +12,6 @@ node_modules*/
 /tmp*/
 
 .DS_Store
-.npmrc
 npm-debug.log
 yarn-error.log
 # end managed by skuba

package/template/base/_.eslintignore

@@ -3,6 +3,7 @@
 .vscode/*
 
 .cdk.staging/
+.pnpm-store/
 .serverless/
 cdk.out/
 node_modules*/

package/template/base/_.gitignore

@@ -14,7 +14,7 @@ node_modules*/
 
 .DS_Store
 .eslintcache
-.npmrc
+.pnpm-debug.log
 *.tgz
 *.tsbuildinfo
 npm-debug.log

package/template/base/_.npmrc

@@ -0,0 +1,8 @@
+# managed by skuba
+public-hoist-pattern[]="@types*"
+public-hoist-pattern[]="*eslint*"
+public-hoist-pattern[]="*prettier*"
+public-hoist-pattern[]="esbuild"
+public-hoist-pattern[]="jest"
+public-hoist-pattern[]="tsconfig-seek"
+# end managed by skuba

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

@@ -4,21 +4,20 @@ agents:
 configs:
   plugins:
     - &aws-sm
-      seek-oss/aws-sm#v2.3.1:
+      seek-oss/aws-sm#v2.3.2:
         env:
           NPM_READ_TOKEN: arn:aws:secretsmanager:ap-southeast-2:987872074697:secret:npm/npm-read-token
 
     - &docker-ecr-cache
-      seek-oss/docker-ecr-cache#v2.1.0: &docker-ecr-cache-defaults
-        cache-on:
-          - package.json
-          - yarn.lock
+      seek-oss/docker-ecr-cache#v2.1.1: &docker-ecr-cache-defaults
+        cache-on: pnpm-lock.yaml
         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,16 +35,18 @@ steps:
     plugins:
       - *aws-sm
       - *private-npm
-      - seek-oss/docker-ecr-cache#v2.1.0:
+      - seek-oss/docker-ecr-cache#v2.1.1:
           <<: *docker-ecr-cache-defaults
           skip-pull-from-cache: true
 
   - label: 🧪 Test & Lint
     commands:
-      - echo '+++ yarn test:ci'
-      - yarn test:ci
-      - echo '--- yarn lint'
-      - yarn lint
+      - echo '--- pnpm install --offline'
+      - pnpm install --offline
+      - echo '+++ pnpm run test:ci'
+      - pnpm run test:ci
+      - echo '--- pnpm run lint'
+      - pnpm run lint
     depends_on: warm-prod
     env:
       GET_GITHUB_TOKEN: please
@@ -53,8 +54,11 @@ steps:
       - *aws-sm
       - *private-npm
       - *docker-ecr-cache
-      - docker-compose#v4.14.0:
+      - docker-compose#v4.16.0:
           run: app
+          environment:
+            - GITHUB_API_TOKEN
+          propagate-environment: true
     timeout_in_minutes: 10
 
   - label: 📦 Build & Package

package/template/express-rest-api/.gantry/dev.yml

@@ -6,3 +6,6 @@ isProduction: false
 
 maxInstanceCount: 1
 minInstanceCount: 1
+
+# Disable dashboard for cost savings
+cloudwatchDashboardDisabled: true

package/template/express-rest-api/.nvmrc

@@ -1 +1 @@
-18
+20

package/template/express-rest-api/Dockerfile

@@ -1,29 +1,23 @@
 ARG BASE_IMAGE
-ARG BASE_TAG
 
 ###
 
-FROM ${BASE_IMAGE}:${BASE_TAG} AS deps
-
-RUN yarn install --ignore-optional --ignore-scripts --non-interactive --offline --production
-
-###
-
-FROM ${BASE_IMAGE}:${BASE_TAG} AS build
+FROM ${BASE_IMAGE} AS build
 
 COPY . .
 
-RUN yarn build
+RUN pnpm install --offline
+RUN pnpm run build
+RUN pnpm install --offline --prod
 
 ###
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} gcr.io/distroless/nodejs18-debian11 AS runtime
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} gcr.io/distroless/nodejs20-debian12 AS runtime
 
 WORKDIR /workdir
 
 COPY --from=build /workdir/lib lib
-
-COPY --from=deps /workdir/node_modules node_modules
+COPY --from=build /workdir/node_modules node_modules
 
 ENV NODE_ENV=production
 

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

@@ -1,11 +1,12 @@
-# syntax=docker/dockerfile:1.2
+# syntax=docker/dockerfile:1.6
 
-FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:18-alpine AS dev-deps
+FROM --platform=${BUILDPLATFORM:-<%- platformName %>} node:20-alpine AS dev-deps
 
-WORKDIR /workdir
+RUN corepack enable pnpm
+RUN pnpm config set store-dir /root/.pnpm-store
 
-COPY package.json yarn.lock ./
+WORKDIR /workdir
 
-RUN \
-  --mount=type=secret,id=npm,dst=/workdir/.npmrc \
-  yarn install --frozen-lockfile --ignore-optional --non-interactive
+RUN --mount=type=bind,source=pnpm-lock.yaml,target=pnpm-lock.yaml \
+    --mount=type=secret,id=npm,dst=/root/.npmrc,required=true \
+    pnpm fetch