skuba 0.0.0-beta-20231002015947

package/LICENSE

@@ -0,0 +1,21 @@
+### MIT License
+
+Copyright (c) 2020 SEEK
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,67 @@
+# [![🤿 skuba](./docs/logo.svg)](https://seek-oss.github.io/skuba)
+
+---
+
+[![GitHub Release](https://github.com/seek-oss/skuba/workflows/Release/badge.svg?branch=master)](https://github.com/seek-oss/skuba/actions?query=workflow%3ARelease)
+[![GitHub Validate](https://github.com/seek-oss/skuba/workflows/Validate/badge.svg?branch=master)](https://github.com/seek-oss/skuba/actions?query=workflow%3AValidate)
+[![Node.js version](https://img.shields.io/badge/node-%3E%3D%2018.12-brightgreen)](https://nodejs.org/en/)
+[![npm package](https://img.shields.io/npm/v/skuba)](https://www.npmjs.com/package/skuba)
+
+---
+
+**skuba** is a toolkit for backend application and package development on SEEK's gravel and paved roads:
+
+- Write in [TypeScript]
+- Enforce coding standards with [ESLint] and [Prettier]
+- Test with [Jest]
+- Deploy with [Gantry], [Serverless] or the [AWS CDK]
+
+[aws cdk]: https://docs.aws.amazon.com/cdk/latest/guide/work-with-cdk-typescript.html
+[gantry]: https://backstage.myseek.xyz/docs/default/component/gantry/
+[serverless]: https://serverless.com/
+
+It provides you with:
+
+- [CLI] commands for developing your project
+- [Templates] to base your backend application or package on
+- [Development] and optional [runtime] APIs for cross-cutting concerns
+
+Learn more [about](docs/about.md) **skuba** and [contribute](CONTRIBUTING.md) to it.
+
+---
+
+**skuba** is distributed as an npm package.
+
+In projects that list it as a `devDependency`,
+usage may look something like this:
+
+```shell
+# Install project dependencies.
+yarn
+
+# Run the skuba CLI.
+yarn skuba help
+```
+
+Global installations are also supported to speed up local development:
+
+```shell
+# Install skuba globally.
+yarn global add skuba
+
+# Look, no `npx`!
+skuba help
+```
+
+If you're new here, jump ahead to the [CLI] section to [create a new project] or [update an existing one].
+
+[cli]: ./docs/cli
+[create a new project]: ./docs/cli/init.md
+[development]: ./docs/development-api
+[eslint]: https://eslint.org/
+[jest]: https://jestjs.io
+[prettier]: https://prettier.io/
+[runtime]: ./docs/runtime-api
+[templates]: ./docs/templates
+[typescript]: https://www.typescriptlang.org/
+[update an existing one]: ./docs/cli/configure.md

package/config/eslint.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['skuba'],
+};

package/config/jest.js

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

package/config/prettier.d.ts

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

package/config/prettier.js

@@ -0,0 +1,6 @@
+module.exports = {
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: 'all',
+  plugins: [require.resolve('prettier-plugin-packagejson')],
+};

package/config/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "incremental": true,
+    "isolatedModules": true,
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "noUnusedLocals": false,
+    "noUnusedParameters": false
+  },
+  "extends": "tsconfig-seek"
+}

package/jest/moduleNameMapper.js

@@ -0,0 +1,58 @@
+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 });
+
+  // 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/moduleNameMapper.test.ts

@@ -0,0 +1,64 @@
+import { createModuleNameMapper } from './moduleNameMapper';
+
+describe('moduleNameMapper', () => {
+  const act = (paths?: unknown, baseUrl?: string) =>
+    createModuleNameMapper(() => ({
+      compilerOptions: {
+        baseUrl,
+        paths,
+      },
+    }));
+
+  it('expands wildcard paths', () =>
+    expect(act({ 'src/*': ['src/*'], 'lib/wip/*': ['lib/wip/*'] }))
+      .toMatchInlineSnapshot(`
+      {
+        "^lib/wip$": "<rootDir>/lib/wip",
+        "^lib/wip/(.*)$": "<rootDir>/lib/wip/$1",
+        "^src$": "<rootDir>/src",
+        "^src/(.*)$": "<rootDir>/src/$1",
+      }
+    `));
+
+  it('expands non-wildcard paths', () =>
+    expect(act({ cli: ['cli'], 'src/': ['src/'] })).toMatchInlineSnapshot(`
+      {
+        "^cli$": "<rootDir>/cli",
+        "^cli/(.*)$": "<rootDir>/cli/$1",
+        "^src$": "<rootDir>/src",
+        "^src/(.*)$": "<rootDir>/src/$1",
+      }
+    `));
+
+  it('expands duplicate asymmetric paths', () =>
+    expect(
+      act({
+        jquery: ['node_modules/jquery/dist/jquery'],
+        'jquery/*': ['node_modules/jquery/dist/jquery/*'],
+      }),
+    ).toMatchInlineSnapshot(`
+      {
+        "^jquery$": "<rootDir>/node_modules/jquery/dist/jquery",
+        "^jquery/(.*)$": "<rootDir>/node_modules/jquery/dist/jquery/$1",
+      }
+    `));
+
+  it('respects a base URL', () =>
+    expect(act({ cli: ['../cli'], 'app/*': ['app/*'] }, 'src'))
+      .toMatchInlineSnapshot(`
+      {
+        "^app$": "<rootDir>/src/app",
+        "^app/(.*)$": "<rootDir>/src/app/$1",
+        "^cli$": "<rootDir>/cli",
+        "^cli/(.*)$": "<rootDir>/cli/$1",
+      }
+    `));
+
+  it('respects no paths', () => expect(act({})).toMatchInlineSnapshot(`{}`));
+
+  it('defaults to no paths on undefined', () =>
+    expect(act(undefined)).toMatchInlineSnapshot(`{}`));
+
+  it('defaults to no paths on invalid config', () =>
+    expect(act('INVALID')).toMatchInlineSnapshot(`{}`));
+});

package/jest/transform.js

@@ -0,0 +1,50 @@
+const { defaults } = require('ts-jest/presets');
+
+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();
+
+// Rewrite `ts-jest` transformations using our resolved `TS_JEST_PATH`.
+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,
+              {
+                isolatedModules: maybeTsConfig?.options.isolatedModules ?? true,
+              },
+            ]
+          : value,
+      ];
+    }
+
+    return [
+      key,
+      value[0] === TS_JEST_NAME
+        ? [
+            TS_JEST_PATH,
+            {
+              ...value[1],
+              isolatedModules:
+                value[1]?.isolatedModules ??
+                maybeTsConfig?.isolatedModules ??
+                true,
+            },
+          ]
+        : value,
+    ];
+  }),
+);

