skuba 8.1.0-pm-20240430084912 → 8.1.0-skuba-dive-secret-20240522031929

package/lib/api/git/index.d.ts

@@ -9,3 +9,4 @@ export { getOwnerAndRepo } from './remote';
 export { push } from './push';
 export { fastForwardBranch } from './pull';
 export { reset } from './reset';
+export { isFileGitIgnored } from './isFileGitIgnored';

package/lib/api/git/index.js

@@ -27,6 +27,7 @@ __export(git_exports, {
   getHeadCommitId: () => import_log.getHeadCommitId,
   getHeadCommitMessage: () => import_log.getHeadCommitMessage,
   getOwnerAndRepo: () => import_remote.getOwnerAndRepo,
+  isFileGitIgnored: () => import_isFileGitIgnored.isFileGitIgnored,
   push: () => import_push.push,
   reset: () => import_reset.reset
 });
@@ -41,6 +42,7 @@ var import_remote = require("./remote");
 var import_push = require("./push");
 var import_pull = require("./pull");
 var import_reset = require("./reset");
+var import_isFileGitIgnored = require("./isFileGitIgnored");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   commit,
@@ -52,6 +54,7 @@ var import_reset = require("./reset");
   getHeadCommitId,
   getHeadCommitMessage,
   getOwnerAndRepo,
+  isFileGitIgnored,
   push,
   reset
 });

