plumbbob 0.9.5 → 0.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (144) hide show
  1. package/.claude-plugin/plugin.json +1 -1
  2. package/README.md +89 -87
  3. package/dist/cli-core.js +18 -8
  4. package/dist/cli.js +1 -1
  5. package/dist/lib/agents.js +26 -26
  6. package/dist/lib/buildlog.js +21 -11
  7. package/dist/lib/buildlogsync.js +8 -8
  8. package/dist/lib/check.js +14 -14
  9. package/dist/lib/commitbody.js +72 -0
  10. package/dist/lib/commitmsg.js +7 -7
  11. package/dist/lib/git.js +44 -15
  12. package/dist/lib/intent.js +20 -19
  13. package/dist/lib/latch.js +16 -16
  14. package/dist/lib/orient.js +36 -17
  15. package/dist/lib/reentry.js +3 -3
  16. package/dist/lib/settings.js +16 -16
  17. package/dist/lib/sidecar.js +70 -54
  18. package/dist/lib/templates.js +1 -1
  19. package/dist/verbs/abandon.js +122 -0
  20. package/dist/verbs/agent.js +25 -25
  21. package/dist/verbs/build.js +9 -9
  22. package/dist/verbs/check.js +6 -6
  23. package/dist/verbs/checkpoint.js +48 -47
  24. package/dist/verbs/doctor.js +35 -29
  25. package/dist/verbs/finish.js +27 -40
  26. package/dist/verbs/handoff.js +9 -8
  27. package/dist/verbs/init.js +9 -9
  28. package/dist/verbs/park.js +3 -3
  29. package/dist/verbs/recover.js +12 -12
  30. package/dist/verbs/revert.js +12 -12
  31. package/dist/verbs/spike.js +21 -21
  32. package/dist/verbs/start.js +49 -19
  33. package/dist/verbs/status.js +8 -8
  34. package/dist/verbs/turn.js +16 -16
  35. package/dist/verbs/use.js +4 -4
  36. package/node_modules/checkride/.claude-plugin/plugin.json +1 -1
  37. package/node_modules/checkride/CHANGELOG.md +401 -0
  38. package/node_modules/checkride/README.md +27 -9
  39. package/node_modules/checkride/dist/adapters.d.ts +12 -4
  40. package/node_modules/checkride/dist/adapters.d.ts.map +1 -1
  41. package/node_modules/checkride/dist/adapters.js +21 -1
  42. package/node_modules/checkride/dist/adapters.js.map +1 -1
  43. package/node_modules/checkride/dist/agent-setup/cursor.d.ts +9 -1
  44. package/node_modules/checkride/dist/agent-setup/cursor.d.ts.map +1 -1
  45. package/node_modules/checkride/dist/agent-setup/cursor.js +59 -1
  46. package/node_modules/checkride/dist/agent-setup/cursor.js.map +1 -1
  47. package/node_modules/checkride/dist/agent-setup/harness.d.ts +1 -1
  48. package/node_modules/checkride/dist/agent-setup/harness.d.ts.map +1 -1
  49. package/node_modules/checkride/dist/agent-setup/harness.js +10 -1
  50. package/node_modules/checkride/dist/agent-setup/harness.js.map +1 -1
  51. package/node_modules/checkride/dist/agent-setup/scripts.d.ts +23 -0
  52. package/node_modules/checkride/dist/agent-setup/scripts.d.ts.map +1 -1
  53. package/node_modules/checkride/dist/agent-setup/scripts.js +387 -82
  54. package/node_modules/checkride/dist/agent-setup/scripts.js.map +1 -1
  55. package/node_modules/checkride/dist/baseline/fallow.js +2 -2
  56. package/node_modules/checkride/dist/baseline/fingerprint.d.ts +14 -5
  57. package/node_modules/checkride/dist/baseline/fingerprint.d.ts.map +1 -1
  58. package/node_modules/checkride/dist/baseline/fingerprint.js +58 -5
  59. package/node_modules/checkride/dist/baseline/fingerprint.js.map +1 -1
  60. package/node_modules/checkride/dist/baseline/history.d.ts +98 -0
  61. package/node_modules/checkride/dist/baseline/history.d.ts.map +1 -0
  62. package/node_modules/checkride/dist/baseline/history.js +232 -0
  63. package/node_modules/checkride/dist/baseline/history.js.map +1 -0
  64. package/node_modules/checkride/dist/baseline/index.d.ts +4 -2
  65. package/node_modules/checkride/dist/baseline/index.d.ts.map +1 -1
  66. package/node_modules/checkride/dist/baseline/index.js +2 -1
  67. package/node_modules/checkride/dist/baseline/index.js.map +1 -1
  68. package/node_modules/checkride/dist/baseline/store.d.ts +30 -7
  69. package/node_modules/checkride/dist/baseline/store.d.ts.map +1 -1
  70. package/node_modules/checkride/dist/baseline/store.js +50 -16
  71. package/node_modules/checkride/dist/baseline/store.js.map +1 -1
  72. package/node_modules/checkride/dist/cli.d.ts +5 -1
  73. package/node_modules/checkride/dist/cli.d.ts.map +1 -1
  74. package/node_modules/checkride/dist/cli.js +98 -25
  75. package/node_modules/checkride/dist/cli.js.map +1 -1
  76. package/node_modules/checkride/dist/config.d.ts +33 -4
  77. package/node_modules/checkride/dist/config.d.ts.map +1 -1
  78. package/node_modules/checkride/dist/config.js +21 -6
  79. package/node_modules/checkride/dist/config.js.map +1 -1
  80. package/node_modules/checkride/dist/digest/digest.js +1 -1
  81. package/node_modules/checkride/dist/doctor.d.ts +2 -0
  82. package/node_modules/checkride/dist/doctor.d.ts.map +1 -1
  83. package/node_modules/checkride/dist/doctor.js +39 -1
  84. package/node_modules/checkride/dist/doctor.js.map +1 -1
  85. package/node_modules/checkride/dist/gate.d.ts +49 -4
  86. package/node_modules/checkride/dist/gate.d.ts.map +1 -1
  87. package/node_modules/checkride/dist/gate.js +143 -16
  88. package/node_modules/checkride/dist/gate.js.map +1 -1
  89. package/node_modules/checkride/dist/init.d.ts +8 -1
  90. package/node_modules/checkride/dist/init.d.ts.map +1 -1
  91. package/node_modules/checkride/dist/init.js +68 -7
  92. package/node_modules/checkride/dist/init.js.map +1 -1
  93. package/node_modules/checkride/dist/node-pin.d.ts +1 -1
  94. package/node_modules/checkride/dist/node-pin.js +1 -1
  95. package/node_modules/checkride/dist/orchestrator.d.ts +13 -0
  96. package/node_modules/checkride/dist/orchestrator.d.ts.map +1 -1
  97. package/node_modules/checkride/dist/orchestrator.js +118 -13
  98. package/node_modules/checkride/dist/orchestrator.js.map +1 -1
  99. package/node_modules/checkride/dist/pm/index.d.ts +1 -0
  100. package/node_modules/checkride/dist/pm/index.d.ts.map +1 -1
  101. package/node_modules/checkride/dist/pm/index.js.map +1 -1
  102. package/node_modules/checkride/dist/pm/launch.d.ts +23 -2
  103. package/node_modules/checkride/dist/pm/launch.d.ts.map +1 -1
  104. package/node_modules/checkride/dist/pm/launch.js +16 -0
  105. package/node_modules/checkride/dist/pm/launch.js.map +1 -1
  106. package/node_modules/checkride/dist/pm/translate.js +1 -1
  107. package/node_modules/checkride/dist/pm/translate.js.map +1 -1
  108. package/node_modules/checkride/dist/qa/mutation.d.ts +4 -4
  109. package/node_modules/checkride/dist/qa/mutation.js +4 -4
  110. package/node_modules/checkride/dist/recover.d.ts +48 -0
  111. package/node_modules/checkride/dist/recover.d.ts.map +1 -0
  112. package/node_modules/checkride/dist/recover.js +220 -0
  113. package/node_modules/checkride/dist/recover.js.map +1 -0
  114. package/node_modules/checkride/dist/smoke.d.ts +1 -1
  115. package/node_modules/checkride/dist/smoke.js +1 -1
  116. package/node_modules/checkride/dist/snippets.d.ts +1 -1
  117. package/node_modules/checkride/package.json +3 -2
  118. package/node_modules/checkride/schema/checkride.config.schema.json +9 -1
  119. package/node_modules/checkride/skills/check/SKILL.md +9 -1
  120. package/node_modules/checkride/templates/shared/styles/Repo/Drift.yml +41 -0
  121. package/node_modules/checkride/templates/shared/styles/Repo/Latin.yml +14 -0
  122. package/node_modules/checkride/templates/shared/styles/Repo/LyHyphen.yml +28 -0
  123. package/node_modules/checkride/templates/shared/styles/Repo/Minted.yml +33 -0
  124. package/node_modules/checkride/templates/shared/styles/Repo/ThereIs.yml +16 -0
  125. package/node_modules/checkride/templates/shared/styles/Repo/Weasel.yml +26 -0
  126. package/node_modules/checkride/templates/shared/vale.ini +34 -0
  127. package/package.json +13 -11
  128. package/skills/abandon/SKILL.md +20 -0
  129. package/skills/build/SKILL.md +69 -64
  130. package/skills/doctor/SKILL.md +11 -11
  131. package/skills/finish/SKILL.md +20 -19
  132. package/skills/harvest/SKILL.md +13 -12
  133. package/skills/park/SKILL.md +10 -10
  134. package/skills/plan/SKILL.md +63 -54
  135. package/skills/recover/SKILL.md +7 -7
  136. package/skills/refine/SKILL.md +18 -16
  137. package/skills/revert/SKILL.md +6 -6
  138. package/skills/spike/SKILL.md +9 -9
  139. package/skills/status/SKILL.md +5 -5
  140. package/skills/step/SKILL.md +17 -12
  141. package/skills/verify/SKILL.md +45 -40
  142. package/templates/build-log.md +7 -7
  143. package/templates/intent.md +49 -39
  144. package/templates/spike-report.md +10 -10
