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

package/lib/cli/configure/upgrade/patches/7.3.1/moveNpmrcOutOfGitignoreManagedSection.js

@@ -0,0 +1,94 @@
+"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 moveNpmrcOutOfGitignoreManagedSection_exports = {};
+__export(moveNpmrcOutOfGitignoreManagedSection_exports, {
+  tryMoveNpmrcOutOfGitignoreManagedSection: () => tryMoveNpmrcOutOfGitignoreManagedSection
+});
+module.exports = __toCommonJS(moveNpmrcOutOfGitignoreManagedSection_exports);
+var import_path = __toESM(require("path"));
+var import_util = require("util");
+var import_fs_extra = __toESM(require("fs-extra"));
+var import_logging = require("../../../../../utils/logging");
+var import_project = require("../../../analysis/project");
+const NPMRC_IGNORE_SECTION = `
+
+# Ignore .npmrc. This is no longer managed by skuba as pnpm projects use a managed .npmrc.
+# IMPORTANT: if migrating to pnpm, remove this line and add an .npmrc IN THE SAME COMMIT.
+# You can use \`skuba format\` to generate the file or otherwise commit an empty file.
+# Doing so will conflict with a local .npmrc and make it more difficult to unintentionally commit auth secrets.
+.npmrc
+`;
+const moveNpmrcOutOfGitignoreManagedSection = async (mode, dir) => {
+  const readFile = (0, import_project.createDestinationFileReader)(dir);
+  const gitignore = await readFile(".gitignore");
+  if (!gitignore) {
+    return { result: "skip", reason: "no .gitignore file found" };
+  }
+  let isIgnored;
+  let currentlyInManagedSection = false;
+  for (const line of gitignore.split("\n")) {
+    if (line.trim() === "# managed by skuba") {
+      currentlyInManagedSection = true;
+    } else if (line.trim() === "# end managed by skuba") {
+      currentlyInManagedSection = false;
+    }
+    if (line.trim() === ".npmrc" || line.trim() === "/.npmrc") {
+      isIgnored = { inManaged: currentlyInManagedSection };
+    }
+    if (line.trim() === "!.npmrc" || line.trim() === "!/.npmrc") {
+      isIgnored = void 0;
+    }
+  }
+  if (isIgnored && !isIgnored.inManaged) {
+    return { result: "skip", reason: "already ignored in unmanaged section" };
+  }
+  if (!isIgnored) {
+    return { result: "skip", reason: "not ignored" };
+  }
+  if (mode === "lint") {
+    return { result: "apply" };
+  }
+  const newGitignore = gitignore.split("\n").filter((line) => line.trim().replace(/^[!/]+/g, "") !== ".npmrc").join("\n").trim() + NPMRC_IGNORE_SECTION;
+  await import_fs_extra.default.promises.writeFile(import_path.default.join(dir, ".gitignore"), newGitignore);
+  return { result: "apply" };
+};
+const tryMoveNpmrcOutOfGitignoreManagedSection = async (mode, dir = process.cwd()) => {
+  try {
+    return await moveNpmrcOutOfGitignoreManagedSection(mode, dir);
+  } catch (err) {
+    import_logging.log.warn("Failed to move .npmrc out of .gitignore managed section.");
+    import_logging.log.subtle((0, import_util.inspect)(err));
+    return { result: "skip", reason: "due to an error" };
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  tryMoveNpmrcOutOfGitignoreManagedSection
+});
+//# sourceMappingURL=moveNpmrcOutOfGitignoreManagedSection.js.map

