skuba 3.15.3-beta.0 → 3.17.0-beta.0

package/lib/api/github/checkRun.js

@@ -1,4 +1,23 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -9,82 +28,64 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createCheckRunFromBuildkite = void 0;
+exports.createCheckRun = void 0;
 const rest_1 = require("@octokit/rest");
+const logging_1 = require("../../utils/logging");
+const Git = __importStar(require("../git"));
+const environment_1 = require("./environment");
 const GITHUB_MAX_ANNOTATIONS = 50;
-const isGitHubAnnotationsEnabled = () => Boolean(process.env.BUILDKITE_BUILD_NUMBER &&
-    process.env.BUILDKITE_COMMIT &&
-    process.env.BUILDKITE_REPO &&
-    process.env.GITHUB_API_TOKEN);
-// Pulls out the GitHub Owner + Repo String from repo urls eg.
-// git@github.com:seek-oss/skuba.git
-// https://github.com/seek-oss/skuba.git
-// Pulls out `seek-oss` as owner and `skuba` as repo
-const ownerRepoRegex = new RegExp(/github.com(?::|\/)(.*)\/(.*).git/);
-const getOwnerRepo = () => {
-    const match = ownerRepoRegex.exec(process.env.BUILDKITE_REPO);
-    const owner = match === null || match === void 0 ? void 0 : match[1];
-    const repo = match === null || match === void 0 ? void 0 : match[2];
-    if (!owner || !repo) {
-        throw new Error('Could not extract GitHub owner/repo from BUILDKITE_REPO environment variable');
-    }
-    return {
-        owner,
-        repo,
-    };
-};
 /**
- * Create a uniform title format for our check runs
- * @param conclusion - `failure` or `success`
- * @param annotationsLength - Number of annotations added
- * @returns Title eg. Build #12 failed (24 annotations added)
+ * Suffixes the title with the number of annotations added, e.g.
+ *
+ * ```text
+ * Build #12 failed (24 annotations added)
+ * ```
  */
