willfire 0.1.36 → 0.1.37

package/dist/cli/parseArgs.js

@@ -11,9 +11,8 @@ export function parseArgs(argv) {
         console.error(USAGE);
         process.exit(2);
     }
-    // An unrecognised action is refused rather than ignored. Silently falling
-    // back to the guess would turn a typo into a wrong prediction, which is the
-    // failure this flag exists to remove.
+    // Refused, not ignored: falling back to the guess would turn a typo into a
+    // wrong prediction, the failure this flag exists to remove.
     const action = get("--action");
     if (action !== undefined && !isPrEventAction(action)) {
         console.error(`unknown --action: ${action}`);

package/dist/cli.js

@@ -1,9 +1,6 @@
 #!/usr/bin/env node
 // Usage: pnpm predict --repo owner/name --pr N [--json]
-//
-// Auth: GH_TOKEN or GITHUB_TOKEN env var (any token with
-// contents/actions/pull-requests read). Inside an action, pass the workflow's
-// GITHUB_TOKEN.
+// Auth: GH_TOKEN or GITHUB_TOKEN, needing contents/actions/pull-requests read.
 import { parseArgs } from "./cli/parseArgs.js";
 import { isWorkflowEntry } from "./entries/isWorkflowEntry.js";
 import { makeGithubClient } from "./predict/makeGithubClient.js";
@@ -33,8 +30,8 @@ if (isMain) {
                 }
             }
         }
-        // Last, and on the skip path too, so a red gate's first question — which
-        // commits was this read from? — is answered wherever the reader lands.
+        // Last, and on the skip path too, so a red gate's reader always sees which
+        // commits this was read from.
         for (const s of sources) {
             console.log(`# read ${s.owner}/${s.repo}@${s.ref} -> ${s.sha}`);
         }

package/dist/jobs/prScope.d.ts

@@ -1,10 +1,3 @@
 import type { Scope } from "../expr/val.js";
-/**
- * A scope with the fixed pull-request facts filled in.
- *
- * Every `${{ }}` this module evaluates — a job `if:`, a matrix axis — is
- * evaluated for the same event, so they all get the same `github.*`. Anything
- * the caller states wins; there is nothing here worth overriding, but a scope
- * that silently ignored what it was handed would be the wrong shape.
- */
+/** Anything the caller states wins over the defaults. */
 export declare const prScope: (scope: Scope) => Scope;

package/dist/jobs/prScope.js

@@ -1,18 +1,10 @@
 /**
- * The `github.*` values that are fixed for everything this module predicts.
- * `predict` only ever answers for a pull request, so `event_name` is not a
- * variable — which is what lets a `github.event_name == 'pull_request'` guard
- * resolve instead of hanging the job on an unknown.
+ * `predict` only ever answers for a pull request, so `event_name` is fixed —
+ * which is what lets a `github.event_name == 'pull_request'` guard resolve
+ * instead of hanging the job on an unknown.
  */
 const PR_GITHUB_CONTEXT = { event_name: "pull_request" };