package/lib/cli/configure/upgrade/patches/7.3.1/moveNpmrcOutOfGitignoreManagedSection.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../../src/cli/configure/upgrade/patches/7.3.1/moveNpmrcOutOfGitignoreManagedSection.ts"],
+  "sourcesContent": ["import path from 'path';\nimport { inspect } from 'util';\n\nimport fs from 'fs-extra';\n\nimport type { PatchFunction, PatchReturnType } from '../..';\nimport { log } from '../../../../../utils/logging';\nimport { createDestinationFileReader } from '../../../analysis/project';\n\nconst NPMRC_IGNORE_SECTION = `\n\n# Ignore .npmrc. This is no longer managed by skuba as pnpm projects use a managed .npmrc.\n# IMPORTANT: if migrating to pnpm, remove this line and add an .npmrc IN THE SAME COMMIT.\n# You can use \\`skuba format\\` to generate the file or otherwise commit an empty file.\n# Doing so will conflict with a local .npmrc and make it more difficult to unintentionally commit auth secrets.\n.npmrc\n`;\n\nconst moveNpmrcOutOfGitignoreManagedSection = async (\n  mode: 'format' | 'lint',\n  dir: string,\n): Promise<PatchReturnType> => {\n  const readFile = createDestinationFileReader(dir);\n\n  const gitignore = await readFile('.gitignore');\n\n  if (!gitignore) {\n    return { result: 'skip', reason: 'no .gitignore file found' };\n  }\n\n  let isIgnored: { inManaged: boolean } | undefined;\n  let currentlyInManagedSection = false;\n\n  for (const line of gitignore.split('\\n')) {\n    if (line.trim() === '# managed by skuba') {\n      currentlyInManagedSection = true;\n    } else if (line.trim() === '# end managed by skuba') {\n      currentlyInManagedSection = false;\n    }\n\n    if (line.trim() === '.npmrc' || line.trim() === '/.npmrc') {\n      isIgnored = { inManaged: currentlyInManagedSection };\n    }\n\n    if (line.trim() === '!.npmrc' || line.trim() === '!/.npmrc') {\n      isIgnored = undefined;\n    }\n  }\n\n  if (isIgnored && !isIgnored.inManaged) {\n    return { result: 'skip', reason: 'already ignored in unmanaged section' };\n  }\n\n  if (!isIgnored) {\n    return { result: 'skip', reason: 'not ignored' };\n  }\n\n  if (mode === 'lint') {\n    return { result: 'apply' };\n  }\n\n  const newGitignore =\n    gitignore\n      .split('\\n')\n      .filter((line) => line.trim().replace(/^[!/]+/g, '') !== '.npmrc')\n      .join('\\n')\n      .trim() + NPMRC_IGNORE_SECTION;\n\n  await fs.promises.writeFile(path.join(dir, '.gitignore'), newGitignore);\n\n  return { result: 'apply' };\n};\n\nexport const tryMoveNpmrcOutOfGitignoreManagedSection = (async (\n  mode: 'format' | 'lint',\n  dir = process.cwd(),\n) => {\n  try {\n    return await moveNpmrcOutOfGitignoreManagedSection(mode, dir);\n  } catch (err) {\n    log.warn('Failed to move .npmrc out of .gitignore managed section.');\n    log.subtle(inspect(err));\n    return { result: 'skip', reason: 'due to an error' };\n  }\n}) satisfies PatchFunction;\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AACjB,kBAAwB;AAExB,sBAAe;AAGf,qBAAoB;AACpB,qBAA4C;AAE5C,MAAM,uBAAuB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAS7B,MAAM,wCAAwC,OAC5C,MACA,QAC6B;AAC7B,QAAM,eAAW,4CAA4B,GAAG;AAEhD,QAAM,YAAY,MAAM,SAAS,YAAY;AAE7C,MAAI,CAAC,WAAW;AACd,WAAO,EAAE,QAAQ,QAAQ,QAAQ,2BAA2B;AAAA,EAC9D;AAEA,MAAI;AACJ,MAAI,4BAA4B;AAEhC,aAAW,QAAQ,UAAU,MAAM,IAAI,GAAG;AACxC,QAAI,KAAK,KAAK,MAAM,sBAAsB;AACxC,kCAA4B;AAAA,IAC9B,WAAW,KAAK,KAAK,MAAM,0BAA0B;AACnD,kCAA4B;AAAA,IAC9B;AAEA,QAAI,KAAK,KAAK,MAAM,YAAY,KAAK,KAAK,MAAM,WAAW;AACzD,kBAAY,EAAE,WAAW,0BAA0B;AAAA,IACrD;AAEA,QAAI,KAAK,KAAK,MAAM,aAAa,KAAK,KAAK,MAAM,YAAY;AAC3D,kBAAY;AAAA,IACd;AAAA,EACF;AAEA,MAAI,aAAa,CAAC,UAAU,WAAW;AACrC,WAAO,EAAE,QAAQ,QAAQ,QAAQ,uCAAuC;AAAA,EAC1E;AAEA,MAAI,CAAC,WAAW;AACd,WAAO,EAAE,QAAQ,QAAQ,QAAQ,cAAc;AAAA,EACjD;AAEA,MAAI,SAAS,QAAQ;AACnB,WAAO,EAAE,QAAQ,QAAQ;AAAA,EAC3B;AAEA,QAAM,eACJ,UACG,MAAM,IAAI,EACV,OAAO,CAAC,SAAS,KAAK,KAAK,EAAE,QAAQ,WAAW,EAAE,MAAM,QAAQ,EAChE,KAAK,IAAI,EACT,KAAK,IAAI;AAEd,QAAM,gBAAAA,QAAG,SAAS,UAAU,YAAAC,QAAK,KAAK,KAAK,YAAY,GAAG,YAAY;AAEtE,SAAO,EAAE,QAAQ,QAAQ;AAC3B;AAEO,MAAM,2CAA4C,OACvD,MACA,MAAM,QAAQ,IAAI,MACf;AACH,MAAI;AACF,WAAO,MAAM,sCAAsC,MAAM,GAAG;AAAA,EAC9D,SAAS,KAAK;AACZ,uBAAI,KAAK,0DAA0D;AACnE,uBAAI,WAAO,qBAAQ,GAAG,CAAC;AACvB,WAAO,EAAE,QAAQ,QAAQ,QAAQ,kBAAkB;AAAA,EACrD;AACF;",
+  "names": ["fs", "path"]
+}

package/lib/cli/configure/upgrade/patches/7.3.1/patchDockerfile.d.ts

@@ -0,0 +1,2 @@
+import type { PatchFunction } from '../..';
+export declare const tryPatchDockerfile: PatchFunction;

package/lib/cli/configure/{patchDockerfile.js → upgrade/patches/7.3.1/patchDockerfile.js}

