skuba 13.0.2 → 14.0.0-esmify-skuba-20251031135439

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

@@ -1,5 +1,14 @@
 import { PublishCommand } from '@aws-sdk/client-sns';
 import type { SQSBatchResponse } from 'aws-lambda';
+import {
+  afterEach,
+  beforeAll,
+  beforeEach,
+  describe,
+  expect,
+  it,
+  vi,
+} from 'vitest';
 
 import * as app from './app.js';
 import { stdoutMock } from './framework/logging.js';
@@ -20,7 +29,7 @@ describe('handler', () => {
 
   const score = chance.floating({ max: 1, min: 0 });
 
-  const distribution = jest
+  const distribution = vi
     .spyOn(metricsClient, 'distribution')
     .mockReturnValue();
 
@@ -41,9 +50,9 @@ describe('handler', () => {
   it('handles one record', async () => {
     const event = createSqsEvent([JSON.stringify(jobPublished)]);
 
-    await expect(app.handler(event, ctx)).resolves.toEqual<SQSBatchResponse>({
+    await expect(app.handler(event, ctx)).resolves.toEqual({
       batchItemFailures: [],
-    });
+    } satisfies SQSBatchResponse);
 
     expect(scoringService.request).toHaveBeenCalledTimes(1);
 
@@ -72,9 +81,9 @@ describe('handler', () => {
       JSON.stringify(jobPublished),
     ]);
 
-    await expect(app.handler(event, ctx)).resolves.toEqual<SQSBatchResponse>({
+    await expect(app.handler(event, ctx)).resolves.toEqual({
       batchItemFailures: [],
-    });
+    } satisfies SQSBatchResponse);
 
     expect(stdoutMock.calls).toMatchObject([
       { count: 2, level: 20, msg: 'Received jobs' },
@@ -100,9 +109,9 @@ describe('handler', () => {
       JSON.stringify(jobPublished),
     ]);
 
-    await expect(app.handler(event, ctx)).resolves.toEqual<SQSBatchResponse>({
+    await expect(app.handler(event, ctx)).resolves.toEqual({
       batchItemFailures: [{ itemIdentifier: event.Records[0]!.messageId }],
-    });
+    } satisfies SQSBatchResponse);
 
     expect(stdoutMock.calls).toMatchObject([
       { count: 2, level: 20, msg: 'Received jobs' },
@@ -128,13 +137,13 @@ describe('handler', () => {
   it('returns a batchItemFailure on invalid input', () => {
     const event = createSqsEvent(['}']);
 
-    return expect(app.handler(event, ctx)).resolves.toEqual<SQSBatchResponse>({
+    return expect(app.handler(event, ctx)).resolves.toEqual({
       batchItemFailures: [
         {
           itemIdentifier: event.Records[0]!.messageId,
         },
       ],
-    });
+    } satisfies SQSBatchResponse);
   });
 
   it('bubbles up scoring service error', async () => {
@@ -144,9 +153,9 @@ describe('handler', () => {
 
     const event = createSqsEvent([JSON.stringify(jobPublished)]);
 
-    await expect(app.handler(event, ctx)).resolves.toEqual<SQSBatchResponse>({
+    await expect(app.handler(event, ctx)).resolves.toEqual({
       batchItemFailures: [{ itemIdentifier: event.Records[0]!.messageId }],
-    });
+    } satisfies SQSBatchResponse);
 
     expect(stdoutMock.calls).toMatchObject([
       { count: 1, level: 20, msg: 'Received jobs' },
@@ -170,9 +179,9 @@ describe('handler', () => {
 
     const event = createSqsEvent([JSON.stringify(jobPublished)]);
 
-    await expect(app.handler(event, ctx)).resolves.toEqual<SQSBatchResponse>({
+    await expect(app.handler(event, ctx)).resolves.toEqual({
       batchItemFailures: [{ itemIdentifier: event.Records[0]!.messageId }],
-    });
+    } satisfies SQSBatchResponse);
 
     expect(stdoutMock.calls).toMatchObject([
       {

package/template/lambda-sqs-worker-cdk/src/framework/handler.test.ts

@@ -1,4 +1,5 @@
 import type { SQSEvent } from 'aws-lambda';
+import { afterEach, describe, expect, it } from 'vitest';
 
 import { createHandler } from './handler.js';
 import { logger, stdoutMock } from './logging.js';

package/template/lambda-sqs-worker-cdk/src/framework/validation.test.ts

@@ -1,3 +1,5 @@
+import { describe, expect, it } from 'vitest';
+
 import { validateJson } from './validation.js';
 
 import {
@@ -30,17 +32,17 @@ describe('validateJson', () => {
 
     expect(() => validateJson(input, IdDescriptionSchema))
       .toThrowErrorMatchingInlineSnapshot(`
-      "[
-        {
-          "expected": "string",
-          "code": "invalid_type",
-          "path": [
-            "id"
-          ],
-          "message": "Invalid input: expected string, received null"
-        }
-      ]"
-    `);
+        [ZodError: [
+          {
+            "expected": "string",
+            "code": "invalid_type",
+            "path": [
+              "id"
+            ],
+            "message": "Invalid input: expected string, received null"
+          }
+        ]]
+      `);
   });
 
   it('blocks missing prop', () => {
@@ -48,25 +50,25 @@ describe('validateJson', () => {
 
     expect(() => validateJson(input, IdDescriptionSchema))
       .toThrowErrorMatchingInlineSnapshot(`
-      "[
-        {
-          "expected": "string",
-          "code": "invalid_type",
-          "path": [
-            "id"
-          ],
-          "message": "Invalid input: expected string, received undefined"
-        },
-        {
-          "expected": "string",
-          "code": "invalid_type",
-          "path": [
-            "description"
-          ],
-          "message": "Invalid input: expected string, received undefined"
-        }
-      ]"
-    `);
+        [ZodError: [
+          {
+            "expected": "string",
+            "code": "invalid_type",
+            "path": [
+              "id"
+            ],
+            "message": "Invalid input: expected string, received undefined"
+          },
+          {
+            "expected": "string",
+            "code": "invalid_type",
+            "path": [
+              "description"
+            ],
+            "message": "Invalid input: expected string, received undefined"
+          }
+        ]]
+      `);
   });
 
   it('blocks invalid JSON', () => {
@@ -75,7 +77,7 @@ describe('validateJson', () => {
     expect(() =>
       validateJson(input, IdDescriptionSchema),
     ).toThrowErrorMatchingInlineSnapshot(
-      `"Unexpected token '}', "}" is not valid JSON"`,
+      `[SyntaxError: Unexpected token '}', "}" is not valid JSON]`,
     );
   });
 });

package/template/lambda-sqs-worker-cdk/src/services/jobScorer.test.ts

@@ -1,12 +1,18 @@
+import { afterEach, beforeAll, describe, expect, it } from 'vitest';
+
 import * as jobScorer from './jobScorer.js';
 
 import { scoringService } from '#src/testing/services.js';
 import { chance, mockJobPublishedEvent } from '#src/testing/types.js';
 
 describe('scoreJobPublishedEvent', () => {
-  beforeAll(scoringService.spy);
+  beforeAll(() => {
+    scoringService.spy();
+  });
 
-  afterEach(scoringService.clear);
+  afterEach(() => {
+    scoringService.clear();
+  });
 
   it('scores an event', async () => {
     const score = chance.floating({ max: 1, min: 0 });

package/template/lambda-sqs-worker-cdk/src/services/pipelineEventSender.test.ts

@@ -1,4 +1,5 @@
 import { PublishCommand } from '@aws-sdk/client-sns';
+import { afterEach, describe, expect, it, vi } from 'vitest';
 
 import { sendPipelineEvent } from './pipelineEventSender.js';
 
@@ -7,7 +8,7 @@ import { chance } from '#src/testing/types.js';
 
 describe('sendPipelineEvent', () => {
   afterEach(() => {
-    jest.clearAllMocks();
+    vi.clearAllMocks();
   });
 
   it('handles happy path', async () => {
@@ -34,7 +35,7 @@ describe('sendPipelineEvent', () => {
     return expect(
       sendPipelineEvent({}),
     ).rejects.toThrowErrorMatchingInlineSnapshot(
-      `"SNS did not return a message ID"`,
+      `[Error: SNS did not return a message ID]`,
     );
   });
 });

package/template/lambda-sqs-worker-cdk/src/testing/services.ts

@@ -1,18 +1,19 @@
-import 'aws-sdk-client-mock-jest';
+import 'aws-sdk-client-mock-vitest/extend';
 
 import { PublishCommand } from '@aws-sdk/client-sns';
 import { mockClient } from 'aws-sdk-client-mock';
+import { vi } from 'vitest';
 
 import { sns as snsClient } from '#src/services/aws.js';
 import * as jobScorer from '#src/services/jobScorer.js';
 
 export const scoringService = {
-  request: jest.fn(),
+  request: vi.fn(),
 
   clear: () => scoringService.request.mockClear(),
 
   spy: () =>
-    jest
+    vi
       .spyOn(jobScorer.scoringService, 'request')
       .mockImplementation(scoringService.request),
 };

package/template/oss-npm-package/.github/workflows/release.yml

@@ -26,7 +26,7 @@ jobs:
         uses: pnpm/action-setup@v4
 
       - name: Set up Node.js
-        uses: actions/setup-node@v5
+        uses: actions/setup-node@v6
         with:
           node-version-file: .nvmrc
 

package/template/oss-npm-package/.github/workflows/validate.yml

@@ -22,7 +22,7 @@ jobs:
         uses: pnpm/action-setup@v4
 
       - name: Set up Node.js
-        uses: actions/setup-node@v5
+        uses: actions/setup-node@v6
         with:
           node-version-file: .nvmrc
 

package/template/oss-npm-package/_package.json

@@ -14,6 +14,7 @@
   },
   "license": "MIT",
   "sideEffects": false,
+  "type": "module",
   "main": "./lib-commonjs/index.js",
   "module": "./lib-es2015/index.js",
   "types": "./lib-types/index.d.ts",

package/template/oss-npm-package/skuba.template.js

@@ -2,7 +2,7 @@
  * Run `skuba configure` to finish templating and remove this file.
  */
 
-module.exports = {
+export default {
   entryPoint: 'src/index.ts',
   fields: [
     {

package/template/oss-npm-package/src/index.test.ts

@@ -1,3 +1,5 @@
+import { describe, expect, it } from 'vitest';
+
 import { log } from './index.js';
 
 describe('app', () => {

package/template/private-npm-package/_package.json

@@ -14,6 +14,7 @@
   },
   "license": "UNLICENSED",
   "sideEffects": false,
+  "type": "module",
   "main": "./lib-commonjs/index.js",
   "module": "./lib-es2015/index.js",
   "types": "./lib-types/index.d.ts",

package/template/private-npm-package/skuba.template.js

@@ -2,7 +2,7 @@
  * Run `skuba configure` to finish templating and remove this file.
  */
 
-module.exports = {
+export default {
   entryPoint: 'src/index.ts',
   fields: [
     {

package/template/private-npm-package/src/index.test.ts

@@ -1,3 +1,5 @@
+import { describe, expect, it } from 'vitest';
+
 import { log } from './index.js';
 
 describe('app', () => {

package/config/jest.js

@@ -1 +0,0 @@
-module.exports = require('../jest-preset');

package/config/prettier.d.ts

@@ -1,4 +0,0 @@
-export const singleQuote: boolean;
-export const tabWidth: number;
-export const trailingComma: 'all';
-export const plugins: ['prettier-plugin-packagejson'];

package/jest/moduleNameMapper.js

@@ -1,64 +0,0 @@
-const path = require('path');
-
-const { pathsToModuleNameMapper } = require('ts-jest');
-
-const { tryParseTsConfig } = require('./tsConfig');
-
-module.exports.createModuleNameMapper = (getConfig) => {
-  const maybeTsConfig = tryParseTsConfig(getConfig);
-
-  const paths = Object.fromEntries(
-    Object.entries(maybeTsConfig?.options.paths ?? {}).flatMap(
-      ([key, values]) => [
-        // Pass through the input path entry almost verbatim.
-        // We trim a trailing slash because TypeScript allows `import 'src'`
-        // to be resolved by the alias `src/`, but Jest's mapper does not.
-        [
-          key.replace(/\/$/, ''),
-          values.map((value) => value.replace(/\/$/, '')),
-        ],
-        // Append a variant of the input path entry.
-        // As TypeScript allows both `import 'src'` and `import 'src/nested'`
-        // to be resolved by the alias `src/*` (and likewise for plain `src`),
-        // we need to seed two Jest mappings per path.
-        ...(key.endsWith('/*')
-          ? [
-              [
-                // Given a path `src/*`, seed an extra `src`.
-                key.replace(/\/\*$/, ''),
-                values.map((value) => value.replace(/\/\*$/, '')),
-              ],
-            ]
-          : [
-              [
-                // Given a path `src`, seed an extra `src/*`.
-                path.join(key, '*'),
-                values.map((value) => path.join(value, '*')),
-              ],
-            ]),
-      ],
-    ),
-  );
-
-  const prefix = path.join('<rootDir>', maybeTsConfig?.options.baseUrl ?? '.');
-
-  const moduleNameMapper = pathsToModuleNameMapper(paths, {
-    prefix,
-    useESM: true,
-  });
-
-  // Always try finding the file with extension before trying without
-  moduleNameMapper['^(\\.{1,2}/.*)\\.js$'] = ['$1.js', '$1'];
-
-  // Normalise away any `..`s that may crop up from `baseUrl` usage.
-  // For example, a `baseUrl` of `src` and a path of `../cli` will result in
-  // `<rootDir>/src/../cli`, which can be normalised to `<rootDir>/cli`.
-  return Object.fromEntries(
-    Object.entries(moduleNameMapper).map(([key, values]) => [
-      key,
-      Array.isArray(values)
-        ? values.map((value) => path.normalize(value))
-        : path.normalize(values),
-    ]),
-  );
-};

package/jest/transform.js

@@ -1,62 +0,0 @@
-const { defaults } = require('ts-jest/presets');
-const { ModuleResolutionKind } = require('typescript');
-
-const { tryParseTsConfig } = require('./tsConfig');
-
-const TS_JEST_NAME = 'ts-jest';
-
-/**
- * Resolved path of the `ts-jest` preset.
- *
- * This allows Jest to resolve the preset even if it is installed to a nested
- * `./node_modules/skuba/node_modules/ts-jest` directory.
- */
-const TS_JEST_PATH = require.resolve(TS_JEST_NAME);
-
-const maybeTsConfig = tryParseTsConfig();
-
-const BROKEN_MODULE_RESOLUTIONS = new Set([
-  ModuleResolutionKind.Bundler,
-  ModuleResolutionKind.NodeNext,
-]);
-
-/**
- * Passing through these module resolutions seems to break `ts-jest`.
- *
- * ```
- * error TS5110: Option 'module' must be set to 'NodeNext' when option 'moduleResolution' is set to 'NodeNext'.
- * ```
- *
- * https://github.com/kulshekhar/ts-jest/issues/4198
- */
-const tsconfig = BROKEN_MODULE_RESOLUTIONS.has(
-  maybeTsConfig?.options.moduleResolution,
-)
-  ? { tsconfig: { moduleResolution: 'Node' } }
-  : undefined;
-
-/**
- * Rewrite `ts-jest` transformations using our resolved `TS_JEST_PATH`.
- *
- * @type {import ('@jest/types').Config.InitialOptions['transform']}
- */
-module.exports.transform = Object.fromEntries(
-  Object.entries(defaults.transform).map(([key, value]) => {
-    if (typeof value === 'string') {
-      return [key, value === TS_JEST_NAME ? [TS_JEST_PATH, tsconfig] : value];
-    }
-
-    return [
-      key,
-      value[0] === TS_JEST_NAME
-        ? [
-            TS_JEST_PATH,
-            {
-              ...value[1],
-              ...tsconfig,
-            },
-          ]
-        : value,
-    ];
-  }),
-);

package/jest/tsConfig.js

@@ -1,26 +0,0 @@
-const {
-  sys,
-  findConfigFile,
-  readConfigFile,
-  parseJsonConfigFileContent,
-} = require('typescript');
-
-/**
- * @returns {unknown}
- */
-const getTsConfigFromDisk = () => {
-  const filename =
-    findConfigFile('.', sys.fileExists.bind(this)) ?? 'tsconfig.json';
-
-  return readConfigFile(filename, sys.readFile.bind(this)).config;
-};
-
-module.exports.tryParseTsConfig = (getConfig = getTsConfigFromDisk) => {
-  try {
-    const json = getConfig();
-
-    return parseJsonConfigFileContent(json, sys, '.');
-  } catch {
-    // Bail out here to support zero-config mode.
-  }
-};

package/jest-preset.js

@@ -1,37 +0,0 @@
-const { defaults } = require('ts-jest/presets');
-
-const { createModuleNameMapper } = require('./jest/moduleNameMapper');
-const { transform } = require('./jest/transform');
-
-/** @type {import('@jest/types').Config.InitialOptions} */
-module.exports = {
-  ...defaults,
-
-  moduleNameMapper: createModuleNameMapper(),
-  transform,
-
-  collectCoverageFrom: [
-    '**/*.ts',
-    '**/*.tsx',
-    '!**/node_modules*/**',
-    '!<rootDir>/coverage*/**',
-    '!<rootDir>/dist*/**',
-    '!<rootDir>/lib*/**',
-    '!<rootDir>/tmp*/**',
-    '!<rootDir>/jest.*.ts',
-  ],
-  coverageDirectory: 'coverage',
-  reporters: ['default', require.resolve('./lib/cli/test/reporters/github')],
-  testEnvironment: 'node',
-  testPathIgnorePatterns: [
-    '/node_modules.*/',
-    '<rootDir>/(coverage|dist|lib|tmp).*/',
-  ],
-  watchPlugins: [
-    require.resolve('jest-watch-typeahead/filename'),
-    require.resolve('jest-watch-typeahead/testname'),
-  ],
-  testEnvironmentOptions: {
-    globalsCleanup: 'on',
-  },
-};

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

@@ -1,15 +0,0 @@
-import type { Config } from '@jest/types';
-export type { Config } from '@jest/types';
-/**
- * Set of Jest options that are recommended and supported for customisation.
- *
- * While we technically accept anything compatible with `Config.InitialOptions`,
- * these are tacitly endorsed for our use cases and receive IntelliSense.
- */
-type DefaultOptions = 'collectCoverage' | 'collectCoverageFrom' | 'coveragePathIgnorePatterns' | 'coverageThreshold' | 'displayName' | 'globals' | 'globalSetup' | 'globalTeardown' | 'projects' | 'setupFiles' | 'setupFilesAfterEnv' | 'snapshotSerializers' | 'testEnvironment' | 'testPathIgnorePatterns' | 'testTimeout' | 'watchPathIgnorePatterns';
-/**
- * Merge additional Jest options into the **skuba** preset.
- *
- * This concatenates array options like `testPathIgnorePatterns`.
- */
-export declare const mergePreset: <AdditionalOptions extends keyof Config.InitialOptions>({ projects, ...options }: Pick<Config.InitialOptions, AdditionalOptions | DefaultOptions>) => Config.InitialOptions;

package/lib/api/jest/index.js

@@ -1,59 +0,0 @@
-"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 jest_exports = {};
-__export(jest_exports, {
-  mergePreset: () => mergePreset
-});
-module.exports = __toCommonJS(jest_exports);
-var import_jest_preset = __toESM(require("../../../jest-preset.js"));
-var import_record = require("../../cli/configure/processing/record.js");
-const mergePreset = ({
-  projects,
-  ...options
-}) => {
-  const root = (0, import_record.mergeRaw)(import_jest_preset.default, options);
-  return {
-    ...root,
-    projects: projects?.map((project) => {
-      if (typeof project === "string") {
-        return project;
-      }
-      return {
-        moduleNameMapper: root.moduleNameMapper,
-        transform: root.transform,
-        ...project
-      };
-    })
-  };
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  mergePreset
-});
-//# sourceMappingURL=index.js.map

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

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/api/jest/index.ts"],
-  "sourcesContent": ["import type { Config } from '@jest/types';\n\nimport jestPreset from '../../../jest-preset.js';\nimport { mergeRaw } from '../../cli/configure/processing/record.js';\n\n// Avoid TS4082 in Jest configuration files:\n// Default export of the module has or is using private name `ConfigGlobals`.\nexport type { Config } from '@jest/types';\n\n/**\n * Set of Jest options that are recommended and supported for customisation.\n *\n * While we technically accept anything compatible with `Config.InitialOptions`,\n * these are tacitly endorsed for our use cases and receive IntelliSense.\n */\ntype DefaultOptions =\n  | 'collectCoverage'\n  | 'collectCoverageFrom'\n  | 'coveragePathIgnorePatterns'\n  | 'coverageThreshold'\n  | 'displayName'\n  | 'globals'\n  | 'globalSetup'\n  | 'globalTeardown'\n  | 'projects'\n  | 'setupFiles'\n  | 'setupFilesAfterEnv'\n  | 'snapshotSerializers'\n  | 'testEnvironment'\n  | 'testPathIgnorePatterns'\n  | 'testTimeout'\n  | 'watchPathIgnorePatterns';\n\n/**\n * Merge additional Jest options into the **skuba** preset.\n *\n * This concatenates array options like `testPathIgnorePatterns`.\n */\nexport const mergePreset = <\n  AdditionalOptions extends keyof Config.InitialOptions,\n>({\n  projects,\n  ...options\n}: Pick<\n  Config.InitialOptions,\n  AdditionalOptions | DefaultOptions\n>): Config.InitialOptions => {\n  const root = mergeRaw(jestPreset, options);\n\n  return {\n    ...root,\n\n    projects: projects?.map((project) => {\n      if (typeof project === 'string') {\n        return project;\n      }\n\n      return {\n        moduleNameMapper: root.moduleNameMapper,\n        transform: root.transform,\n        ...project,\n      };\n    }),\n  };\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEA,yBAAuB;AACvB,oBAAyB;AAmClB,MAAM,cAAc,CAEzB;AAAA,EACA;AAAA,EACA,GAAG;AACL,MAG6B;AAC3B,QAAM,WAAO,wBAAS,mBAAAA,SAAY,OAAO;AAEzC,SAAO;AAAA,IACL,GAAG;AAAA,IAEH,UAAU,UAAU,IAAI,CAAC,YAAY;AACnC,UAAI,OAAO,YAAY,UAAU;AAC/B,eAAO;AAAA,MACT;AAEA,aAAO;AAAA,QACL,kBAAkB,KAAK;AAAA,QACvB,WAAW,KAAK;AAAA,QAChB,GAAG;AAAA,MACL;AAAA,IACF,CAAC;AAAA,EACH;AACF;",
-  "names": ["jestPreset"]
-}

package/lib/cli/configure/modules/jest.d.ts

@@ -1,2 +0,0 @@
-import type { Module } from '../types.js';
-export declare const jestModule: () => Promise<Module>;