pr-report-core 0.1.0 → 0.2.1

package/dist/types.d.mts

@@ -12,22 +12,21 @@ export type RepoRef = Readonly<{
  * What one context has reported on a head commit.
  *
  * `skipped` is its own state rather than a kind of `passed`. GitHub counts a
- * skip as met, and so does the verdict — but once the two are one word a
- * reader cannot tell them apart, and the aggregate that skipped may be from a
- * round that was superseded by one about to fail.
+ * skip as met, and so does the verdict — but once the two are one word a reader
+ * cannot tell them apart, and the aggregate that skipped may be from a round
+ * that was superseded by one about to fail.
  */
 export type ContextState = 'failed' | 'passed' | 'pending' | 'skipped';
 export type ChecksSummary = Readonly<{
     /**
-     * `paused` is `skip-ci`: the gated jobs boot no runner and
-     * `no-skip-ci-label` sits `pending` by design, so neither "pending" nor
-     * "failing" describes it.
+     * `paused` is `skip-ci`: the gated jobs boot no runner and `no-skip-ci-label`
+     * sits `pending` by design, so neither "pending" nor "failing" describes it.
      */
     verdict: 'failing' | 'passed' | 'paused' | 'pending';
     /**
      * Every required context by what it reported. These four,
-     * {@link ChecksSummary.missing} and {@link ChecksSummary.notRun} are
-     * disjoint and cover the required list.
+     * {@link ChecksSummary.missing} and {@link ChecksSummary.notRun} are disjoint
+     * and cover the required list.
      */
     passed: readonly string[];
     failed: readonly string[];
@@ -41,9 +40,9 @@ export type ChecksSummary = Readonly<{
     missing: readonly string[];
     /**
      * Required contexts with nothing reported, on a pull request whose base the
-     * ruleset does not cover — a stacked one. A workflow may run on pull
-     * requests into `main` only, and then its contexts never come here; nothing
-     * waits for them, since GitHub requires nothing of this base either.
+     * ruleset does not cover — a stacked one. A workflow may run on pull requests
+     * into `main` only, and then its contexts never come here; nothing waits for
+     * them, since GitHub requires nothing of this base either.
      */
     notRun: readonly string[];
     /** How many contexts the verdict was reached over. */
@@ -82,28 +81,28 @@ export type PullRequestFacts = Readonly<{
     labels: readonly Label[];
     /**
      * Whether auto-merge is armed. Separate from `merge-queued`, which is the
-     * author saying a pull request is to be landed: the label is the request
-     * and this is the mechanism, which `unblock-prs` arms when it picks the
-     * pull request.
+     * author saying a pull request is to be landed: the label is the request and
+     * this is the mechanism, which `unblock-prs` arms when it picks the pull
+     * request.
      */
     autoMerge: boolean;
     headRef: string;
     headSha: string;
     baseRef: string;
     /**
-     * Whether the head branch lives in a fork, which keeps it from being read
-     * as the parent of a stacked pull request. See `stack.mts`.
+     * Whether the head branch lives in a fork, which keeps it from being read as
+     * the parent of a stacked pull request. See `stack.mts`.
      */
     fromFork: boolean;
     url: string;
     /**
-     * When anything about the pull request last changed — a label, a comment,
-     * an edit — which is why it is not {@link PullRequestFacts.headCommittedAt}.
+     * When anything about the pull request last changed — a label, a comment, an
+     * edit — which is why it is not {@link PullRequestFacts.headCommittedAt}.
      */
     updatedAt: string;
     /**
-     * When the head commit was made, which is when the branch was last pushed
-     * to as nearly as GitHub records it. Undefined when it could not be read.
+     * When the head commit was made, which is when the branch was last pushed to
+     * as nearly as GitHub records it. Undefined when it could not be read.
      */
     headCommittedAt: string | undefined;
     /** Undefined when the comparison could not be read. */
@@ -111,8 +110,8 @@ export type PullRequestFacts = Readonly<{
     /** What every context reported on the head commit, required or not. */
     reported: ReadonlyMap<string, ContextState>;
     /**
-     * Whether any check run on the head commit has not finished, required or
-     * not. See `anyRunInProgress` for why the required ones are not enough.
+     * Whether any check run on the head commit has not finished, required or not.
+     * See `anyRunInProgress` for why the required ones are not enough.
      */
     checksRunning: boolean;
     linkedIssues: readonly LinkedIssue[];
@@ -126,8 +125,8 @@ export type ReportEntry = PullRequestFacts & Readonly<{
      */
     stackedOn: number | undefined;
     /**
-     * The open pull requests it merges after because an issue it closes
-     * starts after them (`start-after.mts`'s `inheritStartAfter`), less what
+     * The open pull requests it merges after because an issue it closes starts
+     * after them (`start-after.mts`'s `inheritStartAfter`), less what
      * `mergeAfter` and `stackedOn` already say.
      */
     inheritedMergeAfter: readonly number[];
@@ -146,9 +145,9 @@ export type ReportEntry = PullRequestFacts & Readonly<{
 }>;
 /**
  * One pull request in the merge order. `repeated` marks the second and later
- * appearances of a pull request with more than one predecessor — declared,
- * or the one it is stacked on: it is drawn under each of them, but expanded
- * under the first only.
+ * appearances of a pull request with more than one predecessor — declared, or
+ * the one it is stacked on: it is drawn under each of them, but expanded under
+ * the first only.
  */
 export type TreeNode = Readonly<{
     number: number;
@@ -158,8 +157,8 @@ export type TreeNode = Readonly<{
 /**
  * One pull request that has already landed, for the section that says what
  * shipped. Nothing that is true of an open pull request — a merge order, a
- * check verdict, a distance from its base — is true of one that has merged,
- * so it is its own shape rather than an entry with the fields blanked.
+ * check verdict, a distance from its base — is true of one that has merged, so
+ * it is its own shape rather than an entry with the fields blanked.
  */
 export type MergedPullRequest = Readonly<{
     number: number;
@@ -193,8 +192,8 @@ export type OpenIssue = Readonly<{
      */
     startAfter: readonly number[];
     /**
-     * What a `Merge-After:` in its body names. That line is not read on an
-     * issue, and is shown as a slip to fix: `Start-After:` is the issue's.
+     * What a `Merge-After:` in its body names. That line is not read on an issue,
+     * and is shown as a slip to fix: `Start-After:` is the issue's.
      */
     misplacedMergeAfter: readonly number[];
 }>;
@@ -215,8 +214,8 @@ export type IssueDeclarations = Readonly<{
     /** Each issue's `Start-After:`; an issue not in it declares nothing. */
     startAfter: ReadonlyMap<number, readonly number[]>;
     /**
-     * The numbers known to be open issues, beyond the ones an open pull
-     * request links as open. Decides only what is said not to be started.
+     * The numbers known to be open issues, beyond the ones an open pull request
+     * links as open. Decides only what is said not to be started.
      */
     open: ReadonlySet<number>;
 }>;

package/dist/types.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.mts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE1E;;;GAGG;AAEH,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEhE;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;AAEvE,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC;IACnC;;;;OAIG;IACH,OAAO,EAAE,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IACrD;;;;OAIG;IACH,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B;;;;OAIG;IACH,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B;;;;;OAKG;IACH,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC,CAAC;AAEH,4EAA4E;AAC5E,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEzE,oEAAoE;AACpE,MAAM,MAAM,KAAK,GAAG,QAAQ,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;CACtC,CAAC,CAAC;AAEH,0EAA0E;AAC1E,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,SAAS,KAAK,EAAE,CAAC;IACzB;;;;;OAKG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,uDAAuD;IACvD,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC;IACnC,uEAAuE;IACvE,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC5C;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB,YAAY,EAAE,SAAS,WAAW,EAAE,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,gBAAgB,GACxC,QAAQ,CAAC;IACP,uEAAuE;IACvE,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;;;OAIG;IACH,mBAAmB,EAAE,SAAS,MAAM,EAAE,CAAC;IACvC;;;;OAIG;IACH,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC;;;OAGG;IACH,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7B,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC,CAAC;AAEL;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,SAAS,QAAQ,EAAE,CAAC;CAC/B,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,SAAS,KAAK,EAAE,CAAC;IACzB,0EAA0E;IAC1E,YAAY,EAAE,SAAS,WAAW,EAAE,CAAC;CACtC,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,SAAS,KAAK,EAAE,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B;;;OAGG;IACH,mBAAmB,EAAE,SAAS,MAAM,EAAE,CAAC;CACxC,CAAC,CAAC;AAEH,4EAA4E;AAC5E,MAAM,MAAM,WAAW,GAAG,SAAS,GACjC,QAAQ,CAAC;IACP,KAAK,EAAE,eAAe,CAAC;IACvB,0EAA0E;IAC1E,KAAK,EAAE,SAAS,QAAQ,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,eAAe,CAAA;KAAE,CAAC,EAAE,CAAC;CACzE,CAAC,CAAC;AAEL;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC;IACvC,wEAAwE;IACxE,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC;IACnD;;;OAGG;IACH,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CAC3B,CAAC,CAAC;AAEH,sCAAsC;AACtC,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC;IAC9B,IAAI,EAAE,OAAO,CAAC;IACd,mDAAmD;IACnD,aAAa,EAAE,MAAM,CAAC;IACtB,2EAA2E;IAC3E,WAAW,EAAE,MAAM,CAAC;IACpB,yEAAyE;IACzE,aAAa,EAAE,OAAO,CAAC;IACvB,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,oDAAoD;IACpD,OAAO,EAAE,SAAS,WAAW,EAAE,CAAC;IAChC;;;OAGG;IACH,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;IAC3B,MAAM,EAAE,SAAS,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC;IACvC,qEAAqE;IACrE,MAAM,EAAE,SAAS,iBAAiB,EAAE,CAAC;IACrC,mCAAmC;IACnC,gBAAgB,EAAE,MAAM,CAAC;IACzB,oDAAoD;IACpD,MAAM,EAAE,SAAS,WAAW,EAAE,CAAC;IAC/B,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC,CAAC"}
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.mts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAE1E;;;GAGG;AAEH,wCAAwC;AACxC,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEhE;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,CAAC;AAEvE,MAAM,MAAM,aAAa,GAAG,QAAQ,CAAC;IACnC;;;OAGG;IACH,OAAO,EAAE,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IACrD;;;;OAIG;IACH,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B;;;;OAIG;IACH,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B;;;;;OAKG;IACH,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1B,sDAAsD;IACtD,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC,CAAC;AAEH,4EAA4E;AAC5E,MAAM,MAAM,UAAU,GAAG,QAAQ,CAAC;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEzE,oEAAoE;AACpE,MAAM,MAAM,KAAK,GAAG,QAAQ,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,6DAA6D;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;CACtC,CAAC,CAAC;AAEH,0EAA0E;AAC1E,MAAM,MAAM,gBAAgB,GAAG,QAAQ,CAAC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,mEAAmE;IACnE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,SAAS,KAAK,EAAE,CAAC;IACzB;;;;;OAKG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,uDAAuD;IACvD,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC;IACnC,uEAAuE;IACvE,QAAQ,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;IAC5C;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB,YAAY,EAAE,SAAS,WAAW,EAAE,CAAC;CACtC,CAAC,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,gBAAgB,GACxC,QAAQ,CAAC;IACP,uEAAuE;IACvE,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B;;;;OAIG;IACH,mBAAmB,EAAE,SAAS,MAAM,EAAE,CAAC;IACvC;;;;OAIG;IACH,gBAAgB,EAAE,SAAS,MAAM,EAAE,CAAC;IACpC;;;OAGG;IACH,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IAC7B,MAAM,EAAE,aAAa,CAAC;CACvB,CAAC,CAAC;AAEL;;;;;GAKG;AACH,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,SAAS,QAAQ,EAAE,CAAC;CAC/B,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,SAAS,KAAK,EAAE,CAAC;IACzB,0EAA0E;IAC1E,YAAY,EAAE,SAAS,WAAW,EAAE,CAAC;CACtC,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,SAAS,KAAK,EAAE,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B;;;OAGG;IACH,mBAAmB,EAAE,SAAS,MAAM,EAAE,CAAC;CACxC,CAAC,CAAC;AAEH,4EAA4E;AAC5E,MAAM,MAAM,WAAW,GAAG,SAAS,GACjC,QAAQ,CAAC;IACP,KAAK,EAAE,eAAe,CAAC;IACvB,0EAA0E;IAC1E,KAAK,EAAE,SAAS,QAAQ,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,eAAe,CAAA;KAAE,CAAC,EAAE,CAAC;CACzE,CAAC,CAAC;AAEL;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC;IACvC,wEAAwE;IACxE,UAAU,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC;IACnD;;;OAGG;IACH,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;CAC3B,CAAC,CAAC;AAEH,sCAAsC;AACtC,MAAM,MAAM,OAAO,GAAG,QAAQ,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,qEAAqE;IACrE,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,2DAA2D;IAC3D,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC,CAAC;AAEH,MAAM,MAAM,QAAQ,GAAG,QAAQ,CAAC;IAC9B,IAAI,EAAE,OAAO,CAAC;IACd,mDAAmD;IACnD,aAAa,EAAE,MAAM,CAAC;IACtB,2EAA2E;IAC3E,WAAW,EAAE,MAAM,CAAC;IACpB,yEAAyE;IACzE,aAAa,EAAE,OAAO,CAAC;IACvB,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,oDAAoD;IACpD,OAAO,EAAE,SAAS,WAAW,EAAE,CAAC;IAChC;;;OAGG;IACH,KAAK,EAAE,SAAS,QAAQ,EAAE,CAAC;IAC3B,MAAM,EAAE,SAAS,CAAC,SAAS,MAAM,EAAE,CAAC,EAAE,CAAC;IACvC,qEAAqE;IACrE,MAAM,EAAE,SAAS,iBAAiB,EAAE,CAAC;IACrC,mCAAmC;IACnC,gBAAgB,EAAE,MAAM,CAAC;IACzB,oDAAoD;IACpD,MAAM,EAAE,SAAS,WAAW,EAAE,CAAC;IAC/B,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pr-report-core",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "private": false,
   "description": "What a GitHub merge queue driven by labels and `Merge-After:` trailers decides about the open pull requests — verdicts, merge order, stacks, owners — with no I/O, shared by the GitHub Pull Requests Manager page and the unblock-prs worker",
   "keywords": [
@@ -39,8 +39,8 @@
     "LICENSE"
   ],
   "dependencies": {
-    "ts-data-forge": "^14.10.0",
-    "ts-fortress": "^12.4.1"
+    "ts-data-forge": "^14.11.0",
+    "ts-fortress": "^12.4.3"
   },
   "devDependencies": {
     "@octokit/openapi-types": "^29.0.1",
@@ -49,16 +49,16 @@
     "cspell": "10.4.0",
     "dedent": "1.7.2",
     "eslint": "10.13.0",
-    "eslint-config-typed": "7.1.0",
-    "eslint-plugin-ts-data-forge": "0.10.5",
-    "eslint-plugin-ts-fortress": "1.3.10",
-    "eslint-plugin-ts-type-forge": "0.8.15",
+    "eslint-config-typed": "7.4.0",
+    "eslint-plugin-ts-data-forge": "0.10.9",
+    "eslint-plugin-ts-fortress": "1.3.13",
+    "eslint-plugin-ts-type-forge": "0.8.18",
     "jiti": "2.7.0",
     "npm-run-all2": "9.0.4",
     "prettier": "3.9.10",
     "prettier-plugin-organize-imports": "4.3.0",
     "prettier-plugin-packagejson": "3.0.2",
-    "ts-repo-utils": "10.7.1",
+    "ts-repo-utils": "10.7.2",
     "tsx": "4.23.15",
     "typescript": "6.0.3",
     "typescript-native": "npm:typescript@7.0.2",

package/src/checks.mts

@@ -6,36 +6,36 @@ import type { ChecksSummary, ContextState } from './types.mjs';
 /**
  * What every context reported, from a head commit's check runs.
  *
- * A name appears more than once whenever two check suites reported it, and on
- * a queued pull request that is the normal case rather than the odd one: the
- * run the `opened` event starts is cancelled by the `labeled` event's, and
- * both stay on the commit — the cancelled one leaving its `*-result`
- * aggregate concluded `failure`, because an `if: always()` job that asserts
- * on cancelled `needs` fails.
+ * A name appears more than once whenever two check suites reported it, and on a
+ * queued pull request that is the normal case rather than the odd one: the run
+ * the `opened` event starts is cancelled by the `labeled` event's, and both
+ * stay on the commit — the cancelled one leaving its `*-result` aggregate
+ * concluded `failure`, because an `if: always()` job that asserts on cancelled
+ * `needs` fails.
  *
- * **The newest check suite wins, and that is not the same as the newest
- * run.** GitHub resolves a required context to the run in the suite with the
- * greatest id, so where the cancelled suite happens to have been created
- * after the one that superseded it, the stale red is what holds the merge —
- * however much later the green one finished. Every suite of one push is
- * created in the same second, so which of them got the higher id is not
- * something the repository decides.
+ * **The newest check suite wins, and that is not the same as the newest run.**
+ * GitHub resolves a required context to the run in the suite with the greatest
+ * id, so where the cancelled suite happens to have been created after the one
+ * that superseded it, the stale red is what holds the merge — however much
+ * later the green one finished. Every suite of one push is created in the same
+ * second, so which of them got the higher id is not something the repository
+ * decides.
  *
  * This is why the rule is not "the newest `started_at`", which reads more
  * natural and would call such a pull request green while GitHub blocks it.
- * A report that says a blocked pull request will merge is worse than one
- * that says a green one will not: `CLAUDE.md`'s "Commits and pull requests"
- * says to ignore the red the cancelled run leaves, and this is the case where
+ * A report that says a blocked pull request will merge is worse than one that
+ * says a green one will not: `CLAUDE.md`'s "Commits and pull requests" says to
+ * ignore the red the cancelled run leaves, and this is the case where
  * GitHub does not.
  *
  * **A run whose workflow has a newer round still going is pending.** An
- * aggregate has no run in a round until the jobs it waits on are done, so
- * until then the only run of its name is the previous round's — on a pull
- * request whose label events started two rounds, the red the second left on
- * the first (#2191). That run is what GitHub shows, but not what it will
- * answer with: the newer round is in the suite with the greater id, and its
- * aggregate will be the newest run of the name. Where the newer round has
- * finished without one, the older run stands, as it does on GitHub.
+ * aggregate has no run in a round until the jobs it waits on are done, so until
+ * then the only run of its name is the previous round's — on a pull request
+ * whose label events started two rounds, the red the second left on the first
+ * (#2191). That run is what GitHub shows, but not what it will answer with: the
+ * newer round is in the suite with the greater id, and its aggregate will be
+ * the newest run of the name. Where the newer round has finished without one,
+ * the older run stands, as it does on GitHub.
  */
 export const statesFromCheckRuns = (
   runs: readonly CheckRunReport[],
@@ -101,9 +101,9 @@ export type CheckRunReport = Readonly<{
   /**
    * The workflow run its suite is, where it is one: the workflow, so that a
    * newer round of it can be told from an unrelated suite, and whether the
-   * round has finished, which its runs alone do not say — an aggregate's run
-   * is created only once every job before it has completed. `undefined` for
-   * a run no workflow made, or where the workflow runs could not be read.
+   * round has finished, which its runs alone do not say — an aggregate's run is
+   * created only once every job before it has completed. `undefined` for a run
+   * no workflow made, or where the workflow runs could not be read.
    */
   round: Readonly<{ workflowId: number; completed: boolean }> | undefined;
 }>;
@@ -114,12 +114,12 @@ export type CheckRunReport = Readonly<{
  * A run that has not completed is pending whatever it concluded last — the
  * conclusion of a re-run is the previous verdict until the new one finishes.
  * A `skipped` conclusion is reported as `skipped` and counted as met by
- * {@link summarizeChecks}, because GitHub counts it as met: the gated jobs
- * skip on `skip-ci` and on a diff the workflow does not read, and reading
- * that as a failure would call every gated pull request red.
+ * {@link summarizeChecks}, because GitHub counts it as met: the gated jobs skip
+ * on `skip-ci` and on a diff the workflow does not read, and reading that as a
+ * failure would call every gated pull request red.
  * Everything else that finished — `cancelled`, `stale`, `timed_out`,
- * `action_required` — is something a reader has to act on, so it is a
- * failure here even where GitHub is vaguer about it.
+ * `action_required` — is something a reader has to act on, so it is a failure
+ * here even where GitHub is vaguer about it.
  */
 export const classifyCheckRun = (
   status: string,
@@ -141,12 +141,12 @@ const PASSING_CONCLUSIONS: ReadonlySet<string> = new Set<string>([
 /**
  * Whether any run on the head commit has not finished, or any round has not.
  *
- * Every run, not only the required ones: the aggregates are `if: always()`
- * and have no run in the newest round until the jobs they wait on are done,
- * so "every required context has reported" is true of a commit halfway
- * through a round — with the reports coming from the round before. And the
- * round, not only its runs: between the last job finishing and the aggregate
- * being created, every run there is has completed.
+ * Every run, not only the required ones: the aggregates are `if: always()` and
+ * have no run in the newest round until the jobs they wait on are done, so
+ * "every required context has reported" is true of a commit halfway through a
+ * round — with the reports coming from the round before. And the round, not
+ * only its runs: between the last job finishing and the aggregate being
+ * created, every run there is has completed.
  */
 export const anyRunInProgress = (runs: readonly CheckRunReport[]): boolean =>
   runs.some(
@@ -154,20 +154,10 @@ export const anyRunInProgress = (runs: readonly CheckRunReport[]): boolean =>
   );
 
 /**
- * Which of two runs of one name GitHub would answer with: the one in the
- * later-created suite, and within one suite the later run of it — a re-run
- * keeps the suite and takes a new run id.
- */
-const outranks = (run: CheckRunReport, previous: CheckRunReport): boolean =>
-  run.checkSuiteId === previous.checkSuiteId
-    ? run.id > previous.id
-    : run.checkSuiteId > previous.checkSuiteId;
-
-/**
- * What every context has reported on one commit, from both places GitHub
- * keeps them. The aggregate jobs are check runs; `no-skip-ci-label` is a
- * commit status, so reading only the first would report the context that
- * holds every labelled pull request as missing.
+ * What every context has reported on one commit, from both places GitHub keeps
+ * them. The aggregate jobs are check runs; `no-skip-ci-label` is a commit
+ * status, so reading only the first would report the context that holds every
+ * labelled pull request as missing.
  *
  * `state` is a commit status's as the REST API spells it, in lower case.
  */
@@ -175,9 +165,9 @@ export const reportedContexts = (
   runs: readonly CheckRunReport[],
   statuses: readonly Readonly<{ context: string; state: string }>[],
 ): ReadonlyMap<string, ContextState> => {
-  // A commit status and a check run of the same name are two requirements,
-  // not one reported twice: GitHub asks both to pass. So the stricter of
-  // the two is kept rather than whichever was read second.
+  // A commit status and a check run of the same name are two requirements, not
+  // one reported twice: GitHub asks both to pass. So the stricter of the two is
+  // kept rather than whichever was read second.
   const mut_states = new Map<string, ContextState>(statesFromCheckRuns(runs));
 
   for (const { context, state } of statuses) {
@@ -199,12 +189,11 @@ export const reportedContexts = (
 /**
  * What a context reported that is both a check run and a commit status.
  *
- * Not "the status wins", which is what this used to assume. GitHub's own
- * answer is that neither does: "If a check and a commit status have the same
- * name, both must pass when that name is required." So the stricter of the
- * two is the verdict, and a green status cannot cover a red check run of the
- * same name. A skip beside a pass is a skip: both are met, but only one of
- * them ran.
+ * Not "the status wins", which is what this used to assume. GitHub's own answer
+ * is that neither does: "If a check and a commit status have the same name,
+ * both must pass when that name is required." So the stricter of the two is the
+ * verdict, and a green status cannot cover a red check run of the same name. A
+ * skip beside a pass is a skip: both are met, but only one of them ran.
  */
 export const combineContextStates = (
   a: ContextState,
@@ -220,8 +209,8 @@ export const combineContextStates = (
 
 /**
  * What one commit status has reported. `no-skip-ci-label` is one of these
- * rather than a check run, so a report that read only check runs would call
- * the context that holds every labelled pull request "missing".
+ * rather than a check run, so a report that read only check runs would call the
+ * context that holds every labelled pull request "missing".
  */
 export const classifyCommitStatus = (state: string): ContextState => {
   switch (state) {
@@ -241,24 +230,24 @@ export const classifyCommitStatus = (state: string): ContextState => {
  * requires and no others: a failing job nothing requires does not block a
  * merge, and listing it would bury the one that does.
  *
- * `paused` outranks the rest. While `skip-ci` is on, the checks a reader
- * sees are whatever survived from before the label went on — typically the
- * red left by the `opened` run that the `labeled` run cancelled. Calling
- * that "failing" would make every queued pull request look broken; the
- * failures are still listed, because they are what a reader asks about.
+ * `paused` outranks the rest. While `skip-ci` is on, the checks a reader sees
+ * are whatever survived from before the label went on — typically the red left
+ * by the `opened` run that the `labeled` run cancelled. Calling that "failing"
+ * would make every queued pull request look broken; the failures are still
+ * listed, because they are what a reader asks about.
  *
  * `running` is the third thing that makes a verdict provisional, beside a
- * required context that is pending and one that has not reported. Without it
- * a commit mid-round reads as settled out of the round before — which is how
- * a failing pull request (#2031) came to show a tick.
+ * required context that is pending and one that has not reported. Without it a
+ * commit mid-round reads as settled out of the round before — which is how a
+ * failing pull request (#2031) came to show a tick.
  *
  * **Off the covered base, a context that never reported is not awaited.**
  * The contexts are the ones the ruleset asks of `main`, and a workflow that
- * runs only on pull requests into `main` never reports on a stacked one —
- * which kept #2103, every check of it green, "running" until it was moved
- * onto `main`. Such a context is {@link ChecksSummary.notRun} instead, but
- * only once some required context has reported: before the first check
- * suite, nothing having come is not a pass over zero contexts.
+ * runs only on pull requests into `main` never reports on a stacked one — which
+ * kept #2103, every check of it green, "running" until it was moved onto
+ * `main`. Such a context is {@link ChecksSummary.notRun} instead, but only once
+ * some required context has reported: before the first check suite, nothing
+ * having come is not a pass over zero contexts.
  */
 export const summarizeChecks = ({
   required,
@@ -308,3 +297,13 @@ export const summarizeChecks = ({
     required: required.length,
   };
 };
+
+/**
+ * Which of two runs of one name GitHub would answer with: the one in the
+ * later-created suite, and within one suite the later run of it — a re-run
+ * keeps the suite and takes a new run id.
+ */
+const outranks = (run: CheckRunReport, previous: CheckRunReport): boolean =>
+  run.checkSuiteId === previous.checkSuiteId
+    ? run.id > previous.id
+    : run.checkSuiteId > previous.checkSuiteId;

package/src/checks.test.mts

@@ -17,11 +17,11 @@ describe(classifyCheckRun, () => {
     assert.strictEqual(classifyCheckRun('in_progress', 'failure'), 'pending');
   });
 
-  // The gated jobs skip on `skip-ci` and on a diff the workflow does not
-  // read; GitHub counts that as met, so reading it as a failure would call
-  // every gated pull request red. `summarizeChecks` still counts it as met —
-  // but it is reported as what it was, because folding it into `passed` is
-  // what let a failing pull request show a tick.
+  // The gated jobs skip on `skip-ci` and on a diff the workflow does not read;
+  // GitHub counts that as met, so reading it as a failure would call every
+  // gated pull request red. `summarizeChecks` still counts it as met — but it
+  // is reported as what it was, because folding it into `passed` is what let a
+  // failing pull request show a tick.
   test('a skipped job is reported as skipped, not as passed', () => {
     assert.strictEqual(classifyCheckRun('completed', 'skipped'), 'skipped');
 
@@ -114,10 +114,9 @@ describe(summarizeChecks, () => {
 
   test('`skip-ci` is a pause, and the detail is still reported', () => {
     // While the label is on, the gated jobs boot no runner and
-    // `no-skip-ci-label` sits `pending` by design. Calling that "failing"
-    // would make every queued pull request look broken; the red left by the
-    // cancelled `opened` run is still listed, because it is what a reader
-    // asks about.
+    // `no-skip-ci-label` sits `pending` by design. Calling that "failing" would
+    // make every queued pull request look broken; the red left by the cancelled
+    // `opened` run is still listed, because it is what a reader asks about.
     const summary = summarizeChecks({
       required,
       reported: new Map<string, ContextState>([
@@ -207,9 +206,9 @@ describe(summarizeChecks, () => {
   });
 
   // #2103, stacked on `chore/pnpm-update`: `lint-pull-request.yml` runs on
-  // pull requests into `main` only, so its three contexts never came, and
-  // the page kept calling a pull request whose checks had all passed
-  // "checks running".
+  // pull requests into `main` only, so its three contexts never came, and the
+  // page kept calling a pull request whose checks had all passed "checks
+  // running".
   describe('on a base the ruleset does not cover', () => {
     const withLint = Arr.toPushed(required, 'Validate PR title');
 
@@ -235,8 +234,8 @@ describe(summarizeChecks, () => {
     });
 
     test('while nothing required has reported, everything is still coming', () => {
-      // Between a push and the first check suite, a head commit has nothing
-      // on it at all; that is not a pass over zero contexts.
+      // Between a push and the first check suite, a head commit has nothing on
+      // it at all; that is not a pass over zero contexts.
       const summary = summarizeChecks({
         required: withLint,
         reported: new Map<string, ContextState>(),
@@ -331,8 +330,8 @@ describe(statesFromCheckRuns, () => {
     // `test-node-versions-result`, the one context of the five that blocked
     // #2021: the cancelled suite happens to have the greater id, so GitHub
     // reports the failure however much later the green one finished. Reading
-    // the newest `started_at` instead would call this pull request green
-    // while GitHub blocks it.
+    // the newest `started_at` instead would call this pull request green while
+    // GitHub blocks it.
     const states = statesFromCheckRuns([
       run(
         'test-node-versions-result / result',
@@ -496,11 +495,11 @@ describe(anyRunInProgress, () => {
  * The state #2031 was in when the page showed it a tick.
  *
  * `skip-ci` came off, which started a new round. The old round's
- * `code-check-result` had concluded `skipped` and was the only run of that
- * name on the commit — the new round's aggregate does not exist until the
- * jobs it waits on are done. Folding `skipped` into `passed` then made the
- * pull request look settled and green, two minutes before
- * `code-check-result` concluded `failure`.
+ * `code-check-result` had concluded `skipped` and was the only run of that name
+ * on the commit — the new round's aggregate does not exist until the jobs it
+ * waits on are done. Folding `skipped` into `passed` then made the pull request
+ * look settled and green, two minutes before `code-check-result` concluded
+ * `failure`.
  */
 describe('a required context in a superseded round', () => {
   const required = [
@@ -607,9 +606,9 @@ describe('a required context in a superseded round', () => {
  * `skip-ci` came off, which started a round, and `merge-queued` went on a
  * minute later, which started another and cancelled the first — whose
  * `*-result` aggregates, `if: always()` over cancelled `needs`, concluded
- * `failure`. The newer round was still at its matrix, so its aggregates did
- * not exist yet, and the red of the cancelled one was the only run of each
- * name on the commit.
+ * `failure`. The newer round was still at its matrix, so its aggregates did not
+ * exist yet, and the red of the cancelled one was the only run of each name on
+ * the commit.
  */
 describe('a required context whose workflow has a newer round running', () => {
   const codeCheck = 359_266_435;
@@ -659,8 +658,8 @@ describe('a required context whose workflow has a newer round running', () => {
       conclusion: undefined,
       round: { workflowId: codeCheck, completed: false },
     },
-    // Style Check has finished every job it has created, but the round is
-    // not over: its aggregate is created only after that.
+    // Style Check has finished every job it has created, but the round is not
+    // over: its aggregate is created only after that.
     {
       id: 114_375_644_790,
       checkSuiteId: 103_247_840_622,
@@ -719,8 +718,8 @@ describe('a required context whose workflow has a newer round running', () => {
   });
 
   // The rule is not "an older round never counts": where the newer round
-  // finished without a run of that name, GitHub answers with the older run,
-  // and so does this.
+  // finished without a run of that name, GitHub answers with the older run, and
+  // so does this.
   test('a finished round that never ran the job does not hide the older run', () => {
     const states = statesFromCheckRuns([
       runs[0],
@@ -737,9 +736,9 @@ describe('a required context whose workflow has a newer round running', () => {
     assert.strictEqual(states.get('code-check-result / result'), 'failed');
   });
 
-  // Nor "the round still running wins": GitHub resolves a context to the
-  // suite with the greatest id, and where the cancelled one has it, its red
-  // holds the merge however the other round goes.
+  // Nor "the round still running wins": GitHub resolves a context to the suite
+  // with the greatest id, and where the cancelled one has it, its red holds the
+  // merge however the other round goes.
   test('a cancelled round with the greater id still holds the merge', () => {
     const states = statesFromCheckRuns([
       {

package/src/claim.mts

@@ -4,25 +4,24 @@
  *
  * `unblock-prs` leaves a set-aside pull request alone until its head moves —
  * or, for every reason but `checks-failed` and `awaiting-bypass`, until the
- * base does, when it tries the rebase again. A session fixing that pull
- * request is then racing the script, and a second session, or the one that
- * opened the pull request and is woken by the set-aside comment, may be
- * fixing the same failure. The leases on every push keep any of them from
- * overwriting another's work, but not from doing it twice. So whoever starts
- * on one says so first in a comment whose first line is a hidden record this
- * module writes and reads, and everyone else — the script included — leaves
- * that pull request to it.
+ * base does, when it tries the rebase again. A session fixing that pull request
+ * is then racing the script, and a second session, or the one that opened the
+ * pull request and is woken by the set-aside comment, may be fixing the same
+ * failure. The leases on every push keep any of them from overwriting another's
+ * work, but not from doing it twice. So whoever starts on one says so first in
+ * a comment whose first line is a hidden record this module writes and reads,
+ * and everyone else — the script included — leaves that pull request to it.
  *
  * **It lasts while the head is the one it claimed**, and for at most
  * {@link CLAIM_LIFETIME_MINUTES}. The push that carries the fix moves the head
- * and so ends the claim with nothing left to clean up; that push is what
- * hands the pull request back to the script, as it always was. The lifetime is
- * for a claimant that stopped without pushing. A claimant that needs longer
- * writes the claim again.
+ * and so ends the claim with nothing left to clean up; that push is what hands
+ * the pull request back to the script, as it always was. The lifetime is for a
+ * claimant that stopped without pushing. A claimant that needs longer writes
+ * the claim again.
  *
  * **One comment per pull request, edited in place**, like the set-aside one;
- * a claim that has ended is simply written over. Of several, the oldest is
- * the one, so two claimants writing at once both read back the same answer.
+ * a claim that has ended is simply written over. Of several, the oldest is the
+ * one, so two claimants writing at once both read back the same answer.
  *
  * **Only the comments the reader's own account wrote count**, as for the
  * set-aside comment (`set-aside.mts`): the repository is public. `by` is what