package/jest/transform.test.ts

@@ -0,0 +1,11 @@
+import { transform } from './transform';
+
+test('transform', () =>
+  expect(transform).toStrictEqual({
+    '^.+\\.tsx?$': [
+      expect.stringMatching(/\/skuba\/node_modules\/ts-jest\/dist\/index\.js$/),
+      {
+        isolatedModules: true,
+      },
+    ],
+  }));

package/jest/tsConfig.js

@@ -0,0 +1,26 @@
+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

@@ -0,0 +1,40 @@
+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',
+  // jestjs/jest#14305
+  prettierPath: null,
+  reporters: [
+    'default',
+    require.resolve('./lib/cli/test/reporters/github'),
+    require.resolve('./lib/cli/test/reporters/prettier'),
+  ],
+  testEnvironment: 'node',
+  testPathIgnorePatterns: [
+    '/node_modules.*/',
+    '<rootDir>/(coverage|dist|lib|tmp).*/',
+  ],
+  watchPlugins: [
+    require.resolve('jest-watch-typeahead/filename'),
+    require.resolve('jest-watch-typeahead/testname'),
+  ],
+};

package/lib/api/buildkite/annotate.d.ts

@@ -0,0 +1,26 @@
+export type AnnotationStyle = 'success' | 'info' | 'warning' | 'error';
+interface AnnotationOptions {
+    context?: string;
+    /**
+     * Scopes an annotation's context to the Buildkite step ID.
+     *
+     * This lets you emit distinct annotations per step, and only takes effect if
+     * the `BUILDKITE_STEP_ID` environment variable is present.
+     */
+    scopeContextToStep?: boolean;
+    style?: AnnotationStyle;
+}
+/**
+ * Asynchronously uploads a Buildkite annotation.
+ *
+ * If the following environment variables are not present,
+ * the function will silently return without attempting to annotate:
+ *
+ * - `BUILDKITE`
+ * - `BUILDKITE_AGENT_ACCESS_TOKEN`
+ * - `BUILDKITE_JOB_ID`
+ *
+ * The `buildkite-agent` binary must also be on your `PATH`.
+ */
+export declare const annotate: (markdown: string, opts?: AnnotationOptions) => Promise<void>;
+export {};

package/lib/api/buildkite/annotate.js

