src/job-checklist.ts

Functions

Imports

It imports src/job-body-check.ts. Imported by src/complete-ci.ts, src/fail-exemption.ts, src/tools/jobs.ts.

Source

1import { heading, proseOnly } from "./job-body-check";
2
3// The DONE WHEN checklist (docs/work-queue.md, "CI on complete"; Grok design review
4// 2026-10-23, build step 6). The poster numbers the items under DONE WHEN, at most
5// CHECKLIST_MAX of them. An item that says it changes a path in backticks ("3. The breaker
6// skips run keys: changes `src/job-breaker.ts`") is checked at complete: a pull request
7// the complete names must change that path, or the job is not done. A path ending in /
8// is a directory, matched by any file under it. Every other item is the session's to
9// meet and the reviewer's to read; Capsid checks only what it can see in the diff.
10
11const CHECKLIST_MAX = 10;
12
13const PART_HEADINGS = heading("GOAL|DO|OUT OF SCOPE|DECIDED|RULES");
14const DONE_WHEN = heading("DONE WHEN");
15const ITEM = /^[ \t]*(\d+)[.)][ \t]+(.*)$/;
16const CHANGES = /\bchanges?[ \t]+`([^`\s*?]+)`/gi;
17
18export interface ChecklistItem {
19  n: number;
20  paths: string[];
21}
22
23/** The numbered items under DONE WHEN, each with the paths it says it changes. Pure. */
24export function checklistItems(body: string): ChecklistItem[] {
25  const raw = body.split(/\r?\n/);
26  const prose = proseOnly(body).split("\n");
27  const start = prose.findIndex((line) => DONE_WHEN.test(line));
28  if (start < 0) return [];
29  const items: ChecklistItem[] = [];
30  for (let i = start + 1; i < raw.length; i++) {
31    if (PART_HEADINGS.test(prose[i])) break;
32    const m = ITEM.exec(prose[i]);
33    // The paths are read from the line as written, since proseOnly blanks code spans.
34    if (m) items.push({ n: Number(m[1]), paths: [...raw[i].matchAll(CHANGES)].map((c) => c[1]) });
35  }
36  return items;
37}
38
39/** A warning when DONE WHEN has more numbered items than CHECKLIST_MAX, or null. */
40export function checklistWarning(body: string): string | null {
41  const n = checklistItems(body).length;
42  return n > CHECKLIST_MAX ? `DONE WHEN has ${n} numbered items. Keep it to ${CHECKLIST_MAX}, so each one is checked rather than skimmed. Posted anyway.` : null;
43}
44
45/** The checklist items naming a path no pull request changed, as refusal lines. Pure. */
46export function unchangedItems(items: readonly ChecklistItem[], changed: readonly string[]): string[] {
47  const touched = (path: string) => changed.some((c) => (path.endsWith("/") ? c.startsWith(path) : c === path));
48  return items.flatMap((item) => item.paths.filter((p) => !touched(p)).map((p) => `DONE WHEN item ${item.n} changes \`${p}\``));
49}