plumbbob 0.9.3 → 0.10.0

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 (320) hide show
  1. package/.claude-plugin/plugin.json +1 -1
  2. package/README.md +92 -89
  3. package/dist/cli-core.js +25 -8
  4. package/dist/cli.js +1 -1
  5. package/dist/lib/agents.js +26 -26
  6. package/dist/lib/buildlog.js +11 -11
  7. package/dist/lib/buildlogsync.js +8 -8
  8. package/dist/lib/check.js +55 -22
  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 +21 -20
  13. package/dist/lib/latch.js +19 -19
  14. package/dist/lib/orient.js +36 -17
  15. package/dist/lib/reentry.js +70 -0
  16. package/dist/lib/settings.js +16 -16
  17. package/dist/lib/sidecar.js +54 -54
  18. package/dist/lib/templates.js +1 -1
  19. package/dist/verbs/agent.js +27 -27
  20. package/dist/verbs/build.js +9 -9
  21. package/dist/verbs/check.js +6 -6
  22. package/dist/verbs/checkpoint.js +48 -47
  23. package/dist/verbs/doctor.js +31 -30
  24. package/dist/verbs/finish.js +28 -41
  25. package/dist/verbs/handoff.js +9 -8
  26. package/dist/verbs/init.js +9 -9
  27. package/dist/verbs/park.js +3 -3
  28. package/dist/verbs/recover.js +297 -0
  29. package/dist/verbs/revert.js +13 -13
  30. package/dist/verbs/spike.js +25 -19
  31. package/dist/verbs/start.js +49 -19
  32. package/dist/verbs/status.js +8 -8
  33. package/dist/verbs/turn.js +16 -16
  34. package/dist/verbs/use.js +4 -4
  35. package/hooks/post-edit.sh +4 -4
  36. package/hooks/pre-bash-commit.sh +3 -3
  37. package/node_modules/checkride/.claude-plugin/plugin.json +11 -0
  38. package/node_modules/checkride/CHANGELOG.md +1404 -0
  39. package/node_modules/checkride/LICENSE +201 -21
  40. package/node_modules/checkride/README.md +197 -38
  41. package/node_modules/checkride/dist/__tests__/fixtures/released-stanzas.d.ts +15 -0
  42. package/node_modules/checkride/dist/__tests__/fixtures/released-stanzas.d.ts.map +1 -0
  43. package/node_modules/checkride/dist/__tests__/fixtures/released-stanzas.js +17 -0
  44. package/node_modules/checkride/dist/__tests__/fixtures/released-stanzas.js.map +1 -0
  45. package/node_modules/checkride/dist/adapters.d.ts +30 -10
  46. package/node_modules/checkride/dist/adapters.d.ts.map +1 -1
  47. package/node_modules/checkride/dist/adapters.js +62 -23
  48. package/node_modules/checkride/dist/adapters.js.map +1 -1
  49. package/node_modules/checkride/dist/agent-setup/claude.d.ts +88 -0
  50. package/node_modules/checkride/dist/agent-setup/claude.d.ts.map +1 -0
  51. package/node_modules/checkride/dist/agent-setup/claude.js +305 -0
  52. package/node_modules/checkride/dist/agent-setup/claude.js.map +1 -0
  53. package/node_modules/checkride/dist/agent-setup/command.d.ts +43 -0
  54. package/node_modules/checkride/dist/agent-setup/command.d.ts.map +1 -0
  55. package/node_modules/checkride/dist/agent-setup/command.js +77 -0
  56. package/node_modules/checkride/dist/agent-setup/command.js.map +1 -0
  57. package/node_modules/checkride/dist/agent-setup/cursor.d.ts +69 -0
  58. package/node_modules/checkride/dist/agent-setup/cursor.d.ts.map +1 -0
  59. package/node_modules/checkride/dist/agent-setup/cursor.js +247 -0
  60. package/node_modules/checkride/dist/agent-setup/cursor.js.map +1 -0
  61. package/node_modules/checkride/dist/agent-setup/files.d.ts +50 -0
  62. package/node_modules/checkride/dist/agent-setup/files.d.ts.map +1 -0
  63. package/node_modules/checkride/dist/agent-setup/files.js +80 -0
  64. package/node_modules/checkride/dist/agent-setup/files.js.map +1 -0
  65. package/node_modules/checkride/dist/agent-setup/harness.d.ts +101 -0
  66. package/node_modules/checkride/dist/agent-setup/harness.d.ts.map +1 -0
  67. package/node_modules/checkride/dist/agent-setup/harness.js +93 -0
  68. package/node_modules/checkride/dist/agent-setup/harness.js.map +1 -0
  69. package/node_modules/checkride/dist/agent-setup/hook.d.ts +45 -52
  70. package/node_modules/checkride/dist/agent-setup/hook.d.ts.map +1 -1
  71. package/node_modules/checkride/dist/agent-setup/hook.js +64 -95
  72. package/node_modules/checkride/dist/agent-setup/hook.js.map +1 -1
  73. package/node_modules/checkride/dist/agent-setup/index.d.ts +10 -4
  74. package/node_modules/checkride/dist/agent-setup/index.d.ts.map +1 -1
  75. package/node_modules/checkride/dist/agent-setup/index.js +9 -4
  76. package/node_modules/checkride/dist/agent-setup/index.js.map +1 -1
  77. package/node_modules/checkride/dist/agent-setup/scripts.d.ts +81 -0
  78. package/node_modules/checkride/dist/agent-setup/scripts.d.ts.map +1 -0
  79. package/node_modules/checkride/dist/agent-setup/scripts.js +604 -0
  80. package/node_modules/checkride/dist/agent-setup/scripts.js.map +1 -0
  81. package/node_modules/checkride/dist/agent-setup/skills.d.ts +31 -0
  82. package/node_modules/checkride/dist/agent-setup/skills.d.ts.map +1 -0
  83. package/node_modules/checkride/dist/agent-setup/skills.js +56 -0
  84. package/node_modules/checkride/dist/agent-setup/skills.js.map +1 -0
  85. package/node_modules/checkride/dist/artifacts/configured.d.ts +30 -0
  86. package/node_modules/checkride/dist/artifacts/configured.d.ts.map +1 -0
  87. package/node_modules/checkride/dist/artifacts/configured.js +45 -0
  88. package/node_modules/checkride/dist/artifacts/configured.js.map +1 -0
  89. package/node_modules/checkride/dist/artifacts/format.d.ts +33 -0
  90. package/node_modules/checkride/dist/artifacts/format.d.ts.map +1 -0
  91. package/node_modules/checkride/dist/artifacts/format.js +56 -0
  92. package/node_modules/checkride/dist/artifacts/format.js.map +1 -0
  93. package/node_modules/checkride/dist/artifacts/freshness.d.ts +32 -0
  94. package/node_modules/checkride/dist/artifacts/freshness.d.ts.map +1 -0
  95. package/node_modules/checkride/dist/artifacts/freshness.js +37 -0
  96. package/node_modules/checkride/dist/artifacts/freshness.js.map +1 -0
  97. package/node_modules/checkride/dist/artifacts/index.d.ts +22 -0
  98. package/node_modules/checkride/dist/artifacts/index.d.ts.map +1 -0
  99. package/node_modules/checkride/dist/artifacts/index.js +19 -0
  100. package/node_modules/checkride/dist/artifacts/index.js.map +1 -0
  101. package/node_modules/checkride/dist/artifacts/json.d.ts +31 -0
  102. package/node_modules/checkride/dist/artifacts/json.d.ts.map +1 -0
  103. package/node_modules/checkride/dist/artifacts/json.js +47 -0
  104. package/node_modules/checkride/dist/artifacts/json.js.map +1 -0
  105. package/node_modules/checkride/dist/artifacts/raw.d.ts +60 -0
  106. package/node_modules/checkride/dist/artifacts/raw.d.ts.map +1 -0
  107. package/node_modules/checkride/dist/artifacts/raw.js +91 -0
  108. package/node_modules/checkride/dist/artifacts/raw.js.map +1 -0
  109. package/node_modules/checkride/dist/artifacts/summary.d.ts +69 -0
  110. package/node_modules/checkride/dist/artifacts/summary.d.ts.map +1 -0
  111. package/node_modules/checkride/dist/artifacts/summary.js +108 -0
  112. package/node_modules/checkride/dist/artifacts/summary.js.map +1 -0
  113. package/node_modules/checkride/dist/atomic.d.ts +16 -1
  114. package/node_modules/checkride/dist/atomic.d.ts.map +1 -1
  115. package/node_modules/checkride/dist/atomic.js +25 -3
  116. package/node_modules/checkride/dist/atomic.js.map +1 -1
  117. package/node_modules/checkride/dist/baseline/fallow.d.ts +9 -5
  118. package/node_modules/checkride/dist/baseline/fallow.d.ts.map +1 -1
  119. package/node_modules/checkride/dist/baseline/fallow.js +163 -60
  120. package/node_modules/checkride/dist/baseline/fallow.js.map +1 -1
  121. package/node_modules/checkride/dist/baseline/fingerprint.d.ts +20 -11
  122. package/node_modules/checkride/dist/baseline/fingerprint.d.ts.map +1 -1
  123. package/node_modules/checkride/dist/baseline/fingerprint.js +73 -23
  124. package/node_modules/checkride/dist/baseline/fingerprint.js.map +1 -1
  125. package/node_modules/checkride/dist/baseline/history.d.ts +98 -0
  126. package/node_modules/checkride/dist/baseline/history.d.ts.map +1 -0
  127. package/node_modules/checkride/dist/baseline/history.js +232 -0
  128. package/node_modules/checkride/dist/baseline/history.js.map +1 -0
  129. package/node_modules/checkride/dist/baseline/index.d.ts +7 -5
  130. package/node_modules/checkride/dist/baseline/index.d.ts.map +1 -1
  131. package/node_modules/checkride/dist/baseline/index.js +5 -4
  132. package/node_modules/checkride/dist/baseline/index.js.map +1 -1
  133. package/node_modules/checkride/dist/baseline/store.d.ts +41 -10
  134. package/node_modules/checkride/dist/baseline/store.d.ts.map +1 -1
  135. package/node_modules/checkride/dist/baseline/store.js +65 -24
  136. package/node_modules/checkride/dist/baseline/store.js.map +1 -1
  137. package/node_modules/checkride/dist/baseline-command.d.ts +5 -5
  138. package/node_modules/checkride/dist/baseline-command.js +7 -7
  139. package/node_modules/checkride/dist/baseline-command.js.map +1 -1
  140. package/node_modules/checkride/dist/cli.d.ts +21 -4
  141. package/node_modules/checkride/dist/cli.d.ts.map +1 -1
  142. package/node_modules/checkride/dist/cli.js +350 -36
  143. package/node_modules/checkride/dist/cli.js.map +1 -1
  144. package/node_modules/checkride/dist/config.d.ts +114 -9
  145. package/node_modules/checkride/dist/config.d.ts.map +1 -1
  146. package/node_modules/checkride/dist/config.js +142 -23
  147. package/node_modules/checkride/dist/config.js.map +1 -1
  148. package/node_modules/checkride/dist/digest/digest.d.ts +5 -5
  149. package/node_modules/checkride/dist/digest/digest.js +6 -6
  150. package/node_modules/checkride/dist/digest/index.d.ts +2 -2
  151. package/node_modules/checkride/dist/digest/index.js +2 -2
  152. package/node_modules/checkride/dist/doctor.d.ts +27 -6
  153. package/node_modules/checkride/dist/doctor.d.ts.map +1 -1
  154. package/node_modules/checkride/dist/doctor.js +231 -27
  155. package/node_modules/checkride/dist/doctor.js.map +1 -1
  156. package/node_modules/checkride/dist/gate.d.ts +180 -0
  157. package/node_modules/checkride/dist/gate.d.ts.map +1 -0
  158. package/node_modules/checkride/dist/gate.js +617 -0
  159. package/node_modules/checkride/dist/gate.js.map +1 -0
  160. package/node_modules/checkride/dist/init.d.ts +79 -12
  161. package/node_modules/checkride/dist/init.d.ts.map +1 -1
  162. package/node_modules/checkride/dist/init.js +385 -81
  163. package/node_modules/checkride/dist/init.js.map +1 -1
  164. package/node_modules/checkride/dist/json.d.ts +21 -0
  165. package/node_modules/checkride/dist/json.d.ts.map +1 -0
  166. package/node_modules/checkride/dist/json.js +21 -0
  167. package/node_modules/checkride/dist/json.js.map +1 -0
  168. package/node_modules/checkride/dist/links.d.ts +31 -5
  169. package/node_modules/checkride/dist/links.d.ts.map +1 -1
  170. package/node_modules/checkride/dist/links.js +141 -32
  171. package/node_modules/checkride/dist/links.js.map +1 -1
  172. package/node_modules/checkride/dist/node-pin.d.ts +129 -0
  173. package/node_modules/checkride/dist/node-pin.d.ts.map +1 -0
  174. package/node_modules/checkride/dist/node-pin.js +211 -0
  175. package/node_modules/checkride/dist/node-pin.js.map +1 -0
  176. package/node_modules/checkride/dist/orchestrator.d.ts +53 -10
  177. package/node_modules/checkride/dist/orchestrator.d.ts.map +1 -1
  178. package/node_modules/checkride/dist/orchestrator.js +312 -113
  179. package/node_modules/checkride/dist/orchestrator.js.map +1 -1
  180. package/node_modules/checkride/dist/pack.d.ts +8 -9
  181. package/node_modules/checkride/dist/pack.d.ts.map +1 -1
  182. package/node_modules/checkride/dist/pack.js +53 -17
  183. package/node_modules/checkride/dist/pack.js.map +1 -1
  184. package/node_modules/checkride/dist/pm/detect.d.ts +6 -1
  185. package/node_modules/checkride/dist/pm/detect.d.ts.map +1 -1
  186. package/node_modules/checkride/dist/pm/detect.js +6 -1
  187. package/node_modules/checkride/dist/pm/detect.js.map +1 -1
  188. package/node_modules/checkride/dist/pm/index.d.ts +7 -2
  189. package/node_modules/checkride/dist/pm/index.d.ts.map +1 -1
  190. package/node_modules/checkride/dist/pm/index.js +6 -2
  191. package/node_modules/checkride/dist/pm/index.js.map +1 -1
  192. package/node_modules/checkride/dist/pm/launch.d.ts +72 -0
  193. package/node_modules/checkride/dist/pm/launch.d.ts.map +1 -0
  194. package/node_modules/checkride/dist/pm/launch.js +108 -0
  195. package/node_modules/checkride/dist/pm/launch.js.map +1 -0
  196. package/node_modules/checkride/dist/pm/tools.d.ts +73 -0
  197. package/node_modules/checkride/dist/pm/tools.d.ts.map +1 -0
  198. package/node_modules/checkride/dist/pm/tools.js +124 -0
  199. package/node_modules/checkride/dist/pm/tools.js.map +1 -0
  200. package/node_modules/checkride/dist/pm/translate.d.ts +35 -9
  201. package/node_modules/checkride/dist/pm/translate.d.ts.map +1 -1
  202. package/node_modules/checkride/dist/pm/translate.js +78 -18
  203. package/node_modules/checkride/dist/pm/translate.js.map +1 -1
  204. package/node_modules/checkride/dist/proc.d.ts +30 -0
  205. package/node_modules/checkride/dist/proc.d.ts.map +1 -0
  206. package/node_modules/checkride/dist/proc.js +42 -0
  207. package/node_modules/checkride/dist/proc.js.map +1 -0
  208. package/node_modules/checkride/dist/qa/cli.d.ts +20 -0
  209. package/node_modules/checkride/dist/qa/cli.d.ts.map +1 -0
  210. package/node_modules/checkride/dist/qa/cli.js +24 -0
  211. package/node_modules/checkride/dist/qa/cli.js.map +1 -0
  212. package/node_modules/checkride/dist/qa/dead.d.ts +39 -0
  213. package/node_modules/checkride/dist/qa/dead.d.ts.map +1 -0
  214. package/node_modules/checkride/dist/qa/dead.js +88 -0
  215. package/node_modules/checkride/dist/qa/dead.js.map +1 -0
  216. package/node_modules/checkride/dist/qa/dupes.d.ts +45 -0
  217. package/node_modules/checkride/dist/qa/dupes.d.ts.map +1 -0
  218. package/node_modules/checkride/dist/qa/dupes.js +62 -0
  219. package/node_modules/checkride/dist/qa/dupes.js.map +1 -0
  220. package/node_modules/checkride/dist/qa/health.d.ts +85 -0
  221. package/node_modules/checkride/dist/qa/health.d.ts.map +1 -0
  222. package/node_modules/checkride/dist/qa/health.js +109 -0
  223. package/node_modules/checkride/dist/qa/health.js.map +1 -0
  224. package/node_modules/checkride/dist/qa/index.d.ts +23 -0
  225. package/node_modules/checkride/dist/qa/index.d.ts.map +1 -0
  226. package/node_modules/checkride/dist/qa/index.js +22 -0
  227. package/node_modules/checkride/dist/qa/index.js.map +1 -0
  228. package/node_modules/checkride/dist/qa/mutation.d.ts +80 -0
  229. package/node_modules/checkride/dist/qa/mutation.d.ts.map +1 -0
  230. package/node_modules/checkride/dist/qa/mutation.js +195 -0
  231. package/node_modules/checkride/dist/qa/mutation.js.map +1 -0
  232. package/node_modules/checkride/dist/qa/qa.d.ts +71 -0
  233. package/node_modules/checkride/dist/qa/qa.d.ts.map +1 -0
  234. package/node_modules/checkride/dist/qa/qa.js +158 -0
  235. package/node_modules/checkride/dist/qa/qa.js.map +1 -0
  236. package/node_modules/checkride/dist/qa/read.d.ts +40 -0
  237. package/node_modules/checkride/dist/qa/read.d.ts.map +1 -0
  238. package/node_modules/checkride/dist/qa/read.js +47 -0
  239. package/node_modules/checkride/dist/qa/read.js.map +1 -0
  240. package/node_modules/checkride/dist/qa/render.d.ts +26 -0
  241. package/node_modules/checkride/dist/qa/render.d.ts.map +1 -0
  242. package/node_modules/checkride/dist/qa/render.js +310 -0
  243. package/node_modules/checkride/dist/qa/render.js.map +1 -0
  244. package/node_modules/checkride/dist/recover.d.ts +48 -0
  245. package/node_modules/checkride/dist/recover.d.ts.map +1 -0
  246. package/node_modules/checkride/dist/recover.js +220 -0
  247. package/node_modules/checkride/dist/recover.js.map +1 -0
  248. package/node_modules/checkride/dist/security.d.ts +45 -0
  249. package/node_modules/checkride/dist/security.d.ts.map +1 -0
  250. package/node_modules/checkride/dist/security.js +86 -0
  251. package/node_modules/checkride/dist/security.js.map +1 -0
  252. package/node_modules/checkride/dist/smoke.d.ts +6 -6
  253. package/node_modules/checkride/dist/smoke.js +6 -6
  254. package/node_modules/checkride/dist/snippets.d.ts +27 -30
  255. package/node_modules/checkride/dist/snippets.d.ts.map +1 -1
  256. package/node_modules/checkride/dist/snippets.js +26 -30
  257. package/node_modules/checkride/dist/snippets.js.map +1 -1
  258. package/node_modules/checkride/dist/tool-json.d.ts +33 -0
  259. package/node_modules/checkride/dist/tool-json.d.ts.map +1 -0
  260. package/node_modules/checkride/dist/tool-json.js +58 -0
  261. package/node_modules/checkride/dist/tool-json.js.map +1 -0
  262. package/node_modules/checkride/dist/triage/cli.d.ts +21 -0
  263. package/node_modules/checkride/dist/triage/cli.d.ts.map +1 -0
  264. package/node_modules/checkride/dist/triage/cli.js +26 -0
  265. package/node_modules/checkride/dist/triage/cli.js.map +1 -0
  266. package/node_modules/checkride/dist/triage/doctor-fold.d.ts +51 -0
  267. package/node_modules/checkride/dist/triage/doctor-fold.d.ts.map +1 -0
  268. package/node_modules/checkride/dist/triage/doctor-fold.js +88 -0
  269. package/node_modules/checkride/dist/triage/doctor-fold.js.map +1 -0
  270. package/node_modules/checkride/dist/triage/env.d.ts +54 -0
  271. package/node_modules/checkride/dist/triage/env.d.ts.map +1 -0
  272. package/node_modules/checkride/dist/triage/env.js +81 -0
  273. package/node_modules/checkride/dist/triage/env.js.map +1 -0
  274. package/node_modules/checkride/dist/triage/gate.d.ts +61 -0
  275. package/node_modules/checkride/dist/triage/gate.d.ts.map +1 -0
  276. package/node_modules/checkride/dist/triage/gate.js +121 -0
  277. package/node_modules/checkride/dist/triage/gate.js.map +1 -0
  278. package/node_modules/checkride/dist/triage/index.d.ts +22 -0
  279. package/node_modules/checkride/dist/triage/index.d.ts.map +1 -0
  280. package/node_modules/checkride/dist/triage/index.js +20 -0
  281. package/node_modules/checkride/dist/triage/index.js.map +1 -0
  282. package/node_modules/checkride/dist/triage/render.d.ts +19 -0
  283. package/node_modules/checkride/dist/triage/render.d.ts.map +1 -0
  284. package/node_modules/checkride/dist/triage/render.js +419 -0
  285. package/node_modules/checkride/dist/triage/render.js.map +1 -0
  286. package/node_modules/checkride/dist/triage/triage.d.ts +83 -0
  287. package/node_modules/checkride/dist/triage/triage.d.ts.map +1 -0
  288. package/node_modules/checkride/dist/triage/triage.js +131 -0
  289. package/node_modules/checkride/dist/triage/triage.js.map +1 -0
  290. package/node_modules/checkride/package.json +18 -15
  291. package/node_modules/checkride/schema/checkride.config.schema.json +70 -5
  292. package/node_modules/checkride/schema/checkride.summary.schema.json +1 -1
  293. package/node_modules/checkride/skills/check/SKILL.md +265 -0
  294. package/node_modules/checkride/skills/qa/SKILL.md +231 -0
  295. package/node_modules/checkride/templates/shared/cspell.json +1 -0
  296. package/node_modules/checkride/templates/shared/oxlintrc.json +1 -1
  297. package/node_modules/checkride/templates/shared/styles/Repo/Drift.yml +41 -0
  298. package/node_modules/checkride/templates/shared/styles/Repo/Latin.yml +14 -0
  299. package/node_modules/checkride/templates/shared/styles/Repo/LyHyphen.yml +28 -0
  300. package/node_modules/checkride/templates/shared/styles/Repo/Minted.yml +33 -0
  301. package/node_modules/checkride/templates/shared/styles/Repo/ThereIs.yml +16 -0
  302. package/node_modules/checkride/templates/shared/styles/Repo/Weasel.yml +26 -0
  303. package/node_modules/checkride/templates/shared/vale.ini +34 -0
  304. package/package.json +10 -9
  305. package/skills/build/SKILL.md +85 -76
  306. package/skills/doctor/SKILL.md +11 -11
  307. package/skills/finish/SKILL.md +21 -18
  308. package/skills/harvest/SKILL.md +13 -11
  309. package/skills/park/SKILL.md +10 -10
  310. package/skills/plan/SKILL.md +69 -59
  311. package/skills/recover/SKILL.md +28 -0
  312. package/skills/refine/SKILL.md +21 -18
  313. package/skills/revert/SKILL.md +6 -6
  314. package/skills/spike/SKILL.md +9 -9
  315. package/skills/status/SKILL.md +5 -5
  316. package/skills/step/SKILL.md +20 -15
  317. package/skills/verify/SKILL.md +56 -46
  318. package/templates/build-log.md +7 -7
  319. package/templates/intent.md +52 -41
  320. package/templates/spike-report.md +10 -10