package/lib/api/git/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/api/git/index.ts"],
-  "sourcesContent": ["export { commit } from './commit';\nexport { commitAllChanges } from './commitAllChanges';\nexport { currentBranch } from './currentBranch';\nexport { findRoot } from './findRoot';\nexport type { ChangedFile } from './getChangedFiles';\nexport { getChangedFiles } from './getChangedFiles';\nexport { getHeadCommitId, getHeadCommitMessage } from './log';\nexport { getOwnerAndRepo } from './remote';\nexport { push } from './push';\nexport { fastForwardBranch } from './pull';\nexport { reset } from './reset';\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAuB;AACvB,8BAAiC;AACjC,2BAA8B;AAC9B,sBAAyB;AAEzB,6BAAgC;AAChC,iBAAsD;AACtD,oBAAgC;AAChC,kBAAqB;AACrB,kBAAkC;AAClC,mBAAsB;",
+  "sourcesContent": ["export { commit } from './commit';\nexport { commitAllChanges } from './commitAllChanges';\nexport { currentBranch } from './currentBranch';\nexport { findRoot } from './findRoot';\nexport type { ChangedFile } from './getChangedFiles';\nexport { getChangedFiles } from './getChangedFiles';\nexport { getHeadCommitId, getHeadCommitMessage } from './log';\nexport { getOwnerAndRepo } from './remote';\nexport { push } from './push';\nexport { fastForwardBranch } from './pull';\nexport { reset } from './reset';\nexport { isFileGitIgnored } from './isFileGitIgnored';\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,oBAAuB;AACvB,8BAAiC;AACjC,2BAA8B;AAC9B,sBAAyB;AAEzB,6BAAgC;AAChC,iBAAsD;AACtD,oBAAgC;AAChC,kBAAqB;AACrB,kBAAkC;AAClC,mBAAsB;AACtB,8BAAiC;",
   "names": []
 }

package/lib/api/git/isFileGitIgnored.d.ts

@@ -0,0 +1,4 @@
+export declare const isFileGitIgnored: ({ absolutePath, gitRoot, }: {
+    absolutePath: string;
+    gitRoot: string;
+}) => Promise<boolean>;

package/lib/api/git/isFileGitIgnored.js

@@ -0,0 +1,49 @@
+"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 isFileGitIgnored_exports = {};
+__export(isFileGitIgnored_exports, {
+  isFileGitIgnored: () => isFileGitIgnored
+});
+module.exports = __toCommonJS(isFileGitIgnored_exports);
+var import_path = __toESM(require("path"));
+var import_fs_extra = __toESM(require("fs-extra"));
+var import_isomorphic_git = __toESM(require("isomorphic-git"));
+const isFileGitIgnored = ({
+  absolutePath,
+  gitRoot
+}) => import_isomorphic_git.default.isIgnored({
+  dir: gitRoot,
+  filepath: import_path.default.relative(gitRoot, absolutePath),
+  fs: import_fs_extra.default
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  isFileGitIgnored
+});
+//# sourceMappingURL=isFileGitIgnored.js.map

package/lib/api/git/isFileGitIgnored.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/api/git/isFileGitIgnored.ts"],
+  "sourcesContent": ["import path from 'path';\n\nimport fs from 'fs-extra';\nimport git from 'isomorphic-git';\n\nexport const isFileGitIgnored = ({\n  absolutePath,\n  gitRoot,\n}: {\n  absolutePath: string;\n  gitRoot: string;\n}): Promise<boolean> =>\n  git.isIgnored({\n    dir: gitRoot,\n    filepath: path.relative(gitRoot, absolutePath),\n    fs,\n  });\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AAEjB,sBAAe;AACf,4BAAgB;AAET,MAAM,mBAAmB,CAAC;AAAA,EAC/B;AAAA,EACA;AACF,MAIE,sBAAAA,QAAI,UAAU;AAAA,EACZ,KAAK;AAAA,EACL,UAAU,YAAAC,QAAK,SAAS,SAAS,YAAY;AAAA,EAC7C,oBAAAC;AACF,CAAC;",
+  "names": ["git", "path", "fs"]
+}

package/lib/cli/lint/internalLints/refreshConfigFiles.js

@@ -37,6 +37,7 @@ var import_path = __toESM(require("path"));
 var import_util = require("util");
 var import_fs_extra = require("fs-extra");
 var import_strip_ansi = __toESM(require("strip-ansi"));
+var import__ = require("../../..");
 var import_npmrc = require("../../../utils/npmrc");
 var import_packageManager = require("../../../utils/packageManager");
 var import_template = require("../../../utils/template");
@@ -72,7 +73,10 @@ const REFRESHABLE_CONFIG_FILES = [
   }
 ];
 const refreshConfigFiles = async (mode, logger) => {
-  const manifest = await (0, import_package.getDestinationManifest)();
+  const [manifest, gitRoot] = await Promise.all([
+    (0, import_package.getDestinationManifest)(),
+    import__.Git.findRoot({ dir: process.cwd() })
+  ]);
   const destinationRoot = import_path.default.dirname(manifest.path);
   const readDestinationFile = (0, import_project.createDestinationFileReader)(destinationRoot);
   const refreshConfigFile = async ({
@@ -84,10 +88,17 @@ const refreshConfigFiles = async (mode, logger) => {
     if (!condition(packageManager2)) {
       return { needsChange: false };
     }
-    const [inputFile, templateFile] = await Promise.all([
+    const [inputFile, templateFile, isGitIgnored] = await Promise.all([
       readDestinationFile(filename),
-      (0, import_template.readBaseTemplateFile)(`_${filename}`)
+      (0, import_template.readBaseTemplateFile)(`_${filename}`),
+      gitRoot ? import__.Git.isFileGitIgnored({
+        gitRoot,
+        absolutePath: import_path.default.join(destinationRoot, filename)
+      }) : false
     ]);
+    if (inputFile === void 0 && isGitIgnored) {
+      return { needsChange: false };
+    }
     const data = additionalMapping(
       inputFile ? (0, import_configFile.mergeWithConfigFile)(templateFile, fileType)(inputFile) : templateFile,
       packageManager2

package/lib/cli/lint/internalLints/refreshConfigFiles.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../../src/cli/lint/internalLints/refreshConfigFiles.ts"],
-  "sourcesContent": ["import path from 'path';\nimport { inspect } from 'util';\n\nimport { writeFile } from 'fs-extra';\nimport stripAnsi from 'strip-ansi';\n\nimport type { Logger } from '../../../utils/logging';\nimport { NPMRC_LINES, hasNpmrcSecret } from '../../../utils/npmrc';\nimport {\n  type PackageManagerConfig,\n  detectPackageManager,\n} from '../../../utils/packageManager';\nimport { readBaseTemplateFile } from '../../../utils/template';\nimport { getDestinationManifest } from '../../configure/analysis/package';\nimport { createDestinationFileReader } from '../../configure/analysis/project';\nimport { mergeWithConfigFile } from '../../configure/processing/configFile';\nimport type { InternalLintResult } from '../internal';\n\nconst ensureNoAuthToken = (fileContents: string) =>\n  fileContents\n    .split('\\n')\n    .filter((line) => !hasNpmrcSecret(line))\n    .join('\\n');\n\ntype RefreshableConfigFile = {\n  name: string;\n  type: 'ignore' | 'npmrc';\n  additionalMapping?: (\n    s: string,\n    packageManager: PackageManagerConfig,\n  ) => string;\n  if?: (packageManager: PackageManagerConfig) => boolean;\n};\n\nconst removeRedundantNpmrc = (contents: string) => {\n  const npmrcLines = contents\n    .split('\\n')\n    .filter((line) => NPMRC_LINES.includes(line.trim()));\n\n  // If we're only left with !.npmrc line we can remove it\n  // TODO: Consider if we should generalise this\n  if (npmrcLines.length > 0 && npmrcLines.every((line) => line.includes('!'))) {\n    return contents\n      .split('\\n')\n      .filter((line) => !NPMRC_LINES.includes(line.trim()))\n      .join('\\n');\n  }\n  return contents;\n};\n\nexport const REFRESHABLE_CONFIG_FILES: RefreshableConfigFile[] = [\n  { name: '.eslintignore', type: 'ignore' },\n  {\n    name: '.gitignore',\n    type: 'ignore',\n    additionalMapping: removeRedundantNpmrc,\n  },\n  { name: '.prettierignore', type: 'ignore' },\n  {\n    name: '.npmrc',\n    type: 'npmrc',\n    additionalMapping: ensureNoAuthToken,\n    if: (packageManager: PackageManagerConfig) =>\n      packageManager.command === 'pnpm',\n  },\n  {\n    name: '.dockerignore',\n    type: 'ignore',\n    additionalMapping: removeRedundantNpmrc,\n  },\n];\n\nexport const refreshConfigFiles = async (\n  mode: 'format' | 'lint',\n  logger: Logger,\n) => {\n  const manifest = await getDestinationManifest();\n\n  const destinationRoot = path.dirname(manifest.path);\n\n  const readDestinationFile = createDestinationFileReader(destinationRoot);\n\n  const refreshConfigFile = async (\n    {\n      name: filename,\n      type: fileType,\n      additionalMapping = (s) => s,\n      if: condition = () => true,\n    }: RefreshableConfigFile,\n    packageManager: PackageManagerConfig,\n  ) => {\n    if (!condition(packageManager)) {\n      return { needsChange: false };\n    }\n\n    const [inputFile, templateFile] = await Promise.all([\n      readDestinationFile(filename),\n      readBaseTemplateFile(`_${filename}`),\n    ]);\n\n    const data = additionalMapping(\n      inputFile\n        ? mergeWithConfigFile(templateFile, fileType)(inputFile)\n        : templateFile,\n      packageManager,\n    );\n\n    const filepath = path.join(destinationRoot, filename);\n\n    if (mode === 'format') {\n      if (data === inputFile) {\n        return { needsChange: false };\n      }\n\n      await writeFile(filepath, data);\n      return {\n        needsChange: false,\n        msg: `Refreshed ${logger.bold(filename)}.`,\n        filename,\n      };\n    }\n\n    if (data !== inputFile) {\n      return {\n        needsChange: true,\n        msg: `The ${logger.bold(\n          filename,\n        )} file is out of date. Run \\`${logger.bold(\n          packageManager.exec,\n          'skuba',\n          'format',\n        )}\\` to update it.`,\n        filename,\n      };\n    }\n\n    return { needsChange: false };\n  };\n\n  const packageManager = await detectPackageManager(destinationRoot);\n\n  const results = await Promise.all(\n    REFRESHABLE_CONFIG_FILES.map((conf) =>\n      refreshConfigFile(conf, packageManager),\n    ),\n  );\n\n  // Log after for reproducible test output ordering\n  results.forEach((result) => {\n    if (result.msg) {\n      logger.warn(result.msg, logger.dim('refresh-config-files'));\n    }\n  });\n\n  const anyNeedChanging = results.some(({ needsChange }) => needsChange);\n\n  return {\n    ok: !anyNeedChanging,\n    fixable: anyNeedChanging,\n    annotations: results.flatMap(({ needsChange, filename, msg }) =>\n      needsChange && msg\n        ? [\n            {\n              path: filename,\n              message: stripAnsi(msg),\n            },\n          ]\n        : [],\n    ),\n  };\n};\n\nexport const tryRefreshConfigFiles = async (\n  mode: 'format' | 'lint',\n  logger: Logger,\n): Promise<InternalLintResult> => {\n  try {\n    return await refreshConfigFiles(mode, logger);\n  } catch (err) {\n    logger.warn('Failed to refresh config files.');\n    logger.subtle(inspect(err));\n\n    return {\n      ok: false,\n      fixable: false,\n      annotations: [],\n    };\n  }\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AACjB,kBAAwB;AAExB,sBAA0B;AAC1B,wBAAsB;AAGtB,mBAA4C;AAC5C,4BAGO;AACP,sBAAqC;AACrC,qBAAuC;AACvC,qBAA4C;AAC5C,wBAAoC;AAGpC,MAAM,oBAAoB,CAAC,iBACzB,aACG,MAAM,IAAI,EACV,OAAO,CAAC,SAAS,KAAC,6BAAe,IAAI,CAAC,EACtC,KAAK,IAAI;AAYd,MAAM,uBAAuB,CAAC,aAAqB;AACjD,QAAM,aAAa,SAChB,MAAM,IAAI,EACV,OAAO,CAAC,SAAS,yBAAY,SAAS,KAAK,KAAK,CAAC,CAAC;AAIrD,MAAI,WAAW,SAAS,KAAK,WAAW,MAAM,CAAC,SAAS,KAAK,SAAS,GAAG,CAAC,GAAG;AAC3E,WAAO,SACJ,MAAM,IAAI,EACV,OAAO,CAAC,SAAS,CAAC,yBAAY,SAAS,KAAK,KAAK,CAAC,CAAC,EACnD,KAAK,IAAI;AAAA,EACd;AACA,SAAO;AACT;AAEO,MAAM,2BAAoD;AAAA,EAC/D,EAAE,MAAM,iBAAiB,MAAM,SAAS;AAAA,EACxC;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,mBAAmB;AAAA,EACrB;AAAA,EACA,EAAE,MAAM,mBAAmB,MAAM,SAAS;AAAA,EAC1C;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,mBAAmB;AAAA,IACnB,IAAI,CAAC,mBACH,eAAe,YAAY;AAAA,EAC/B;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,mBAAmB;AAAA,EACrB;AACF;AAEO,MAAM,qBAAqB,OAChC,MACA,WACG;AACH,QAAM,WAAW,UAAM,uCAAuB;AAE9C,QAAM,kBAAkB,YAAAA,QAAK,QAAQ,SAAS,IAAI;AAElD,QAAM,0BAAsB,4CAA4B,eAAe;AAEvE,QAAM,oBAAoB,OACxB;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,oBAAoB,CAAC,MAAM;AAAA,IAC3B,IAAI,YAAY,MAAM;AAAA,EACxB,GACAC,oBACG;AACH,QAAI,CAAC,UAAUA,eAAc,GAAG;AAC9B,aAAO,EAAE,aAAa,MAAM;AAAA,IAC9B;AAEA,UAAM,CAAC,WAAW,YAAY,IAAI,MAAM,QAAQ,IAAI;AAAA,MAClD,oBAAoB,QAAQ;AAAA,UAC5B,sCAAqB,IAAI,QAAQ,EAAE;AAAA,IACrC,CAAC;AAED,UAAM,OAAO;AAAA,MACX,gBACI,uCAAoB,cAAc,QAAQ,EAAE,SAAS,IACrD;AAAA,MACJA;AAAA,IACF;AAEA,UAAM,WAAW,YAAAD,QAAK,KAAK,iBAAiB,QAAQ;AAEpD,QAAI,SAAS,UAAU;AACrB,UAAI,SAAS,WAAW;AACtB,eAAO,EAAE,aAAa,MAAM;AAAA,MAC9B;AAEA,gBAAM,2BAAU,UAAU,IAAI;AAC9B,aAAO;AAAA,QACL,aAAa;AAAA,QACb,KAAK,aAAa,OAAO,KAAK,QAAQ,CAAC;AAAA,QACvC;AAAA,MACF;AAAA,IACF;AAEA,QAAI,SAAS,WAAW;AACtB,aAAO;AAAA,QACL,aAAa;AAAA,QACb,KAAK,OAAO,OAAO;AAAA,UACjB;AAAA,QACF,CAAC,+BAA+B,OAAO;AAAA,UACrCC,gBAAe;AAAA,UACf;AAAA,UACA;AAAA,QACF,CAAC;AAAA,QACD;AAAA,MACF;AAAA,IACF;AAEA,WAAO,EAAE,aAAa,MAAM;AAAA,EAC9B;AAEA,QAAM,iBAAiB,UAAM,4CAAqB,eAAe;AAEjE,QAAM,UAAU,MAAM,QAAQ;AAAA,IAC5B,yBAAyB;AAAA,MAAI,CAAC,SAC5B,kBAAkB,MAAM,cAAc;AAAA,IACxC;AAAA,EACF;AAGA,UAAQ,QAAQ,CAAC,WAAW;AAC1B,QAAI,OAAO,KAAK;AACd,aAAO,KAAK,OAAO,KAAK,OAAO,IAAI,sBAAsB,CAAC;AAAA,IAC5D;AAAA,EACF,CAAC;AAED,QAAM,kBAAkB,QAAQ,KAAK,CAAC,EAAE,YAAY,MAAM,WAAW;AAErE,SAAO;AAAA,IACL,IAAI,CAAC;AAAA,IACL,SAAS;AAAA,IACT,aAAa,QAAQ;AAAA,MAAQ,CAAC,EAAE,aAAa,UAAU,IAAI,MACzD,eAAe,MACX;AAAA,QACE;AAAA,UACE,MAAM;AAAA,UACN,aAAS,kBAAAC,SAAU,GAAG;AAAA,QACxB;AAAA,MACF,IACA,CAAC;AAAA,IACP;AAAA,EACF;AACF;AAEO,MAAM,wBAAwB,OACnC,MACA,WACgC;AAChC,MAAI;AACF,WAAO,MAAM,mBAAmB,MAAM,MAAM;AAAA,EAC9C,SAAS,KAAK;AACZ,WAAO,KAAK,iCAAiC;AAC7C,WAAO,WAAO,qBAAQ,GAAG,CAAC;AAE1B,WAAO;AAAA,MACL,IAAI;AAAA,MACJ,SAAS;AAAA,MACT,aAAa,CAAC;AAAA,IAChB;AAAA,EACF;AACF;",
+  "sourcesContent": ["import path from 'path';\nimport { inspect } from 'util';\n\nimport { writeFile } from 'fs-extra';\nimport stripAnsi from 'strip-ansi';\n\nimport { Git } from '../../..';\nimport type { Logger } from '../../../utils/logging';\nimport { NPMRC_LINES, hasNpmrcSecret } from '../../../utils/npmrc';\nimport {\n  type PackageManagerConfig,\n  detectPackageManager,\n} from '../../../utils/packageManager';\nimport { readBaseTemplateFile } from '../../../utils/template';\nimport { getDestinationManifest } from '../../configure/analysis/package';\nimport { createDestinationFileReader } from '../../configure/analysis/project';\nimport { mergeWithConfigFile } from '../../configure/processing/configFile';\nimport type { InternalLintResult } from '../internal';\n\nconst ensureNoAuthToken = (fileContents: string) =>\n  fileContents\n    .split('\\n')\n    .filter((line) => !hasNpmrcSecret(line))\n    .join('\\n');\n\ntype RefreshableConfigFile = {\n  name: string;\n  type: 'ignore' | 'npmrc';\n  additionalMapping?: (\n    s: string,\n    packageManager: PackageManagerConfig,\n  ) => string;\n  if?: (packageManager: PackageManagerConfig) => boolean;\n};\n\nconst removeRedundantNpmrc = (contents: string) => {\n  const npmrcLines = contents\n    .split('\\n')\n    .filter((line) => NPMRC_LINES.includes(line.trim()));\n\n  // If we're only left with !.npmrc line we can remove it\n  // TODO: Consider if we should generalise this\n  if (npmrcLines.length > 0 && npmrcLines.every((line) => line.includes('!'))) {\n    return contents\n      .split('\\n')\n      .filter((line) => !NPMRC_LINES.includes(line.trim()))\n      .join('\\n');\n  }\n  return contents;\n};\n\nexport const REFRESHABLE_CONFIG_FILES: RefreshableConfigFile[] = [\n  { name: '.eslintignore', type: 'ignore' },\n  {\n    name: '.gitignore',\n    type: 'ignore',\n    additionalMapping: removeRedundantNpmrc,\n  },\n  { name: '.prettierignore', type: 'ignore' },\n  {\n    name: '.npmrc',\n    type: 'npmrc',\n    additionalMapping: ensureNoAuthToken,\n    if: (packageManager: PackageManagerConfig) =>\n      packageManager.command === 'pnpm',\n  },\n  {\n    name: '.dockerignore',\n    type: 'ignore',\n    additionalMapping: removeRedundantNpmrc,\n  },\n];\n\nexport const refreshConfigFiles = async (\n  mode: 'format' | 'lint',\n  logger: Logger,\n) => {\n  const [manifest, gitRoot] = await Promise.all([\n    getDestinationManifest(),\n    Git.findRoot({ dir: process.cwd() }),\n  ]);\n\n  const destinationRoot = path.dirname(manifest.path);\n\n  const readDestinationFile = createDestinationFileReader(destinationRoot);\n\n  const refreshConfigFile = async (\n    {\n      name: filename,\n      type: fileType,\n      additionalMapping = (s) => s,\n      if: condition = () => true,\n    }: RefreshableConfigFile,\n    packageManager: PackageManagerConfig,\n  ) => {\n    if (!condition(packageManager)) {\n      return { needsChange: false };\n    }\n\n    const [inputFile, templateFile, isGitIgnored] = await Promise.all([\n      readDestinationFile(filename),\n      readBaseTemplateFile(`_${filename}`),\n      gitRoot\n        ? Git.isFileGitIgnored({\n            gitRoot,\n            absolutePath: path.join(destinationRoot, filename),\n          })\n        : false,\n    ]);\n\n    // If the file is gitignored and doesn't exist, don't make it\n    if (inputFile === undefined && isGitIgnored) {\n      return { needsChange: false };\n    }\n\n    const data = additionalMapping(\n      inputFile\n        ? mergeWithConfigFile(templateFile, fileType)(inputFile)\n        : templateFile,\n      packageManager,\n    );\n\n    const filepath = path.join(destinationRoot, filename);\n\n    if (mode === 'format') {\n      if (data === inputFile) {\n        return { needsChange: false };\n      }\n\n      await writeFile(filepath, data);\n      return {\n        needsChange: false,\n        msg: `Refreshed ${logger.bold(filename)}.`,\n        filename,\n      };\n    }\n\n    if (data !== inputFile) {\n      return {\n        needsChange: true,\n        msg: `The ${logger.bold(\n          filename,\n        )} file is out of date. Run \\`${logger.bold(\n          packageManager.exec,\n          'skuba',\n          'format',\n        )}\\` to update it.`,\n        filename,\n      };\n    }\n\n    return { needsChange: false };\n  };\n\n  const packageManager = await detectPackageManager(destinationRoot);\n\n  const results = await Promise.all(\n    REFRESHABLE_CONFIG_FILES.map((conf) =>\n      refreshConfigFile(conf, packageManager),\n    ),\n  );\n\n  // Log after for reproducible test output ordering\n  results.forEach((result) => {\n    if (result.msg) {\n      logger.warn(result.msg, logger.dim('refresh-config-files'));\n    }\n  });\n\n  const anyNeedChanging = results.some(({ needsChange }) => needsChange);\n\n  return {\n    ok: !anyNeedChanging,\n    fixable: anyNeedChanging,\n    annotations: results.flatMap(({ needsChange, filename, msg }) =>\n      needsChange && msg\n        ? [\n            {\n              path: filename,\n              message: stripAnsi(msg),\n            },\n          ]\n        : [],\n    ),\n  };\n};\n\nexport const tryRefreshConfigFiles = async (\n  mode: 'format' | 'lint',\n  logger: Logger,\n): Promise<InternalLintResult> => {\n  try {\n    return await refreshConfigFiles(mode, logger);\n  } catch (err) {\n    logger.warn('Failed to refresh config files.');\n    logger.subtle(inspect(err));\n\n    return {\n      ok: false,\n      fixable: false,\n      annotations: [],\n    };\n  }\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiB;AACjB,kBAAwB;AAExB,sBAA0B;AAC1B,wBAAsB;AAEtB,eAAoB;AAEpB,mBAA4C;AAC5C,4BAGO;AACP,sBAAqC;AACrC,qBAAuC;AACvC,qBAA4C;AAC5C,wBAAoC;AAGpC,MAAM,oBAAoB,CAAC,iBACzB,aACG,MAAM,IAAI,EACV,OAAO,CAAC,SAAS,KAAC,6BAAe,IAAI,CAAC,EACtC,KAAK,IAAI;AAYd,MAAM,uBAAuB,CAAC,aAAqB;AACjD,QAAM,aAAa,SAChB,MAAM,IAAI,EACV,OAAO,CAAC,SAAS,yBAAY,SAAS,KAAK,KAAK,CAAC,CAAC;AAIrD,MAAI,WAAW,SAAS,KAAK,WAAW,MAAM,CAAC,SAAS,KAAK,SAAS,GAAG,CAAC,GAAG;AAC3E,WAAO,SACJ,MAAM,IAAI,EACV,OAAO,CAAC,SAAS,CAAC,yBAAY,SAAS,KAAK,KAAK,CAAC,CAAC,EACnD,KAAK,IAAI;AAAA,EACd;AACA,SAAO;AACT;AAEO,MAAM,2BAAoD;AAAA,EAC/D,EAAE,MAAM,iBAAiB,MAAM,SAAS;AAAA,EACxC;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,mBAAmB;AAAA,EACrB;AAAA,EACA,EAAE,MAAM,mBAAmB,MAAM,SAAS;AAAA,EAC1C;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,mBAAmB;AAAA,IACnB,IAAI,CAAC,mBACH,eAAe,YAAY;AAAA,EAC/B;AAAA,EACA;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,mBAAmB;AAAA,EACrB;AACF;AAEO,MAAM,qBAAqB,OAChC,MACA,WACG;AACH,QAAM,CAAC,UAAU,OAAO,IAAI,MAAM,QAAQ,IAAI;AAAA,QAC5C,uCAAuB;AAAA,IACvB,aAAI,SAAS,EAAE,KAAK,QAAQ,IAAI,EAAE,CAAC;AAAA,EACrC,CAAC;AAED,QAAM,kBAAkB,YAAAA,QAAK,QAAQ,SAAS,IAAI;AAElD,QAAM,0BAAsB,4CAA4B,eAAe;AAEvE,QAAM,oBAAoB,OACxB;AAAA,IACE,MAAM;AAAA,IACN,MAAM;AAAA,IACN,oBAAoB,CAAC,MAAM;AAAA,IAC3B,IAAI,YAAY,MAAM;AAAA,EACxB,GACAC,oBACG;AACH,QAAI,CAAC,UAAUA,eAAc,GAAG;AAC9B,aAAO,EAAE,aAAa,MAAM;AAAA,IAC9B;AAEA,UAAM,CAAC,WAAW,cAAc,YAAY,IAAI,MAAM,QAAQ,IAAI;AAAA,MAChE,oBAAoB,QAAQ;AAAA,UAC5B,sCAAqB,IAAI,QAAQ,EAAE;AAAA,MACnC,UACI,aAAI,iBAAiB;AAAA,QACnB;AAAA,QACA,cAAc,YAAAD,QAAK,KAAK,iBAAiB,QAAQ;AAAA,MACnD,CAAC,IACD;AAAA,IACN,CAAC;AAGD,QAAI,cAAc,UAAa,cAAc;AAC3C,aAAO,EAAE,aAAa,MAAM;AAAA,IAC9B;AAEA,UAAM,OAAO;AAAA,MACX,gBACI,uCAAoB,cAAc,QAAQ,EAAE,SAAS,IACrD;AAAA,MACJC;AAAA,IACF;AAEA,UAAM,WAAW,YAAAD,QAAK,KAAK,iBAAiB,QAAQ;AAEpD,QAAI,SAAS,UAAU;AACrB,UAAI,SAAS,WAAW;AACtB,eAAO,EAAE,aAAa,MAAM;AAAA,MAC9B;AAEA,gBAAM,2BAAU,UAAU,IAAI;AAC9B,aAAO;AAAA,QACL,aAAa;AAAA,QACb,KAAK,aAAa,OAAO,KAAK,QAAQ,CAAC;AAAA,QACvC;AAAA,MACF;AAAA,IACF;AAEA,QAAI,SAAS,WAAW;AACtB,aAAO;AAAA,QACL,aAAa;AAAA,QACb,KAAK,OAAO,OAAO;AAAA,UACjB;AAAA,QACF,CAAC,+BAA+B,OAAO;AAAA,UACrCC,gBAAe;AAAA,UACf;AAAA,UACA;AAAA,QACF,CAAC;AAAA,QACD;AAAA,MACF;AAAA,IACF;AAEA,WAAO,EAAE,aAAa,MAAM;AAAA,EAC9B;AAEA,QAAM,iBAAiB,UAAM,4CAAqB,eAAe;AAEjE,QAAM,UAAU,MAAM,QAAQ;AAAA,IAC5B,yBAAyB;AAAA,MAAI,CAAC,SAC5B,kBAAkB,MAAM,cAAc;AAAA,IACxC;AAAA,EACF;AAGA,UAAQ,QAAQ,CAAC,WAAW;AAC1B,QAAI,OAAO,KAAK;AACd,aAAO,KAAK,OAAO,KAAK,OAAO,IAAI,sBAAsB,CAAC;AAAA,IAC5D;AAAA,EACF,CAAC;AAED,QAAM,kBAAkB,QAAQ,KAAK,CAAC,EAAE,YAAY,MAAM,WAAW;AAErE,SAAO;AAAA,IACL,IAAI,CAAC;AAAA,IACL,SAAS;AAAA,IACT,aAAa,QAAQ;AAAA,MAAQ,CAAC,EAAE,aAAa,UAAU,IAAI,MACzD,eAAe,MACX;AAAA,QACE;AAAA,UACE,MAAM;AAAA,UACN,aAAS,kBAAAC,SAAU,GAAG;AAAA,QACxB;AAAA,MACF,IACA,CAAC;AAAA,IACP;AAAA,EACF;AACF;AAEO,MAAM,wBAAwB,OACnC,MACA,WACgC;AAChC,MAAI;AACF,WAAO,MAAM,mBAAmB,MAAM,MAAM;AAAA,EAC9C,SAAS,KAAK;AACZ,WAAO,KAAK,iCAAiC;AAC7C,WAAO,WAAO,qBAAQ,GAAG,CAAC;AAE1B,WAAO;AAAA,MACL,IAAI;AAAA,MACJ,SAAS;AAAA,MACT,aAAa,CAAC;AAAA,IAChB;AAAA,EACF;AACF;",
   "names": ["path", "packageManager", "stripAnsi"]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "skuba",
-  "version": "8.1.0-pm-20240430084912",
+  "version": "8.1.0-skuba-dive-secret-20240522031929",
   "private": false,
   "description": "SEEK development toolkit for backend applications and packages",
   "homepage": "https://github.com/seek-oss/skuba#readme",
@@ -132,7 +132,7 @@
     "type-fest": "2.19.0"
   },
   "peerDependencies": {
-    "skuba-dive": "1 || 2"
+    "skuba-dive": "2.0.1-skuba-dive-secret-20240522031929"
   },
   "peerDependenciesMeta": {
     "skuba-dive": {
@@ -161,11 +161,11 @@
     "lint:md": "remark --frail --quiet .",
     "release": "pnpm --silent build && changeset publish",
     "skuba": "pnpm --silent build && pnpm --silent skuba:exec",
-    "skuba:exec": "node --env-file=.env lib/skuba",
+    "skuba:exec": "node --experimental-vm-modules lib/skuba",
     "stage": "changeset version && node ./.changeset/inject.js && pnpm format",
-    "test": "pnpm --silent skuba test --selectProjects unit",
+    "test": "pnpm --silent skuba test --selectProjects unit --",
     "test:ci": "pnpm --silent skuba test --runInBand",
-    "test:int": "pnpm --silent skuba test --runInBand --selectProjects integration",
+    "test:int": "pnpm --silent skuba test --selectProjects integration --runInBand",
     "test:template": "scripts/test-template.sh",
     "test:watch": "pnpm --silent skuba test --runInBand --watch"
   }

package/template/base/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+}

package/template/base/_.gitignore

@@ -1,6 +1,7 @@
 # managed by skuba
 .idea/*
 .vscode/*
+!.vscode/extensions.json
 
 .cdk.staging/
 .serverless/

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

@@ -14,6 +14,8 @@
   "dependencies": {
     "@seek/logger": "^6.0.0",
     "express": "^4.17.1",
+    "hot-shots": "^10.0.0",
+    "seek-datadog-custom-metrics": "^4.6.3",
     "skuba-dive": "^2.0.0"
   },
   "devDependencies": {

package/template/express-rest-api/src/config.ts

@@ -7,8 +7,8 @@ interface Config {
   name: string;
   version: string;
 
-  metricsServer?: string;
-  port?: number;
+  metricsServer: string | null;
+  port: number | null;
 }
 
 type Environment = (typeof environments)[number];
@@ -26,19 +26,27 @@ const configs: Record<Environment, () => Omit<Config, 'environment'>> = {
     logLevel: 'debug',
     name: '<%- serviceName %>',
     version: 'local',
+
+    metricsServer: null,
+    port: null,
   }),
 
   test: () => ({
-    ...configs.local(),
-
     logLevel: Env.string('LOG_LEVEL', { default: 'silent' }),
+    name: '<%- serviceName %>',
     version: 'test',
+
+    metricsServer: null,
+    port: null,
   }),
 
   [dev]: () => ({
-    ...configs[prod](),
-
     logLevel: 'debug',
+    name: Env.string('SERVICE'),
+    version: Env.string('VERSION'),
+
+    metricsServer: 'localhost',
+    port: Env.nonNegativeInteger('PORT'),
   }),
 
   [prod]: () => ({

package/template/express-rest-api/src/framework/logging.ts

@@ -2,7 +2,7 @@ import createLogger from '@seek/logger';
 
 import { config } from 'src/config';
 
-export const rootLogger = createLogger({
+export const logger = createLogger({
   base: {
     environment: config.environment,
     version: config.version,

package/template/express-rest-api/src/framework/metrics.ts

@@ -0,0 +1,11 @@
+import { StatsD } from 'hot-shots';
+import { createStatsDClient } from 'seek-datadog-custom-metrics';
+
+import { config } from 'src/config';
+
+import { logger } from './logging';
+
+/* istanbul ignore next: StatsD client is not our responsibility */
+export const metricsClient = createStatsDClient(StatsD, config, (err) =>
+  logger.error({ err }, 'StatsD error'),
+);

package/template/express-rest-api/src/listen.ts

@@ -2,7 +2,7 @@ import './register';
 
 import app from './app';
 import { config } from './config';
-import { rootLogger } from './framework/logging';
+import { logger } from './framework/logging';
 
 // If your application is deployed with more than 1 vCPU you can delete this
 // file and use a clustering utility to run `lib/app`.
@@ -11,7 +11,7 @@ const listener = app.listen(config.port, () => {
   const address = listener.address();
 
   if (typeof address === 'object' && address) {
-    rootLogger.debug(`listening on port ${address.port}`);
+    logger.debug(`listening on port ${address.port}`);
   }
 });
 

package/template/koa-rest-api/package.json

@@ -26,7 +26,7 @@
     "koa": "^2.13.4",
     "koa-bodyparser": "^4.3.0",
     "koa-compose": "^4.2.0",
-    "seek-datadog-custom-metrics": "^4.2.1",
+    "seek-datadog-custom-metrics": "^4.6.3",
     "seek-koala": "^7.0.0",
     "skuba-dive": "^2.0.0",
     "zod": "^3.19.1"

package/template/koa-rest-api/src/config.ts

@@ -7,8 +7,8 @@ interface Config {
   name: string;
   version: string;
 
-  metricsServer?: string;
-  port?: number;
+  metricsServer: string | null;
+  port: number | null;
 }
 
 type Environment = (typeof environments)[number];
@@ -26,19 +26,29 @@ const configs: Record<Environment, () => Omit<Config, 'environment'>> = {
     logLevel: 'debug',
     name: '<%- serviceName %>',
     version: 'local',
+
+    metricsServer: null,
+    port: null,
   }),
 
   test: () => ({
-    ...configs.local(),
-
     logLevel: Env.string('LOG_LEVEL', { default: 'silent' }),
+    name: '<%- serviceName %>',
     version: 'test',
+
+    metricsServer: null,
+    port: null,
   }),
 
   [dev]: () => ({
     ...configs[prod](),
 
     logLevel: 'debug',
+    name: Env.string('SERVICE'),
+    version: Env.string('VERSION'),
+
+    metricsServer: 'localhost',
+    port: Env.nonNegativeInteger('PORT'),
   }),
 
   [prod]: () => ({

package/template/lambda-sqs-worker/src/config.ts

@@ -29,16 +29,21 @@ const configs: Record<Environment, () => Omit<Config, 'environment'>> = {
   }),
 
   test: () => ({
-    ...configs.local(),
-
     logLevel: Env.string('LOG_LEVEL', { default: 'silent' }),
+    metrics: false,
+    name: '<%- serviceName %>',
     version: 'test',
+
+    destinationSnsTopicArn: 'arn:aws:sns:us-east-2:123456789012:destination',
   }),
 
   dev: () => ({
-    ...configs.prod(),
-
     logLevel: 'debug',
+    metrics: true,
+    name: Env.string('SERVICE'),
+    version: Env.string('VERSION'),
+
+    destinationSnsTopicArn: Env.string('DESTINATION_SNS_TOPIC_ARN'),
   }),
 
   prod: () => ({

package/template/lambda-sqs-worker-cdk/infra/__snapshots__/appStack.test.ts.snap

@@ -451,6 +451,8 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
             "ENVIRONMENT": "dev",
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
+            "SERVICE": "serviceName",
+            "VERSION": "local",
           },
         },
         "FunctionName": "serviceName",
@@ -644,6 +646,8 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
             },
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
+            "SERVICE": "serviceName",
+            "VERSION": "local",
           },
         },
         "FunctionName": "serviceName-post-hook",
@@ -796,6 +800,8 @@ exports[`returns expected CloudFormation stack for dev 1`] = `
             },
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
+            "SERVICE": "serviceName",
+            "VERSION": "local",
           },
         },
         "FunctionName": "serviceName-pre-hook",
@@ -1493,6 +1499,8 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
             "ENVIRONMENT": "prod",
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
+            "SERVICE": "serviceName",
+            "VERSION": "local",
           },
         },
         "FunctionName": "serviceName",
@@ -1686,6 +1694,8 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
             },
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
+            "SERVICE": "serviceName",
+            "VERSION": "local",
           },
         },
         "FunctionName": "serviceName-post-hook",
@@ -1838,6 +1848,8 @@ exports[`returns expected CloudFormation stack for prod 1`] = `
             },
             "NODE_ENV": "production",
             "NODE_OPTIONS": "--enable-source-maps",
+            "SERVICE": "serviceName",
+            "VERSION": "local",
           },
         },
         "FunctionName": "serviceName-pre-hook",

package/template/lambda-sqs-worker-cdk/infra/config.ts

@@ -1,27 +1,33 @@
-import { z } from 'zod';
+import { Env } from 'skuba-dive';
 
-const environment = z.enum(['dev', 'prod']).parse(process.env.ENVIRONMENT);
+const ENVIRONMENTS = ['dev', 'prod'] as const;
 
-type Environment = typeof environment;
+type Environment = (typeof ENVIRONMENTS)[number];
 
-export interface Config {
+const environment = Env.oneOf(ENVIRONMENTS)('ENVIRONMENT');
+
+interface Config {
   appName: string;
   workerLambda: {
     reservedConcurrency: number;
     environment: {
       ENVIRONMENT: Environment;
+      SERVICE: string;
+      VERSION: string;
     };
   };
   sourceSnsTopicArn: string;
 }
 
-export const configs: Record<Environment, Config> = {
+const configs: Record<Environment, Config> = {
   dev: {
     appName: '<%- serviceName %>',
     workerLambda: {
       reservedConcurrency: 2,
       environment: {
         ENVIRONMENT: 'dev',
+        SERVICE: '<%- serviceName %>',
+        VERSION: Env.string('VERSION', { default: 'local' }),
       },
     },
     sourceSnsTopicArn: 'TODO: sourceSnsTopicArn',
@@ -32,10 +38,12 @@ export const configs: Record<Environment, Config> = {
       reservedConcurrency: 20,
       environment: {
         ENVIRONMENT: 'prod',
+        SERVICE: '<%- serviceName %>',
+        VERSION: Env.string('VERSION', { default: 'local' }),
       },
     },
     sourceSnsTopicArn: 'TODO: sourceSnsTopicArn',
   },
 };
 
-export const config = configs[environment];
+export const config: Config = configs[environment];

package/template/lambda-sqs-worker-cdk/package.json

@@ -16,6 +16,7 @@
     "@aws-sdk/client-lambda": "^3.363.0",
     "@aws-sdk/client-sns": "^3.363.0",
     "@seek/logger": "^6.0.0",
+    "skuba-dive": "^2.0.0",
     "zod": "^3.19.1"
   },
   "devDependencies": {
@@ -24,6 +25,7 @@
     "aws-cdk": "^2.109.0",
     "aws-cdk-lib": "^2.109.0",
     "constructs": "^10.0.17",
+    "pino-pretty": "^11.0.0",
     "skuba": "*"
   },
   "packageManager": "pnpm@9.0.2",

package/template/lambda-sqs-worker-cdk/src/app.ts

@@ -1,8 +1,20 @@
 import createLogger from '@seek/logger';
 import type { SQSEvent, SQSHandler } from 'aws-lambda';
 
-const logger = createLogger({
-  name: '<%- serviceName %>',
+import { config } from './config';
+
+export const logger = createLogger({
+  base: {
+    environment: config.environment,
+    version: config.version,
+  },
+
+  level: config.logLevel,
+
+  name: config.name,
+
+  transport:
+    config.environment === 'local' ? { target: 'pino-pretty' } : undefined,
 });
 
 /**

package/template/lambda-sqs-worker-cdk/src/config.ts

@@ -0,0 +1,47 @@
+import { Env } from 'skuba-dive';
+
+interface Config {
+  environment: Environment;
+
+  logLevel: string;
+  name: string;
+  version: string;
+}
+
+type Environment = (typeof environments)[number];
+
+const environments = ['local', 'test', 'dev', 'prod'] as const;
+
+const environment = Env.oneOf(environments)('ENVIRONMENT');
+
+/* istanbul ignore next: config verification makes more sense in a smoke test */
+const configs: Record<Environment, () => Omit<Config, 'environment'>> = {
+  local: () => ({
+    logLevel: 'debug',
+    name: '<%- serviceName %>',
+    version: 'local',
+  }),
+
+  test: () => ({
+    logLevel: Env.string('LOG_LEVEL', { default: 'silent' }),
+    name: '<%- serviceName %>',
+    version: 'test',
+  }),
+
+  dev: () => ({
+    logLevel: 'debug',
+    name: Env.string('SERVICE'),
+    version: Env.string('VERSION'),
+  }),
+
+  prod: () => ({
+    logLevel: 'info',
+    name: Env.string('SERVICE'),
+    version: Env.string('VERSION'),
+  }),
+};
+
+export const config: Config = {
+  ...configs[environment](),
+  environment,
+};