-const createTitle = (conclusion, annotationsLength) => {
-    const build = `Build #${process.env.BUILDKITE_BUILD_NUMBER}`;
-    const numAnnotations = annotationsLength > GITHUB_MAX_ANNOTATIONS
+const suffixTitle = (title, inputAnnotations) => {
+    const addedAnnotations = inputAnnotations > GITHUB_MAX_ANNOTATIONS
         ? GITHUB_MAX_ANNOTATIONS
-        : annotationsLength;
-    const status = conclusion === 'success' ? 'passed' : 'failed';
-    const plural = numAnnotations === 1 ? '' : 's';
-    return `${build} ${status} (${numAnnotations} annotation${plural} added)`;
+        : inputAnnotations;
+    return `${title} (${(0, logging_1.pluralise)(addedAnnotations, 'annotation')} added)`;
 };
 /**
- * Adds more context to the summary provided
- * @param summary - report summary
- * @param annotationsLength - Number of annotations added
- * @returns summary with extra metadata
+ * Enriches the summary with more context about the check run.
  */
-const createEnrichedSummary = (summary, annotationsLength) => [
+const createEnrichedSummary = (summary, inputAnnotations) => [
     summary,
-    ...(annotationsLength > GITHUB_MAX_ANNOTATIONS
+    ...(inputAnnotations > GITHUB_MAX_ANNOTATIONS
         ? [
-            `There were ${annotationsLength} annotations created. However, the number of annotations displayed has been capped to ${GITHUB_MAX_ANNOTATIONS}`,
+            `${inputAnnotations} annotations were provided, but only the first ${GITHUB_MAX_ANNOTATIONS} are visible in GitHub.`,
         ]
         : []),
 ].join('\n\n');
-const createCheckRunFromBuildkite = ({ name, summary, annotations, conclusion, }) => __awaiter(void 0, void 0, void 0, function* () {
-    if (!isGitHubAnnotationsEnabled()) {
-        return;
-    }
-    const client = new rest_1.Octokit({
-        auth: process.env.GITHUB_API_TOKEN,
-    });
-    const { owner, repo } = getOwnerRepo();
-    const title = createTitle(conclusion, annotations.length);
-    const enrichedSummary = createEnrichedSummary(summary, annotations.length);
-    const checkRunName = `skuba/${name}`;
+/**
+ * Asynchronously creates a GitHub check run with annotations.
+ *
+ * The first 50 `annotations` are written in full to GitHub.
+ *
+ * A `GITHUB_API_TOKEN` or `GITHUB_TOKEN` with the `checks:write` permission
+ * must be present on the environment.
+ */
+const createCheckRun = ({ annotations, conclusion, name, summary, text, title, }) => __awaiter(void 0, void 0, void 0, function* () {
+    const dir = process.cwd();
+    const [commitId, { owner, repo }] = yield Promise.all([
+        Git.getHeadCommitId({ dir }),
+        Git.getOwnerAndRepo({ dir }),
+    ]);
+    const client = new rest_1.Octokit({ auth: (0, environment_1.apiTokenFromEnvironment)() });
     yield client.checks.create({
-        owner,
-        repo,
-        name: checkRunName,
+        conclusion,
+        head_sha: commitId,
+        name,
         output: {
-            title,
-            summary: enrichedSummary,
             annotations: annotations.slice(0, GITHUB_MAX_ANNOTATIONS),
+            summary: createEnrichedSummary(summary, annotations.length),
+            text,
+            title: suffixTitle(title, annotations.length),
         },
-        head_sha: process.env.BUILDKITE_COMMIT,
-        conclusion,
+        owner,
+        repo,
     });
 });
-exports.createCheckRunFromBuildkite = createCheckRunFromBuildkite;
+exports.createCheckRun = createCheckRun;
 //# sourceMappingURL=checkRun.js.map

package/lib/api/github/checkRun.js.map

@@ -1 +1 @@
-{"version":3,"file":"checkRun.js","sourceRoot":"","sources":["../../../src/api/github/checkRun.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wCAAwC;AASxC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC,MAAM,0BAA0B,GAAG,GAAY,EAAE,CAC/C,OAAO,CACL,OAAO,CAAC,GAAG,CAAC,sBAAsB;IAChC,OAAO,CAAC,GAAG,CAAC,gBAAgB;IAC5B,OAAO,CAAC,GAAG,CAAC,cAAc;IAC1B,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAC/B,CAAC;AACJ,8DAA8D;AAC9D,oCAAoC;AACpC,wCAAwC;AACxC,oDAAoD;AACpD,MAAM,cAAc,GAAG,IAAI,MAAM,CAAC,kCAAkC,CAAC,CAAC;AAEtE,MAAM,YAAY,GAAG,GAAoC,EAAE;IACzD,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,cAAwB,CAAC,CAAC;IACxE,MAAM,KAAK,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAG,CAAC,CAAC,CAAC;IACzB,MAAM,IAAI,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAG,CAAC,CAAC,CAAC;IAExB,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,EAAE;QACnB,MAAM,IAAI,KAAK,CACb,8EAA8E,CAC/E,CAAC;KACH;IAED,OAAO;QACL,KAAK;QACL,IAAI;KACL,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,WAAW,GAAG,CAClB,UAAiC,EACjC,iBAAyB,EACjB,EAAE;IACV,MAAM,KAAK,GAAG,UAAU,OAAO,CAAC,GAAG,CAAC,sBAAgC,EAAE,CAAC;IACvE,MAAM,cAAc,GAClB,iBAAiB,GAAG,sBAAsB;QACxC,CAAC,CAAC,sBAAsB;QACxB,CAAC,CAAC,iBAAiB,CAAC;IACxB,MAAM,MAAM,GAAG,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;IAE9D,MAAM,MAAM,GAAG,cAAc,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;IAC/C,OAAO,GAAG,KAAK,IAAI,MAAM,KAAK,cAAc,cAAc,MAAM,SAAS,CAAC;AAC5E,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,qBAAqB,GAAG,CAC5B,OAAe,EACf,iBAAyB,EACjB,EAAE,CACV;IACE,OAAO;IACP,GAAG,CAAC,iBAAiB,GAAG,sBAAsB;QAC5C,CAAC,CAAC;YACE,cAAc,iBAAiB,yFAAyF,sBAAsB,EAAE;SACjJ;QACH,CAAC,CAAC,EAAE,CAAC;CACR,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AASV,MAAM,2BAA2B,GAAG,CAAO,EAChD,IAAI,EACJ,OAAO,EACP,WAAW,EACX,UAAU,GACe,EAAiB,EAAE;IAC5C,IAAI,CAAC,0BAA0B,EAAE,EAAE;QACjC,OAAO;KACR;IAED,MAAM,MAAM,GAAG,IAAI,cAAO,CAAC;QACzB,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,gBAAgB;KACnC,CAAC,CAAC;IACH,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,YAAY,EAAE,CAAC;IACvC,MAAM,KAAK,GAAG,WAAW,CAAC,UAAU,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC1D,MAAM,eAAe,GAAG,qBAAqB,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAC3E,MAAM,YAAY,GAAG,SAAS,IAAI,EAAE,CAAC;IAErC,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;QACzB,KAAK;QACL,IAAI;QACJ,IAAI,EAAE,YAAY;QAClB,MAAM,EAAE;YACN,KAAK;YACL,OAAO,EAAE,eAAe;YACxB,WAAW,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,sBAAsB,CAAC;SAC1D;QACD,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,gBAA0B;QAChD,UAAU;KACX,CAAC,CAAC;AACL,CAAC,CAAA,CAAC;AA9BW,QAAA,2BAA2B,+BA8BtC"}
+{"version":3,"file":"checkRun.js","sourceRoot":"","sources":["../../../src/api/github/checkRun.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wCAAwC;AAGxC,iDAAgD;AAChD,4CAA8B;AAE9B,+CAAwD;AAQxD,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAElC;;;;;;GAMG;AACH,MAAM,WAAW,GAAG,CAAC,KAAa,EAAE,gBAAwB,EAAU,EAAE;IACtE,MAAM,gBAAgB,GACpB,gBAAgB,GAAG,sBAAsB;QACvC,CAAC,CAAC,sBAAsB;QACxB,CAAC,CAAC,gBAAgB,CAAC;IAEvB,OAAO,GAAG,KAAK,KAAK,IAAA,mBAAS,EAAC,gBAAgB,EAAE,YAAY,CAAC,SAAS,CAAC;AACzE,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,qBAAqB,GAAG,CAC5B,OAAe,EACf,gBAAwB,EAChB,EAAE,CACV;IACE,OAAO;IACP,GAAG,CAAC,gBAAgB,GAAG,sBAAsB;QAC3C,CAAC,CAAC;YACE,GAAG,gBAAgB,kDAAkD,sBAAsB,yBAAyB;SACrH;QACH,CAAC,CAAC,EAAE,CAAC;CACR,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AAuCjB;;;;;;;GAOG;AACI,MAAM,cAAc,GAAG,CAAO,EACnC,WAAW,EACX,UAAU,EACV,IAAI,EACJ,OAAO,EACP,IAAI,EACJ,KAAK,GACoB,EAAiB,EAAE;IAC5C,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAE1B,MAAM,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACpD,GAAG,CAAC,eAAe,CAAC,EAAE,GAAG,EAAE,CAAC;QAC5B,GAAG,CAAC,eAAe,CAAC,EAAE,GAAG,EAAE,CAAC;KAC7B,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,IAAI,cAAO,CAAC,EAAE,IAAI,EAAE,IAAA,qCAAuB,GAAE,EAAE,CAAC,CAAC;IAEhE,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;QACzB,UAAU;QACV,QAAQ,EAAE,QAAQ;QAClB,IAAI;QACJ,MAAM,EAAE;YACN,WAAW,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,sBAAsB,CAAC;YACzD,OAAO,EAAE,qBAAqB,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC;YAC3D,IAAI;YACJ,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,MAAM,CAAC;SAC9C;QACD,KAAK;QACL,IAAI;KACL,CAAC,CAAC;AACL,CAAC,CAAA,CAAC;AA9BW,QAAA,cAAc,kBA8BzB"}

package/lib/api/github/environment.d.ts

@@ -0,0 +1,22 @@
+/// <reference types="node" />
+/**
+ * Returns the name of the build as seen in GitHub status checks.
+ *
+ * This is driven off of environment variables and falls back to `Build`.
+ */
+export declare const buildNameFromEnvironment: (env?: NodeJS.ProcessEnv) => string;
+/**
+ * Whether GitHub API interactions should be enabled.
+ *
+ * This checks environment variables to see if the code is executing in a CI
+ * environment and has access to a GitHub API token.
+ */
+export declare const enabledFromEnvironment: (env?: NodeJS.ProcessEnv) => boolean;
+/**
+ * Tries to return a GitHub API token from the environment.
+ */
+export declare const apiTokenFromEnvironment: (env?: NodeJS.ProcessEnv) => string | undefined;
+/**
+ * Tries to return a branch name from CI environment variables.
+ */
+export declare const currentBranchFromEnvironment: (env?: NodeJS.ProcessEnv) => string | undefined;

package/lib/api/github/environment.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.currentBranchFromEnvironment = exports.apiTokenFromEnvironment = exports.enabledFromEnvironment = exports.buildNameFromEnvironment = void 0;
+/**
+ * Returns the name of the build as seen in GitHub status checks.
+ *
+ * This is driven off of environment variables and falls back to `Build`.
+ */
+const buildNameFromEnvironment = (env = process.env) => {
+    var _a;
+    if (env.BUILDKITE_BUILD_NUMBER) {
+        return `Build #${env.BUILDKITE_BUILD_NUMBER}`;
+    }
+    if (env.GITHUB_RUN_NUMBER) {
+        return `${(_a = env.GITHUB_WORKFLOW) !== null && _a !== void 0 ? _a : 'Build'} #${env.GITHUB_RUN_NUMBER}`;
+    }
+    return 'Build';
+};
+exports.buildNameFromEnvironment = buildNameFromEnvironment;
+/**
+ * Whether GitHub API interactions should be enabled.
+ *
+ * This checks environment variables to see if the code is executing in a CI
+ * environment and has access to a GitHub API token.
+ */
+const enabledFromEnvironment = (env = process.env) => 
+// Running in a CI environment.
+Boolean(env.BUILDKITE || env.CI || env.GITHUB_ACTIONS) &&
+    // Has an API token at the ready.
+    Boolean((0, exports.apiTokenFromEnvironment)(env));
+exports.enabledFromEnvironment = enabledFromEnvironment;
+/**
+ * Tries to return a GitHub API token from the environment.
+ */
+const apiTokenFromEnvironment = (env = process.env) => { var _a; return (_a = env.GITHUB_API_TOKEN) !== null && _a !== void 0 ? _a : env.GITHUB_TOKEN; };
+exports.apiTokenFromEnvironment = apiTokenFromEnvironment;
+/**
+ * Tries to return a branch name from CI environment variables.
+ */
+const currentBranchFromEnvironment = (env = process.env) => { var _a; return (_a = env.BUILDKITE_BRANCH) !== null && _a !== void 0 ? _a : env.GITHUB_REF_NAME; };
+exports.currentBranchFromEnvironment = currentBranchFromEnvironment;
+//# sourceMappingURL=environment.js.map

package/lib/api/github/environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../../src/api/github/environment.ts"],"names":[],"mappings":";;;AAAA;;;;GAIG;AACI,MAAM,wBAAwB,GAAG,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,EAAU,EAAE;;IACpE,IAAI,GAAG,CAAC,sBAAsB,EAAE;QAC9B,OAAO,UAAU,GAAG,CAAC,sBAAsB,EAAE,CAAC;KAC/C;IAED,IAAI,GAAG,CAAC,iBAAiB,EAAE;QACzB,OAAO,GAAG,MAAA,GAAG,CAAC,eAAe,mCAAI,OAAO,KAAK,GAAG,CAAC,iBAAiB,EAAE,CAAC;KACtE;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAVW,QAAA,wBAAwB,4BAUnC;AAEF;;;;;GAKG;AACI,MAAM,sBAAsB,GAAG,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,EAAW,EAAE;AACnE,+BAA+B;AAC/B,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,cAAc,CAAC;IACtD,iCAAiC;IACjC,OAAO,CAAC,IAAA,+BAAuB,EAAC,GAAG,CAAC,CAAC,CAAC;AAJ3B,QAAA,sBAAsB,0BAIK;AAExC;;GAEG;AACI,MAAM,uBAAuB,GAAG,CACrC,GAAG,GAAG,OAAO,CAAC,GAAG,EACG,EAAE,WAAC,OAAA,MAAA,GAAG,CAAC,gBAAgB,mCAAI,GAAG,CAAC,YAAY,CAAA,EAAA,CAAC;AAFrD,QAAA,uBAAuB,2BAE8B;AAElE;;GAEG;AACI,MAAM,4BAA4B,GAAG,CAC1C,GAAG,GAAG,OAAO,CAAC,GAAG,EACG,EAAE,WAAC,OAAA,MAAA,GAAG,CAAC,gBAAgB,mCAAI,GAAG,CAAC,eAAe,CAAA,EAAA,CAAC;AAFxD,QAAA,4BAA4B,gCAE4B"}

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

@@ -1,2 +1,3 @@
 export type { Annotation } from './checkRun';
-export { createCheckRunFromBuildkite } from './checkRun';
+export { createCheckRun } from './checkRun';
+export { buildNameFromEnvironment, enabledFromEnvironment, } from './environment';

package/lib/api/github/index.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createCheckRunFromBuildkite = void 0;
+exports.enabledFromEnvironment = exports.buildNameFromEnvironment = exports.createCheckRun = void 0;
 var checkRun_1 = require("./checkRun");
-Object.defineProperty(exports, "createCheckRunFromBuildkite", { enumerable: true, get: function () { return checkRun_1.createCheckRunFromBuildkite; } });
+Object.defineProperty(exports, "createCheckRun", { enumerable: true, get: function () { return checkRun_1.createCheckRun; } });
+var environment_1 = require("./environment");
+Object.defineProperty(exports, "buildNameFromEnvironment", { enumerable: true, get: function () { return environment_1.buildNameFromEnvironment; } });
+Object.defineProperty(exports, "enabledFromEnvironment", { enumerable: true, get: function () { return environment_1.enabledFromEnvironment; } });
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/github/index.ts"],"names":[],"mappings":";;;AACA,uCAAyD;AAAhD,uHAAA,2BAA2B,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/github/index.ts"],"names":[],"mappings":";;;AACA,uCAA4C;AAAnC,0GAAA,cAAc,OAAA;AACvB,6CAGuB;AAFrB,uHAAA,wBAAwB,OAAA;AACxB,qHAAA,sBAAsB,OAAA"}

package/lib/api/github/issueComment.d.ts

@@ -0,0 +1,59 @@
+/**
+ * https://docs.github.com/en/rest/reference/issues#create-an-issue-comment
+ */
+interface PutIssueCommentParameters {
+    /**
+     * The body of the issue comment.
+     */
+    body: string;
+    /**
+     * An internal identifier for the issue comment.
+     *
+     * This can be used to scope a given `put` to a particular comment, preventing
+     * it from clobbering other comments from the same bot or user.
+     *
+     * The identifier is embedded as hidden content in the comment body.
+     */
+    internalId?: string;
+    env?: Record<string, string | undefined>;
+    /**
+     * The number that identifies the GitHub issue.
+     *
+     * If this is not provided, the number will be inferred from the GitHub Repos
+     * API by finding the latest pull request associated with the head commit.
+     *
+     * https://docs.github.com/en/rest/reference/repos#list-pull-requests-associated-with-a-commit
+     */
+    issueNumber?: number;
+    /**
+     * The ID of authenticated bot or user that is putting the issue comment.
+     *
+     * This drives our `put` behaviour, which tries to locate and edit an existing
+     * comment before creating a new one. If this is not provided, the ID will be
+     * inferred from the GitHub Users API.
+     *
+     * https://docs.github.com/en/rest/reference/users#get-the-authenticated-user
+     *
+     * If you're at SEEK and using BuildAgency's GitHub API integration, you may
+     * hardcode this to `87109344` as an optimisation to skip the user lookup.
+     *
+     * https://api.github.com/users/buildagencygitapitoken[bot]
+     */
+    userId?: number;
+}
+interface IssueComment {
+    id: number;
+}
+/**
+ * Asynchronously creates or updates a GitHub issue comment.
+ *
+ * This emulates `put` behaviour by overwriting the first existing comment by
+ * the same author on the issue, enabling use cases like a persistent bot
+ * comment at the top of the pull request that reflects the current status of a
+ * CI check.
+ *
+ * A `GITHUB_API_TOKEN` or `GITHUB_TOKEN` with write permissions must be present
+ * on the environment.
+ */
+export declare const putIssueComment: (params: PutIssueCommentParameters) => Promise<IssueComment>;
+export {};

package/lib/api/github/issueComment.js

@@ -0,0 +1,96 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.putIssueComment = void 0;
+const rest_1 = require("@octokit/rest");
+const Git = __importStar(require("../git"));
+const environment_1 = require("./environment");
+const pullRequest_1 = require("./pullRequest");
+const getUserId = (client) => __awaiter(void 0, void 0, void 0, function* () {
+    const { data } = yield client.users.getAuthenticated();
+    return data.id;
+});
+/**
+ * Asynchronously creates or updates a GitHub issue comment.
+ *
+ * This emulates `put` behaviour by overwriting the first existing comment by
+ * the same author on the issue, enabling use cases like a persistent bot
+ * comment at the top of the pull request that reflects the current status of a
+ * CI check.
+ *
+ * A `GITHUB_API_TOKEN` or `GITHUB_TOKEN` with write permissions must be present
+ * on the environment.
+ */
+const putIssueComment = (params) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d;
+    const env = (_a = params.env) !== null && _a !== void 0 ? _a : process.env;
+    const dir = process.cwd();
+    const { owner, repo } = yield Git.getOwnerAndRepo({ dir });
+    const client = new rest_1.Octokit({ auth: (0, environment_1.apiTokenFromEnvironment)() });
+    const issueNumber = (_b = params.issueNumber) !== null && _b !== void 0 ? _b : (yield (0, pullRequest_1.getPullRequestNumber)({ client, env }));
+    if (!issueNumber) {
+        throw new Error('Failed to infer an issue number');
+    }
+    const comments = yield client.issues.listComments({
+        issue_number: issueNumber,
+        owner,
+        repo,
+    });
+    const userId = (_c = params.userId) !== null && _c !== void 0 ? _c : (yield getUserId(client));
+    const commentId = (_d = comments.data.find((comment) => {
+        var _a, _b;
+        return ((_a = comment.user) === null || _a === void 0 ? void 0 : _a.id) === userId &&
+            (params.internalId
+                ? (_b = comment.body) === null || _b === void 0 ? void 0 : _b.endsWith(`\n\n<!-- ${params.internalId} -->`)
+                : true);
+    })) === null || _d === void 0 ? void 0 : _d.id;
+    const body = params.internalId
+        ? [params.body.trim(), `<!-- ${params.internalId} -->`].join('\n\n')
+        : params.body.trim();
+    const response = yield (commentId
+        ? client.issues.updateComment({
+            body,
+            comment_id: commentId,
+            issue_number: issueNumber,
+            owner,
+            repo,
+        })
+        : client.issues.createComment({
+            body,
+            issue_number: issueNumber,
+            owner,
+            repo,
+        }));
+    return {
+        id: response.data.id,
+    };
+});
+exports.putIssueComment = putIssueComment;
+//# sourceMappingURL=issueComment.js.map

package/lib/api/github/issueComment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"issueComment.js","sourceRoot":"","sources":["../../../src/api/github/issueComment.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wCAAwC;AAExC,4CAA8B;AAE9B,+CAAwD;AACxD,+CAAqD;AAErD,MAAM,SAAS,GAAG,CAAO,MAAe,EAAmB,EAAE;IAC3D,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,CAAC;IAEvD,OAAO,IAAI,CAAC,EAAE,CAAC;AACjB,CAAC,CAAA,CAAC;AAsDF;;;;;;;;;;GAUG;AACI,MAAM,eAAe,GAAG,CAC7B,MAAiC,EACV,EAAE;;IACzB,MAAM,GAAG,GAAG,MAAA,MAAM,CAAC,GAAG,mCAAI,OAAO,CAAC,GAAG,CAAC;IAEtC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAE1B,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,GAAG,CAAC,eAAe,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;IAE3D,MAAM,MAAM,GAAG,IAAI,cAAO,CAAC,EAAE,IAAI,EAAE,IAAA,qCAAuB,GAAE,EAAE,CAAC,CAAC;IAEhE,MAAM,WAAW,GACf,MAAA,MAAM,CAAC,WAAW,mCAAI,CAAC,MAAM,IAAA,kCAAoB,EAAC,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAEtE,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;KACpD;IAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC;QAChD,YAAY,EAAE,WAAW;QACzB,KAAK;QACL,IAAI;KACL,CAAC,CAAC;IAEH,MAAM,MAAM,GAAG,MAAA,MAAM,CAAC,MAAM,mCAAI,CAAC,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IAE1D,MAAM,SAAS,GAAG,MAAA,QAAQ,CAAC,IAAI,CAAC,IAAI,CAClC,CAAC,OAAO,EAAE,EAAE;;QACV,OAAA,CAAA,MAAA,OAAO,CAAC,IAAI,0CAAE,EAAE,MAAK,MAAM;YAC3B,CAAC,MAAM,CAAC,UAAU;gBAChB,CAAC,CAAC,MAAA,OAAO,CAAC,IAAI,0CAAE,QAAQ,CAAC,YAAY,MAAM,CAAC,UAAU,MAAM,CAAC;gBAC7D,CAAC,CAAC,IAAI,CAAC,CAAA;KAAA,CACZ,0CAAE,EAAE,CAAC;IAEN,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU;QAC5B,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,QAAQ,MAAM,CAAC,UAAU,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QACpE,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;IAEvB,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS;QAC/B,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC;YAC1B,IAAI;YACJ,UAAU,EAAE,SAAS;YACrB,YAAY,EAAE,WAAW;YACzB,KAAK;YACL,IAAI;SACL,CAAC;QACJ,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC;YAC1B,IAAI;YACJ,YAAY,EAAE,WAAW;YACzB,KAAK;YACL,IAAI;SACL,CAAC,CAAC,CAAC;IAER,OAAO;QACL,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,EAAE;KACrB,CAAC;AACJ,CAAC,CAAA,CAAC;AAxDW,QAAA,eAAe,mBAwD1B"}

package/lib/api/github/pullRequest.d.ts

@@ -0,0 +1,21 @@
+import { Octokit } from '@octokit/rest';
+interface GetPullRequestParameters {
+    /**
+     * A preconstructed Octokit client to interact with GitHub's APIs.
+     *
+     * A `GITHUB_API_TOKEN` or `GITHUB_TOKEN` with write permissions must be
+     * present on the environment if this is not provided.
+     */
+    client?: Octokit;
+    env?: Record<string, string | undefined>;
+}
+/**
+ * Gets the number of the current pull request.
+ *
+ * This tries to extract the pull request from common CI environment variables,
+ * and falls back to querying the GitHub Repos API for the latest pull request
+ * associated with the head commit. An error is thrown if there are no
+ * associated pull requests, or if they are all closed or locked.
+ */
+export declare const getPullRequestNumber: (params?: GetPullRequestParameters) => Promise<number>;
+export {};

package/lib/api/github/pullRequest.js

@@ -0,0 +1,70 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPullRequestNumber = void 0;
+const rest_1 = require("@octokit/rest");
+const Git = __importStar(require("../git"));
+const environment_1 = require("./environment");
+/**
+ * Gets the number of the current pull request.
+ *
+ * This tries to extract the pull request from common CI environment variables,
+ * and falls back to querying the GitHub Repos API for the latest pull request
+ * associated with the head commit. An error is thrown if there are no
+ * associated pull requests, or if they are all closed or locked.
+ */
+const getPullRequestNumber = (params = {}) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c, _d;
+    const env = (_a = params.env) !== null && _a !== void 0 ? _a : process.env;
+    const dir = process.cwd();
+    const number = Number((_b = env.BUILDKITE_PULL_REQUEST) !== null && _b !== void 0 ? _b : (_c = env.GITHUB_REF) === null || _c === void 0 ? void 0 : _c.replace(/^refs\/pull\/(\d+).*$/, '$1'));
+    if (Number.isSafeInteger(number)) {
+        return number;
+    }
+    const client = (_d = params.client) !== null && _d !== void 0 ? _d : new rest_1.Octokit({ auth: (0, environment_1.apiTokenFromEnvironment)() });
+    const [commitId, { owner, repo }] = yield Promise.all([
+        Git.getHeadCommitId({ dir, env }),
+        Git.getOwnerAndRepo({ dir }),
+    ]);
+    const response = yield client.repos.listPullRequestsAssociatedWithCommit({
+        commit_sha: commitId,
+        owner,
+        repo,
+    });
+    const data = response.data
+        .filter((pr) => pr.state === 'open' && !pr.locked)
+        .sort((a, b) => b.updated_at.localeCompare(a.updated_at));
+    if (!data.length) {
+        throw new Error(`Commit ${commitId} is not associated with an open GitHub pull request`);
+    }
+    return data[0].number;
+});
+exports.getPullRequestNumber = getPullRequestNumber;
+//# sourceMappingURL=pullRequest.js.map

package/lib/api/github/pullRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pullRequest.js","sourceRoot":"","sources":["../../../src/api/github/pullRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,wCAAwC;AAExC,4CAA8B;AAE9B,+CAAwD;AAcxD;;;;;;;GAOG;AACI,MAAM,oBAAoB,GAAG,CAClC,SAAmC,EAAE,EACpB,EAAE;;IACnB,MAAM,GAAG,GAAG,MAAA,MAAM,CAAC,GAAG,mCAAI,OAAO,CAAC,GAAG,CAAC;IAEtC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAE1B,MAAM,MAAM,GAAG,MAAM,CACnB,MAAA,GAAG,CAAC,sBAAsB,mCACxB,MAAA,GAAG,CAAC,UAAU,0CAAE,OAAO,CAAC,uBAAuB,EAAE,IAAI,CAAC,CACzD,CAAC;IAEF,IAAI,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE;QAChC,OAAO,MAAM,CAAC;KACf;IAED,MAAM,MAAM,GACV,MAAA,MAAM,CAAC,MAAM,mCAAI,IAAI,cAAO,CAAC,EAAE,IAAI,EAAE,IAAA,qCAAuB,GAAE,EAAE,CAAC,CAAC;IAEpE,MAAM,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACpD,GAAG,CAAC,eAAe,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;QACjC,GAAG,CAAC,eAAe,CAAC,EAAE,GAAG,EAAE,CAAC;KAC7B,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,oCAAoC,CAAC;QACvE,UAAU,EAAE,QAAQ;QACpB,KAAK;QACL,IAAI;KACL,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI;SACvB,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,KAAK,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC;SACjD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;IAE5D,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;QAChB,MAAM,IAAI,KAAK,CACb,UAAU,QAAQ,qDAAqD,CACxE,CAAC;KACH;IAED,OAAO,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AACxB,CAAC,CAAA,CAAC;AAzCW,QAAA,oBAAoB,wBAyC/B"}

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

@@ -1,5 +1,5 @@
-import { Config } from '@jest/types';
-declare type Props = Pick<Config.InitialOptions, 'collectCoverage' | 'collectCoverageFrom' | 'collectCoverageOnlyFrom' | 'coveragePathIgnorePatterns' | 'coverageThreshold' | 'globals' | 'globalSetup' | 'globalTeardown' | 'setupFiles' | 'setupFilesAfterEnv' | 'snapshotSerializers' | 'testEnvironment' | 'testPathIgnorePatterns' | 'testTimeout' | 'watchPathIgnorePatterns'>;
+import type { Config } from '@jest/types';
+declare type Props = Pick<Config.InitialOptions, 'collectCoverage' | 'collectCoverageFrom' | 'collectCoverageOnlyFrom' | 'coveragePathIgnorePatterns' | 'coverageThreshold' | 'displayName' | 'globals' | 'globalSetup' | 'globalTeardown' | 'projects' | 'setupFiles' | 'setupFilesAfterEnv' | 'snapshotSerializers' | 'testEnvironment' | 'testPathIgnorePatterns' | 'testTimeout' | 'watchPathIgnorePatterns'>;
 /**
  * Merge additional Jest options into the **skuba** preset.
  *

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/jest/index.ts"],"names":[],"mappings":";;;;;;AAEA,uEAA8C;AAC9C,kEAAiE;AAqBjE;;;;GAIG;AACI,MAAM,WAAW,GAAG,CAAC,KAAY,EAAyB,EAAE,CACjE,IAAA,iBAAQ,EAAC,qBAAU,EAAE,KAAK,CAAC,CAAC;AADjB,QAAA,WAAW,eACM"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/jest/index.ts"],"names":[],"mappings":";;;;;;AAEA,uEAA8C;AAC9C,kEAAiE;AAuBjE;;;;GAIG;AACI,MAAM,WAAW,GAAG,CAAC,KAAY,EAAyB,EAAE,CACjE,IAAA,iBAAQ,EAAC,qBAAU,EAAE,KAAK,CAAC,CAAC;AADjB,QAAA,WAAW,eACM"}

package/lib/api/net/waitFor.d.ts

@@ -1,4 +1,4 @@
-import { SocketAddress } from './socket';
+import type { SocketAddress } from './socket';
 /**
  * Wait for a resource to start listening on a socket address.
  *

package/lib/api/net/waitFor.js.map

@@ -1 +1 @@
-{"version":3,"file":"waitFor.js","sourceRoot":"","sources":["../../../src/api/net/waitFor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAAkD;AAClD,qCAAqD;AAErD;;;;;GAKG;AACI,MAAM,OAAO,GAAG,CAAO,EAC5B,IAAI,GAAG,WAAW,EAClB,IAAI,EACJ,cAAc,GAAG,KAAK,EACtB,OAAO,GAAG,KAAM,GAkBjB,EAA0B,EAAE;IAC3B,MAAM,eAAe,GAAG,cAAc;QACpC,CAAC,CAAC,MAAM,IAAA,+BAAqB,EAAC,IAAI,EAAE,IAAI,CAAC;QACzC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAEnB,MAAM,IAAA,mBAAU,EAAC,eAAe,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEtE,OAAO,eAAe,CAAC;AACzB,CAAC,CAAA,CAAC;AA9BW,QAAA,OAAO,WA8BlB"}
+{"version":3,"file":"waitFor.js","sourceRoot":"","sources":["../../../src/api/net/waitFor.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,uCAAkD;AAElD,qCAAsC;AAEtC;;;;;GAKG;AACI,MAAM,OAAO,GAAG,CAAO,EAC5B,IAAI,GAAG,WAAW,EAClB,IAAI,EACJ,cAAc,GAAG,KAAK,EACtB,OAAO,GAAG,KAAM,GAkBjB,EAA0B,EAAE;IAC3B,MAAM,eAAe,GAAG,cAAc;QACpC,CAAC,CAAC,MAAM,IAAA,+BAAqB,EAAC,IAAI,EAAE,IAAI,CAAC;QACzC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAEnB,MAAM,IAAA,mBAAU,EAAC,eAAe,CAAC,IAAI,EAAE,eAAe,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAEtE,OAAO,eAAe,CAAC;AACzB,CAAC,CAAA,CAAC;AA9BW,QAAA,OAAO,WA8BlB"}

package/lib/cli/adapter/eslint.d.ts

@@ -1,5 +1,5 @@
-import { Linter } from 'eslint';
-import { Logger } from '../../utils/logging';
+import type { Linter } from 'eslint';
+import type { Logger } from '../../utils/logging';
 export interface ESLintResult {
     messages: Linter.LintMessage[];
     filePath: string;

package/lib/cli/adapter/eslint.js

@@ -16,6 +16,7 @@ exports.runESLint = void 0;
 const path_1 = __importDefault(require("path"));
 const chalk_1 = __importDefault(require("chalk"));
 const eslint_1 = require("eslint");
+const logging_1 = require("../../utils/logging");
 const symbolForResult = (result) => {
     if (result.errorCount) {
         return chalk_1.default.red('○');
@@ -25,9 +26,7 @@ const symbolForResult = (result) => {
 const runESLint = (mode, logger) => __awaiter(void 0, void 0, void 0, function* () {
     logger.debug('Initialising ESLint...');
     const engine = new eslint_1.ESLint({
-        // TODO: enable this once we have a less overzealous `skuba configure` that
-        // everyone can apply to update their `.gitignore` files.
-        // cache: true,
+        cache: true,
         extensions: ['js', 'ts', 'tsx'],
         fix: mode === 'format',
         reportUnusedDisableDirectives: 'error',
@@ -40,7 +39,7 @@ const runESLint = (mode, logger) => __awaiter(void 0, void 0, void 0, function*
         engine.lintFiles('.'),
     ]);
     const end = process.hrtime.bigint();
-    logger.plain(`Processed ${logger.pluralise(results.length, 'file')} in ${logger.timing(start, end)}.`);
+    logger.plain(`Processed ${(0, logging_1.pluralise)(results.length, 'file')} in ${logger.timing(start, end)}.`);
     const errors = [];
     const warnings = [];
     for (const result of results) {

package/lib/cli/adapter/eslint.js.map

@@ -1 +1 @@
-{"version":3,"file":"eslint.js","sourceRoot":"","sources":["../../../src/cli/adapter/eslint.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gDAAwB;AAExB,kDAA0B;AAC1B,mCAAwC;AAIxC,MAAM,eAAe,GAAG,CAAC,MAAyB,EAAE,EAAE;IACpD,IAAI,MAAM,CAAC,UAAU,EAAE;QACrB,OAAO,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;KACvB;IAED,OAAO,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,eAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,eAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACpE,CAAC,CAAC;AAcK,MAAM,SAAS,GAAG,CACvB,IAAuB,EACvB,MAAc,EACS,EAAE;IACzB,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAEvC,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC;QACxB,2EAA2E;QAC3E,yDAAyD;QACzD,eAAe;QACf,UAAU,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC;QAC/B,GAAG,EAAE,IAAI,KAAK,QAAQ;QACtB,6BAA6B,EAAE,OAAO;KACvC,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAE1B,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEpC,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAEtC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC7C,MAAM,CAAC,aAAa,EAAE;QACtB,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;KACtB,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAEpC,MAAM,CAAC,KAAK,CACV,aAAa,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,MAAM,CAAC,MAAM,CACvE,KAAK,EACL,GAAG,CACJ,GAAG,CACL,CAAC;IAEF,MAAM,MAAM,GAAmB,EAAE,CAAC;IAClC,MAAM,QAAQ,GAAmB,EAAE,CAAC;IAEpC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;QAC5B,MAAM,YAAY,GAAG,cAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACzD,IAAI,MAAM,CAAC,UAAU,EAAE;YACrB,MAAM,CAAC,IAAI,CAAC;gBACV,QAAQ,EAAE,YAAY;gBACtB,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC1B,CAAC,CAAC;SACJ;QAED,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,QAAQ,CAAC,IAAI,CAAC;gBACZ,QAAQ,EAAE,YAAY;gBACtB,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC1B,CAAC,CAAC;SACJ;QAED,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC,CAAC;KACrD;IAED,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;IAE/B,MAAM,eAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAElC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEzC,IAAI,MAAM,EAAE;QACV,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;KACtB;IAED,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AAC1C,CAAC,CAAA,CAAC;AApEW,QAAA,SAAS,aAoEpB"}
+{"version":3,"file":"eslint.js","sourceRoot":"","sources":["../../../src/cli/adapter/eslint.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,gDAAwB;AAExB,kDAA0B;AAE1B,mCAAgC;AAGhC,iDAAgD;AAEhD,MAAM,eAAe,GAAG,CAAC,MAAyB,EAAE,EAAE;IACpD,IAAI,MAAM,CAAC,UAAU,EAAE;QACrB,OAAO,eAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;KACvB;IAED,OAAO,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,eAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,eAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AACpE,CAAC,CAAC;AAcK,MAAM,SAAS,GAAG,CACvB,IAAuB,EACvB,MAAc,EACS,EAAE;IACzB,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAEvC,MAAM,MAAM,GAAG,IAAI,eAAM,CAAC;QACxB,KAAK,EAAE,IAAI;QACX,UAAU,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC;QAC/B,GAAG,EAAE,IAAI,KAAK,QAAQ;QACtB,6BAA6B,EAAE,OAAO;KACvC,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAE1B,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEpC,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAEtC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC7C,MAAM,CAAC,aAAa,EAAE;QACtB,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;KACtB,CAAC,CAAC;IAEH,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;IAEpC,MAAM,CAAC,KAAK,CACV,aAAa,IAAA,mBAAS,EAAC,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,OAAO,MAAM,CAAC,MAAM,CAChE,KAAK,EACL,GAAG,CACJ,GAAG,CACL,CAAC;IAEF,MAAM,MAAM,GAAmB,EAAE,CAAC;IAClC,MAAM,QAAQ,GAAmB,EAAE,CAAC;IAEpC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;QAC5B,MAAM,YAAY,GAAG,cAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC;QACzD,IAAI,MAAM,CAAC,UAAU,EAAE;YACrB,MAAM,CAAC,IAAI,CAAC;gBACV,QAAQ,EAAE,YAAY;gBACtB,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC1B,CAAC,CAAC;SACJ;QAED,IAAI,MAAM,CAAC,YAAY,EAAE;YACvB,QAAQ,CAAC,IAAI,CAAC;gBACZ,QAAQ,EAAE,YAAY;gBACtB,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC1B,CAAC,CAAC;SACJ;QAED,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC,CAAC;KACrD;IAED,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC;IAE/B,MAAM,eAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;IAElC,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAEzC,IAAI,MAAM,EAAE;QACV,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;KACtB;IAED,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AAC1C,CAAC,CAAA,CAAC;AAlEW,QAAA,SAAS,aAkEpB"}

package/lib/cli/adapter/prettier.d.ts

@@ -1,4 +1,25 @@
-import { Logger } from '../../utils/logging';
+import type { Logger } from '../../utils/logging';
+/**
+ * Infers a parser for the specified filepath.
+ *
+ * This is a cut-down version of Prettier's built-in function of the same name;
+ * ours operates purely on the `filepath` string and does not perform file I/O.
+ * Prettier's internal `getInterpreter` function can open a file to read the
+ * shebang, and its file descriptor usage can throw warnings on worker threads:
+ *
+ * ```console
+ * Warning: File descriptor 123 closed but not opened in unmanaged mode
+ *     at Object.closeSync (node:fs:530:11)
+ *     at Object.closeSync (node_modules/graceful-fs/graceful-fs.js:74:20)
+ *     ...
+ * ```
+ *
+ * References:
+ *
+ * - https://github.com/prettier/prettier/blob/2.4.1/src/main/options.js#L167
+ * - seek-oss/skuba#659
+ */
+export declare const inferParser: (filepath: string) => string | undefined;
 interface Result {
     count: number;
     errored: Array<{