@@ -33,29 +33,35 @@ __export(patchDockerfile_exports, {
 module.exports = __toCommonJS(patchDockerfile_exports);
 var import_util = require("util");
 var import_fs_extra = __toESM(require("fs-extra"));
-var import_logging = require("../../utils/logging");
-var import_project = require("./analysis/project");
+var import_logging = require("../../../../../utils/logging");
+var import_project = require("../../../analysis/project");
 const DOCKERFILE_FILENAME = "Dockerfile";
-const VERSION_REGEX = /gcr.io\/distroless\/nodejs:(16|18|20)/g;
-const VERSION_DEBIAN_REPLACE = "gcr.io/distroless/nodejs$1-debian11";
-const patchDockerfile = async (dir) => {
+const NON_DEBIAN_REGEX = /gcr.io\/distroless\/nodejs:(18|20)/g;
+const DEBIAN_REGEX = /gcr.io\/distroless\/nodejs(18|20)-debian11/g;
+const VERSION_DEBIAN_REPLACE = "gcr.io/distroless/nodejs$1-debian12";
+const patchDockerfile = async (mode, dir) => {
   const readFile = (0, import_project.createDestinationFileReader)(dir);
   const maybeDockerfile = await readFile(DOCKERFILE_FILENAME);
   if (!maybeDockerfile) {
-    return;
+    return { result: "skip", reason: "no Dockerfile found" };
+  }
+  const patched = maybeDockerfile.replaceAll(NON_DEBIAN_REGEX, VERSION_DEBIAN_REPLACE).replaceAll(DEBIAN_REGEX, VERSION_DEBIAN_REPLACE);
+  if (patched === maybeDockerfile) {
+    return { result: "skip" };
+  }
+  if (mode === "lint") {
+    return { result: "apply" };
   }
-  const patched = maybeDockerfile.replaceAll(
-    VERSION_REGEX,
-    VERSION_DEBIAN_REPLACE
-  );
   await import_fs_extra.default.promises.writeFile(DOCKERFILE_FILENAME, patched);
+  return { result: "apply" };
 };
-const tryPatchDockerfile = async (dir = process.cwd()) => {
+const tryPatchDockerfile = async (mode, dir = process.cwd()) => {
   try {
-    await patchDockerfile(dir);
+    return await patchDockerfile(mode, dir);
   } catch (err) {
     import_logging.log.warn("Failed to patch Dockerfile.");
     import_logging.log.subtle((0, import_util.inspect)(err));
+    return { result: "skip", reason: "due to an error" };
   }
 };
 // Annotate the CommonJS export names for ESM import in node:

package/lib/cli/configure/upgrade/patches/7.3.1/patchDockerfile.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../../src/cli/configure/upgrade/patches/7.3.1/patchDockerfile.ts"],
+  "sourcesContent": ["import { inspect } from 'util';\n\nimport fs from 'fs-extra';\n\nimport type { PatchFunction, PatchReturnType } from '../..';\nimport { log } from '../../../../../utils/logging';\nimport { createDestinationFileReader } from '../../../analysis/project';\n\nconst DOCKERFILE_FILENAME = 'Dockerfile';\n\nconst NON_DEBIAN_REGEX = /gcr.io\\/distroless\\/nodejs:(18|20)/g;\nconst DEBIAN_REGEX = /gcr.io\\/distroless\\/nodejs(18|20)-debian11/g;\nconst VERSION_DEBIAN_REPLACE = 'gcr.io/distroless/nodejs$1-debian12';\n\nconst patchDockerfile = async (\n  mode: 'format' | 'lint',\n  dir: string,\n): Promise<PatchReturnType> => {\n  const readFile = createDestinationFileReader(dir);\n\n  const maybeDockerfile = await readFile(DOCKERFILE_FILENAME);\n\n  if (!maybeDockerfile) {\n    return { result: 'skip', reason: 'no Dockerfile found' };\n  }\n\n  const patched = maybeDockerfile\n    .replaceAll(NON_DEBIAN_REGEX, VERSION_DEBIAN_REPLACE)\n    .replaceAll(DEBIAN_REGEX, VERSION_DEBIAN_REPLACE);\n\n  if (patched === maybeDockerfile) {\n    return { result: 'skip' };\n  }\n\n  if (mode === 'lint') {\n    return { result: 'apply' };\n  }\n\n  await fs.promises.writeFile(DOCKERFILE_FILENAME, patched);\n\n  return { result: 'apply' };\n};\n\nexport const tryPatchDockerfile: PatchFunction = async (\n  mode: 'format' | 'lint',\n  dir = process.cwd(),\n) => {\n  try {\n    return await patchDockerfile(mode, dir);\n  } catch (err) {\n    log.warn('Failed to patch Dockerfile.');\n    log.subtle(inspect(err));\n    return { result: 'skip', reason: 'due to an error' };\n  }\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAwB;AAExB,sBAAe;AAGf,qBAAoB;AACpB,qBAA4C;AAE5C,MAAM,sBAAsB;AAE5B,MAAM,mBAAmB;AACzB,MAAM,eAAe;AACrB,MAAM,yBAAyB;AAE/B,MAAM,kBAAkB,OACtB,MACA,QAC6B;AAC7B,QAAM,eAAW,4CAA4B,GAAG;AAEhD,QAAM,kBAAkB,MAAM,SAAS,mBAAmB;AAE1D,MAAI,CAAC,iBAAiB;AACpB,WAAO,EAAE,QAAQ,QAAQ,QAAQ,sBAAsB;AAAA,EACzD;AAEA,QAAM,UAAU,gBACb,WAAW,kBAAkB,sBAAsB,EACnD,WAAW,cAAc,sBAAsB;AAElD,MAAI,YAAY,iBAAiB;AAC/B,WAAO,EAAE,QAAQ,OAAO;AAAA,EAC1B;AAEA,MAAI,SAAS,QAAQ;AACnB,WAAO,EAAE,QAAQ,QAAQ;AAAA,EAC3B;AAEA,QAAM,gBAAAA,QAAG,SAAS,UAAU,qBAAqB,OAAO;AAExD,SAAO,EAAE,QAAQ,QAAQ;AAC3B;AAEO,MAAM,qBAAoC,OAC/C,MACA,MAAM,QAAQ,IAAI,MACf;AACH,MAAI;AACF,WAAO,MAAM,gBAAgB,MAAM,GAAG;AAAA,EACxC,SAAS,KAAK;AACZ,uBAAI,KAAK,6BAA6B;AACtC,uBAAI,WAAO,qBAAQ,GAAG,CAAC;AACvB,WAAO,EAAE,QAAQ,QAAQ,QAAQ,kBAAkB;AAAA,EACrD;AACF;",
+  "names": ["fs"]
+}

package/lib/cli/configure/upgrade/patches/7.3.1/patchServerListener.d.ts

@@ -0,0 +1,2 @@
+import type { PatchFunction } from '../..';
+export declare const tryPatchServerListener: PatchFunction;

package/lib/cli/configure/{patchServerListener.js → upgrade/patches/7.3.1/patchServerListener.js}

@@ -28,16 +28,15 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var patchServerListener_exports = {};
 __export(patchServerListener_exports, {
-  KEEP_ALIVE_CODE: () => KEEP_ALIVE_CODE,
-  SERVER_LISTENER_FILENAME: () => SERVER_LISTENER_FILENAME,
   tryPatchServerListener: () => tryPatchServerListener
 });
 module.exports = __toCommonJS(patchServerListener_exports);
 var import_util = require("util");
 var import_fs_extra = __toESM(require("fs-extra"));
-var import_logging = require("../../utils/logging");
-var import_project = require("./analysis/project");
-var import_prettier = require("./processing/prettier");
+var import_logging = require("../../../../../utils/logging");
+var import_project = require("../../../analysis/project");
+var import_prettier = require("../../../processing/prettier");
+const SERVER_LISTENER_FILENAME = "src/listen.ts";
 const KEEP_ALIVE_CODE = `
 // Gantry ALB default idle timeout is 30 seconds
 // https://nodejs.org/docs/latest-v18.x/api/http.html#serverkeepalivetimeout
@@ -46,12 +45,14 @@ const KEEP_ALIVE_CODE = `
 // AWS recommends setting an application timeout larger than the load balancer
 listener.keepAliveTimeout = 31000;
 `;
-const SERVER_LISTENER_FILENAME = "src/listen.ts";
-const patchServerListener = async (dir) => {
+const patchServerListener = async (mode, dir) => {
   const readFile = (0, import_project.createDestinationFileReader)(dir);
   let listener = await readFile(SERVER_LISTENER_FILENAME);
-  if (!listener || listener.includes("keepAliveTimeout")) {
-    return;
+  if (!listener) {
+    return { result: "skip", reason: "no listener file found" };
+  }
+  if (listener.includes("keepAliveTimeout")) {
+    return { result: "skip", reason: "keepAliveTimeout already configured" };
   }
   if (listener.includes("\napp.listen(")) {
     listener = listener.replace(
@@ -60,7 +61,10 @@ const patchServerListener = async (dir) => {
     );
   }
   if (!listener.includes("\nconst listener = app.listen(")) {
-    return;
+    return { result: "skip", reason: "no server listener found" };
+  }
+  if (mode === "lint") {
+    return { result: "apply" };
   }
   listener = `${listener}${KEEP_ALIVE_CODE}`;
   await import_fs_extra.default.promises.writeFile(
@@ -69,19 +73,19 @@ const patchServerListener = async (dir) => {
       parser: "typescript"
     })
   );
+  return { result: "apply" };
 };
-const tryPatchServerListener = async (dir = process.cwd()) => {
+const tryPatchServerListener = async (mode, dir = process.cwd()) => {
   try {
-    await patchServerListener(dir);
+    return await patchServerListener(mode, dir);
   } catch (err) {
     import_logging.log.warn("Failed to patch server listener.");
     import_logging.log.subtle((0, import_util.inspect)(err));
+    return { result: "skip", reason: "due to an error" };
   }
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  KEEP_ALIVE_CODE,
-  SERVER_LISTENER_FILENAME,
   tryPatchServerListener
 });
 //# sourceMappingURL=patchServerListener.js.map

package/lib/cli/configure/upgrade/patches/7.3.1/patchServerListener.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../../../../src/cli/configure/upgrade/patches/7.3.1/patchServerListener.ts"],
+  "sourcesContent": ["import { inspect } from 'util';\n\nimport fs from 'fs-extra';\n\nimport type { PatchFunction, PatchReturnType } from '../..';\nimport { log } from '../../../../../utils/logging';\nimport { createDestinationFileReader } from '../../../analysis/project';\nimport { formatPrettier } from '../../../processing/prettier';\n\nconst SERVER_LISTENER_FILENAME = 'src/listen.ts';\n\nconst KEEP_ALIVE_CODE = `\n// Gantry ALB default idle timeout is 30 seconds\n// https://nodejs.org/docs/latest-v18.x/api/http.html#serverkeepalivetimeout\n// Node default is 5 seconds\n// https://docs.aws.amazon.com/elasticloadbalancing/latest/application/application-load-balancers.html#connection-idle-timeout\n// AWS recommends setting an application timeout larger than the load balancer\nlistener.keepAliveTimeout = 31000;\n`;\n\nconst patchServerListener = async (\n  mode: 'format' | 'lint',\n  dir: string,\n): Promise<PatchReturnType> => {\n  const readFile = createDestinationFileReader(dir);\n\n  let listener = await readFile(SERVER_LISTENER_FILENAME);\n  if (!listener) {\n    return { result: 'skip', reason: 'no listener file found' };\n  }\n\n  if (listener.includes('keepAliveTimeout')) {\n    return { result: 'skip', reason: 'keepAliveTimeout already configured' };\n  }\n\n  if (listener.includes('\\napp.listen(')) {\n    listener = listener.replace(\n      '\\napp.listen(',\n      '\\nconst listener = app.listen(',\n    );\n  }\n\n  if (!listener.includes('\\nconst listener = app.listen(')) {\n    return { result: 'skip', reason: 'no server listener found' };\n  }\n\n  if (mode === 'lint') {\n    return { result: 'apply' };\n  }\n\n  listener = `${listener}${KEEP_ALIVE_CODE}`;\n\n  await fs.promises.writeFile(\n    SERVER_LISTENER_FILENAME,\n    await formatPrettier(listener, {\n      parser: 'typescript',\n    }),\n  );\n\n  return { result: 'apply' };\n};\n\nexport const tryPatchServerListener: PatchFunction = async (\n  mode: 'format' | 'lint',\n  dir = process.cwd(),\n) => {\n  try {\n    return await patchServerListener(mode, dir);\n  } catch (err) {\n    log.warn('Failed to patch server listener.');\n    log.subtle(inspect(err));\n    return { result: 'skip', reason: 'due to an error' };\n  }\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAwB;AAExB,sBAAe;AAGf,qBAAoB;AACpB,qBAA4C;AAC5C,sBAA+B;AAE/B,MAAM,2BAA2B;AAEjC,MAAM,kBAAkB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AASxB,MAAM,sBAAsB,OAC1B,MACA,QAC6B;AAC7B,QAAM,eAAW,4CAA4B,GAAG;AAEhD,MAAI,WAAW,MAAM,SAAS,wBAAwB;AACtD,MAAI,CAAC,UAAU;AACb,WAAO,EAAE,QAAQ,QAAQ,QAAQ,yBAAyB;AAAA,EAC5D;AAEA,MAAI,SAAS,SAAS,kBAAkB,GAAG;AACzC,WAAO,EAAE,QAAQ,QAAQ,QAAQ,sCAAsC;AAAA,EACzE;AAEA,MAAI,SAAS,SAAS,eAAe,GAAG;AACtC,eAAW,SAAS;AAAA,MAClB;AAAA,MACA;AAAA,IACF;AAAA,EACF;AAEA,MAAI,CAAC,SAAS,SAAS,gCAAgC,GAAG;AACxD,WAAO,EAAE,QAAQ,QAAQ,QAAQ,2BAA2B;AAAA,EAC9D;AAEA,MAAI,SAAS,QAAQ;AACnB,WAAO,EAAE,QAAQ,QAAQ;AAAA,EAC3B;AAEA,aAAW,GAAG,QAAQ,GAAG,eAAe;AAExC,QAAM,gBAAAA,QAAG,SAAS;AAAA,IAChB;AAAA,IACA,UAAM,gCAAe,UAAU;AAAA,MAC7B,QAAQ;AAAA,IACV,CAAC;AAAA,EACH;AAEA,SAAO,EAAE,QAAQ,QAAQ;AAC3B;AAEO,MAAM,yBAAwC,OACnD,MACA,MAAM,QAAQ,IAAI,MACf;AACH,MAAI;AACF,WAAO,MAAM,oBAAoB,MAAM,GAAG;AAAA,EAC5C,SAAS,KAAK;AACZ,uBAAI,KAAK,kCAAkC;AAC3C,uBAAI,WAAO,qBAAQ,GAAG,CAAC;AACvB,WAAO,EAAE,QAAQ,QAAQ,QAAQ,kBAAkB;AAAA,EACrD;AACF;",
+  "names": ["fs"]
+}

package/lib/cli/format.js

@@ -36,32 +36,25 @@ var import_args = require("../utils/args");
 var import_logging = require("../utils/logging");
 var import_eslint = require("./adapter/eslint");
 var import_prettier = require("./adapter/prettier");
-var import_addEmptyExports = require("./configure/addEmptyExports");
-var import_patchDockerfile = require("./configure/patchDockerfile");
-var import_patchRenovateConfig = require("./configure/patchRenovateConfig");
-var import_patchServerListener = require("./configure/patchServerListener");
-var import_refreshIgnoreFiles = require("./configure/refreshIgnoreFiles");
+var import_internal = require("./lint/internal");
 const format = async (args = process.argv.slice(2)) => {
-  await Promise.all([
-    (0, import_addEmptyExports.tryAddEmptyExports)(),
-    (0, import_patchRenovateConfig.tryPatchRenovateConfig)(),
-    (0, import_patchDockerfile.tryPatchDockerfile)(),
-    (0, import_patchServerListener.tryPatchServerListener)(),
-    (0, import_refreshIgnoreFiles.tryRefreshIgnoreFiles)()
-  ]);
   const debug = (0, import_args.hasDebugFlag)(args);
+  import_logging.log.plain(import_chalk.default.blueBright("skuba lints"));
+  const internal = await (0, import_internal.internalLint)("format", { debug, serial: true });
   const logger = (0, import_logging.createLogger)(debug);
+  import_logging.log.newline();
   import_logging.log.plain(import_chalk.default.magenta("ESLint"));
   const eslint = await (0, import_eslint.runESLint)("format", logger);
   import_logging.log.newline();
   import_logging.log.plain(import_chalk.default.cyan("Prettier"));
   const prettier = await (0, import_prettier.runPrettier)("format", logger);
-  if (eslint.ok && prettier.ok) {
+  if (eslint.ok && prettier.ok && internal.ok) {
     return;
   }
   const tools = [
     ...eslint.ok ? [] : ["ESLint"],
-    ...prettier.ok ? [] : ["Prettier"]
+    ...prettier.ok ? [] : ["Prettier"],
+    ...internal.ok ? [] : ["skuba"]
   ];
   import_logging.log.newline();
   import_logging.log.err(tools.join(", "), "found issues that require triage.");

package/lib/cli/format.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/cli/format.ts"],
-  "sourcesContent": ["import chalk from 'chalk';\n\nimport { hasDebugFlag } from '../utils/args';\nimport { createLogger, log } from '../utils/logging';\n\nimport { runESLint } from './adapter/eslint';\nimport { runPrettier } from './adapter/prettier';\nimport { tryAddEmptyExports } from './configure/addEmptyExports';\nimport { tryPatchDockerfile } from './configure/patchDockerfile';\nimport { tryPatchRenovateConfig } from './configure/patchRenovateConfig';\nimport { tryPatchServerListener } from './configure/patchServerListener';\nimport { tryRefreshIgnoreFiles } from './configure/refreshIgnoreFiles';\n\nexport const format = async (args = process.argv.slice(2)): Promise<void> => {\n  await Promise.all([\n    tryAddEmptyExports(),\n    tryPatchRenovateConfig(),\n    tryPatchDockerfile(),\n    tryPatchServerListener(),\n    tryRefreshIgnoreFiles(),\n  ]);\n\n  const debug = hasDebugFlag(args);\n  const logger = createLogger(debug);\n\n  log.plain(chalk.magenta('ESLint'));\n\n  const eslint = await runESLint('format', logger);\n\n  log.newline();\n  log.plain(chalk.cyan('Prettier'));\n\n  const prettier = await runPrettier('format', logger);\n\n  if (eslint.ok && prettier.ok) {\n    return;\n  }\n\n  const tools = [\n    ...(eslint.ok ? [] : ['ESLint']),\n    ...(prettier.ok ? [] : ['Prettier']),\n  ];\n\n  log.newline();\n  log.err(tools.join(', '), 'found issues that require triage.');\n\n  process.exitCode = 1;\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAkB;AAElB,kBAA6B;AAC7B,qBAAkC;AAElC,oBAA0B;AAC1B,sBAA4B;AAC5B,6BAAmC;AACnC,6BAAmC;AACnC,iCAAuC;AACvC,iCAAuC;AACvC,gCAAsC;AAE/B,MAAM,SAAS,OAAO,OAAO,QAAQ,KAAK,MAAM,CAAC,MAAqB;AAC3E,QAAM,QAAQ,IAAI;AAAA,QAChB,2CAAmB;AAAA,QACnB,mDAAuB;AAAA,QACvB,2CAAmB;AAAA,QACnB,mDAAuB;AAAA,QACvB,iDAAsB;AAAA,EACxB,CAAC;AAED,QAAM,YAAQ,0BAAa,IAAI;AAC/B,QAAM,aAAS,6BAAa,KAAK;AAEjC,qBAAI,MAAM,aAAAA,QAAM,QAAQ,QAAQ,CAAC;AAEjC,QAAM,SAAS,UAAM,yBAAU,UAAU,MAAM;AAE/C,qBAAI,QAAQ;AACZ,qBAAI,MAAM,aAAAA,QAAM,KAAK,UAAU,CAAC;AAEhC,QAAM,WAAW,UAAM,6BAAY,UAAU,MAAM;AAEnD,MAAI,OAAO,MAAM,SAAS,IAAI;AAC5B;AAAA,EACF;AAEA,QAAM,QAAQ;AAAA,IACZ,GAAI,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ;AAAA,IAC9B,GAAI,SAAS,KAAK,CAAC,IAAI,CAAC,UAAU;AAAA,EACpC;AAEA,qBAAI,QAAQ;AACZ,qBAAI,IAAI,MAAM,KAAK,IAAI,GAAG,mCAAmC;AAE7D,UAAQ,WAAW;AACrB;",
+  "sourcesContent": ["import chalk from 'chalk';\n\nimport { hasDebugFlag } from '../utils/args';\nimport { createLogger, log } from '../utils/logging';\n\nimport { runESLint } from './adapter/eslint';\nimport { runPrettier } from './adapter/prettier';\nimport { internalLint } from './lint/internal';\n\nexport const format = async (args = process.argv.slice(2)): Promise<void> => {\n  const debug = hasDebugFlag(args);\n\n  log.plain(chalk.blueBright('skuba lints'));\n  const internal = await internalLint('format', { debug, serial: true });\n\n  const logger = createLogger(debug);\n\n  log.newline();\n  log.plain(chalk.magenta('ESLint'));\n\n  const eslint = await runESLint('format', logger);\n\n  log.newline();\n  log.plain(chalk.cyan('Prettier'));\n\n  const prettier = await runPrettier('format', logger);\n\n  if (eslint.ok && prettier.ok && internal.ok) {\n    return;\n  }\n\n  const tools = [\n    ...(eslint.ok ? [] : ['ESLint']),\n    ...(prettier.ok ? [] : ['Prettier']),\n    ...(internal.ok ? [] : ['skuba']),\n  ];\n\n  log.newline();\n  log.err(tools.join(', '), 'found issues that require triage.');\n\n  process.exitCode = 1;\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAkB;AAElB,kBAA6B;AAC7B,qBAAkC;AAElC,oBAA0B;AAC1B,sBAA4B;AAC5B,sBAA6B;AAEtB,MAAM,SAAS,OAAO,OAAO,QAAQ,KAAK,MAAM,CAAC,MAAqB;AAC3E,QAAM,YAAQ,0BAAa,IAAI;AAE/B,qBAAI,MAAM,aAAAA,QAAM,WAAW,aAAa,CAAC;AACzC,QAAM,WAAW,UAAM,8BAAa,UAAU,EAAE,OAAO,QAAQ,KAAK,CAAC;AAErE,QAAM,aAAS,6BAAa,KAAK;AAEjC,qBAAI,QAAQ;AACZ,qBAAI,MAAM,aAAAA,QAAM,QAAQ,QAAQ,CAAC;AAEjC,QAAM,SAAS,UAAM,yBAAU,UAAU,MAAM;AAE/C,qBAAI,QAAQ;AACZ,qBAAI,MAAM,aAAAA,QAAM,KAAK,UAAU,CAAC;AAEhC,QAAM,WAAW,UAAM,6BAAY,UAAU,MAAM;AAEnD,MAAI,OAAO,MAAM,SAAS,MAAM,SAAS,IAAI;AAC3C;AAAA,EACF;AAEA,QAAM,QAAQ;AAAA,IACZ,GAAI,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ;AAAA,IAC9B,GAAI,SAAS,KAAK,CAAC,IAAI,CAAC,UAAU;AAAA,IAClC,GAAI,SAAS,KAAK,CAAC,IAAI,CAAC,OAAO;AAAA,EACjC;AAEA,qBAAI,QAAQ;AACZ,qBAAI,IAAI,MAAM,KAAK,IAAI,GAAG,mCAAmC;AAE7D,UAAQ,WAAW;AACrB;",
   "names": ["chalk"]
 }

package/lib/cli/init/getConfig.d.ts

@@ -1,26 +1,28 @@
-import { TemplateConfig } from '../../utils/template';
+import { type TemplateConfig } from '../../utils/template';
+import { type Choice } from './prompts';
 import { type InitConfig } from './types';
-import { type FormChoice } from 'enquirer';
 export declare const runForm: <T = Record<string, string>>(props: {
-    choices: Readonly<FormChoice[]>;
+    choices: Readonly<Choice[]>;
     message: string;
     name: string;
 }) => Promise<T>;
 export declare const getTemplateConfig: (dir: string) => TemplateConfig;
 export declare const configureFromPrompt: () => Promise<InitConfig>;
 export declare const getConfig: () => Promise<{
+    packageManager: "yarn" | "pnpm";
     templateName: string;
     destinationDir: string;
     templateComplete: boolean;
     templateData: {
         port: string;
+        defaultBranch: string;
         orgName: string;
         repoName: string;
         ownerName: string;
         teamName: string;
     } & {
-        [x: string]: string;
+        [k: string]: string;
     };
-    type?: "package" | "application" | undefined;
     entryPoint?: string | undefined;
+    type?: "package" | "application" | undefined;
 }>;

package/lib/cli/init/getConfig.js

@@ -36,22 +36,23 @@ __export(getConfig_exports, {
 module.exports = __toCommonJS(getConfig_exports);
 var import_path = __toESM(require("path"));
 var import_chalk = __toESM(require("chalk"));
+var import_enquirer = require("enquirer");
 var import_fs_extra = __toESM(require("fs-extra"));
 var import_copy = require("../../utils/copy");
 var import_error = require("../../utils/error");
 var import_logging = require("../../utils/logging");
+var import_packageManager = require("../../utils/packageManager");
 var import_port = require("../../utils/port");
 var import_template = require("../../utils/template");
 var import_git = require("./git");
 var import_prompts = require("./prompts");
 var import_types = require("./types");
-var import_enquirer = require("enquirer");
 const runForm = (props) => {
   const { message, name } = props;
   const choices = props.choices.map((choice) => ({
     ...choice,
     validate: (value) => {
-      if (!value || value === "" || value === choice.initial) {
+      if (!value || value === "" || value === choice.initial && !choice.allowInitial) {
         return "Form is not complete";
       }
       return choice.validate?.(value) ?? true;
@@ -92,20 +93,38 @@ const createDirectory = async (dir) => {
   }
 };
 const cloneTemplate = async (templateName, destinationDir) => {
-  if (templateName.startsWith("github:")) {
+  const isCustomTemplate = templateName.startsWith("github:");
+  if (isCustomTemplate) {
     const gitHubPath = templateName.slice("github:".length);
-    return (0, import_git.downloadGitHubTemplate)(gitHubPath, destinationDir);
+    await (0, import_git.downloadGitHubTemplate)(gitHubPath, destinationDir);
+  } else {
+    const templateDir = import_path.default.join(import_template.TEMPLATE_DIR, templateName);
+    await (0, import_copy.copyFiles)({
+      // assume built-in templates have no extraneous files
+      include: () => true,
+      sourceRoot: templateDir,
+      destinationRoot: destinationDir,
+      processors: [],
+      // built-in templates have files like _package.json
+      stripUnderscorePrefix: true
+    });
   }
-  const templateDir = import_path.default.join(import_template.TEMPLATE_DIR, templateName);
-  await (0, import_copy.copyFiles)({
-    // assume built-in templates have no extraneous files
-    include: () => true,
-    sourceRoot: templateDir,
-    destinationRoot: destinationDir,
-    processors: [],
-    // built-in templates have files like _package.json
-    stripUnderscorePrefix: true
-  });
+  const templateConfig = getTemplateConfig(
+    import_path.default.join(process.cwd(), destinationDir)
+  );
+  if (isCustomTemplate) {
+    import_logging.log.newline();
+    import_logging.log.warn(
+      "You may need to run",
+      import_logging.log.bold(
+        (0, import_packageManager.configForPackageManager)(templateConfig.packageManager).exec,
+        "skuba",
+        "configure"
+      ),
+      "once this is done."
+    );
+  }
+  return templateConfig;
 };
 const getTemplateName = async () => {
   const templateSelection = await import_prompts.TEMPLATE_PROMPT.run();
@@ -122,12 +141,13 @@ const getTemplateConfig = (dir) => {
   const templateConfigPath = import_path.default.join(dir, import_template.TEMPLATE_CONFIG_FILENAME);
   try {
     const templateConfig = require(templateConfigPath);
-    return import_template.TemplateConfig.check(templateConfig);
+    return import_template.templateConfigSchema.parse(templateConfig);
   } catch (err) {
     if ((0, import_error.isErrorWithCode)(err, "MODULE_NOT_FOUND")) {
       return {
         entryPoint: void 0,
         fields: [],
+        packageManager: import_packageManager.DEFAULT_PACKAGE_MANAGER,
         type: void 0
       };
     }
@@ -137,7 +157,8 @@ const getTemplateConfig = (dir) => {
 const baseToTemplateData = async ({
   ownerName,
   platformName,
-  repoName
+  repoName,
+  defaultBranch
 }) => {
   const [orgName, teamName] = ownerName.split("/");
   const port = String(await (0, import_port.getRandomPort)());
@@ -148,6 +169,7 @@ const baseToTemplateData = async ({
     orgName,
     ownerName,
     repoName,
+    defaultBranch,
     // Use standalone username in `teamName` contexts
     teamName: teamName ?? orgName,
     port,
@@ -157,25 +179,24 @@ const baseToTemplateData = async ({
   };
 };
 const configureFromPrompt = async () => {
-  const { ownerName, platformName, repoName } = await runForm(import_prompts.BASE_PROMPT_PROPS);
+  const { ownerName, platformName, repoName, defaultBranch } = await runForm(import_prompts.BASE_PROMPT_PROPS);
   import_logging.log.plain(import_chalk.default.cyan(repoName), "by", import_chalk.default.cyan(ownerName));
   const templateData = await baseToTemplateData({
     ownerName,
     platformName,
-    repoName
+    repoName,
+    defaultBranch
   });
   const destinationDir = repoName;
   await createDirectory(destinationDir);
   import_logging.log.newline();
   const templateName = await getTemplateName();
-  await cloneTemplate(templateName, destinationDir);
-  const { entryPoint, fields, noSkip, type } = getTemplateConfig(
-    import_path.default.join(process.cwd(), destinationDir)
-  );
+  const { entryPoint, fields, noSkip, packageManager, type } = await cloneTemplate(templateName, destinationDir);
   if (fields.length === 0) {
     return {
       destinationDir,
       entryPoint,
+      packageManager,
       templateComplete: true,
       templateData,
       templateName,
@@ -193,6 +214,7 @@ const configureFromPrompt = async () => {
     return {
       destinationDir,
       entryPoint,
+      packageManager,
       templateComplete: true,
       templateData: { ...templateData, ...customAnswers2 },
       templateName,
@@ -200,11 +222,17 @@ const configureFromPrompt = async () => {
     };
   }
   import_logging.log.newline();
-  import_logging.log.warn(`Resume this later with ${import_chalk.default.bold("yarn skuba configure")}.`);
+  import_logging.log.warn(
+    `Resume this later with ${import_chalk.default.bold(
+      (0, import_packageManager.configForPackageManager)(packageManager).exec,
+      "skuba configure"
+    )}.`
+  );
   const customAnswers = generatePlaceholders(fields);
   return {
     destinationDir,
     entryPoint,
+    packageManager,
     templateComplete: false,
     templateData: { ...templateData, ...customAnswers },
     templateName,
@@ -228,30 +256,28 @@ const configureFromPipe = async () => {
     import_logging.log.err("Invalid JSON from stdin.");
     process.exit(1);
   }
-  const result = import_types.InitConfigInput.validate(value);
+  const result = import_types.initConfigInputSchema.safeParse(value);
   if (!result.success) {
     import_logging.log.err("Invalid data from stdin:");
-    import_logging.log.err(result.message);
+    import_logging.log.err(result.error);
     process.exit(1);
   }
-  const { destinationDir, templateComplete, templateName } = result.value;
+  const { destinationDir, templateComplete, templateName } = result.data;
   const templateData = {
-    ...await baseToTemplateData(result.value.templateData),
-    ...result.value.templateData
+    ...await baseToTemplateData(result.data.templateData),
+    ...result.data.templateData
   };
   await createDirectory(destinationDir);
-  await cloneTemplate(templateName, destinationDir);
-  const { entryPoint, fields, noSkip, type } = getTemplateConfig(
-    import_path.default.join(process.cwd(), destinationDir)
-  );
+  const { entryPoint, fields, noSkip, packageManager, type } = await cloneTemplate(templateName, destinationDir);
   if (!templateComplete) {
     if (noSkip) {
       import_logging.log.err("Templating for", import_logging.log.bold(templateName), "cannot be skipped.");
       process.exit(1);
     }
     return {
-      ...result.value,
+      ...result.data,
       entryPoint,
+      packageManager,
       templateData: {
         ...templateData,
         ...generatePlaceholders(fields)
@@ -269,8 +295,9 @@ const configureFromPipe = async () => {
     process.exit(1);
   }
   return {
-    ...result.value,
+    ...result.data,
     entryPoint,
+    packageManager,
     templateData,
     type
   };