@@ -0,0 +1,49 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var annotate_exports = {};
+__export(annotate_exports, {
+  annotate: () => annotate
+});
+module.exports = __toCommonJS(annotate_exports);
+var import_exec = require("../../utils/exec");
+const isAnnotationEnabled = async () => Boolean(
+  process.env.BUILDKITE && process.env.BUILDKITE_AGENT_ACCESS_TOKEN && process.env.BUILDKITE_JOB_ID && await (0, import_exec.hasCommand)("buildkite-agent")
+);
+const annotate = async (markdown, opts = {}) => {
+  if (!await isAnnotationEnabled()) {
+    return;
+  }
+  const context = [
+    opts.scopeContextToStep && process.env.BUILDKITE_STEP_ID,
+    opts.context
+  ].filter(Boolean).join("|");
+  const { style } = opts;
+  await (0, import_exec.exec)(
+    "buildkite-agent",
+    "annotate",
+    ...context ? ["--context", context] : [],
+    ...style ? ["--style", style] : [],
+    markdown
+  );
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  annotate
+});
+//# sourceMappingURL=annotate.js.map

package/lib/api/buildkite/annotate.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/api/buildkite/annotate.ts"],
+  "sourcesContent": ["import { exec, hasCommand } from '../../utils/exec';\n\nexport type AnnotationStyle = 'success' | 'info' | 'warning' | 'error';\n\nconst isAnnotationEnabled = async () =>\n  Boolean(\n    process.env.BUILDKITE &&\n      process.env.BUILDKITE_AGENT_ACCESS_TOKEN &&\n      process.env.BUILDKITE_JOB_ID &&\n      (await hasCommand('buildkite-agent')),\n  );\n\ninterface AnnotationOptions {\n  context?: string;\n\n  /**\n   * Scopes an annotation's context to the Buildkite step ID.\n   *\n   * This lets you emit distinct annotations per step, and only takes effect if\n   * the `BUILDKITE_STEP_ID` environment variable is present.\n   */\n  scopeContextToStep?: boolean;\n\n  style?: AnnotationStyle;\n}\n\n/**\n * Asynchronously uploads a Buildkite annotation.\n *\n * If the following environment variables are not present,\n * the function will silently return without attempting to annotate:\n *\n * - `BUILDKITE`\n * - `BUILDKITE_AGENT_ACCESS_TOKEN`\n * - `BUILDKITE_JOB_ID`\n *\n * The `buildkite-agent` binary must also be on your `PATH`.\n */\nexport const annotate = async (\n  markdown: string,\n  opts: AnnotationOptions = {},\n): Promise<void> => {\n  if (!(await isAnnotationEnabled())) {\n    return;\n  }\n\n  // Always scope to the current Buildkite step.\n  const context = [\n    opts.scopeContextToStep && process.env.BUILDKITE_STEP_ID,\n    opts.context,\n  ]\n    .filter(Boolean)\n    .join('|');\n\n  const { style } = opts;\n\n  await exec(\n    'buildkite-agent',\n    'annotate',\n    ...(context ? ['--context', context] : []),\n    ...(style ? ['--style', style] : []),\n    markdown,\n  );\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAAiC;AAIjC,MAAM,sBAAsB,YAC1B;AAAA,EACE,QAAQ,IAAI,aACV,QAAQ,IAAI,gCACZ,QAAQ,IAAI,oBACX,UAAM,wBAAW,iBAAiB;AACvC;AA4BK,MAAM,WAAW,OACtB,UACA,OAA0B,CAAC,MACT;AAClB,MAAI,CAAE,MAAM,oBAAoB,GAAI;AAClC;AAAA,EACF;AAGA,QAAM,UAAU;AAAA,IACd,KAAK,sBAAsB,QAAQ,IAAI;AAAA,IACvC,KAAK;AAAA,EACP,EACG,OAAO,OAAO,EACd,KAAK,GAAG;AAEX,QAAM,EAAE,MAAM,IAAI;AAElB,YAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA,GAAI,UAAU,CAAC,aAAa,OAAO,IAAI,CAAC;AAAA,IACxC,GAAI,QAAQ,CAAC,WAAW,KAAK,IAAI,CAAC;AAAA,IAClC;AAAA,EACF;AACF;",
+  "names": []
+}

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

@@ -0,0 +1,3 @@
+export type { AnnotationStyle } from './annotate';
+export { annotate } from './annotate';
+export { md } from './md';

package/lib/api/buildkite/index.js