-/**
- * A scope with the fixed pull-request facts filled in.
- *
- * Every `${{ }}` this module evaluates — a job `if:`, a matrix axis — is
- * evaluated for the same event, so they all get the same `github.*`. Anything
- * the caller states wins; there is nothing here worth overriding, but a scope
- * that silently ignored what it was handed would be the wrong shape.
- */
+/** Anything the caller states wins over the defaults. */
 export const prScope = (scope) => ({
     ...scope,
     github: { ...PR_GITHUB_CONTEXT, ...scope.github },

package/dist/names/capDisplayName.d.ts

@@ -1,6 +1,6 @@
 /**
- * GitHub cuts a display name over 100 characters to 97 plus `...`. Verified
- * on a live dispatch (dirsql PR #1013): the cap applies to the leaf name
- * before any reusable-call prefixing, so it lives here, not on the entry.
+ * GitHub cuts a display name over 100 characters to 97 plus `...`. Verified on
+ * dirsql PR #1013: the cap applies to the leaf name before any reusable-call
+ * prefixing, so it lives here, not on the entry.
  */
 export declare function capDisplayName(name: string): string;

package/dist/names/capDisplayName.js

@@ -1,7 +1,7 @@
 /**
- * GitHub cuts a display name over 100 characters to 97 plus `...`. Verified
- * on a live dispatch (dirsql PR #1013): the cap applies to the leaf name
- * before any reusable-call prefixing, so it lives here, not on the entry.
+ * GitHub cuts a display name over 100 characters to 97 plus `...`. Verified on
+ * dirsql PR #1013: the cap applies to the leaf name before any reusable-call
+ * prefixing, so it lives here, not on the entry.
  */
 export function capDisplayName(name) {
     return name.length > 100 ? `${name.slice(0, 97)}...` : name;

package/dist/predict/makeGithubClient.d.ts

@@ -70,7 +70,6 @@ export interface GithubClient {
             }): Promise<{
                 data: GithubCommit;
             }>;
-            /** The file at `path` as text — always the `raw` media type. */
             getContent(params: RepoParams & {
                 path: string;
                 ref: string;

package/dist/predict/makeGithubClient.js

@@ -1,6 +1,5 @@
-// The GitHub REST surface willfire uses: a handful of GET endpoints plus the
-// tarball download, over plain `fetch`. The shape mirrors the octokit subset
-// it replaced (#75) so call sites and their fakes carry over unchanged.
+// Plain `fetch`, shaped to mirror the octokit subset it replaced (#75) so call
+// sites and their fakes carry over unchanged.
 export function makeGithubClient() {
     const token = process.env.GH_TOKEN ?? process.env.GITHUB_TOKEN;
     if (!token) {
@@ -76,9 +75,8 @@ export function makeGithubClient() {
                 },
             },
         },
-        // A short page ends the walk. A count landing exactly on a page boundary
-        // costs one extra empty-page request, which keeps this free of Link-header
-        // parsing.
+        // A short page ends the walk. An exact page boundary costs one extra empty
+        // request, which keeps this free of Link-header parsing.
         paginate: async (route, params) => {
             const perPage = params.per_page ?? 30;
             const all = [];

package/dist/sandbox/sandboxConfig.d.ts

@@ -1,7 +1,4 @@
-/**
- * The node major the image ships — also the refusal boundary for `setup-node`
- * and `node2x` runtimes asking for any other major.
- */
+/** Also the refusal boundary: `setup-node` and `node2x` get no other major. */
 export declare const SANDBOX_NODE_MAJOR = 24;
 export declare const DOCKERFILE = "FROM node:24-slim\nRUN apt-get update && apt-get install -y --no-install-recommends git ca-certificates python3 && rm -rf /var/lib/apt/lists/*\n";
 export interface SandboxConfig {

package/dist/sandbox/sandboxConfig.js

@@ -1,7 +1,4 @@
-/**
- * The node major the image ships — also the refusal boundary for `setup-node`
- * and `node2x` runtimes asking for any other major.
- */
+/** Also the refusal boundary: `setup-node` and `node2x` get no other major. */
 export const SANDBOX_NODE_MAJOR = 24;
 // git and python3: checkout's postcondition and the interpreters a script on
 // a GitHub-hosted runner takes for granted.

package/dist/uses/parseUses.d.ts

@@ -1,15 +1,12 @@
 import type { UsesTarget } from "../types.js";
 /**
- * Split a job-level `uses:` into the file it names and the repo it lives in.
- *
  * Two spellings are legal:
  *
  *   `./.github/workflows/x.yml`              -> the caller's repo, same commit
  *   `owner/repo/.github/workflows/x.yml@ref` -> another repo, at `ref`
  *
- * The ref is taken from the last `@` so a branch containing a slash
- * (`@feature/foo`) survives. Returns null for anything else — including a
- * reference built from an expression, which we cannot evaluate and so must not
- * guess a fetch target for.
+ * The ref comes off the last `@`, so a branch with a slash survives. Anything
+ * else is null, including a reference built from an expression — no fetch
+ * target to guess at.
  */
 export declare function parseUses(uses: string): UsesTarget | null;

package/dist/uses/parseUses.js

@@ -1,16 +1,13 @@
 import { EXPRESSION_RE } from "../names/jobDisplayName.js";
 /**
- * Split a job-level `uses:` into the file it names and the repo it lives in.
- *
  * Two spellings are legal:
  *
  *   `./.github/workflows/x.yml`              -> the caller's repo, same commit
  *   `owner/repo/.github/workflows/x.yml@ref` -> another repo, at `ref`
  *
- * The ref is taken from the last `@` so a branch containing a slash
- * (`@feature/foo`) survives. Returns null for anything else — including a
- * reference built from an expression, which we cannot evaluate and so must not
- * guess a fetch target for.
+ * The ref comes off the last `@`, so a branch with a slash survives. Anything
+ * else is null, including a reference built from an expression — no fetch
+ * target to guess at.
  */
 export function parseUses(uses) {
     if (EXPRESSION_RE.test(uses)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "willfire",
-  "version": "0.1.36",
+  "version": "0.1.37",
   "description": "Predict the set of CI check entries GitHub Actions will create for a pull request",
   "license": "MIT",
   "packageManager": "pnpm@10.33.0",