@@ -1,21 +1,201 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 Rob McLarty
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Rob McLarty
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -2,9 +2,20 @@
2
2
 
3
3
  # checkride
4
4
 
5
- **An agent harness for TypeScript repositories**, delivered as one npm package.
6
- It gives an LLM agent two things it otherwise lacks: a definition of done, and
7
- lanes to stay inside.
5
+ **One command that tells a coding agent — and you — when the work is actually
6
+ done.**
7
+
8
+ checkride is an npm package that runs your whole verification pipeline as a
9
+ single command (`pnpm check`) whose exit code is the verdict, and mechanically
10
+ enforces module boundaries so parallel changes stay out of each other's way.
11
+ Together those give an LLM agent the two things it otherwise lacks: a
12
+ definition of done, and lanes to stay inside.
13
+
14
+ It is built first for TypeScript, but it is not TypeScript-only: built-in
15
+ checks stand down when their tool isn't in the repo, and custom checks run any
16
+ command — so the same gate works for a plain-JavaScript package, a
17
+ mixed-language monorepo, or a different ecosystem entirely (delivered through
18
+ npm either way, for now).
8
19
 
9
20
  ## The thesis
10
21
 
@@ -15,19 +26,25 @@ both halves of that problem.
15
26
  types, lint, structure, dead code, tests, docs, links, spelling. **Exit 0