@@ -0,0 +1,32 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var buildkite_exports = {};
+__export(buildkite_exports, {
+  annotate: () => import_annotate.annotate,
+  md: () => import_md.md
+});
+module.exports = __toCommonJS(buildkite_exports);
+var import_annotate = require("./annotate");
+var import_md = require("./md");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  annotate,
+  md
+});
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/api/buildkite/index.ts"],
+  "sourcesContent": ["export type { AnnotationStyle } from './annotate';\nexport { annotate } from './annotate';\nexport { md } from './md';\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,sBAAyB;AACzB,gBAAmB;",
+  "names": []
+}

package/lib/api/buildkite/md.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @internal
+ */
+export declare const md: {
+    terminal: (code: string) => string;
+};

package/lib/api/buildkite/md.js

@@ -0,0 +1,33 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var md_exports = {};
+__export(md_exports, {
+  md: () => md
+});
+module.exports = __toCommonJS(md_exports);
+const md = {
+  terminal: (code) => `\`\`\`term
+${code.replace(/```/g, "\\`\\`\\`")}
+\`\`\``
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  md
+});
+//# sourceMappingURL=md.js.map

package/lib/api/buildkite/md.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/api/buildkite/md.ts"],
+  "sourcesContent": ["/**\n * @internal\n */\nexport const md = {\n  terminal: (code: string) =>\n    `\\`\\`\\`term\\n${code.replace(/```/g, '\\\\`\\\\`\\\\`')}\\n\\`\\`\\``,\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAGO,MAAM,KAAK;AAAA,EAChB,UAAU,CAAC,SACT;AAAA,EAAe,KAAK,QAAQ,QAAQ,WAAW,CAAC;AAAA;AACpD;",
+  "names": []
+}

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

@@ -0,0 +1,15 @@
+export interface Identity {
+    email?: string;
+    name?: string;
+}
+interface CommitParameters {
+    author?: Identity;
+    committer?: Identity;
+    dir: string;
+    message: string;
+}
+/**
+ * Writes a commit to the local Git repository.
+ */
+export declare const commit: ({ author, committer, dir, message, }: CommitParameters) => Promise<string>;
+export {};

package/lib/api/git/commit.js

@@ -0,0 +1,52 @@
+"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 commit_exports = {};
+__export(commit_exports, {
+  commit: () => commit
+});
+module.exports = __toCommonJS(commit_exports);
+var import_fs_extra = __toESM(require("fs-extra"));
+var import_isomorphic_git = __toESM(require("isomorphic-git"));
+const commit = async ({
+  author = { name: "skuba" },
+  committer = { name: "skuba" },
+  dir,
+  message
+}) => import_isomorphic_git.default.commit({
+  author,
+  committer,
+  dir,
+  fs: import_fs_extra.default,
+  message
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  commit
+});
+//# sourceMappingURL=commit.js.map

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

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/api/git/commit.ts"],
+  "sourcesContent": ["import fs from 'fs-extra';\nimport git from 'isomorphic-git';\n\nexport interface Identity {\n  email?: string;\n  name?: string;\n}\n\ninterface CommitParameters {\n  author?: Identity;\n  committer?: Identity;\n  dir: string;\n  message: string;\n}\n\n/**\n * Writes a commit to the local Git repository.\n */\nexport const commit = async ({\n  author = { name: 'skuba' },\n  committer = { name: 'skuba' },\n  dir,\n  message,\n}: CommitParameters): Promise<string> =>\n  git.commit({\n    author,\n    committer,\n    dir,\n    fs,\n    message,\n  });\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,sBAAe;AACf,4BAAgB;AAiBT,MAAM,SAAS,OAAO;AAAA,EAC3B,SAAS,EAAE,MAAM,QAAQ;AAAA,EACzB,YAAY,EAAE,MAAM,QAAQ;AAAA,EAC5B;AAAA,EACA;AACF,MACE,sBAAAA,QAAI,OAAO;AAAA,EACT;AAAA,EACA;AAAA,EACA;AAAA,EACA,oBAAAC;AAAA,EACA;AACF,CAAC;",
+  "names": ["git", "fs"]
+}

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

@@ -0,0 +1,19 @@
+import { type Identity } from './commit';
+import { type ChangedFile } from './getChangedFiles';
+interface CommitAllParameters {
+    dir: string;
+    message: string;
+    author?: Identity;
+    committer?: Identity;
+    /**
+     * File changes to exclude from the commit.
+     *
+     * Defaults to `[]` (no exclusions).
+     */
+    ignore?: ChangedFile[];
+}
+/**
+ * Stages all changes and writes a commit to the local Git repository.
+ */
+export declare const commitAllChanges: ({ dir, message, author, committer, ignore, }: CommitAllParameters) => Promise<string | undefined>;
+export {};