plumbbob 0.9.3 → 0.9.5
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.
- package/.claude-plugin/plugin.json +1 -1
- package/README.md +15 -13
- package/dist/cli-core.js +19 -2
- package/dist/lib/check.js +46 -13
- package/dist/lib/intent.js +1 -1
- package/dist/lib/latch.js +3 -3
- package/dist/lib/reentry.js +70 -0
- package/dist/verbs/agent.js +2 -2
- package/dist/verbs/doctor.js +4 -4
- package/dist/verbs/finish.js +1 -1
- package/dist/verbs/recover.js +297 -0
- package/dist/verbs/revert.js +2 -2
- package/dist/verbs/spike.js +8 -2
- package/hooks/post-edit.sh +4 -4
- package/hooks/pre-bash-commit.sh +3 -3
- package/node_modules/checkride/.claude-plugin/plugin.json +11 -0
- package/node_modules/checkride/CHANGELOG.md +1003 -0
- package/node_modules/checkride/LICENSE +201 -21
- package/node_modules/checkride/README.md +171 -30
- package/node_modules/checkride/dist/__tests__/fixtures/released-stanzas.d.ts +15 -0
- package/node_modules/checkride/dist/__tests__/fixtures/released-stanzas.d.ts.map +1 -0
- package/node_modules/checkride/dist/__tests__/fixtures/released-stanzas.js +17 -0
- package/node_modules/checkride/dist/__tests__/fixtures/released-stanzas.js.map +1 -0
- package/node_modules/checkride/dist/adapters.d.ts +18 -6
- package/node_modules/checkride/dist/adapters.d.ts.map +1 -1
- package/node_modules/checkride/dist/adapters.js +42 -23
- package/node_modules/checkride/dist/adapters.js.map +1 -1
- package/node_modules/checkride/dist/agent-setup/claude.d.ts +88 -0
- package/node_modules/checkride/dist/agent-setup/claude.d.ts.map +1 -0
- package/node_modules/checkride/dist/agent-setup/claude.js +305 -0
- package/node_modules/checkride/dist/agent-setup/claude.js.map +1 -0
- package/node_modules/checkride/dist/agent-setup/command.d.ts +43 -0
- package/node_modules/checkride/dist/agent-setup/command.d.ts.map +1 -0
- package/node_modules/checkride/dist/agent-setup/command.js +77 -0
- package/node_modules/checkride/dist/agent-setup/command.js.map +1 -0
- package/node_modules/checkride/dist/agent-setup/cursor.d.ts +61 -0
- package/node_modules/checkride/dist/agent-setup/cursor.d.ts.map +1 -0
- package/node_modules/checkride/dist/agent-setup/cursor.js +189 -0
- package/node_modules/checkride/dist/agent-setup/cursor.js.map +1 -0
- package/node_modules/checkride/dist/agent-setup/files.d.ts +50 -0
- package/node_modules/checkride/dist/agent-setup/files.d.ts.map +1 -0
- package/node_modules/checkride/dist/agent-setup/files.js +80 -0
- package/node_modules/checkride/dist/agent-setup/files.js.map +1 -0
- package/node_modules/checkride/dist/agent-setup/harness.d.ts +101 -0
- package/node_modules/checkride/dist/agent-setup/harness.d.ts.map +1 -0
- package/node_modules/checkride/dist/agent-setup/harness.js +84 -0
- package/node_modules/checkride/dist/agent-setup/harness.js.map +1 -0
- package/node_modules/checkride/dist/agent-setup/hook.d.ts +45 -52
- package/node_modules/checkride/dist/agent-setup/hook.d.ts.map +1 -1
- package/node_modules/checkride/dist/agent-setup/hook.js +64 -95
- package/node_modules/checkride/dist/agent-setup/hook.js.map +1 -1
- package/node_modules/checkride/dist/agent-setup/index.d.ts +10 -4
- package/node_modules/checkride/dist/agent-setup/index.d.ts.map +1 -1
- package/node_modules/checkride/dist/agent-setup/index.js +9 -4
- package/node_modules/checkride/dist/agent-setup/index.js.map +1 -1
- package/node_modules/checkride/dist/agent-setup/scripts.d.ts +58 -0
- package/node_modules/checkride/dist/agent-setup/scripts.d.ts.map +1 -0
- package/node_modules/checkride/dist/agent-setup/scripts.js +299 -0
- package/node_modules/checkride/dist/agent-setup/scripts.js.map +1 -0
- package/node_modules/checkride/dist/agent-setup/skills.d.ts +31 -0
- package/node_modules/checkride/dist/agent-setup/skills.d.ts.map +1 -0
- package/node_modules/checkride/dist/agent-setup/skills.js +56 -0
- package/node_modules/checkride/dist/agent-setup/skills.js.map +1 -0
- package/node_modules/checkride/dist/artifacts/configured.d.ts +30 -0
- package/node_modules/checkride/dist/artifacts/configured.d.ts.map +1 -0
- package/node_modules/checkride/dist/artifacts/configured.js +45 -0
- package/node_modules/checkride/dist/artifacts/configured.js.map +1 -0
- package/node_modules/checkride/dist/artifacts/format.d.ts +33 -0
- package/node_modules/checkride/dist/artifacts/format.d.ts.map +1 -0
- package/node_modules/checkride/dist/artifacts/format.js +56 -0
- package/node_modules/checkride/dist/artifacts/format.js.map +1 -0
- package/node_modules/checkride/dist/artifacts/freshness.d.ts +32 -0
- package/node_modules/checkride/dist/artifacts/freshness.d.ts.map +1 -0
- package/node_modules/checkride/dist/artifacts/freshness.js +37 -0
- package/node_modules/checkride/dist/artifacts/freshness.js.map +1 -0
- package/node_modules/checkride/dist/artifacts/index.d.ts +22 -0
- package/node_modules/checkride/dist/artifacts/index.d.ts.map +1 -0
- package/node_modules/checkride/dist/artifacts/index.js +19 -0
- package/node_modules/checkride/dist/artifacts/index.js.map +1 -0
- package/node_modules/checkride/dist/artifacts/json.d.ts +31 -0
- package/node_modules/checkride/dist/artifacts/json.d.ts.map +1 -0
- package/node_modules/checkride/dist/artifacts/json.js +47 -0
- package/node_modules/checkride/dist/artifacts/json.js.map +1 -0
- package/node_modules/checkride/dist/artifacts/raw.d.ts +60 -0
- package/node_modules/checkride/dist/artifacts/raw.d.ts.map +1 -0
- package/node_modules/checkride/dist/artifacts/raw.js +91 -0
- package/node_modules/checkride/dist/artifacts/raw.js.map +1 -0
- package/node_modules/checkride/dist/artifacts/summary.d.ts +69 -0
- package/node_modules/checkride/dist/artifacts/summary.d.ts.map +1 -0
- package/node_modules/checkride/dist/artifacts/summary.js +108 -0
- package/node_modules/checkride/dist/artifacts/summary.js.map +1 -0
- package/node_modules/checkride/dist/atomic.d.ts +16 -1
- package/node_modules/checkride/dist/atomic.d.ts.map +1 -1
- package/node_modules/checkride/dist/atomic.js +25 -3
- package/node_modules/checkride/dist/atomic.js.map +1 -1
- package/node_modules/checkride/dist/baseline/fallow.d.ts +9 -5
- package/node_modules/checkride/dist/baseline/fallow.d.ts.map +1 -1
- package/node_modules/checkride/dist/baseline/fallow.js +161 -58
- package/node_modules/checkride/dist/baseline/fallow.js.map +1 -1
- package/node_modules/checkride/dist/baseline/fingerprint.d.ts +7 -7
- package/node_modules/checkride/dist/baseline/fingerprint.d.ts.map +1 -1
- package/node_modules/checkride/dist/baseline/fingerprint.js +16 -19
- package/node_modules/checkride/dist/baseline/fingerprint.js.map +1 -1
- package/node_modules/checkride/dist/baseline/index.d.ts +4 -4
- package/node_modules/checkride/dist/baseline/index.d.ts.map +1 -1
- package/node_modules/checkride/dist/baseline/index.js +4 -4
- package/node_modules/checkride/dist/baseline/index.js.map +1 -1
- package/node_modules/checkride/dist/baseline/store.d.ts +12 -4
- package/node_modules/checkride/dist/baseline/store.d.ts.map +1 -1
- package/node_modules/checkride/dist/baseline/store.js +16 -9
- package/node_modules/checkride/dist/baseline/store.js.map +1 -1
- package/node_modules/checkride/dist/baseline-command.d.ts +5 -5
- package/node_modules/checkride/dist/baseline-command.js +7 -7
- package/node_modules/checkride/dist/baseline-command.js.map +1 -1
- package/node_modules/checkride/dist/cli.d.ts +17 -4
- package/node_modules/checkride/dist/cli.d.ts.map +1 -1
- package/node_modules/checkride/dist/cli.js +259 -18
- package/node_modules/checkride/dist/cli.js.map +1 -1
- package/node_modules/checkride/dist/config.d.ts +84 -8
- package/node_modules/checkride/dist/config.d.ts.map +1 -1
- package/node_modules/checkride/dist/config.js +122 -18
- package/node_modules/checkride/dist/config.js.map +1 -1
- package/node_modules/checkride/dist/digest/digest.d.ts +5 -5
- package/node_modules/checkride/dist/digest/digest.js +5 -5
- package/node_modules/checkride/dist/digest/index.d.ts +2 -2
- package/node_modules/checkride/dist/digest/index.js +2 -2
- package/node_modules/checkride/dist/doctor.d.ts +25 -6
- package/node_modules/checkride/dist/doctor.d.ts.map +1 -1
- package/node_modules/checkride/dist/doctor.js +193 -27
- package/node_modules/checkride/dist/doctor.js.map +1 -1
- package/node_modules/checkride/dist/gate.d.ts +135 -0
- package/node_modules/checkride/dist/gate.d.ts.map +1 -0
- package/node_modules/checkride/dist/gate.js +490 -0
- package/node_modules/checkride/dist/gate.js.map +1 -0
- package/node_modules/checkride/dist/init.d.ts +72 -12
- package/node_modules/checkride/dist/init.d.ts.map +1 -1
- package/node_modules/checkride/dist/init.js +324 -81
- package/node_modules/checkride/dist/init.js.map +1 -1
- package/node_modules/checkride/dist/json.d.ts +21 -0
- package/node_modules/checkride/dist/json.d.ts.map +1 -0
- package/node_modules/checkride/dist/json.js +21 -0
- package/node_modules/checkride/dist/json.js.map +1 -0
- package/node_modules/checkride/dist/links.d.ts +31 -5
- package/node_modules/checkride/dist/links.d.ts.map +1 -1
- package/node_modules/checkride/dist/links.js +141 -32
- package/node_modules/checkride/dist/links.js.map +1 -1
- package/node_modules/checkride/dist/node-pin.d.ts +129 -0
- package/node_modules/checkride/dist/node-pin.d.ts.map +1 -0
- package/node_modules/checkride/dist/node-pin.js +211 -0
- package/node_modules/checkride/dist/node-pin.js.map +1 -0
- package/node_modules/checkride/dist/orchestrator.d.ts +40 -10
- package/node_modules/checkride/dist/orchestrator.d.ts.map +1 -1
- package/node_modules/checkride/dist/orchestrator.js +196 -102
- package/node_modules/checkride/dist/orchestrator.js.map +1 -1
- package/node_modules/checkride/dist/pack.d.ts +8 -9
- package/node_modules/checkride/dist/pack.d.ts.map +1 -1
- package/node_modules/checkride/dist/pack.js +53 -17
- package/node_modules/checkride/dist/pack.js.map +1 -1
- package/node_modules/checkride/dist/pm/detect.d.ts +6 -1
- package/node_modules/checkride/dist/pm/detect.d.ts.map +1 -1
- package/node_modules/checkride/dist/pm/detect.js +6 -1
- package/node_modules/checkride/dist/pm/detect.js.map +1 -1
- package/node_modules/checkride/dist/pm/index.d.ts +6 -2
- package/node_modules/checkride/dist/pm/index.d.ts.map +1 -1
- package/node_modules/checkride/dist/pm/index.js +6 -2
- package/node_modules/checkride/dist/pm/index.js.map +1 -1
- package/node_modules/checkride/dist/pm/launch.d.ts +51 -0
- package/node_modules/checkride/dist/pm/launch.d.ts.map +1 -0
- package/node_modules/checkride/dist/pm/launch.js +92 -0
- package/node_modules/checkride/dist/pm/launch.js.map +1 -0
- package/node_modules/checkride/dist/pm/tools.d.ts +73 -0
- package/node_modules/checkride/dist/pm/tools.d.ts.map +1 -0
- package/node_modules/checkride/dist/pm/tools.js +124 -0
- package/node_modules/checkride/dist/pm/tools.js.map +1 -0
- package/node_modules/checkride/dist/pm/translate.d.ts +35 -9
- package/node_modules/checkride/dist/pm/translate.d.ts.map +1 -1
- package/node_modules/checkride/dist/pm/translate.js +78 -18
- package/node_modules/checkride/dist/pm/translate.js.map +1 -1
- package/node_modules/checkride/dist/proc.d.ts +30 -0
- package/node_modules/checkride/dist/proc.d.ts.map +1 -0
- package/node_modules/checkride/dist/proc.js +42 -0
- package/node_modules/checkride/dist/proc.js.map +1 -0
- package/node_modules/checkride/dist/qa/cli.d.ts +20 -0
- package/node_modules/checkride/dist/qa/cli.d.ts.map +1 -0
- package/node_modules/checkride/dist/qa/cli.js +24 -0
- package/node_modules/checkride/dist/qa/cli.js.map +1 -0
- package/node_modules/checkride/dist/qa/dead.d.ts +39 -0
- package/node_modules/checkride/dist/qa/dead.d.ts.map +1 -0
- package/node_modules/checkride/dist/qa/dead.js +88 -0
- package/node_modules/checkride/dist/qa/dead.js.map +1 -0
- package/node_modules/checkride/dist/qa/dupes.d.ts +45 -0
- package/node_modules/checkride/dist/qa/dupes.d.ts.map +1 -0
- package/node_modules/checkride/dist/qa/dupes.js +62 -0
- package/node_modules/checkride/dist/qa/dupes.js.map +1 -0
- package/node_modules/checkride/dist/qa/health.d.ts +85 -0
- package/node_modules/checkride/dist/qa/health.d.ts.map +1 -0
- package/node_modules/checkride/dist/qa/health.js +109 -0
- package/node_modules/checkride/dist/qa/health.js.map +1 -0
- package/node_modules/checkride/dist/qa/index.d.ts +23 -0
- package/node_modules/checkride/dist/qa/index.d.ts.map +1 -0
- package/node_modules/checkride/dist/qa/index.js +22 -0
- package/node_modules/checkride/dist/qa/index.js.map +1 -0
- package/node_modules/checkride/dist/qa/mutation.d.ts +80 -0
- package/node_modules/checkride/dist/qa/mutation.d.ts.map +1 -0
- package/node_modules/checkride/dist/qa/mutation.js +195 -0
- package/node_modules/checkride/dist/qa/mutation.js.map +1 -0
- package/node_modules/checkride/dist/qa/qa.d.ts +71 -0
- package/node_modules/checkride/dist/qa/qa.d.ts.map +1 -0
- package/node_modules/checkride/dist/qa/qa.js +158 -0
- package/node_modules/checkride/dist/qa/qa.js.map +1 -0
- package/node_modules/checkride/dist/qa/read.d.ts +40 -0
- package/node_modules/checkride/dist/qa/read.d.ts.map +1 -0
- package/node_modules/checkride/dist/qa/read.js +47 -0
- package/node_modules/checkride/dist/qa/read.js.map +1 -0
- package/node_modules/checkride/dist/qa/render.d.ts +26 -0
- package/node_modules/checkride/dist/qa/render.d.ts.map +1 -0
- package/node_modules/checkride/dist/qa/render.js +310 -0
- package/node_modules/checkride/dist/qa/render.js.map +1 -0
- package/node_modules/checkride/dist/security.d.ts +45 -0
- package/node_modules/checkride/dist/security.d.ts.map +1 -0
- package/node_modules/checkride/dist/security.js +86 -0
- package/node_modules/checkride/dist/security.js.map +1 -0
- package/node_modules/checkride/dist/smoke.d.ts +5 -5
- package/node_modules/checkride/dist/smoke.js +5 -5
- package/node_modules/checkride/dist/snippets.d.ts +26 -29
- package/node_modules/checkride/dist/snippets.d.ts.map +1 -1
- package/node_modules/checkride/dist/snippets.js +26 -30
- package/node_modules/checkride/dist/snippets.js.map +1 -1
- package/node_modules/checkride/dist/tool-json.d.ts +33 -0
- package/node_modules/checkride/dist/tool-json.d.ts.map +1 -0
- package/node_modules/checkride/dist/tool-json.js +58 -0
- package/node_modules/checkride/dist/tool-json.js.map +1 -0
- package/node_modules/checkride/dist/triage/cli.d.ts +21 -0
- package/node_modules/checkride/dist/triage/cli.d.ts.map +1 -0
- package/node_modules/checkride/dist/triage/cli.js +26 -0
- package/node_modules/checkride/dist/triage/cli.js.map +1 -0
- package/node_modules/checkride/dist/triage/doctor-fold.d.ts +51 -0
- package/node_modules/checkride/dist/triage/doctor-fold.d.ts.map +1 -0
- package/node_modules/checkride/dist/triage/doctor-fold.js +88 -0
- package/node_modules/checkride/dist/triage/doctor-fold.js.map +1 -0
- package/node_modules/checkride/dist/triage/env.d.ts +54 -0
- package/node_modules/checkride/dist/triage/env.d.ts.map +1 -0
- package/node_modules/checkride/dist/triage/env.js +81 -0
- package/node_modules/checkride/dist/triage/env.js.map +1 -0
- package/node_modules/checkride/dist/triage/gate.d.ts +61 -0
- package/node_modules/checkride/dist/triage/gate.d.ts.map +1 -0
- package/node_modules/checkride/dist/triage/gate.js +121 -0
- package/node_modules/checkride/dist/triage/gate.js.map +1 -0
- package/node_modules/checkride/dist/triage/index.d.ts +22 -0
- package/node_modules/checkride/dist/triage/index.d.ts.map +1 -0
- package/node_modules/checkride/dist/triage/index.js +20 -0
- package/node_modules/checkride/dist/triage/index.js.map +1 -0
- package/node_modules/checkride/dist/triage/render.d.ts +19 -0
- package/node_modules/checkride/dist/triage/render.d.ts.map +1 -0
- package/node_modules/checkride/dist/triage/render.js +419 -0
- package/node_modules/checkride/dist/triage/render.js.map +1 -0
- package/node_modules/checkride/dist/triage/triage.d.ts +83 -0
- package/node_modules/checkride/dist/triage/triage.d.ts.map +1 -0
- package/node_modules/checkride/dist/triage/triage.js +131 -0
- package/node_modules/checkride/dist/triage/triage.js.map +1 -0
- package/node_modules/checkride/package.json +17 -15
- package/node_modules/checkride/schema/checkride.config.schema.json +62 -5
- package/node_modules/checkride/schema/checkride.summary.schema.json +1 -1
- package/node_modules/checkride/skills/check/SKILL.md +257 -0
- package/node_modules/checkride/skills/qa/SKILL.md +231 -0
- package/node_modules/checkride/templates/shared/cspell.json +1 -0
- package/node_modules/checkride/templates/shared/oxlintrc.json +1 -1
- package/package.json +2 -2
- package/skills/build/SKILL.md +23 -19
- package/skills/finish/SKILL.md +3 -1
- package/skills/harvest/SKILL.md +2 -1
- package/skills/plan/SKILL.md +8 -7
- package/skills/recover/SKILL.md +28 -0
- package/skills/refine/SKILL.md +5 -4
- package/skills/spike/SKILL.md +1 -1
- package/skills/step/SKILL.md +4 -4
- package/skills/verify/SKILL.md +19 -14
- package/templates/intent.md +8 -7
|
@@ -1,21 +1,201 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
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
|
-
**
|
|
6
|
-
|
|
7
|
-
|
|
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.**
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
Philosophy of Software Design
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
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
|
-
|
|
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
|
|
56
|
-
`.claude/settings.json`
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
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,24 @@ 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
|
-
--
|
|
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 +
|
|
107
|
-
--
|
|
158
|
+
checkride agent-setup Add the "check" alias, AGENTS.md stanza + agent hooks to a repo.
|
|
159
|
+
--hook <a,b> write only these hooks (gate | dirty | protect)
|
|
160
|
+
--no-hook skip the hooks (write only the stanza)
|
|
161
|
+
--remove-hook <a,b> remove these installed hooks; with --no-hook, remove only
|
|
162
|
+
--harness <a,b> which harnesses to write for (claude | cursor; default: detected)
|
|
163
|
+
--force refresh a stanza that has local edits (refused otherwise)
|
|
164
|
+
checkride gate Run the check script as a stop gate, answering a harness's
|
|
165
|
+
hook protocol. The generated hook scripts invoke this.
|
|
166
|
+
checkride triage Triage a red gate: run it, then read .check/ as a bounded report.
|
|
167
|
+
checkride qa Read the quality artifacts a previous run left.
|
|
108
168
|
```
|
|
109
169
|
|
|
110
170
|
During iteration, narrow the loop: `checkride --bail`, `checkride --only
|
|
@@ -127,7 +187,7 @@ generates config for the blessed default.
|
|
|
127
187
|
| `types` | Type checking | `tsc --build` | — |
|
|
128
188
|
| `format` | Formatting (opt-in) | `prettier` | `biome` |
|
|
129
189
|
| `lint` | Linting | `oxlint` | `biome`, `eslint`|
|
|
130
|
-
| `struct` | Structural rules (deep modules)
|
|
190
|
+
| `struct` | Structural rules (deep modules by default) | `ast-grep` | — |
|
|
131
191
|
| `dead` | Dead code, deps, cycles, boundaries | `fallow` (dead-code)| `knip` |
|
|
132
192
|
| `dupes` | Code duplication (opt-in) | `fallow` (dupes) | — |
|
|
133
193
|
| `health` | Complexity / maintainability (opt-in) | `fallow` (health) | — |
|
|
@@ -140,6 +200,11 @@ generates config for the blessed default.
|
|
|
140
200
|
| `publint` | Package publishing lint (opt-in) | `publint` | — |
|
|
141
201
|
| `attw` | Type resolution across module systems (opt-in) | `attw --pack`| — |
|
|
142
202
|
|
|
203
|
+
Most of these tools you already know. The one unfamiliar name, `fallow`, is a
|
|
204
|
+
Rust-native codebase-analysis tool covering dead code, duplication, and
|
|
205
|
+
complexity; the [tools guide](./docs/tools.md) covers it and every other
|
|
206
|
+
adapter.
|
|
207
|
+
|
|
143
208
|
Zero-config: for each slot, checkride runs the first adapter whose config file
|
|
144
209
|
exists, and skips slots with no detected tool. The core has **no runtime
|
|
145
210
|
dependency** on any checked tool — it spawns `<pm> exec <tool>`; the project
|
|
@@ -152,6 +217,12 @@ it in `checks`**: an explicit entry like `"format": "prettier"` opts the slot in
|
|
|
152
217
|
run. `checkride fix` then runs its write form (e.g. `prettier --write`) alongside the
|
|
153
218
|
other fixers. `format` sits before `lint` so the tree is tidy before the linters look.
|
|
154
219
|
|
|
220
|
+
To **configure a slot without opting it in** — say, give `attw` a `--profile` but keep it
|
|
221
|
+
in the full sweep only — add `"optIn": true` to its entry: it stays out of the default run
|
|
222
|
+
and runs solely under `--all`/`--include <slot>`. The same field demotes a normally-default
|
|
223
|
+
slot (or a heavy custom check like `test:integration`) to full-sweep-only; `"optIn": false`
|
|
224
|
+
does the opposite, forcing a slot into the default run.
|
|
225
|
+
|
|
155
226
|
`publint` and `attw` are the **library-publishing** pair — turn them on for a package you
|
|
156
227
|
ship to npm to make "the published artifact is correct" part of your definition of done.
|
|
157
228
|
`publint` lints `package.json`'s publishing surface (exports, files, types); `attw` runs
|
|
@@ -225,6 +296,36 @@ To debug a failure: read `summary.json` to find the failing slot, then read that
|
|
|
225
296
|
slot's raw output for structured diagnostics. On a large repo, `--digest` writes
|
|
226
297
|
`digest.md` as a capped starting point.
|
|
227
298
|
|
|
299
|
+
## The Claude Code plugin
|
|
300
|
+
|
|
301
|
+
The package root is also a [Claude Code](https://claude.com/claude-code) plugin
|
|
302
|
+
— two skills that consume the contract above, bundled in the same npm package
|
|
303
|
+
and versioned with it:
|
|
304
|
+
|
|
305
|
+
```text
|
|
306
|
+
/plugin marketplace add robmclarty/agent-tools
|
|
307
|
+
/plugin install checkride@robmclarty
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
- **`/checkride:check`** — triage a red gate. It runs the repo's own `check`
|
|
311
|
+
script, branches on the promised 0/1/2 exit split, and names **one root cause**
|
|
312
|
+
plus what it is deliberately not reading. It covers the corners a summary read
|
|
313
|
+
by hand gets wrong — exit 2 versus exit 1, vacuous green, a narrow run's green,
|
|
314
|
+
`baselined` counts, `skipped` slots, `exit_code: -1`, stale artifacts — then
|
|
315
|
+
opens exactly one raw file.
|
|
316
|
+
- **`/checkride:qa`** — read the quality signal. It folds `mutation.json`,
|
|
317
|
+
`dead.json`, `dupes.json` and `health.json` into a report under 8 kB, runs
|
|
318
|
+
nothing, and reports which dimensions were never measured rather than guessing
|
|
319
|
+
at them.
|
|
320
|
+
|
|
321
|
+
Both are **readers**: no new command, no new flag, no config, no hook. They
|
|
322
|
+
exist because reading `.check/` by hand is unbounded (`mutation.json` is 2.2 MB
|
|
323
|
+
in this repo) and credulous (every run overwrites `summary.json`, so an
|
|
324
|
+
`ok: true` on disk may describe three of seventeen slots from a while ago). The
|
|
325
|
+
readers ship prebuilt in `dist/`, so installing the plugin needs no build step,
|
|
326
|
+
and they run without it too — `node node_modules/checkride/dist/triage/cli.js`
|
|
327
|
+
prints the same report. Full details in [docs/plugin.md](./docs/plugin.md).
|
|
328
|
+
|
|
228
329
|
## Configuration
|
|
229
330
|
|
|
230
331
|
`checkride.config.json` is optional — add it only to deviate from the defaults:
|
|
@@ -246,12 +347,29 @@ slot's raw output for structured diagnostics. On a large repo, `--digest` writes
|
|
|
246
347
|
},
|
|
247
348
|
"licenses": { // a custom check (runs last by default)
|
|
248
349
|
"command": "node",
|
|
249
|
-
"args": ["scripts/check-licenses.mjs"]
|
|
350
|
+
"args": ["scripts/check-licenses.mjs"],
|
|
351
|
+
"description": "License audit", // rendered beside the check in the output
|
|
352
|
+
"note": "Legal asked for this in RFC-114; drop it when the SBOM job lands."
|
|
250
353
|
}
|
|
251
354
|
}
|
|
252
355
|
}
|
|
253
356
|
```
|
|
254
357
|
|
|
358
|
+
### `description` vs `note`
|
|
359
|
+
|
|
360
|
+
Two strings, deliberately not one. **`description`** is user-facing: it is the
|
|
361
|
+
text a run prints beside the check in its status line and records in
|
|
362
|
+
`.check/summary.json`, so it wants to be short. **`note`** is the opposite —
|
|
363
|
+
maintainer commentary that never renders anywhere, the JSON-comment this file
|
|
364
|
+
otherwise has no room for. Put "why is this check here", "revisit after the
|
|
365
|
+
2.0 upgrade", or a ticket number in `note` and keep the output readable.
|
|
366
|
+
|
|
367
|
+
`note` is accepted on any check entry — an adapter override (`{ "use": … }`) or
|
|
368
|
+
a custom check (`{ "command": … }`) — and at the top level of the file for a
|
|
369
|
+
note about the config as a whole. It is validated as a string (a typo is a
|
|
370
|
+
config error, not silence) and then dropped: no code path carries it onto an
|
|
371
|
+
adapter, so it cannot reach the CLI output or the summary.
|
|
372
|
+
|
|
255
373
|
### The `$schema` pointer
|
|
256
374
|
|
|
257
375
|
The `"$schema"` pointer is optional but recommended: it turns on validation and
|
|
@@ -296,6 +414,10 @@ that don't all use the same tools. An `extends` that can't be found, or a config
|
|
|
296
414
|
that extends itself in a loop, fails fast with
|
|
297
415
|
`invalid checkride.config.json: <reason>`.
|
|
298
416
|
|
|
417
|
+
For operating a preset across many repos — versioning it, rolling a rule out as
|
|
418
|
+
a release, and automating the per-repo bump — see
|
|
419
|
+
[Running a fleet with shared presets](./docs/presets.md).
|
|
420
|
+
|
|
299
421
|
### Timeouts
|
|
300
422
|
|
|
301
423
|
A per-check timeout guards against a hung tool, and it is **on by default**: a
|
|
@@ -392,7 +514,9 @@ with `--only`/`--changed`, not per-directory.
|
|
|
392
514
|
|
|
393
515
|
## Conventions
|
|
394
516
|
|
|
395
|
-
|
|
517
|
+
`init` scaffolds one **default** convention — [deep
|
|
518
|
+
modules](./docs/deep-modules.md), whose boundaries are enforced by `ast-grep`
|
|
519
|
+
(the `struct` slot) and `fallow`:
|
|
396
520
|
|
|
397
521
|
- A module is a unit of encapsulation. A single file is a module; promote it to
|
|
398
522
|
a folder with a barrel `index.ts` when it grows internals worth hiding — a
|
|
@@ -403,6 +527,23 @@ Module boundaries, enforced by `ast-grep` and `fallow`:
|
|
|
403
527
|
- Named exports only; no classes; `.js` extensions on relative imports
|
|
404
528
|
(NodeNext); tests colocated with the code they cover.
|
|
405
529
|
|
|
530
|
+
None of this is hardcoded into checkride. The `struct` slot just runs whatever
|
|
531
|
+
ast-grep rules live in your repo's `rules/` directory (the barrel rule is
|
|
532
|
+
`rules/no-deep-sibling-import.yml`), so the convention is whatever those files
|
|
533
|
+
encode:
|
|
534
|
+
|
|
535
|
+
- **A different convention, same language.** Edit or replace the rules to match
|
|
536
|
+
how your repo is organized — public/private folders, a naming prefix, an
|
|
537
|
+
allowed-import list — and `struct` enforces the new shape unchanged.
|
|
538
|
+
- **Another language.** ast-grep is polyglot; set each rule's `language`
|
|
539
|
+
(`typescript`, `python`, `go`, `rust`, …) and the same slot covers boundaries
|
|
540
|
+
there.
|
|
541
|
+
- **Beyond ast-grep.** When a rule can't be expressed in ast-grep, or lives in
|
|
542
|
+
another ecosystem's tooling (`import-linter`, `depguard`, `dependency-cruiser`),
|
|
543
|
+
wire it as a [custom check](./docs/tools.md#when-to-write-a-custom-check).
|
|
544
|
+
|
|
545
|
+
checkride ships an opinionated default; it does not lock you to it.
|
|
546
|
+
|
|
406
547
|
## Tested envelope
|
|
407
548
|
|
|
408
549
|
Every push runs the full suite — unit, contract, and end-to-end (generated
|
|
@@ -444,4 +585,4 @@ every public type are re-exported too. The full surface is the package's
|
|
|
444
585
|
|
|
445
586
|
## License
|
|
446
587
|
|
|
447
|
-
[
|
|
588
|
+
[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
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"released-stanzas.js","sourceRoot":"","sources":["../../../src/__tests__/fixtures/released-stanzas.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAA+C;IAC1E,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,o+BAAo+B,EAAE;IACtgC,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,gpDAAgpD,EAAE;IAClrD,EAAE,KAAK,EAAE,eAAe,EAAE,IAAI,EAAE,wuDAAwuD,EAAE;IAC1wD,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,q0DAAq0D,EAAE;CACl2D,CAAC"}
|
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
* data only: no logic lives here. Resolution (config vs detection) lives in
|
|
7
7
|
* `../config`, and execution lives in `../orchestrator`.
|
|
8
8
|
*
|
|
9
|
-
*
|
|
10
|
-
* security, and the library-publishing
|
|
11
|
-
* knip, eslint, jest)
|
|
9
|
+
* The catalogue covers the blessed defaults, the opt-in slots (format,
|
|
10
|
+
* mutation, security, and the library-publishing checks), and alternate
|
|
11
|
+
* adapters (biome, knip, eslint, jest) that fill a slot when detected.
|
|
12
12
|
*/
|
|
13
13
|
/** The aggregate-report schema version written to `.check/summary.json`. */
|
|
14
14
|
export declare const SCHEMA_VERSION = 1;
|
|
@@ -45,20 +45,20 @@ export type Adapter = {
|
|
|
45
45
|
name: string;
|
|
46
46
|
/** The slot this adapter fills, e.g. `'lint'`. */
|
|
47
47
|
slot: string;
|
|
48
|
-
/** Human description for the report
|
|
48
|
+
/** Human description for the report. */
|
|
49
49
|
description: string;
|
|
50
50
|
/** Config files whose presence activates this adapter. `[]` = always available. */
|
|
51
51
|
detect: string[];
|
|
52
52
|
/**
|
|
53
53
|
* Detection by package script: the slot is available when `scripts.<name>`
|
|
54
54
|
* exists in package.json. `build` uses `scripts.build` — an opted-in `build`
|
|
55
|
-
* on a repo with no build script stands down as a skip, never a red check
|
|
55
|
+
* on a repo with no build script stands down as a skip, never a red check.
|
|
56
56
|
*/
|
|
57
57
|
detectScript?: string;
|
|
58
58
|
/**
|
|
59
59
|
* Backup detection signal: the slot activates when a `detect` file exists OR
|
|
60
60
|
* one of these packages appears in dependencies/devDependencies. Populated only
|
|
61
|
-
* on adapters whose tool runs correctly with zero config
|
|
61
|
+
* on adapters whose tool runs correctly with zero config, so a repo that
|
|
62
62
|
* installed the tool but never wrote its config file still opts in.
|
|
63
63
|
*/
|
|
64
64
|
detectDeps?: string[];
|
|
@@ -76,6 +76,18 @@ export type Adapter = {
|
|
|
76
76
|
timeout?: number;
|
|
77
77
|
/** In-process check id (e.g. `'links'`); when set, the orchestrator runs it directly. */
|
|
78
78
|
builtin?: string;
|
|
79
|
+
/**
|
|
80
|
+
* Consumed by the `links` built-in only: extra directory names to skip while
|
|
81
|
+
* walking for markdown, on top of its built-in exclude set. Carried from a
|
|
82
|
+
* config entry's `exclude`; ignored by every other adapter.
|
|
83
|
+
*/
|
|
84
|
+
exclude?: string[];
|
|
85
|
+
/**
|
|
86
|
+
* Consumed by the `links` built-in only: regex sources for link targets to
|
|
87
|
+
* treat as always-valid (deliberately illustrative links). Carried from a
|
|
88
|
+
* config entry's `allowlist` and validated at config load; ignored elsewhere.
|
|
89
|
+
*/
|
|
90
|
+
allowlist?: string[];
|
|
79
91
|
/**
|
|
80
92
|
* When set, checkride derives this adapter's pass/fail from its parsed JSON
|
|
81
93
|
* output instead of its process exit code. Only `'fallow'` today: fallow's
|