16
27
  means the work is complete.** Agents stop guessing; humans stop re-reviewing
17
28
  half-finished work.
18
- 2. **Structured boundaries.** A module is an encapsulation boundary with a
19
- narrow public surface. When one grows internals worth hiding it becomes a
20
- folder whose only public surface is its `index.ts`, and siblings reach only
21
- that index — never the internals. These are **deep modules** — Ousterhout's
22
- term for a small interface hiding a substantial implementation (*A
23
- Philosophy of Software Design*). Enforced mechanically, boundaries keep
24
- agents inside lanes and let humans and agents work in parallel with minimal
25
- merge conflicts.
26
-
27
- The consumer of the output is an LLM, so checkride never normalizes diagnostics
28
- into a common format. Each tool writes its own raw JSON to `.check/`; the agent
29
- reads whatever the tool emits. That deletes the layer that makes every prior
30
- meta-runner expensive to extend.
29
+ 2. **Structured boundaries.** Code is organized into modules with narrow
30
+ public surfaces. In the default layout, a module starts as a single file;
31
+ when it grows internals worth hiding, it becomes a folder whose only public
32
+ surface is its `index.ts`, and sibling modules import that index — never the
33
+ internals. (These are [**deep modules**](./docs/deep-modules.md) —
34
+ Ousterhout's term, from *A Philosophy of Software Design*, for a small
35
+ interface hiding a substantial implementation.) checkride enforces this
36
+ mechanically, which keeps each
37
+ change inside one module's boundary and lets humans and agents work in
38
+ parallel with minimal merge conflicts. Deep modules are checkride's default
39
+ convention, not a hardcoded one — the rules are swappable ast-grep files in
40
+ your repo, and the same slot enforces boundaries in other conventions and
41
+ languages (see [Conventions](#conventions)).
42
+
43
+ One design choice to know up front: because the consumer of the output is an
44
+ LLM, checkride never normalizes diagnostics into a common format. Each tool
45
+ writes its own raw JSON to `.check/`, and the agent reads whatever the tool
46
+ emits. Skipping normalization deletes the adapter-maintenance layer that makes
47
+ traditional run-all-my-tools wrappers expensive to extend.
31
48
 
32
49
  ## Install
33
50
 
@@ -49,14 +66,34 @@ pnpm install
49
66
  pnpm check
50
67
  ```
51
68
 
52
- Either way — `init` auto-detects which case it is in — it writes a
53
- `"check": "checkride"` alias, so daily usage is `pnpm check`
69
+ Both paths end in the same place — `init` auto-detects which case it is in.
70
+ It writes a `"check": "checkride"` script alias, so daily usage is `pnpm check`
54
71
  regardless of the tool's name. It also writes the agent contract: an AGENTS.md
55
- stanza (the "exit 0 = done" rule) and a Claude Code **Stop hook** in
56
- `.claude/settings.json` that blocks an agent from finishing while the pipeline is
57
- red. The hook uses your detected package manager (`pnpm`/`npm`/`yarn`/`bun run
58
- check`); skip it with `--no-hook`, or add all of this — alias, stanza, and hook —
59
- to a repo you already set up with `checkride agent-setup`.
72
+ stanza stating the "exit 0 = done" rule, and **hooks** in your agent harness's
73
+ config — `.claude/settings.json` for Claude Code, `.cursor/hooks.json` for
74
+ Cursor. Three of them: a stop gate (a checkride-owned script that runs your
75
+ detected package manager's `run check --strict --digest` and blocks an agent
76
+ from finishing while the pipeline is red), an edit marker so turns that touched
77
+ no files skip the gate, and a guard that denies edits to
78
+ `checkride.baseline.json` and `.check/**`. Select hooks with `--hook <a,b>`
79
+ (gate | dirty | protect), harnesses with `--harness <a,b>` (claude | cursor;
80
+ detected by default), skip the hooks with `--no-hook`, or take an installed one
81
+ back out with `--remove-hook <a,b>`. To add all of this — alias, stanza, hooks,
82
+ and the Cursor skills — to a repo you already set up, run
83
+ `checkride agent-setup`.
84
+
85
+ Re-running either command refreshes the stanza in place, but never behind your
86
+ back: the marker carries a hash of what checkride wrote, so a stanza you have
87
+ since edited stops the run (exit 2) instead of being overwritten. Keep
88
+ repo-specific additions outside the markers, where nothing rewrites them — or
89
+ pass `--force` to discard the edits and refresh. A stanza written before the hash
90
+ existed is matched against the wordings checkride released, so upgrading is not
91
+ itself mistaken for an edit.
92
+
93
+ To add or remove a hook on its own, use `checkride hooks add <a,b>` /
94
+ `checkride hooks remove <a,b>`. It writes only the harness config and the
95
+ generated scripts, and never reads or writes AGENTS.md — managing a hook is not
96
+ managing your contract file, and an edited stanza does not stand in its way.
60
97
 
61
98
  ## Docs
62
99
 
@@ -76,9 +113,21 @@ Task-focused guides live in [docs/](./docs/README.md):
76
113
  - [The contract](./docs/contract.md) — the surfaces consumers may rely on:
77
114
  exit codes, the `summary.json` schema discipline, flags, exports, and the
78
115
  pin policy.
116
+ - [The Claude Code plugin](./docs/plugin.md) — the bundled `/checkride:check`
117
+ and `/checkride:qa` skills: install, what each one reads, and what they
118
+ deliberately do not do.
119
+ - [Cursor](./docs/cursor.md) — what `agent-setup` writes for Cursor, where
120
+ Cursor's hook API differs from Claude Code's, and the assumptions not yet
121
+ verified against a live Cursor.
79
122
  - [Reliability](./docs/reliability.md) — why checkride is safe to build a
80
123
  gate on.
81
124
 
125
+ Runnable counterparts live in [examples/](./examples/): standalone projects you
126
+ can install and run on their own, each demonstrating one thing — what an agent
127
+ reads when the gate is red, or how a repo with existing debt adopts checkride
128
+ without a cleanup project first. Each one declares the run it expects, and the
129
+ end-to-end suite asserts it on every push.
130
+
82
131
  The rest of this README is the reference: the command surface, the pipeline
83
132
  model, the `.check/` output contract, configuration, and the baseline.
84
133
 
@@ -98,13 +147,30 @@ checkride init Set up a project (new or existing — auto-detected).
98
147
  --add <a,b> (existing mode) scaffold blessed configs for the named empty slots
99
148
  --baseline (existing mode) grandfather current debt instead of disabling slots
100
149
  --force (new mode) overwrite existing files instead of refusing
101
- --no-hook skip writing the Claude Code Stop hook
150
+ --hook <a,b> write only these hooks (gate | dirty | protect)
151
+ --no-hook skip writing the agent hooks
152
+ --remove-hook <a,b> remove these installed hooks (entry + generated script)
153
+ --harness <a,b> write them for these harnesses (claude | cursor; default: detected)
102
154
  --dry-run plan only; write nothing
103
155
  checkride doctor Verify environment + every slot's status (read-only, exit 0/1).
104
156
  checkride fix Run every active adapter's fix command (oxlint --fix, ...).
105
157
  checkride baseline Record current diagnostics as a committed baseline.
106
- checkride agent-setup Add the "check" alias, AGENTS.md stanza + Stop hook to a repo.
107
- --no-hook skip the Stop hook (write only the stanza)
158
+ checkride recover Rebuild checkride.baseline.json candidates from git history
159
+ and restore one (bare `recover` lists them with deltas).
160
+ --pick <n|sha|union> apply a candidate — additive union with the current file
161
+ --exact write the picked snapshot verbatim instead of the union
162
+ --dry-run preview the per-slot delta; write nothing
163
+ --depth <n> commits of file history to walk (default 25)
164
+ checkride agent-setup Add the "check" alias, AGENTS.md stanza + agent hooks to a repo.
165
+ --hook <a,b> write only these hooks (gate | dirty | protect)
166
+ --no-hook skip the hooks (write only the stanza)
167
+ --remove-hook <a,b> remove these installed hooks; with --no-hook, remove only
168
+ --harness <a,b> which harnesses to write for (claude | cursor; default: detected)
169
+ --force refresh a stanza that has local edits (refused otherwise)
170
+ checkride gate Run the check script as a stop gate, answering a harness's
171
+ hook protocol. The generated hook scripts invoke this.
172
+ checkride triage Triage a red gate: run it, then read .check/ as a bounded report.
173
+ checkride qa Read the quality artifacts a previous run left.
108
174
  ```
109
175
 
110
176
  During iteration, narrow the loop: `checkride --bail`, `checkride --only
@@ -118,8 +184,8 @@ default run leaves stdout empty.
118
184
  ## The pipeline: slots and adapters
119
185
 
120
186
  A **slot** is a role in the pipeline (order matters — cheapest first). An
121
- **adapter** is a concrete tool that fills a slot. There is one blessed default
122
- per slot; alternates are wired so checkride can run them, but `init` only
187
+ **adapter** is a concrete tool that fills a slot. Each slot has one blessed
188
+ default; alternates are wired so checkride can run them, but `init` only
123
189
  generates config for the blessed default.
124
190
 
125
191
  | Slot | Role | Blessed default | Alternates |
@@ -127,7 +193,7 @@ generates config for the blessed default.
127
193
  | `types` | Type checking | `tsc --build` | — |
128
194
  | `format` | Formatting (opt-in) | `prettier` | `biome` |
129
195
  | `lint` | Linting | `oxlint` | `biome`, `eslint`|
130
- | `struct` | Structural rules (deep modules) | `ast-grep` | — |
196
+ | `struct` | Structural rules (deep modules by default) | `ast-grep` | — |
131
197
  | `dead` | Dead code, deps, cycles, boundaries | `fallow` (dead-code)| `knip` |
132
198
  | `dupes` | Code duplication (opt-in) | `fallow` (dupes) | — |
133
199
  | `health` | Complexity / maintainability (opt-in) | `fallow` (health) | — |
@@ -135,23 +201,40 @@ generates config for the blessed default.
135
201
  | `docs` | Markdown lint | `markdownlint-cli2` | — |
136
202
  | `links` | Relative markdown links resolve | built-in | — |
137
203
  | `spell` | Spelling | `cspell` | — |
204
+ | `prose` | Writing style (opt-in) | `vale` | — |
138
205
  | `mutation` | Mutation testing (opt-in) | `stryker` | — |
139
206
  | `security` | Dependency audit (opt-in) | `pnpm audit` | — |
207
+ | `build` | Runs the consumer's build script (opt-in) | `<pm> run build` | — |
140
208
  | `publint` | Package publishing lint (opt-in) | `publint` | — |
141
209
  | `attw` | Type resolution across module systems (opt-in) | `attw --pack`| — |
210
+ | `pack` | Tarball ships the right files (opt-in) | built-in | — |
211
+ | `smoke` | Built package imports cleanly (opt-in) | built-in | — |
212
+ | `snippets` | Tagged doc fences type-check (opt-in) | built-in (`tsc`) | — |
213
+
214
+ Most of these tools you already know. The one unfamiliar name, `fallow`, is a
215
+ Rust-native codebase-analysis tool covering dead code, duplication, and
216
+ complexity; the [tools guide](./docs/tools.md) covers it and every other
217
+ adapter.
142
218
 
143
219
  Zero-config: for each slot, checkride runs the first adapter whose config file
144
220
  exists, and skips slots with no detected tool. The core has **no runtime
145
221
  dependency** on any checked tool — it spawns `<pm> exec <tool>`; the project
146
222
  owns the pinned tool versions.
147
223
 
148
- **Opt-in slots** (`format`, `mutation`, `security`, `publint`, `attw`) stay out of the
224
+ **Opt-in slots** (`format`, `dupes`, `health`, `prose`, `mutation`, `security`, `build`,
225
+ `publint`, `attw`, `pack`, `smoke`, `snippets`) stay out of the
149
226
  default run so adopting checkride — or bumping its version — never turns a repo red on a
150
227
  check it didn't ask for. Turn one on with `--include <slot>` (or `--all`), or by **naming
151
228
  it in `checks`**: an explicit entry like `"format": "prettier"` opts the slot into every
152
- run. `checkride fix` then runs its write form (e.g. `prettier --write`) alongside the
229
+ run. `checkride fix` then runs its write form (for example `prettier --write`) alongside the
153
230
  other fixers. `format` sits before `lint` so the tree is tidy before the linters look.
154
231
 
232
+ To **configure a slot without opting it in** — say, give `attw` a `--profile` but keep it
233
+ in the full sweep only — add `"optIn": true` to its entry: it stays out of the default run
234
+ and runs solely under `--all`/`--include <slot>`. The same field demotes a normally default
235
+ slot (or a heavy custom check like `test:integration`) to full-sweep-only; `"optIn": false`
236
+ does the opposite, forcing a slot into the default run.
237
+
155
238
  `publint` and `attw` are the **library-publishing** pair — turn them on for a package you
156
239
  ship to npm to make "the published artifact is correct" part of your definition of done.
157
240
  `publint` lints `package.json`'s publishing surface (exports, files, types); `attw` runs
@@ -225,6 +308,36 @@ To debug a failure: read `summary.json` to find the failing slot, then read that
225
308
  slot's raw output for structured diagnostics. On a large repo, `--digest` writes
226
309
  `digest.md` as a capped starting point.
227
310
 
311
+ ## The Claude Code plugin
312
+
313
+ The package root is also a [Claude Code](https://claude.com/claude-code) plugin
314
+ — two skills that consume the contract above, bundled in the same npm package
315
+ and versioned with it:
316
+
317
+ ```text
318
+ /plugin marketplace add robmclarty/agent-tools
319
+ /plugin install checkride@robmclarty
320
+ ```
321
+
322
+ - **`/checkride:check`** — triage a red gate. It runs the repo's own `check`
323
+ script, branches on the promised 0/1/2 exit split, and names **one root cause**
324
+ plus what it is deliberately not reading. It covers the corners a summary read
325
+ by hand gets wrong — exit 2 versus exit 1, vacuous green, a narrow run's green,
326
+ `baselined` counts, `skipped` slots, `exit_code: -1`, stale artifacts — then
327
+ opens exactly one raw file.
328
+ - **`/checkride:qa`** — read the quality signal. It folds `mutation.json`,
329
+ `dead.json`, `dupes.json` and `health.json` into a report under 8 kB, runs
330
+ nothing, and reports which dimensions were never measured rather than guessing
331
+ at them.
332
+
333
+ Both are **readers**: no new command, no new flag, no config, no hook. They
334
+ exist because reading `.check/` by hand is unbounded (`mutation.json` is 2.2 MB
335
+ in this repo) and credulous (every run overwrites `summary.json`, so an
336
+ `ok: true` on disk may describe three of seventeen slots from a while ago). The
337
+ readers ship prebuilt in `dist/`, so installing the plugin needs no build step,
338
+ and they run without it too — `node node_modules/checkride/dist/triage/cli.js`
339
+ prints the same report. Full details in [docs/plugin.md](./docs/plugin.md).
340
+
228
341
  ## Configuration
229
342
 
230
343
  `checkride.config.json` is optional — add it only to deviate from the defaults:
@@ -246,12 +359,29 @@ slot's raw output for structured diagnostics. On a large repo, `--digest` writes
246
359
  },
247
360
  "licenses": { // a custom check (runs last by default)
248
361
  "command": "node",
249
- "args": ["scripts/check-licenses.mjs"]
362
+ "args": ["scripts/check-licenses.mjs"],
363
+ "description": "License audit", // rendered beside the check in the output
364
+ "note": "Legal asked for this in RFC-114; drop it when the SBOM job lands."
250
365
  }
251
366
  }
252
367
  }
253
368
  ```
254
369
 
370
+ ### `description` vs `note`
371
+
372
+ Two strings, deliberately not one. **`description`** is user-facing: it is the
373
+ text a run prints beside the check in its status line and records in
374
+ `.check/summary.json`, so it wants to be short. **`note`** is the opposite —
375
+ maintainer commentary that never renders anywhere, the JSON-comment this file
376
+ otherwise has no room for. Put "why is this check here", "revisit after the
377
+ 2.0 upgrade", or a ticket number in `note` and keep the output readable.
378
+
379
+ `note` is accepted on any check entry — an adapter override (`{ "use": … }`) or
380
+ a custom check (`{ "command": … }`) — and at the top level of the file for a
381
+ note about the config as a whole. It is validated as a string (a typo is a
382
+ config error, not silence) and then dropped: no code path carries it onto an
383
+ adapter, so it cannot reach the CLI output or the summary.
384
+
255
385
  ### The `$schema` pointer
256
386
 
257
387
  The `"$schema"` pointer is optional but recommended: it turns on validation and
@@ -296,6 +426,10 @@ that don't all use the same tools. An `extends` that can't be found, or a config
296
426
  that extends itself in a loop, fails fast with
297
427
  `invalid checkride.config.json: <reason>`.
298
428
 
429
+ For operating a preset across many repos — versioning it, rolling a rule out as
430
+ a release, and automating the per-repo bump — see
431
+ [Running a fleet with shared presets](./docs/presets.md).
432
+
299
433
  ### Timeouts
300
434
 
301
435
  A per-check timeout guards against a hung tool, and it is **on by default**: a
@@ -353,7 +487,13 @@ keys are sorted), so parallel branches usually merge cleanly; when they do
353
487
  conflict, resolve by keeping both sides' entries and running a full
354
488
  `checkride` — the ratchet prunes anything already fixed, so an over-generous
355
489
  union self-heals, while a dropped entry that still fails simply resurfaces as
356
- a red check. **Deliberate re-baseline:** `checkride baseline` re-records
490
+ a red check. When a merge went badly anyway — entries deleted wholesale, or a
491
+ file so mangled it no longer parses (a run says so on stderr and treats it as
492
+ no baseline at all) — the run diagnoses what it can: a red run whose "new"
493
+ findings were grandfathered until a recent commit prints a `hint:` line naming
494
+ that commit. `checkride recover` then rebuilds candidate states from the
495
+ file's git history and restores one additively; see `checkride recover --help`.
496
+ **Deliberate re-baseline:** `checkride baseline` re-records
357
497
  *everything* currently failing — including brand-new debt you might rather
358
498
  fix — so treat re-running it as a reviewed change: do it deliberately (say,
359
499
  after adopting a stricter rule set) and read the `checkride.baseline.json`
@@ -386,13 +526,15 @@ At runtime, checkride itself is workspace-agnostic: whatever the shape, it runs
386
526
  each tool **once, from the repo root** — one pipeline, one `.check/`. Workspace
387
527
  awareness comes from the tools' own configs, which is what the monorepo scaffold
388
528
  sets up: `tsc --build` follows the root tsconfig's project references, and
389
- vitest, oxlint, ast-grep, and the rest walk the whole tree. There is no
390
- per-package orchestration and no way to check a single package — narrow a run
391
- with `--only`/`--changed`, not per-directory.
529
+ vitest, oxlint, ast-grep, and the rest walk the whole tree. checkride itself
530
+ does no per-package orchestration and offers no way to check a single package —
531
+ narrow a run with `--only`/`--changed`, not per-directory.
392
532
 
393
533
  ## Conventions
394
534
 
395
- Module boundaries, enforced by `ast-grep` and `fallow`:
535
+ `init` scaffolds one **default** convention — [deep
536
+ modules](./docs/deep-modules.md), whose boundaries are enforced by `ast-grep`
537
+ (the `struct` slot) and `fallow`:
396
538
 
397
539
  - A module is a unit of encapsulation. A single file is a module; promote it to
398
540
  a folder with a barrel `index.ts` when it grows internals worth hiding — a
@@ -403,6 +545,23 @@ Module boundaries, enforced by `ast-grep` and `fallow`:
403
545
  - Named exports only; no classes; `.js` extensions on relative imports
404
546
  (NodeNext); tests colocated with the code they cover.
405
547
 
548
+ None of this is hardcoded into checkride. The `struct` slot just runs whatever
549
+ ast-grep rules live in your repo's `rules/` directory (the barrel rule is
550
+ `rules/no-deep-sibling-import.yml`), so the convention is whatever those files
551
+ encode:
552
+
553
+ - **A different convention, same language.** Edit or replace the rules to match
554
+ how your repo is organized — public/private folders, a naming prefix, an
555
+ allowed-import list — and `struct` enforces the new shape unchanged.
556
+ - **Another language.** ast-grep is polyglot; set each rule's `language`
557
+ (`typescript`, `python`, `go`, `rust`, …) and the same slot covers boundaries
558
+ there.
559
+ - **Beyond ast-grep.** When a rule can't be expressed in ast-grep, or lives in
560
+ another ecosystem's tooling (`import-linter`, `depguard`, `dependency-cruiser`),
561
+ wire it as a [custom check](./docs/tools.md#when-to-write-a-custom-check).
562
+
563
+ checkride ships an opinionated default; it does not lock you to it.
564
+
406
565
  ## Tested envelope
407
566
 
408
567
  Every push runs the full suite — unit, contract, and end-to-end (generated
@@ -444,4 +603,4 @@ every public type are re-exported too. The full surface is the package's
444
603
 
445
604
  ## License
446
605
 
447
- [MIT](./LICENSE)
606
+ [Apache-2.0](./LICENSE)
@@ -0,0 +1,15 @@
1
+ /**
2
+ * The stanza body checkride actually shipped, one per distinct wording, taken
3
+ * verbatim from the release tags with `activeSlots = ['types', 'lint']`.
4
+ *
5
+ * These exist so the legacy registry in `init.ts` is pinned against real
6
+ * released output rather than against itself: a hash list can only be verified
7
+ * by the text it was computed from. Regenerate from git if a wording is ever
8
+ * found missing — `git show <tag>:src/init.ts` — but the set is closed, since
9
+ * every release from 0.10.1 stamps what it writes.
10
+ */
11
+ export declare const RELEASED_STANZAS: readonly {
12
+ range: string;
13
+ body: string;
14
+ }[];
15
+ //# sourceMappingURL=released-stanzas.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"released-stanzas.d.ts","sourceRoot":"","sources":["../../../src/__tests__/fixtures/released-stanzas.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,eAAO,MAAM,gBAAgB,EAAE,SAAS;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAKtE,CAAC"}
@@ -0,0 +1,17 @@
1
+ /**
2
+ * The stanza body checkride actually shipped, one per distinct wording, taken
3
+ * verbatim from the release tags with `activeSlots = ['types', 'lint']`.
4
+ *
5
+ * These exist so the legacy registry in `init.ts` is pinned against real
6
+ * released output rather than against itself: a hash list can only be verified
7
+ * by the text it was computed from. Regenerate from git if a wording is ever
8
+ * found missing — `git show <tag>:src/init.ts` — but the set is closed, since
9
+ * every release from 0.10.1 stamps what it writes.
10
+ */
11
+ export const RELEASED_STANZAS = [
12
+ { range: "v0.1.1–v0.1.6", body: "## Checkride: the definition of done\n\n`pnpm check` is the single source of truth for \"done\". Exit 0 means the work is\ncomplete; any other exit code means it is not. Never claim a task is finished while\n`pnpm check` is red.\n\nWhen it fails:\n\n1. Read `.check/summary.json` to see which check failed.\n2. Read that check's raw output (`.check/<slot>.json` or `.check/<slot>.stdout.txt`).\n3. Fix the root cause, then re-run.\n\nTight feedback loops: `pnpm check --bail`, `pnpm check --only types,lint`, and\n`pnpm check --changed`.\n\n### Module boundaries\n\nA module is a unit of encapsulation. A single file is a module; promote it to a\nfolder with a barrel `index.ts` when it grows internals worth hiding. A folder\nmodule's `index.ts` is its only public surface — re-exports only, no logic. Import\nsiblings through `'../<sibling>/index.js'`, never their internals.\n\nNamed exports only; no classes; `.js` extensions on relative imports.\n\nActive checks in this repo: types, lint." },
13
+ { range: "v0.2.0–v0.7.0", body: "## Checkride: the definition of done\n\n`pnpm check` is the single source of truth for \"done\". Exit 0 means the work is\ncomplete; any other exit code means it is not. Never claim a task is finished while\n`pnpm check` is red.\n\nWhen it fails:\n\n1. Read `.check/summary.json` to see which check failed.\n2. Read that check's raw output (`.check/<slot>.json` or `.check/<slot>.stdout.txt`).\n3. Fix the root cause, then re-run.\n\nTight feedback loops: `pnpm check --bail`, `pnpm check --only types,lint`, and\n`pnpm check --changed`.\n\nIf a Claude Code Stop hook is configured (`.claude/settings.json`), it runs the full\n`pnpm check` as the final gate — so while iterating, prefer the narrow commands above\nand let the hook run the authoritative pipeline once at the end rather than running\nthe full check yourself every loop.\n\n### Baseline\n\nIf `checkride.baseline.json` is present, checkride grandfathers the diagnostics it\nlists: a slot is green as long as only baselined findings remain, while a genuinely\nnew diagnostic still fails it. Fixing a baselined finding prunes it from the file —\nthe ratchet, so the baseline only ever shrinks. Never add to the baseline to make a\ncheck pass; fix the finding.\n\n### Module boundaries\n\nA module is a unit of encapsulation. A single file is a module; promote it to a\nfolder with a barrel `index.ts` when it grows internals worth hiding. A folder\nmodule's `index.ts` is its only public surface — re-exports only, no logic. Import\nsiblings through `'../<sibling>/index.js'`, never their internals.\n\nNamed exports only; no classes; `.js` extensions on relative imports.\n\nActive checks in this repo: types, lint." },
14
+ { range: "v0.8.0–v0.9.6", body: "## Checkride: the definition of done\n\n`pnpm check` is the single source of truth for \"done\". Exit 0 means the work is\ncomplete; any other exit code means it is not. Never claim a task is finished while\n`pnpm check` is red.\n\nWhen it fails:\n\n1. Read `.check/summary.json` to see which check failed.\n2. Read that check's raw output (`.check/<slot>.json` or `.check/<slot>.stdout.txt`).\n3. Fix the root cause, then re-run.\n\nWith the checkride plugin installed, `/checkride:check` runs this procedure in full.\n\nTight feedback loops: `pnpm check --bail`, `pnpm check --only types,lint`, and\n`pnpm check --changed`.\n\nIf a Claude Code Stop hook is configured (`.claude/settings.json`), it runs the full\n`pnpm check` as the final gate — so while iterating, prefer the narrow commands above\nand let the hook run the authoritative pipeline once at the end rather than running\nthe full check yourself every loop.\n\n### Baseline\n\nIf `checkride.baseline.json` is present, checkride grandfathers the diagnostics it\nlists: a slot is green as long as only baselined findings remain, while a genuinely\nnew diagnostic still fails it. Fixing a baselined finding prunes it from the file —\nthe ratchet, so the baseline only ever shrinks. Never add to the baseline to make a\ncheck pass; fix the finding.\n\n### Module boundaries\n\nA module is a unit of encapsulation. A single file is a module; promote it to a\nfolder with a barrel `index.ts` when it grows internals worth hiding. A folder\nmodule's `index.ts` is its only public surface — re-exports only, no logic. Import\nsiblings through `'../<sibling>/index.js'`, never their internals.\n\nNamed exports only; no classes; `.js` extensions on relative imports.\n\nActive checks in this repo: types, lint." },
15
+ { range: "v0.10.0", body: "## Checkride: the definition of done\n\n`pnpm check` is the single source of truth for \"done\". Exit 0 means the work is\ncomplete; any other exit code means it is not. Never claim a task is finished while\n`pnpm check` is red.\n\nWhen it fails:\n\n1. Read `.check/summary.json` to see which check failed.\n2. Read that check's raw output (`.check/<slot>.json` or `.check/<slot>.stdout.txt`).\n3. Fix the root cause, then re-run.\n\n`pnpm exec checkride triage` runs this procedure in full and reads `.check/` for you\n(`/checkride:check` and `/checkride-check` are the same thing as a skill).\n\nTight feedback loops: `pnpm check --bail`, `pnpm check --only types,lint`, and\n`pnpm check --changed`.\n\nIf a stop-gate hook is configured (`.claude/settings.json` or `.cursor/hooks.json`),\nit runs the full `pnpm check` as the final gate — so while iterating, prefer the narrow\ncommands above and let the hook run the authoritative pipeline once at the end rather\nthan running the full check yourself every loop.\n\n### Baseline\n\nIf `checkride.baseline.json` is present, checkride grandfathers the diagnostics it\nlists: a slot is green as long as only baselined findings remain, while a genuinely\nnew diagnostic still fails it. Fixing a baselined finding prunes it from the file —\nthe ratchet, so the baseline only ever shrinks. Never add to the baseline to make a\ncheck pass; fix the finding.\n\n### Module boundaries\n\nA module is a unit of encapsulation. A single file is a module; promote it to a\nfolder with a barrel `index.ts` when it grows internals worth hiding. A folder\nmodule's `index.ts` is its only public surface — re-exports only, no logic. Import\nsiblings through `'../<sibling>/index.js'`, never their internals.\n\nNamed exports only; no classes; `.js` extensions on relative imports.\n\nActive checks in this repo: types, lint." },
16
+ ];
17
+ //# sourceMappingURL=released-stanzas.js.map