@@ -1,18 +1,18 @@
1
- // `plumbbob revert [--to n]` — git reset --hard to a checkpoint SHA (the most
1
+ // `plumbbob revert [--to n]`: git reset --hard to a checkpoint SHA (the most
2
2
  // recent step, or `--to n`, with the baseline as fallback), then remove untracked
3
3
  // files under the SEAM only (the seam is the in-flight step's flat list of
4
- // granted edit paths). The artifact plane — the tracked `.plumbbob/builds/<slug>/`
5
- // folder holding intent, build-log, checkpoints, and park lines — would not
4
+ // granted edit paths). The artifact plane (the tracked `.plumbbob/builds/<slug>/`
5
+ // folder holding intent, build-log, checkpoints, and park lines) would not
6
6
  // survive a bare reset: it would discard park lines and intent edits, or, when
7
7
  // reverting to a baseline that predates the build folder, delete the folder
8
8
  // wholesale. So revert snapshots the sidecar to temp and restores it as
9
- // uncommitted changes after the reset — a rewind must never destroy recorded
9
+ // uncommitted changes after the reset: a rewind must never destroy recorded
10
10
  // work, in either case. The untracked cleanup additionally whitelists the
11
11
  // artifact plane, so no seam pattern can ever sweep away a build's own files.
