pr-report-core 0.2.0 → 0.3.0

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.2.0",
+  "version": "0.3.0",
   "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,26 +39,26 @@
     "LICENSE"
   ],
   "dependencies": {
-    "ts-data-forge": "^14.10.0",
-    "ts-fortress": "^12.4.1"
+    "ts-data-forge": "^14.11.0",
+    "ts-fortress": "^12.4.4"
   },
   "devDependencies": {
     "@octokit/openapi-types": "^29.0.1",
     "@types/node": "26.6.5",
-    "@vitest/coverage-v8": "5.0.5",
+    "@vitest/coverage-istanbul": "5.0.5",
     "cspell": "10.4.0",
     "dedent": "1.7.2",
     "eslint": "10.13.0",
-    "eslint-config-typed": "7.2.1",
-    "eslint-plugin-ts-data-forge": "0.10.6",
-    "eslint-plugin-ts-fortress": "1.3.11",
-    "eslint-plugin-ts-type-forge": "0.8.16",
+    "eslint-config-typed": "7.5.0",
+    "eslint-plugin-ts-data-forge": "0.10.10",
+    "eslint-plugin-ts-fortress": "1.3.14",
+    "eslint-plugin-ts-type-forge": "0.8.19",
     "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.3",
     "tsx": "4.23.15",
     "typescript": "6.0.3",
     "typescript-native": "npm:typescript@7.0.2",
@@ -70,7 +70,7 @@
     "pnpm": ">=9.0.0"
   },
   "volta": {
-    "node": "26.12.1"
+    "node": "26.13.0"
   },
   "publishConfig": {
     "access": "public",

package/src/branch-rules.mts

@@ -0,0 +1,105 @@
+/**
+ * What GitHub enforces on a branch, read the one way every reader reads it:
+ * every ruleset that applies to the branch
+ * (`GET /repos/{owner}/{repo}/rules/branches/{branch}`), and the contexts a
+ * classic branch protection rule requires
+ * (`GET /repos/{owner}/{repo}/branches/{branch}`). Neither wants more than
+ * reading the repository, where the endpoints that list a ruleset's own
+ * settings or a protection rule's whole want an admin.
+ *
+ * What a classic rule says about reviews is not among what the second answers,
+ * so a code owner's approval is waited for only where a ruleset asks for it.
+ *
+ * Nothing here talks to GitHub: the reader hands over its own way of asking.
+ */
+
+import { Arr, Result } from 'ts-data-forge';
+import * as t from 'ts-fortress';
+import { requirementsOfRules, type RulesetRequirements } from './ruleset.mjs';
+
+/**
+ * One `GET`, by the reader's own transport. `path` is relative to
+ * `/repos/{owner}/{repo}` and may carry a query string; `what` names the
+ * request for a message.
+ */
+export type BranchRulesGet = <A>(
+  path: string,
+  schema: t.Type<A>,
+  what: string,
+) => Promise<Result<A, string>>;
+
+/**
+ * The requirements on `branch`, or why they could not be read. Either request
+ * failing fails it: a list of required contexts missing half of them would be
+ * read as the whole.
+ */
+export const readBranchRequirements = async (
+  branch: string,
+  get: BranchRulesGet,
+): Promise<Result<RulesetRequirements, string>> => {
+  // One path segment, whatever the name holds: `release/1.x` included. The
+  // rule's premise, building a query string, is not what this is.
+  // eslint-disable-next-line no-restricted-globals
+  const segment = encodeURIComponent(branch);
+
+  const [rules, branchAnswer] = await Promise.all([
+    get(
+      `/rules/branches/${segment}?per_page=${RULES_PER_PAGE}`,
+      RulesSchema,
+      `the rules on ${branch}`,
+    ),
+    get(`/branches/${segment}`, BranchSchema, `the protection of ${branch}`),
+  ]);
+
+  if (Result.isErr(rules)) {
+    return rules;
+  }
+
+  if (Result.isErr(branchAnswer)) {
+    return branchAnswer;
+  }
+
+  const fromRulesets = requirementsOfRules(rules.value);
+
+  const protection = branchAnswer.value.protection;
+
+  const classic =
+    protection?.enabled === false
+      ? undefined
+      : protection?.required_status_checks;
+
+  return Result.ok({
+    ...fromRulesets,
+    requiredContexts: Arr.uniq([
+      ...fromRulesets.requiredContexts,
+      // GitHub's description leaves the level out of what it promises, so one
+      // not given is taken as enforcing.
+      ...(classic === undefined || classic.enforcement_level === 'off'
+        ? []
+        : classic.contexts),
+    ]),
+  });
+};
+
+/**
+ * As many rules as a page holds; GitHub's default is 30. Each ruleset
+ * contributes a handful, so a branch with more than a hundred is not one a
+ * person keeps.
+ */
+const RULES_PER_PAGE = 100;
+
+const RulesSchema = t.array(t.unknown());
+
+const BranchSchema = t.record({
+  protection: t.optional(
+    t.record({
+      enabled: t.optional(t.boolean()),
+      required_status_checks: t.optional(
+        t.record({
+          enforcement_level: t.optional(t.string()),
+          contexts: t.array(t.string()),
+        }),
+      ),
+    }),
+  ),
+});

package/src/branch-rules.test.mts

@@ -0,0 +1,221 @@
+import { Result } from 'ts-data-forge';
+import type * as t from 'ts-fortress';
+import {
+  readBranchRequirements,
+  type BranchRulesGet,
+} from './branch-rules.mjs';
+
+describe(readBranchRequirements, () => {
+  test('adds up the rulesets on the branch and its classic protection', async () => {
+    const { get, asked } = answering({
+      rules: [
+        {
+          type: 'pull_request',
+          parameters: {
+            require_code_owner_review: true,
+            required_review_thread_resolution: false,
+          },
+        },
+        {
+          type: 'required_status_checks',
+          parameters: {
+            required_status_checks: [
+              { context: 'code-check-result / result' },
+              { context: 'lint' },
+            ],
+          },
+        },
+        { type: 'deletion' },
+      ],
+      branch: {
+        protection: {
+          enabled: true,
+          required_status_checks: {
+            enforcement_level: 'non_admins',
+            contexts: ['lint', 'build'],
+          },
+        },
+      },
+    });
+
+    const read = await readBranchRequirements('main', get);
+
+    assert.isTrue(Result.isOk(read));
+
+    assert.deepStrictEqual(read.value, {
+      requiredContexts: ['code-check-result / result', 'lint', 'build'],
+      requireCodeOwnerReview: true,
+      requireConversationResolution: false,
+    });
+
+    assert.deepStrictEqual(asked.toSorted(), [
+      '/branches/main',
+      '/rules/branches/main?per_page=100',
+    ]);
+  });
+
+  test('reads the contexts of a classic rule where no ruleset applies', async () => {
+    const { get } = answering({
+      rules: [],
+      branch: {
+        protection: {
+          enabled: true,
+          required_status_checks: {
+            enforcement_level: 'everyone',
+            contexts: ['build'],
+          },
+        },
+      },
+    });
+
+    const read = await readBranchRequirements('main', get);
+
+    assert.isTrue(Result.isOk(read));
+
+    assert.deepStrictEqual(read.value.requiredContexts, ['build']);
+  });
+
+  test('requires nothing of a branch nothing protects', async () => {
+    const { get } = answering({ rules: [], branch: { protection: {} } });
+
+    const read = await readBranchRequirements('main', get);
+
+    assert.isTrue(Result.isOk(read));
+
+    assert.deepStrictEqual(read.value, {
+      requiredContexts: [],
+      requireCodeOwnerReview: false,
+      requireConversationResolution: false,
+    });
+  });
+
+  test('reads no contexts off classic protection that is switched off', async () => {
+    const { get } = answering({
+      rules: [],
+      branch: {
+        protection: {
+          enabled: true,
+          required_status_checks: {
+            enforcement_level: 'off',
+            contexts: ['stale'],
+          },
+        },
+      },
+    });
+
+    const read = await readBranchRequirements('main', get);
+
+    assert.isTrue(Result.isOk(read));
+
+    assert.deepStrictEqual(read.value.requiredContexts, []);
+  });
+
+  test('reads no contexts off classic protection that is disabled', async () => {
+    const { get } = answering({
+      rules: [],
+      branch: {
+        protection: {
+          enabled: false,
+          required_status_checks: { contexts: ['stale'] },
+        },
+      },
+    });
+
+    const read = await readBranchRequirements('main', get);
+
+    assert.isTrue(Result.isOk(read));
+
+    assert.deepStrictEqual(read.value.requiredContexts, []);
+  });
+
+  test('puts the branch name in the path as one segment', async () => {
+    const { get, asked } = answering({ rules: [], branch: {} });
+
+    await readBranchRequirements('release/1.x', get);
+
+    assert.deepStrictEqual(asked.toSorted(), [
+      '/branches/release%2F1.x',
+      '/rules/branches/release%2F1.x?per_page=100',
+    ]);
+  });
+
+  test.each(['/rules/', '/branches/main'] as const)(
+    'fails when %s fails',
+    async (failing) => {
+      const get: BranchRulesGet = (path, schema, what) =>
+        Promise.resolve(
+          path.startsWith(failing)
+            ? Result.err(`refused ${what}`)
+            : validated(schema, path.startsWith('/rules/') ? [] : {}),
+        );
+
+      const read = await readBranchRequirements('main', get);
+
+      assert.isTrue(Result.isErr(read));
+
+      assert.include(read.value, 'main');
+    },
+  );
+
+  test('fails on rules of another shape', async () => {
+    const { get } = answering({ rules: { rules: [] }, branch: {} });
+
+    const read = await readBranchRequirements('main', get);
+
+    assert.isTrue(Result.isErr(read));
+  });
+
+  test('fails on protection of another shape', async () => {
+    const { get } = answering({
+      rules: [],
+      branch: { protection: { required_status_checks: { contexts: 'build' } } },
+    });
+
+    const read = await readBranchRequirements('main', get);
+
+    assert.isTrue(Result.isErr(read));
+  });
+
+  test('takes a classic rule that names no level as enforcing', async () => {
+    const { get } = answering({
+      rules: [],
+      branch: {
+        protection: { required_status_checks: { contexts: ['build'] } },
+      },
+    });
+
+    const read = await readBranchRequirements('main', get);
+
+    assert.isTrue(Result.isOk(read));
+
+    assert.deepStrictEqual(read.value.requiredContexts, ['build']);
+  });
+});
+
+const validated = <A,>(schema: t.Type<A>, body: unknown): Result<A, string> => {
+  const checked = schema.validate(body);
+
+  return Result.isErr(checked)
+    ? Result.err('not the shape expected')
+    : Result.ok(checked.value);
+};
+
+/** A `get` answering the two paths with the bodies given. */
+const answering = (
+  bodies: Readonly<{ rules: unknown; branch: unknown }>,
+): Readonly<{ get: BranchRulesGet; asked: readonly string[] }> => {
+  const mut_asked: string[] = [];
+
+  const get: BranchRulesGet = (path, schema) => {
+    mut_asked.push(path);
+
+    return Promise.resolve(
+      validated(
+        schema,
+        path.startsWith('/rules/') ? bodies.rules : bodies.branch,
+      ),
+    );
+  };
+
+  return { get, asked: mut_asked };
+};