12
12
  //
13
13
  // Plumbbob also installs its driver skills INTO the repo (.claude/skills/<driver>/
14
14
  // for a self-contained install), so a blunt reset would discard an out-of-seam
15
- // skill edit — or a `pnpm up plumbbob` re-setup — together with the half-done
15
+ // skill edit (or a `pnpm up plumbbob` re-setup) together with the half-done
16
16
  // step. revert discards the step's WORK, never plumbbob's own machinery, so those
17
17
  // paths are carried across the reset unchanged.
18
18
  import { cpSync, existsSync, mkdtempSync, readFileSync, readdirSync, rmSync } from 'node:fs';
@@ -66,7 +66,7 @@ export function revert(cwd, args) {
66
66
  const seam = readSeamTokens(root, slug);
67
67
  const toRemove = untrackedPaths(root).filter((p) => matchesSeam(p, seam) && !isArtifactPath(p));
68
68
  // A revert against an in-flight step is a datapoint the finish report's stats
69
- // table wants — read the STEP marker before it goes, bump the counter after
69
+ // table wants: read the STEP marker before it goes, bump the counter after
70
70
  // the reset (the sidecar is preserved through it, so the write survives).
71
71
  const inFlight = readInFlightStep(root, slug);
72
72
  resetPreserving(root, sha, plumbbobOwnedPaths(root));
@@ -79,7 +79,7 @@ export function revert(cwd, args) {
79
79
  bumpStepStat(root, slug, inFlight, 'reverts');
80
80
  }
81
81
  // The step is abandoned: the build-log's Current-step line returns to the
82
- // boundary and its Steps mirror re-renders from the preserved intent.md —
82
+ // boundary and its Steps mirror re-renders from the preserved intent.md:
83
83
  // revert keeps intent edits, so intent's checkboxes stay the truth to reflect.
84
84
  // Best-effort, like every build-log write.
85
85
  syncBuildLogState(root, slug, AT_BOUNDARY);
@@ -94,8 +94,8 @@ export function revert(cwd, args) {
94
94
  * under .claude/skills/, named from plumbbob's own bundled `skills/` dir.
95
95
  *
96
96
  * The match is by name alone, and since the skills dropped their `pb-` prefix
97
- * those names are ordinary words — a user's own `.claude/skills/plan/` is
98
- * carried across the reset too. That errs toward keeping work — never destroy —
97
+ * those names are ordinary words; a user's own `.claude/skills/plan/` is
98
+ * carried across the reset too. That errs toward keeping work (never destroy),
99
99
  * so it is the safe direction to be wrong in. Only paths that currently exist are returned.
100
100
  */
101
101
  function plumbbobOwnedPaths(root) {
@@ -106,7 +106,7 @@ function plumbbobOwnedPaths(root) {
106
106
  }
107
107
  }
108
108
  catch {
109
- // Bundled skills dir not resolvable (unexpected) — protect just the sidecar.
109
+ // Bundled skills dir not resolvable (unexpected): protect just the sidecar.
110
110
  }
111
111
  return paths.filter((p) => existsSync(p));
112
112
  }
@@ -146,7 +146,7 @@ function parseTo(args) {
146
146
  /**
147
147
  * Parse the build's CHECKPOINTS record into a baseline sha and per-step shas.
148
148
  *
149
- * A missing or unreadable file yields an empty record — the caller then refuses
149
+ * A missing or unreadable file yields an empty record: the caller then refuses
150
150
  * with its own message rather than crashing here.
151
151
  */
152
152
  function readCheckpoints(root, slug) {
@@ -173,7 +173,7 @@ function readCheckpoints(root, slug) {
173
173
  return { baseline, steps };
174
174
  }
175
175
  /**
176
- * Read the in-flight step's seam — its edit-grant paths, one per line.
176
+ * Read the in-flight step's seam: its edit-grant paths, one per line.
177
177
  *
178
178
  * A missing or unreadable SEAM contributes nothing: no tokens, never an error.
179
179
  */
@@ -1,15 +1,15 @@
1
- // `plumbbob spike` — the spike lifecycle for a genuine fork the design phase
1
+ // `plumbbob spike`: the spike lifecycle for a genuine fork the design phase
2
2
  // couldn't settle. `spike "<slug>" [opt…]` creates a sibling git worktree and a
3
3
  // `spike/<slug>-<opt>` branch per option OUTSIDE the repo root (default options
4
- // a/b) and drops the SPIKE marker — one of the untracked per-build control files
4
+ // a/b) and drops the SPIKE marker: one of the untracked per-build control files
5
5
  // under `.plumbbob/` that record what's in flight. The main tree stays put while
6
6
  // you experiment in the worktrees, which are hook-dormant by construction: the
7
7
  // untracked control files don't exist in a fresh checkout, so the hooks find no
8
8
  // STATE (the session sentinel) there. `spike done` removes every spike worktree
9
9
  // and branch and clears the marker.
10
10
  //
11
- // Every spike also leaves a durable report — `spike-NN-<slug>.md` beside
12
- // intent.md in the tracked `builds/<slug>/` folder — so the verdict rides the
11
+ // Every spike also leaves a durable report (`spike-NN-<slug>.md` beside
12
+ // intent.md in the tracked `builds/<slug>/` folder) so the verdict rides the
13
13
  // branch into the PR instead of evaporating with the throwaway worktrees.
14
14
  //
15
15
  // Worktree git calls run directly here rather than via lib/git.ts (which holds the
@@ -21,15 +21,15 @@ import { basename, dirname, join, relative } from 'node:path';
21
21
  import { findRepoRoot } from "../lib/git.js";
22
22
  import { buildFolder, clearSpike, hasSession, inSpike, listSpikeReports, markSpike, nextSpikeReportPath, resolveBuild, stepPath, } from "../lib/sidecar.js";
23
23
  import { readTemplate, stampTemplate } from "../lib/templates.js";
24
- // Worktree/branch names when the caller lists none — a fork defaults to two arms.
24
+ // Worktree/branch names when the caller lists none: a fork defaults to two arms.
25
25
  const DEFAULT_OPTIONS = ['a', 'b'];
26
26
  /**
27
- * The verbatim Verdict placeholder from templates/spike-report.md — its presence
27
+ * The verbatim Verdict placeholder from templates/spike-report.md: its presence
28
28
  * means the spike's call was never recorded, which `spike done` nudges on.
29
29
  */
30
30
  const VERDICT_PLACEHOLDER = '*(viable | not viable | partial';
31
31
  /**
32
- * Entry point for `plumbbob spike` — dispatches to open, `report`, or `done`.
32
+ * Entry point for `plumbbob spike`: dispatches to open, `report`, or `done`.
33
33
  *
34
34
  * Requires an active session (the STATE sentinel) and resolves which build the
35
35
  * spike belongs to before dispatching.
@@ -51,11 +51,11 @@ export function spike(cwd, args) {
51
51
  return spikeStart(root, buildSlug, positionals);
52
52
  }
53
53
  /**
54
- * `spike report "<slug>"` — scaffold a spike report WITHOUT worktrees.
54
+ * `spike report "<slug>"`: scaffold a spike report WITHOUT worktrees.
55
55
  *
56
56
  * Serves the spike-as-step case: a planned step titled `spike: …`, where the
57
57
  * increment itself is the experiment. No boundary requirement and no SPIKE
58
- * marker — a step in flight is exactly when this runs. Provenance is stamped
58
+ * marker: a step in flight is exactly when this runs. Provenance is stamped
59
59
  * `step <n>` when a step is in flight, else `/plumbbob:spike`.
60
60
  */
61
61
  function spikeReport(root, buildSlug, positionals) {
@@ -75,7 +75,7 @@ function spikeReport(root, buildSlug, positionals) {
75
75
  * Write a fresh spike report from the template at the next free
76
76
  * `spike-NN-<slug>.md` in the build folder, and return its path.
77
77
  *
78
- * Shared by the worktree-opening spike and the spike-as-step `spike report` —
78
+ * Shared by the worktree-opening spike and the spike-as-step `spike report`:
79
79
  * one artifact, two entry points. The CLI owns the numbering; the human never
80
80
  * creates or numbers a report.
81
81
  */
@@ -86,7 +86,7 @@ function scaffoldSpikeReport(root, buildSlug, spikeSlug, via) {
86
86
  return path;
87
87
  }
88
88
  /**
89
- * The build's in-flight step number, or null — reads the STEP marker `build`
89
+ * The build's in-flight step number, or null: reads the STEP marker `build`
90
90
  * writes.
91
91
  *
92
92
  * Used to stamp a spike-as-step report's provenance as `step <n>`.
@@ -103,10 +103,10 @@ function readInFlightStep(root, buildSlug) {
103
103
  /**
104
104
  * Open a spike: one throwaway worktree + `spike/<slug>-<opt>` branch per option.
105
105
  *
106
- * Refuses when a spike is already open or a step is in flight — a spike is a
107
- * deliberate fork from a settled boundary, so the current step must checkpoint
108
- * or revert first. Marks the SPIKE control file and scaffolds the report before
109
- * returning.
106
+ * Refuses when a spike is already open or a step is in flight: a spike is a
107
+ * deliberate fork from a settled boundary, so the current step must exit first
108
+ * (checkpoint, abandon, or revert). Marks the SPIKE control file and scaffolds
109
+ * the report before returning.
110
110
  */
111
111
  function spikeStart(root, buildSlug, positionals) {
112
112
  if (inSpike(root, buildSlug)) {
@@ -115,7 +115,7 @@ function spikeStart(root, buildSlug, positionals) {
115
115
  }
116
116
  if (existsSync(stepPath(root, buildSlug))) {
117
117
  process.stderr.write('plumbbob: spike starts from a settled boundary, but a step is in flight. ' +
118
- 'A spike is a deliberate fork — checkpoint or revert the current step first.\n');
118
+ 'A spike is a deliberate fork — checkpoint, abandon, or revert the current step first.\n');
119
119
  return 1;
120
120
  }
121
121
  const slug = sanitize(positionals[0] ?? '');
@@ -147,7 +147,7 @@ function spikeStart(root, buildSlug, positionals) {
147
147
  /**
148
148
  * Close the spike: remove every spike worktree and branch, clear the marker.
149
149
  *
150
- * Nudges — but never refuses — when a report's Verdict is still the template
150
+ * Nudges (but never refuses) when a report's Verdict is still the template
151
151
  * placeholder: guidance, not a gate.
152
152
  */
153
153
  function spikeDone(root, buildSlug) {
@@ -156,7 +156,7 @@ function spikeDone(root, buildSlug) {
156
156
  return 1;
157
157
  }
158
158
  // Check for an unrecorded verdict BEFORE teardown. The reports live in the
159
- // build folder, not the spike worktrees, so they survive the removal — but the
159
+ // build folder, not the spike worktrees, so they survive the removal, but the
160
160
  // learning that fills them does not, so this is the moment to nudge.
161
161
  const unfilled = spikeReportsMissingVerdict(root, buildSlug);
162
162
  for (const path of spikeWorktrees(root)) {
@@ -181,7 +181,7 @@ function spikeDone(root, buildSlug) {
181
181
  }
182
182
  /**
183
183
  * The spike-report filenames in the build folder whose Verdict is still the
184
- * template placeholder — the ones `spike done` nudges on.
184
+ * template placeholder: the ones `spike done` nudges on.
185
185
  *
186
186
  * Best-effort per file: an unreadable report is skipped rather than blocking
187
187
  * the close.
@@ -198,7 +198,7 @@ function spikeReportsMissingVerdict(root, buildSlug) {
198
198
  });
199
199
  }
200
200
  /**
201
- * Worktree paths whose checked-out branch is under spike/ — parsed from the
201
+ * Worktree paths whose checked-out branch is under spike/: parsed from the
202
202
  * porcelain output (blank-line-separated `worktree <path>` / `branch <ref>`
203
203
  * blocks).
204
204
  *
@@ -230,7 +230,7 @@ export function spikeBranches(root) {
230
230
  return out.length === 0 ? [] : out.split('\n').filter((b) => b.length > 0);
231
231
  }
232
232
  /**
233
- * Slugify a raw spike name — lowercase, non-alphanumerics collapsed to dashes.
233
+ * Slugify a raw spike name: lowercase, non-alphanumerics collapsed to dashes.
234
234
  */
235
235
  function sanitize(raw) {
236
236
  return raw
@@ -1,4 +1,4 @@
1
- // `plumbbob start "<title>"` — open a session: scaffold the sidecar (the
1
+ // `plumbbob start "<title>"`: open a session: scaffold the sidecar (the
2
2
  // `.plumbbob/` tree of build artifacts and control files), record the baseline
3
3
  // commit, and point the session at a new build. Refuses on a dirty tree (a
4
4
  // clean baseline is the contract; `--allow-dirty` overrides), an existing
@@ -7,7 +7,7 @@ import { existsSync, writeFileSync, mkdirSync } from 'node:fs';
7
7
  import { join } from 'node:path';
8
8
  import { detectGate } from "../lib/check.js";
9
9
  import { readTemplate, stampTemplate } from "../lib/templates.js";
10
- import { findRepoRoot, hasCommit, headSha, isDirty } from "../lib/git.js";
10
+ import { findRepoRoot, hasCommit, headSha, isDirty, isIgnored } from "../lib/git.js";
11
11
  import { sidecarDir, buildDir, listBuilds, slugify, checkpointsPath, intentPath, buildLogPath, beginSession, hasSession, excludeControl, excludeSidecar, setGrant, stampTick, } from "../lib/sidecar.js";
12
12
  import { settingsPath } from "../lib/settings.js";
13
13
  /**
@@ -15,7 +15,7 @@ import { settingsPath } from "../lib/settings.js";
15
15
  * {{CHECK}} line.
16
16
  *
17
17
  * The gate is checkride unless a `check` setting overrides it, so settings.json
18
- * seeds with no `check` key at all — absence IS the default; this line says
18
+ * seeds with no `check` key at all; absence IS the default; this line says
19
19
  * that in prose where the templates need it.
20
20
  */
21
21
  const CHECK_ECHO = 'checkride (set a "check" key in .plumbbob/settings.json to override)';
@@ -71,13 +71,13 @@ export async function start(cwd, args) {
71
71
  }
72
72
  const sha = headSha(root);
73
73
  mkdirSync(sidecarDir(root), { recursive: true });
74
- // beginSession writes STATE — one file that is both the session sentinel (its
74
+ // beginSession writes STATE: one file that is both the session sentinel (its
75
75
  // existence means a session is live) and the active-build cursor (its single
76
- // line names the build every verb acts on). Point it at this build — null
76
+ // line names the build every verb acts on). Point it at this build: null
77
77
  // under --local, which has no cursor. The cursor lives in STATE, not
78
78
  // settings.local.json, so that personal overlay stays purely human-owned.
79
79
  beginSession(root, local ? null : slug);
80
- // Scaffold the tracked settings.json ONLY when absent, and seed it EMPTY — the
80
+ // Scaffold the tracked settings.json ONLY when absent, and seed it EMPTY: the
81
81
  // human owns this file once it exists (their `check` gate lives here), so a
82
82
  // re-start must never touch it. Inject no opinions even on first create:
83
83
  // absence of `check` already means checkride and absence of `auto` already
@@ -87,11 +87,11 @@ export async function start(cwd, args) {
87
87
  if (!existsSync(settingsPath(root))) {
88
88
  writeFileSync(settingsPath(root), `${JSON.stringify({}, null, 2)}\n`);
89
89
  }
90
- // `--local` keeps a fully-untracked flat layout (the whole `.plumbbob/`
91
- // git-excluded); the default plants a tracked `builds/<slug>/` folder — the
92
- // build's record (intent, build-log, checkpoints) rides its branch into the
93
- // PR — and git-excludes only the per-worktree control files. The slug is
94
- // date-prefixed when derived (see datedSlug) and validated unique above —
90
+ // `--local` keeps a fully untracked flat layout (the whole `.plumbbob/`
91
+ // git-excluded); the default plants a tracked `builds/<slug>/` folder (the
92
+ // build's record [intent, build-log, checkpoints] rides its branch into the
93
+ // PR) and git-excludes only the per-worktree control files. The slug is
94
+ // date-prefixed when derived (see datedSlug) and validated unique above;
95
95
  // the CLI refuses a collision, never auto-suffixes.
96
96
  let intentLocation;
97
97
  if (local) {
@@ -112,18 +112,32 @@ export async function start(cwd, args) {
112
112
  }
113
113
  // The plan's entry stamp for the checkpoint latch: set TICK to the current
114
114
  // TURN, so `checkpoint --plan` only lands once the harness ledger records a
115
- // human turn after this moment. Skipped when TURN is absent — a hookless host
115
+ // human turn after this moment. Skipped when TURN is absent: a hookless host
116
116
  // grows no ledger and the latch stays dormant, which also covers a first
117
117
  // session where the hook has never ticked; that one plan commit stays
118
118
  // guidance-governed. Any GRANT file lying around predates this session (a
119
- // legitimate one is minted by a `/build` prompt, which never runs `start`)
120
- // — clear it so a stale grant can't self-approve this session's plan; a
119
+ // legitimate one is minted by a `/build` prompt, which never runs `start`);
120
+ // clear it so a stale grant can't self-approve this session's plan; a
121
121
  // grant's lifetime is one turn.
122
122
  setGrant(root, null);
123
123
  stampTick(root, local ? null : slug);
124
124
  process.stdout.write(`plumbbob: started "${title}" — baseline ${sha.slice(0, 9)}. Frame and decide in ${intentLocation}; \`build\` a step once the decisions are made.\n`);
125
+ // The tracked layout plants `builds/<slug>/` to ride the branch into the PR,
126
+ // but a repo whose own `.gitignore` excludes `.plumbbob/` overrides that, and
127
+ // an explicit `git add` of an ignored folder is a hard error. Detect it here,
128
+ // once, so the record-only mode (plan/finish commits land empty; their bodies
129
+ // carry the record, the files stay untracked) is a known mode from the start
130
+ // rather than a surprise at the first `checkpoint --plan`. `--local` already
131
+ // excludes the whole sidecar by design and says so, so skip the probe there.
132
+ // Guidance only, and the session is already open: a probe hiccup stays silent
133
+ // rather than half-crashing a scaffolded session.
134
+ if (!local && sidecarIsIgnored(root, slug)) {
135
+ process.stderr.write('plumbbob: heads-up — this repo gitignores .plumbbob/, so the tracked build folder cannot ride the branch.\n' +
136
+ ' Plan and finish commits will be record-only (empty commits; the plan and report ride the commit message).\n' +
137
+ ' To keep the record in-tree, unignore .plumbbob/builds/ (or the whole sidecar) before the first checkpoint.\n');
138
+ }
125
139
  // The plan-time gate probe: if checkride sees no code checks here, say so
126
- // NOW — while the human is still deciding — instead of at the first
140
+ // NOW (while the human is still deciding) instead of at the first
127
141
  // checkpoint, where the gate either refuses a vacuous run or, worse, greens
128
142
  // on the always-on repo checks alone. Guidance only: it never changes the
129
143
  // exit code, and a configured `check` or a probe hiccup stays silent.
@@ -139,8 +153,8 @@ export async function start(cwd, args) {
139
153
  * Derive a `YYYY-MM-DD-<slug>` build slug from the title (local time).
140
154
  *
141
155
  * The date prefix makes `builds/` sort chronologically under `listBuilds`'
142
- * plain lexical sort — ordering by construction, not by titling convention. An
143
- * explicit `--slug` bypasses this and stays verbatim — the CLI never rewrites
156
+ * plain lexical sort: ordering by construction, not by titling convention. An
157
+ * explicit `--slug` bypasses this and stays verbatim: the CLI never rewrites
144
158
  * what the caller chose. An untitleable title yields `''` so the empty-slug
145
159
  * guard fires instead of minting a date-only slug.
146
160
  */
@@ -153,7 +167,23 @@ function datedSlug(title) {
153
167
  return `${now.getFullYear()}-${pad(now.getMonth() + 1)}-${pad(now.getDate())}-${base}`;
154
168
  }
155
169
  /**
156
- * Read the value that follows a `--flag` in argv (e.g. `--slug my-build`), or
170
+ * Whether the tracked build folder is gitignored: the record-only heads-up's
171
+ * predicate, probing exactly the path `checkpoint --plan` will try to stage.
172
+ *
173
+ * Best-effort: a probe that throws (a fatal `git check-ignore`) reads as
174
+ * not-ignored so the heads-up stays silent rather than crashing a session that
175
+ * is already open.
176
+ */
177
+ function sidecarIsIgnored(root, slug) {
178
+ try {
179
+ return isIgnored(root, buildDir(root, slug));
180
+ }
181
+ catch {
182
+ return false;
183
+ }
184
+ }
185
+ /**
186
+ * Read the value that follows a `--flag` in argv (for example `--slug my-build`), or
157
187
  * undefined when the flag is absent or trails with no value.
158
188
  */
159
189
  function flagValue(args, flag) {
@@ -161,7 +191,7 @@ function flagValue(args, flag) {
161
191
  return i >= 0 ? args[i + 1] : undefined;
162
192
  }
163
193
  /**
164
- * Stamp a build template's `{{TITLE}}`/`{{CHECK}}` — the check is always the
194
+ * Stamp a build template's `{{TITLE}}`/`{{CHECK}}`: the check is always the
165
195
  * echo constant, since an absent `check` setting IS the checkride default.
166
196
  */
167
197
  function stampBuild(template, title) {
@@ -1,6 +1,6 @@
1
- // `plumbbob status` — the orientation dashboard, or NO ACTIVE SESSION. It
2
- // parses the live session — intent.md, the build-log, the checkpoints ledger,
3
- // the in-flight STEP marker — into a where-am-I view that suggests one primary
1
+ // `plumbbob status`: the orientation dashboard, or NO ACTIVE SESSION. It
2
+ // parses the live session (intent.md, the build-log, the checkpoints ledger,
3
+ // the in-flight STEP marker) into a where-am-I view that suggests one primary
4
4
  // next move while printing the full picture, so you can always override.
5
5
  // Read-only, always exits 0. Skills pre-inject this output to gate their own
6
6
  // behavior, so the `NO ACTIVE SESSION` sentinel is kept exact.
@@ -25,7 +25,7 @@ function readOr(path) {
25
25
  * Print the orientation dashboard for the active build, plus its harness bindings.
26
26
  *
27
27
  * No session prints the exact `NO ACTIVE SESSION` sentinel; a session with
28
- * builds but no active one lists them and points at `use`. Always exits 0 —
28
+ * builds but no active one lists them and points at `use`. Always exits 0:
29
29
  * status is a report, never a gate.
30
30
  */
31
31
  export function status(cwd, args = []) {
@@ -46,9 +46,9 @@ export function status(cwd, args = []) {
46
46
  }
47
47
  }
48
48
  const inFlightRaw = readOr(stepPath(root, slug)).trim();
49
- // Out-of-band commits — ones that landed outside the checkpoints ledger — are
49
+ // Out-of-band commits (ones that landed outside the checkpoints ledger) are
50
50
  // surfaced here, never blocked. Counting them needs git (orient is pure), so
51
- // status measures it: commits on HEAD since the last ledger line's SHA —
51
+ // status measures it: commits on HEAD since the last ledger line's SHA:
52
52
  // baseline, plan, or step, so a commit landing before the first step
53
53
  // checkpoint still surfaces. No ledger yet ⇒ nothing to reconcile against ⇒ 0.
54
54
  const checkpoints = readOr(checkpointsPath(root, slug));
@@ -70,7 +70,7 @@ export function status(cwd, args = []) {
70
70
  * `defaults` and per step.
71
71
  *
72
72
  * Bindings live in `builds/<slug>/harness.json` and status is the surface that
73
- * reports them — no separate `agent check` verb. Any bound agent that does not
73
+ * reports them: no separate `agent check` verb. Any bound agent that does not
74
74
  * resolve gets a warning, not an error: a teammate can lack a personal agent
75
75
  * and the loop still works. Returns [] when the build has no harness.json (a
76
76
  * clean no-op) or the file binds nothing, so the dashboard stays uncluttered
@@ -100,7 +100,7 @@ function harnessSection(root, slug) {
100
100
  /**
101
101
  * Render a SlotBindings as `slot: name1, name2` fragments, in slot order.
102
102
  *
103
- * A slot bound to no agents (an explicit "override to none") is omitted —
103
+ * A slot bound to no agents (an explicit "override to none") is omitted:
104
104
  * there is nothing to run and nothing to name.
105
105
  */
106
106
  function slotFragments(bindings) {
@@ -1,16 +1,16 @@
1
- // `plumbbob turn` — the turn-ledger hook. Wired to the harness's
1
+ // `plumbbob turn`: the turn-ledger hook. Wired to the harness's
2
2
  // UserPromptSubmit event, it runs once per human prompt and maintains two of the
3
3
  // sidecar's git-excluded control files (flat files under `.plumbbob/`): it ticks
4
4
  // `TURN`, the monotonic count of human turns the checkpoint latch compares
5
5
  // against a step's entry stamp to know a human turn intervened since the step
6
- // began, and it rewrites `GRANT` from the literal prompt — minting a one-turn
6
+ // began, and it rewrites `GRANT` from the literal prompt, minting a one-turn
7
7
  // self-approval only when the human typed `/build --auto` or an `N-M` step
8
8
  // range, clearing it otherwise (those strings can only come from a human
9
- // keystroke, because `build` is disable-model-invocation — a grant the model
9
+ // keystroke, because `build` is disable-model-invocation: a grant the model
10
10
  // could forge would be no grant). When a step is in flight it also emits ONE
11
11
  // `UserPromptSubmit` additionalContext line so a fresh session (post-compaction,
12
12
  // or a scripted `-p` turn where no skill prose is in context) still knows the
13
- // beat — a tangent is parked, not chased. Guidance only: it blocks nothing. It
13
+ // beat: a tangent is parked, not chased. Guidance only: it blocks nothing. It
14
14
  // ALWAYS exits 0 and any failure degrades to no output, so neither the tick nor
15
15
  // the emit can ever wedge prompting.
16
16
  import { readFileSync, writeFileSync } from 'node:fs';
@@ -18,7 +18,7 @@ import { findSessionRoot, setGrant, stepPath, turnPath } from "../lib/sidecar.js
18
18
  /**
19
19
  * The hook entry point: apply the tick, then emit the in-flight-step nudge.
20
20
  *
21
- * Always returns 0 — a broken turn must never wedge a prompt, so any failure is
21
+ * Always returns 0: a broken turn must never wedge a prompt, so any failure is
22
22
  * swallowed and degrades to no output.
23
23
  */
24
24
  export function turn(cwd, _args) {
@@ -29,7 +29,7 @@ export function turn(cwd, _args) {
29
29
  process.stdout.write(context);
30
30
  }
31
31
  catch {
32
- // A broken turn must never wedge a prompt — swallow and exit 0.
32
+ // A broken turn must never wedge a prompt: swallow and exit 0.
33
33
  }
34
34
  return 0;
35
35
  }
@@ -59,7 +59,7 @@ export function stepInFlightContext(cwd) {
59
59
  * The in-flight step number, or null when no STEP marker is present.
60
60
  *
61
61
  * Absent means no step entered, or it already checkpointed. A garbled marker
62
- * reads as null — never an error, because the hook must not wedge a prompt.
62
+ * reads as null (never an error), because the hook must not wedge a prompt.
63
63
  */
64
64
  function inFlightStep(root) {
65
65
  try {
@@ -73,14 +73,14 @@ function inFlightStep(root) {
73
73
  /**
74
74
  * The testable core: apply one tick given the raw hook stdin.
75
75
  *
76
- * Split from the fd-0 read so the unit tests can drive it directly — an
76
+ * Split from the fd-0 read so the unit tests can drive it directly: an
77
77
  * in-process test cannot feed fd 0 (the same constraint checkpoint's `--body`
78
78
  * lives under).
79
79
  */
80
80
  export function applyTurn(cwd, raw) {
81
81
  const root = findSessionRoot(cwd);
82
82
  if (root === null)
83
- return 0; // no active session above cwd — silent no-op.
83
+ return 0; // no active session above cwd: silent no-op.
84
84
  writeFileSync(turnPath(root), `${readTurn(root) + 1}\n`);
85
85
  setGrant(root, grantFromPrompt(extractPrompt(raw)));
86
86
  return 0;
@@ -90,7 +90,7 @@ export function applyTurn(cwd, raw) {
90
90
  *
91
91
  * A grant is minted only from a literal `build` invocation the human typed:
92
92
  * `build` is disable-model-invocation, so this string can only come from a
93
- * human keystroke, never model-authored pressure — a grant the model can forge
93
+ * human keystroke, never model-authored pressure: a grant the model can forge
94
94
  * is no grant. A bounded range beats `--auto` (bounded wins); a bare
95
95
  * `/build`, or any non-invocation prompt, mints nothing. The namespaced
96
96
  * `/plumbbob:build` form is honored alongside the bare one.
@@ -101,10 +101,10 @@ export function applyTurn(cwd, raw) {
101
101
  *
102
102
  * Only the invocation's own arguments can mint: the tokens that follow it on
103
103
  * its line, up to the first token that isn't a sanctioned argument (`--auto`, a
104
- * step number, or a range — the argument-hint sanctions nothing else). An
104
+ * step number, or a range; the argument-hint sanctions nothing else). An
105
105
  * unrecognized flag ends the scan, so `/build --wip 2020-2024` mints
106
- * nothing — the `2020-2024` is never reached. An incidental range elsewhere in
107
- * the prompt — an issue number, a pasted `2020-2024` — is prose, not a grant.
106
+ * nothing: the `2020-2024` is never reached. An incidental range elsewhere in
107
+ * the prompt (an issue number, a pasted `2020-2024`) is prose, not a grant.
108
108
  * Trailing sentence punctuation on an argument (`/build 1-3.`) is still the
109
109
  * argument the human typed.
110
110
  */
@@ -129,8 +129,8 @@ export function grantFromPrompt(prompt) {
129
129
  continue;
130
130
  }
131
131
  if (/^\d+$/.test(word))
132
- continue; // a bare step number — keep scanning for a range/--auto
133
- break; // an unrecognized flag or free text — the arguments have ended
132
+ continue; // a bare step number: keep scanning for a range/--auto
133
+ break; // an unrecognized flag or free text: the arguments have ended
134
134
  }
135
135
  if (ceiling !== undefined)
136
136
  return `range ${ceiling}`;
@@ -170,7 +170,7 @@ function readTurn(root) {
170
170
  * Read the hook JSON from fd 0, degrading to '' on any failure.
171
171
  *
172
172
  * An interactive TTY never sends EOF, so skip the read there rather than hang
173
- * (mirrors checkpoint's `--body`); a read error degrades to '' — extractPrompt
173
+ * (mirrors checkpoint's `--body`); a read error degrades to '': extractPrompt
174
174
  * then clears the grant and the tick still lands.
175
175
  */
176
176
  function readStdin() {
package/dist/verbs/use.js CHANGED
@@ -1,10 +1,10 @@
1
- // `plumbbob use <slug>` — re-point the active-build cursor at an existing build
1
+ // `plumbbob use <slug>`: re-point the active-build cursor at an existing build
2
2
  // and resume it, `nvm use`-shaped: switching and resuming are the same one word.
3
3
  // The cursor is the single-line content of `.plumbbob/STATE`, the untracked
4
4
  // per-worktree file whose existence means a session is live and whose one line
5
- // names the build that session is on — so pointing it elsewhere IS the switch,
5
+ // names the build that session is on, so pointing it elsewhere IS the switch,
6
6
  // and one-active-per-worktree holds by construction (one line cannot name two
7
- // builds). It validates the target folder exists, and warns — but allows —
7
+ // builds). It validates the target folder exists, and warns (but allows)
8
8
  // leaving a build with a step in flight: the in-flight markers live per build,
9
9
  // so that state survives the switch and resumes the next time you `use` the
10
10
  // build.
@@ -15,7 +15,7 @@ import { activeBuild, hasSession, intentPath, listBuilds, setActiveBuild, stepPa
15
15
  * Switch the active-build cursor to the named build.
16
16
  *
17
17
  * Refuses without a session, without a slug, or when the target folder has no
18
- * intent.md; notes — but allows — a step left in flight on the build being left.
18
+ * intent.md; notes (but allows) a step left in flight on the build being left.
19
19
  */
20
20
  export function use(cwd, args) {
21
21
  const root = findRepoRoot(cwd);
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "checkride",
3
3
  "displayName": "checkride",
4
- "version": "0.10.2",
4
+ "version": "0.12.2",
5
5
  "description": "Bounded, contract-aware readers for what checkride already writes: triage a red gate and read quality signal without loading megabytes of raw artifacts.",
6
6
  "author": { "name": "Rob McLarty", "email": "hello@robmclarty.com", "url": "https://robmclarty.com" },
7
7
  "homepage": "https://robmclarty.github.io/checkride/",