@paths.design/caws-cli 9.3.2 → 10.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (273) hide show
  1. package/README.md +58 -27
  2. package/dist/commands/archive.js +67 -28
  3. package/dist/commands/burnup.js +20 -11
  4. package/dist/commands/diagnose.js +34 -22
  5. package/dist/commands/evaluate.js +27 -15
  6. package/dist/commands/gates.js +122 -0
  7. package/dist/commands/init.js +143 -15
  8. package/dist/commands/iterate.js +77 -4
  9. package/dist/commands/parallel.js +4 -0
  10. package/dist/commands/plan.js +9 -19
  11. package/dist/commands/provenance.js +53 -17
  12. package/dist/commands/quality-monitor.js +64 -45
  13. package/dist/commands/sidecar.js +71 -0
  14. package/dist/commands/specs.js +233 -44
  15. package/dist/commands/status.js +113 -9
  16. package/dist/commands/tutorial.js +10 -9
  17. package/dist/commands/validate.js +49 -6
  18. package/dist/commands/verify-acs.js +35 -78
  19. package/dist/commands/waivers.js +69 -12
  20. package/dist/commands/worktree.js +50 -25
  21. package/dist/error-handler.js +2 -13
  22. package/dist/gates/budget-limit.js +116 -0
  23. package/dist/gates/feedback.js +260 -0
  24. package/dist/gates/format.js +179 -0
  25. package/dist/gates/god-object.js +117 -0
  26. package/dist/gates/pipeline.js +167 -0
  27. package/dist/gates/scope-boundary.js +93 -0
  28. package/dist/gates/spec-completeness.js +102 -0
  29. package/dist/gates/todo-detection.js +205 -0
  30. package/dist/index.js +130 -151
  31. package/dist/parallel/parallel-manager.js +3 -3
  32. package/dist/policy/PolicyManager.js +42 -10
  33. package/dist/scaffold/claude-hooks.js +24 -1
  34. package/dist/scaffold/git-hooks.js +45 -102
  35. package/dist/scaffold/index.js +4 -3
  36. package/dist/session/session-manager.js +71 -14
  37. package/dist/sidecars/index.js +33 -0
  38. package/dist/sidecars/listeners.js +40 -0
  39. package/dist/sidecars/provenance-summary.js +238 -0
  40. package/dist/sidecars/quality-gaps.js +258 -0
  41. package/dist/sidecars/schema.js +149 -0
  42. package/dist/sidecars/spec-drift.js +151 -0
  43. package/dist/sidecars/waiver-draft.js +176 -0
  44. package/dist/templates/.caws/schemas/policy.schema.json +50 -0
  45. package/dist/templates/.caws/schemas/waivers.schema.json +30 -24
  46. package/dist/templates/.caws/schemas/working-spec.schema.json +51 -8
  47. package/dist/templates/.caws/schemas/worktrees.schema.json +3 -1
  48. package/dist/templates/.caws/templates/working-spec.template.yml +7 -3
  49. package/dist/templates/.claude/hooks/audit.sh +0 -0
  50. package/dist/templates/.claude/hooks/block-dangerous.sh +52 -11
  51. package/dist/templates/.claude/hooks/classify_command.py +592 -0
  52. package/dist/templates/.claude/hooks/doc-frontmatter-check.sh +173 -0
  53. package/dist/templates/.claude/hooks/quality-check.sh +23 -10
  54. package/dist/templates/.claude/hooks/scope-guard.sh +34 -32
  55. package/dist/templates/.claude/hooks/session-caws-status.sh +2 -2
  56. package/dist/templates/.claude/hooks/session-log.sh +76 -3
  57. package/dist/templates/.claude/hooks/stop-worktree-check.sh +1 -1
  58. package/dist/templates/.claude/hooks/test_classify_command.py +370 -0
  59. package/dist/templates/.claude/hooks/test_wrapper_smoke.sh +96 -0
  60. package/dist/templates/.claude/hooks/worktree-guard.sh +2 -2
  61. package/dist/templates/.claude/hooks/worktree-write-guard.sh +1 -1
  62. package/dist/templates/.claude/settings.json +26 -0
  63. package/dist/templates/.cursor/hooks/caws-quality-check.sh +4 -4
  64. package/dist/templates/.cursor/hooks/caws-scope-guard.sh +1 -1
  65. package/dist/templates/.cursor/hooks/session-log.sh +924 -0
  66. package/dist/templates/.cursor/hooks.json +25 -0
  67. package/dist/templates/.cursor/rules/02-quality-gates.mdc +3 -5
  68. package/dist/templates/.cursor/rules/10-documentation-quality-standards.mdc +6 -11
  69. package/dist/templates/.cursor/rules/11-scope-management-waivers.mdc +14 -18
  70. package/dist/templates/.cursor/rules/12-implementation-completeness.mdc +4 -4
  71. package/dist/templates/.cursor/rules/13-language-agnostic-standards.mdc +3 -13
  72. package/dist/templates/.github/copilot-instructions.md +5 -5
  73. package/dist/templates/.idea/runConfigurations/CAWS_Evaluate.xml +1 -1
  74. package/dist/templates/.junie/guidelines.md +2 -2
  75. package/dist/templates/.vscode/settings.json +3 -1
  76. package/dist/templates/.windsurf/rules/caws-quality-standards.md +2 -2
  77. package/dist/templates/.windsurf/workflows/caws-guided-development.md +3 -3
  78. package/dist/templates/CLAUDE.md +43 -8
  79. package/dist/templates/agents.md +29 -9
  80. package/dist/templates/docs/README.md +8 -7
  81. package/dist/templates/scripts/new_feature.sh +80 -0
  82. package/dist/test-analysis.js +43 -30
  83. package/dist/tool-loader.js +1 -1
  84. package/dist/utils/agent-session.js +202 -0
  85. package/dist/utils/detection.js +8 -2
  86. package/dist/utils/finalization.js +7 -6
  87. package/dist/utils/gitignore-updater.js +3 -0
  88. package/dist/utils/lifecycle-events.js +94 -0
  89. package/dist/utils/quality-gates-utils.js +29 -44
  90. package/dist/utils/schema-validator.js +42 -0
  91. package/dist/utils/spec-resolver.js +93 -21
  92. package/dist/utils/working-state.js +505 -0
  93. package/dist/validation/spec-validation.js +92 -22
  94. package/dist/waivers-manager.js +60 -6
  95. package/dist/worktree/worktree-manager.js +390 -93
  96. package/package.json +6 -6
  97. package/templates/.caws/schemas/policy.schema.json +50 -0
  98. package/templates/.caws/schemas/waivers.schema.json +30 -24
  99. package/templates/.caws/schemas/working-spec.schema.json +51 -8
  100. package/templates/.caws/schemas/worktrees.schema.json +3 -1
  101. package/templates/.caws/templates/working-spec.template.yml +7 -3
  102. package/templates/.claude/hooks/block-dangerous.sh +52 -11
  103. package/templates/.claude/hooks/classify_command.py +592 -0
  104. package/templates/.claude/hooks/doc-frontmatter-check.sh +173 -0
  105. package/templates/.claude/hooks/quality-check.sh +23 -10
  106. package/templates/.claude/hooks/scope-guard.sh +34 -32
  107. package/templates/.claude/hooks/session-caws-status.sh +2 -2
  108. package/templates/.claude/hooks/session-log.sh +76 -3
  109. package/templates/.claude/hooks/stop-worktree-check.sh +1 -1
  110. package/templates/.claude/hooks/test_classify_command.py +370 -0
  111. package/templates/.claude/hooks/test_wrapper_smoke.sh +96 -0
  112. package/templates/.claude/hooks/worktree-guard.sh +2 -2
  113. package/templates/.claude/hooks/worktree-write-guard.sh +1 -1
  114. package/templates/.claude/settings.json +26 -0
  115. package/templates/.cursor/hooks/caws-quality-check.sh +4 -4
  116. package/templates/.cursor/hooks/caws-scope-guard.sh +1 -1
  117. package/templates/.cursor/hooks/session-log.sh +924 -0
  118. package/templates/.cursor/hooks.json +25 -0
  119. package/templates/.cursor/rules/02-quality-gates.mdc +3 -5
  120. package/templates/.cursor/rules/10-documentation-quality-standards.mdc +6 -11
  121. package/templates/.cursor/rules/11-scope-management-waivers.mdc +14 -18
  122. package/templates/.cursor/rules/12-implementation-completeness.mdc +4 -4
  123. package/templates/.cursor/rules/13-language-agnostic-standards.mdc +3 -13
  124. package/templates/.github/copilot-instructions.md +5 -5
  125. package/templates/.idea/runConfigurations/CAWS_Evaluate.xml +1 -1
  126. package/templates/.junie/guidelines.md +2 -2
  127. package/templates/.vscode/settings.json +3 -1
  128. package/templates/.windsurf/rules/caws-quality-standards.md +2 -2
  129. package/templates/.windsurf/workflows/caws-guided-development.md +3 -3
  130. package/templates/CLAUDE.md +43 -8
  131. package/templates/{AGENTS.md → agents.md} +29 -9
  132. package/templates/docs/README.md +8 -7
  133. package/templates/scripts/new_feature.sh +80 -0
  134. package/dist/budget-derivation.d.ts +0 -74
  135. package/dist/budget-derivation.d.ts.map +0 -1
  136. package/dist/cicd-optimizer.d.ts +0 -142
  137. package/dist/cicd-optimizer.d.ts.map +0 -1
  138. package/dist/commands/archive.d.ts +0 -51
  139. package/dist/commands/archive.d.ts.map +0 -1
  140. package/dist/commands/burnup.d.ts +0 -6
  141. package/dist/commands/burnup.d.ts.map +0 -1
  142. package/dist/commands/diagnose.d.ts +0 -52
  143. package/dist/commands/diagnose.d.ts.map +0 -1
  144. package/dist/commands/evaluate.d.ts +0 -8
  145. package/dist/commands/evaluate.d.ts.map +0 -1
  146. package/dist/commands/init.d.ts +0 -5
  147. package/dist/commands/init.d.ts.map +0 -1
  148. package/dist/commands/iterate.d.ts +0 -8
  149. package/dist/commands/iterate.d.ts.map +0 -1
  150. package/dist/commands/mode.d.ts +0 -25
  151. package/dist/commands/mode.d.ts.map +0 -1
  152. package/dist/commands/parallel.d.ts +0 -7
  153. package/dist/commands/parallel.d.ts.map +0 -1
  154. package/dist/commands/plan.d.ts +0 -49
  155. package/dist/commands/plan.d.ts.map +0 -1
  156. package/dist/commands/provenance.d.ts +0 -32
  157. package/dist/commands/provenance.d.ts.map +0 -1
  158. package/dist/commands/quality-gates.d.ts +0 -6
  159. package/dist/commands/quality-gates.d.ts.map +0 -1
  160. package/dist/commands/quality-gates.js +0 -444
  161. package/dist/commands/quality-monitor.d.ts +0 -17
  162. package/dist/commands/quality-monitor.d.ts.map +0 -1
  163. package/dist/commands/session.d.ts +0 -7
  164. package/dist/commands/session.d.ts.map +0 -1
  165. package/dist/commands/specs.d.ts +0 -77
  166. package/dist/commands/specs.d.ts.map +0 -1
  167. package/dist/commands/status.d.ts +0 -44
  168. package/dist/commands/status.d.ts.map +0 -1
  169. package/dist/commands/templates.d.ts +0 -74
  170. package/dist/commands/templates.d.ts.map +0 -1
  171. package/dist/commands/tool.d.ts +0 -13
  172. package/dist/commands/tool.d.ts.map +0 -1
  173. package/dist/commands/troubleshoot.d.ts +0 -8
  174. package/dist/commands/troubleshoot.d.ts.map +0 -1
  175. package/dist/commands/troubleshoot.js +0 -104
  176. package/dist/commands/tutorial.d.ts +0 -55
  177. package/dist/commands/tutorial.d.ts.map +0 -1
  178. package/dist/commands/validate.d.ts +0 -15
  179. package/dist/commands/validate.d.ts.map +0 -1
  180. package/dist/commands/waivers.d.ts +0 -8
  181. package/dist/commands/waivers.d.ts.map +0 -1
  182. package/dist/commands/workflow.d.ts +0 -85
  183. package/dist/commands/workflow.d.ts.map +0 -1
  184. package/dist/commands/worktree.d.ts +0 -7
  185. package/dist/commands/worktree.d.ts.map +0 -1
  186. package/dist/config/index.d.ts +0 -29
  187. package/dist/config/index.d.ts.map +0 -1
  188. package/dist/config/lite-scope.d.ts +0 -33
  189. package/dist/config/lite-scope.d.ts.map +0 -1
  190. package/dist/config/modes.d.ts +0 -264
  191. package/dist/config/modes.d.ts.map +0 -1
  192. package/dist/constants/spec-types.d.ts +0 -93
  193. package/dist/constants/spec-types.d.ts.map +0 -1
  194. package/dist/error-handler.d.ts +0 -151
  195. package/dist/error-handler.d.ts.map +0 -1
  196. package/dist/generators/jest-config-generator.d.ts +0 -32
  197. package/dist/generators/jest-config-generator.d.ts.map +0 -1
  198. package/dist/generators/jest-config.d.ts +0 -32
  199. package/dist/generators/jest-config.d.ts.map +0 -1
  200. package/dist/generators/jest-config.js +0 -242
  201. package/dist/generators/working-spec.d.ts +0 -13
  202. package/dist/generators/working-spec.d.ts.map +0 -1
  203. package/dist/index-new.d.ts +0 -5
  204. package/dist/index-new.d.ts.map +0 -1
  205. package/dist/index-new.js +0 -317
  206. package/dist/index.d.ts +0 -5
  207. package/dist/index.d.ts.map +0 -1
  208. package/dist/index.js.backup +0 -4711
  209. package/dist/minimal-cli.d.ts +0 -3
  210. package/dist/minimal-cli.d.ts.map +0 -1
  211. package/dist/parallel/parallel-manager.d.ts +0 -67
  212. package/dist/parallel/parallel-manager.d.ts.map +0 -1
  213. package/dist/policy/PolicyManager.d.ts +0 -104
  214. package/dist/policy/PolicyManager.d.ts.map +0 -1
  215. package/dist/scaffold/claude-hooks.d.ts +0 -28
  216. package/dist/scaffold/claude-hooks.d.ts.map +0 -1
  217. package/dist/scaffold/cursor-hooks.d.ts +0 -7
  218. package/dist/scaffold/cursor-hooks.d.ts.map +0 -1
  219. package/dist/scaffold/git-hooks.d.ts +0 -38
  220. package/dist/scaffold/git-hooks.d.ts.map +0 -1
  221. package/dist/scaffold/index.d.ts +0 -17
  222. package/dist/scaffold/index.d.ts.map +0 -1
  223. package/dist/session/session-manager.d.ts +0 -94
  224. package/dist/session/session-manager.d.ts.map +0 -1
  225. package/dist/spec/SpecFileManager.d.ts +0 -146
  226. package/dist/spec/SpecFileManager.d.ts.map +0 -1
  227. package/dist/templates/.cursor/hooks/caws-tool-validation.sh +0 -121
  228. package/dist/templates/.github/copilot/instructions.md +0 -311
  229. package/dist/test-analysis.d.ts +0 -231
  230. package/dist/test-analysis.d.ts.map +0 -1
  231. package/dist/tool-interface.d.ts +0 -236
  232. package/dist/tool-interface.d.ts.map +0 -1
  233. package/dist/tool-loader.d.ts +0 -77
  234. package/dist/tool-loader.d.ts.map +0 -1
  235. package/dist/tool-validator.d.ts +0 -72
  236. package/dist/tool-validator.d.ts.map +0 -1
  237. package/dist/utils/async-utils.d.ts +0 -73
  238. package/dist/utils/async-utils.d.ts.map +0 -1
  239. package/dist/utils/command-wrapper.d.ts +0 -66
  240. package/dist/utils/command-wrapper.d.ts.map +0 -1
  241. package/dist/utils/detection.d.ts +0 -14
  242. package/dist/utils/detection.d.ts.map +0 -1
  243. package/dist/utils/error-categories.d.ts +0 -52
  244. package/dist/utils/error-categories.d.ts.map +0 -1
  245. package/dist/utils/finalization.d.ts +0 -17
  246. package/dist/utils/finalization.d.ts.map +0 -1
  247. package/dist/utils/git-lock.d.ts +0 -13
  248. package/dist/utils/git-lock.d.ts.map +0 -1
  249. package/dist/utils/gitignore-updater.d.ts +0 -39
  250. package/dist/utils/gitignore-updater.d.ts.map +0 -1
  251. package/dist/utils/ide-detection.d.ts +0 -89
  252. package/dist/utils/ide-detection.d.ts.map +0 -1
  253. package/dist/utils/project-analysis.d.ts +0 -34
  254. package/dist/utils/project-analysis.d.ts.map +0 -1
  255. package/dist/utils/promise-utils.d.ts +0 -30
  256. package/dist/utils/promise-utils.d.ts.map +0 -1
  257. package/dist/utils/quality-gates-utils.d.ts +0 -49
  258. package/dist/utils/quality-gates-utils.d.ts.map +0 -1
  259. package/dist/utils/quality-gates.d.ts +0 -49
  260. package/dist/utils/quality-gates.d.ts.map +0 -1
  261. package/dist/utils/quality-gates.js +0 -402
  262. package/dist/utils/spec-resolver.d.ts +0 -80
  263. package/dist/utils/spec-resolver.d.ts.map +0 -1
  264. package/dist/utils/typescript-detector.d.ts +0 -66
  265. package/dist/utils/typescript-detector.d.ts.map +0 -1
  266. package/dist/utils/yaml-validation.d.ts +0 -32
  267. package/dist/utils/yaml-validation.d.ts.map +0 -1
  268. package/dist/validation/spec-validation.d.ts +0 -43
  269. package/dist/validation/spec-validation.d.ts.map +0 -1
  270. package/dist/waivers-manager.d.ts +0 -167
  271. package/dist/waivers-manager.d.ts.map +0 -1
  272. package/dist/worktree/worktree-manager.d.ts +0 -54
  273. package/dist/worktree/worktree-manager.d.ts.map +0 -1
@@ -0,0 +1,151 @@
1
+ /**
2
+ * @fileoverview Spec Drift Analysis Sidecar
3
+ * Compares implementation evidence (files_touched, AC results, gate results)
4
+ * against spec scope and acceptance criteria.
5
+ * @author @darianrosebrook
6
+ */
7
+
8
+ const _minimatch = require('minimatch');
9
+ const minimatch = typeof _minimatch === 'function'
10
+ ? _minimatch
11
+ : (_minimatch.minimatch || (() => { throw new Error('minimatch export not found — expected v3 default or v5+ named export'); }));
12
+ const { createSidecarOutput, createNoStateOutput } = require('./schema');
13
+ const { getRecurrence } = require('../gates/feedback');
14
+
15
+ // ---------------------------------------------------------------------------
16
+ // Helpers
17
+ // ---------------------------------------------------------------------------
18
+
19
+ /**
20
+ * Check whether a file path is within the spec's declared scope.
21
+ * A file is in scope if it matches at least one scope.in pattern
22
+ * and does not match any scope.out pattern.
23
+ * @param {string} file
24
+ * @param {string[]} scopeIn
25
+ * @param {string[]} scopeOut
26
+ * @returns {boolean}
27
+ */
28
+ function isInScope(file, scopeIn, scopeOut) {
29
+ if (scopeIn.length === 0) return true; // No scope.in means everything is allowed
30
+ const matchesIn = scopeIn.some(pattern => minimatch(file, pattern));
31
+ if (!matchesIn) return false;
32
+ const matchesOut = scopeOut.some(pattern => minimatch(file, pattern));
33
+ return !matchesOut;
34
+ }
35
+
36
+ /**
37
+ * Build a set of file paths that are referenced by any acceptance criterion.
38
+ * This is a rough heuristic: ACs that have results with file references, or
39
+ * whose descriptions mention paths present in files_touched.
40
+ * @param {object[]} acResults - state.acceptance_criteria.results
41
+ * @param {string[]} filesTouched
42
+ * @returns {Set<string>}
43
+ */
44
+ function filesWithACCoverage(acResults, filesTouched) {
45
+ const covered = new Set();
46
+ if (!acResults || !filesTouched) return covered;
47
+
48
+ for (const result of acResults) {
49
+ // If a result references files explicitly, mark them covered
50
+ if (result.files) {
51
+ result.files.forEach(f => covered.add(f));
52
+ }
53
+ // Heuristic: any file_touched whose basename appears in the AC description
54
+ // is considered loosely covered
55
+ if (result.description) {
56
+ for (const file of filesTouched) {
57
+ const basename = file.split('/').pop();
58
+ if (result.description.includes(basename)) {
59
+ covered.add(file);
60
+ }
61
+ }
62
+ }
63
+ }
64
+ return covered;
65
+ }
66
+
67
+ /**
68
+ * Gather gate corroboration: how many scope_boundary failures exist in history.
69
+ * @param {object|null} state
70
+ * @returns {{ scope_failures: number, last_failure: string|null }}
71
+ */
72
+ function getGateCorroboration(state) {
73
+ const recurrence = getRecurrence('scope_boundary', state);
74
+ if (!recurrence) return { scope_failures: 0, last_failure: null };
75
+ return { scope_failures: recurrence.count, last_failure: recurrence.lastSeen };
76
+ }
77
+
78
+ // ---------------------------------------------------------------------------
79
+ // Main analysis
80
+ // ---------------------------------------------------------------------------
81
+
82
+ /**
83
+ * Analyze spec drift by comparing implementation evidence against spec intent.
84
+ * Pure function -- no side effects, no writes.
85
+ * @param {object|null} state - Working state (from loadState)
86
+ * @param {object} spec - Resolved spec object
87
+ * @returns {object} Sidecar output envelope
88
+ */
89
+ function analyzeSpecDrift(state, spec) {
90
+ if (!state) {
91
+ return createNoStateOutput('drift', spec.id);
92
+ }
93
+
94
+ const scopeIn = (spec.scope && spec.scope.in) || [];
95
+ const scopeOut = (spec.scope && spec.scope.out) || [];
96
+ const filesTouched = state.files_touched || [];
97
+ const acceptance = spec.acceptance || [];
98
+ const acResults = (state.acceptance_criteria && state.acceptance_criteria.results) || [];
99
+
100
+ // 1. Scope analysis -- find files outside declared scope
101
+ const outOfScopeFiles = filesTouched.filter(f => !isInScope(f, scopeIn, scopeOut));
102
+
103
+ // 2. Acceptance criteria cross-reference
104
+ const acResultMap = new Map();
105
+ for (const r of acResults) {
106
+ acResultMap.set(r.id, r);
107
+ }
108
+
109
+ const failingCriteria = [];
110
+ const missingEvidence = [];
111
+
112
+ for (const ac of acceptance) {
113
+ const result = acResultMap.get(ac.id);
114
+ if (!result || result.status === 'UNCHECKED') {
115
+ missingEvidence.push({ id: ac.id, description: ac.description || ac.text || '' });
116
+ } else if (result.status === 'FAIL') {
117
+ failingCriteria.push({ id: ac.id, description: ac.description || ac.text || '' });
118
+ }
119
+ }
120
+
121
+ // 3. Scope creep -- files with no AC coverage
122
+ const covered = filesWithACCoverage(acResults, filesTouched);
123
+ const scopeCreepFiles = filesTouched.filter(f => !covered.has(f));
124
+
125
+ // 4. Gate corroboration
126
+ const gateCorroboration = getGateCorroboration(state);
127
+
128
+ // 5. Drift detection
129
+ const driftDetected = outOfScopeFiles.length > 0 ||
130
+ failingCriteria.length > 0 ||
131
+ missingEvidence.length > 0;
132
+
133
+ // 6. Summary
134
+ const parts = [];
135
+ if (outOfScopeFiles.length > 0) parts.push(`${outOfScopeFiles.length} file(s) outside scope`);
136
+ if (failingCriteria.length > 0) parts.push(`${failingCriteria.length} AC failing`);
137
+ if (missingEvidence.length > 0) parts.push(`${missingEvidence.length} AC unchecked`);
138
+ const summary = parts.length > 0 ? parts.join(', ') : 'No drift detected';
139
+
140
+ return createSidecarOutput('drift', spec.id, {
141
+ drift_detected: driftDetected,
142
+ out_of_scope_files: outOfScopeFiles,
143
+ failing_criteria: failingCriteria,
144
+ missing_evidence: missingEvidence,
145
+ scope_creep_files: scopeCreepFiles,
146
+ gate_corroboration: gateCorroboration,
147
+ summary,
148
+ });
149
+ }
150
+
151
+ module.exports = { analyzeSpecDrift };
@@ -0,0 +1,176 @@
1
+ /**
2
+ * @fileoverview Waiver Drafting Assistance Sidecar
3
+ * Generates pre-filled waiver templates from gate failure context.
4
+ * Reduces boilerplate for the human reviewer.
5
+ * @author @darianrosebrook
6
+ */
7
+
8
+ const yaml = require('js-yaml');
9
+ const { getRecurrence, GATE_CATEGORIES } = require('../gates/feedback');
10
+ const { createSidecarOutput, createNoStateOutput } = require('./schema');
11
+
12
+ // ---------------------------------------------------------------------------
13
+ // Category → reason mapping
14
+ // ---------------------------------------------------------------------------
15
+
16
+ const CATEGORY_REASON_MAP = {
17
+ scope: 'third_party_constraint',
18
+ policy: 'infrastructure_limitation',
19
+ quality: 'experimental_feature',
20
+ architectural: 'legacy_integration',
21
+ };
22
+
23
+ // ---------------------------------------------------------------------------
24
+ // Impact level from recurrence count
25
+ // ---------------------------------------------------------------------------
26
+
27
+ function impactFromRecurrence(count) {
28
+ if (count <= 1) return 'low';
29
+ if (count <= 3) return 'medium';
30
+ return 'high';
31
+ }
32
+
33
+ // ---------------------------------------------------------------------------
34
+ // Template generation
35
+ // ---------------------------------------------------------------------------
36
+
37
+ /**
38
+ * Pad a description to meet the 50-char minimum.
39
+ * @param {string} desc
40
+ * @returns {string}
41
+ */
42
+ function padDescription(desc) {
43
+ if (desc.length >= 50) return desc;
44
+ return desc + ' '.repeat(1) + 'This waiver allows temporary bypass while the issue is addressed.';
45
+ }
46
+
47
+ /**
48
+ * Clamp a string to max length.
49
+ * @param {string} str
50
+ * @param {number} max
51
+ * @returns {string}
52
+ */
53
+ function clamp(str, max) {
54
+ if (str.length <= max) return str;
55
+ return str.slice(0, max - 3) + '...';
56
+ }
57
+
58
+ /**
59
+ * Build a waiver template for one failing gate.
60
+ * @param {object} gate - Gate result object
61
+ * @param {object} spec - Spec object
62
+ * @param {object} state - Working state (for recurrence)
63
+ * @returns {object} Draft object with gate, category, recurrence, template, yaml
64
+ */
65
+ function buildDraft(gate, spec, state) {
66
+ const gateName = gate.name;
67
+ const category = GATE_CATEGORIES[gateName] || 'quality';
68
+ const reason = CATEGORY_REASON_MAP[category] || 'other';
69
+
70
+ const recurrenceInfo = getRecurrence(gateName, state);
71
+ const recurrenceCount = recurrenceInfo ? recurrenceInfo.count : 0;
72
+ const impact = impactFromRecurrence(recurrenceCount);
73
+
74
+ const now = new Date();
75
+ const expiresAt = new Date(now.getTime() + 7 * 24 * 60 * 60 * 1000);
76
+
77
+ // Build description from gate messages
78
+ const specTitle = spec?.title || spec?.id || 'unknown';
79
+ let rawTitle = `Waive ${gateName} for ${specTitle}`;
80
+ // Clamp title to 10-200 chars, pad if too short
81
+ if (rawTitle.length < 10) {
82
+ rawTitle = rawTitle + ' — temporary bypass';
83
+ }
84
+ const title = clamp(rawTitle, 200);
85
+
86
+ // Build description from messages
87
+ const messageText = gate.messages && gate.messages.length > 0
88
+ ? gate.messages.join('. ')
89
+ : `Gate ${gateName} is failing`;
90
+ let description = `Gate ${gateName} is blocking: ${messageText}. This waiver allows temporary bypass while ${gateName} is addressed.`;
91
+ description = padDescription(description);
92
+ description = clamp(description, 1000);
93
+
94
+ const template = {
95
+ id: 'WV-XXXX',
96
+ title,
97
+ reason,
98
+ description,
99
+ gates: [gateName],
100
+ risk_assessment: {
101
+ impact_level: impact,
102
+ mitigation_plan: '[REQUIRED: Describe how you will address the underlying issue within the waiver period]',
103
+ review_required: impact === 'high' || impact === 'critical',
104
+ },
105
+ expires_at: expiresAt.toISOString(),
106
+ approved_by: '[REQUIRED]',
107
+ created_at: now.toISOString(),
108
+ metadata: { environment: 'development' },
109
+ };
110
+
111
+ const yamlStr = yaml.dump(template, { lineWidth: 120, noRefs: true });
112
+
113
+ return {
114
+ gate: gateName,
115
+ category,
116
+ recurrence: recurrenceCount,
117
+ template,
118
+ yaml: yamlStr,
119
+ };
120
+ }
121
+
122
+ // ---------------------------------------------------------------------------
123
+ // Main entry point
124
+ // ---------------------------------------------------------------------------
125
+
126
+ /**
127
+ * Generate waiver draft templates from gate failures.
128
+ * @param {object|null} state - Working state
129
+ * @param {object} [spec] - Spec object
130
+ * @param {object} [options={}] - Options
131
+ * @param {string} [options.gateName] - Filter to a specific gate
132
+ * @returns {object} Sidecar envelope
133
+ */
134
+ function draftWaiver(state, spec, options = {}) {
135
+ const specId = spec?.id || 'unknown';
136
+
137
+ if (!state) {
138
+ return createNoStateOutput('waiver-draft', specId);
139
+ }
140
+
141
+ if (!state.gates || !state.gates.results) {
142
+ return createSidecarOutput('waiver-draft', specId, {
143
+ drafts: [],
144
+ instructions: '',
145
+ summary: 'No gate results available',
146
+ });
147
+ }
148
+
149
+ // Find failing gates
150
+ let failingGates = state.gates.results.filter(g => g.status === 'fail');
151
+
152
+ if (options.gateName) {
153
+ failingGates = failingGates.filter(g => g.name === options.gateName);
154
+ }
155
+
156
+ if (failingGates.length === 0) {
157
+ return createSidecarOutput('waiver-draft', specId, {
158
+ drafts: [],
159
+ instructions: '',
160
+ summary: 'No failing gates found',
161
+ });
162
+ }
163
+
164
+ const drafts = failingGates.map(gate => buildDraft(gate, spec, state));
165
+
166
+ const gateNames = drafts.map(d => d.gate).join(', ');
167
+ const summary = `${drafts.length} waiver draft${drafts.length !== 1 ? 's' : ''} generated for ${gateNames}`;
168
+
169
+ return createSidecarOutput('waiver-draft', specId, {
170
+ drafts,
171
+ instructions: 'Review and fill [REQUIRED] fields, then run: caws waivers create --file <path>',
172
+ summary,
173
+ });
174
+ }
175
+
176
+ module.exports = { draftWaiver };
@@ -0,0 +1,50 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "title": "CAWS Policy",
4
+ "type": "object",
5
+ "required": ["version", "risk_tiers"],
6
+ "properties": {
7
+ "version": { "type": "integer", "const": 1 },
8
+ "risk_tiers": {
9
+ "type": "object",
10
+ "properties": {
11
+ "1": { "$ref": "#/$defs/tier" },
12
+ "2": { "$ref": "#/$defs/tier" },
13
+ "3": { "$ref": "#/$defs/tier" }
14
+ },
15
+ "required": ["1", "2", "3"]
16
+ },
17
+ "edit_rules": {
18
+ "type": "object",
19
+ "properties": {
20
+ "policy_and_code_same_pr": { "type": "boolean" },
21
+ "min_approvers_for_budget_raise": { "type": "integer", "minimum": 1 },
22
+ "require_signed_commits": { "type": "boolean" }
23
+ }
24
+ },
25
+ "gates": {
26
+ "type": "object",
27
+ "additionalProperties": {
28
+ "type": "object",
29
+ "properties": {
30
+ "enabled": { "type": "boolean" },
31
+ "description": { "type": "string" },
32
+ "mode": { "type": "string", "enum": ["block", "warn", "skip"] },
33
+ "thresholds": { "type": "object" }
34
+ },
35
+ "required": ["enabled"]
36
+ }
37
+ }
38
+ },
39
+ "$defs": {
40
+ "tier": {
41
+ "type": "object",
42
+ "required": ["max_files", "max_loc"],
43
+ "properties": {
44
+ "max_files": { "type": "integer", "minimum": 1 },
45
+ "max_loc": { "type": "integer", "minimum": 1 },
46
+ "description": { "type": "string" }
47
+ }
48
+ }
49
+ }
50
+ }
@@ -1,30 +1,36 @@
1
1
  {
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "title": "CAWS Waivers Configuration",
3
+ "title": "CAWS Waiver",
4
+ "description": "Individual waiver file created by caws waivers create",
4
5
  "type": "object",
5
- "patternProperties": {
6
- ".*": {
7
- "type": "object",
8
- "required": ["gate", "reason", "owner", "expiry"],
9
- "properties": {
10
- "gate": {
11
- "type": "string",
12
- "enum": ["coverage", "mutation", "contracts", "a11y", "perf", "security"]
13
- },
14
- "reason": { "type": "string", "minLength": 10 },
15
- "owner": { "type": "string" },
16
- "expiry": { "type": "string", "format": "date-time" },
17
- "compensating_control": { "type": "string" },
18
- "ticket_url": { "type": "string", "format": "uri" },
19
- "approved_by": { "type": "string" },
20
- "created_at": { "type": "string", "format": "date-time" },
21
- "status": {
22
- "type": "string",
23
- "enum": ["active", "expired", "revoked"],
24
- "default": "active"
25
- }
26
- }
27
- }
6
+ "required": ["id", "title", "reason", "gates", "created_at", "expires_at", "approved_by", "status"],
7
+ "properties": {
8
+ "id": { "type": "string", "pattern": "^WV-\\d{4}$" },
9
+ "title": { "type": "string", "minLength": 1 },
10
+ "reason": { "type": "string", "minLength": 10 },
11
+ "description": { "type": "string" },
12
+ "gates": {
13
+ "type": "array",
14
+ "items": { "type": "string" },
15
+ "minItems": 1,
16
+ "description": "Gate names this waiver applies to"
17
+ },
18
+ "created_at": { "type": "string" },
19
+ "expires_at": { "type": "string" },
20
+ "approved_by": { "type": "string" },
21
+ "impact_level": { "type": "string" },
22
+ "mitigation_plan": { "type": "string" },
23
+ "status": {
24
+ "type": "string",
25
+ "enum": ["active", "expired", "revoked"],
26
+ "default": "active"
27
+ },
28
+ "created_by_session": { "type": ["string", "null"] },
29
+ "compensating_control": { "type": "string" },
30
+ "ticket_url": { "type": "string", "format": "uri" },
31
+ "revoked_at": { "type": "string" },
32
+ "revoked_by": { "type": "string" },
33
+ "revocation_reason": { "type": "string" }
28
34
  },
29
35
  "additionalProperties": false
30
36
  }
@@ -18,8 +18,15 @@
18
18
  "properties": {
19
19
  "id": { "type": "string", "pattern": "^[A-Z]{2,6}-\\d{3,4}$" },
20
20
  "title": { "type": "string", "minLength": 10, "maxLength": 200 },
21
+ "type": { "type": "string", "enum": ["feature", "fix", "refactor", "chore", "docs"] },
22
+ "status": {
23
+ "type": "string",
24
+ "enum": ["draft", "active", "in_progress", "completed", "closed", "archived"]
25
+ },
26
+ "created_at": { "type": "string" },
27
+ "updated_at": { "type": "string" },
21
28
  "risk_tier": { "type": ["integer", "string"], "enum": [1, 2, 3, "1", "2", "3"] },
22
- "mode": { "type": "string", "enum": ["feature", "refactor", "fix", "doc", "chore"] },
29
+ "mode": { "type": "string", "enum": ["feature", "refactor", "fix", "doc", "docs", "chore", "development"] },
23
30
  "waiver_ids": {
24
31
  "type": "array",
25
32
  "items": { "type": "string", "pattern": "^WV-\\d{4}$" },
@@ -45,7 +52,7 @@
45
52
  "invariants": { "type": "array", "items": { "type": "string" }, "minItems": 1 },
46
53
  "acceptance": {
47
54
  "type": "array",
48
- "minItems": 1,
55
+ "minItems": 0,
49
56
  "items": {
50
57
  "type": "object",
51
58
  "required": ["id", "given", "when", "then"],
@@ -57,6 +64,35 @@
57
64
  }
58
65
  }
59
66
  },
67
+ "acceptance_criteria": {
68
+ "type": "array",
69
+ "minItems": 0,
70
+ "items": {
71
+ "type": "object",
72
+ "required": ["id"],
73
+ "properties": {
74
+ "id": { "type": "string" },
75
+ "description": { "type": "string" },
76
+ "completed": { "type": "boolean" },
77
+ "test": { "type": "string" },
78
+ "test_command": { "type": "string" },
79
+ "test_nodeids": {
80
+ "type": "array",
81
+ "items": { "type": "string" }
82
+ },
83
+ "evidence": {
84
+ "oneOf": [
85
+ { "type": "string" },
86
+ {
87
+ "type": "array",
88
+ "items": { "type": "string" }
89
+ }
90
+ ]
91
+ }
92
+ },
93
+ "additionalProperties": true
94
+ }
95
+ },
60
96
  "non_functional": {
61
97
  "type": "object",
62
98
  "properties": {
@@ -75,13 +111,14 @@
75
111
  },
76
112
  "contracts": {
77
113
  "type": "array",
78
- "minItems": 1,
79
114
  "items": {
80
115
  "type": "object",
81
116
  "required": ["type", "path"],
82
117
  "properties": {
83
- "type": { "type": "string", "enum": ["openapi", "graphql", "proto", "pact"] },
84
- "path": { "type": "string" }
118
+ "type": { "type": "string", "enum": ["openapi", "graphql", "proto", "pact", "project_setup"] },
119
+ "path": { "type": "string" },
120
+ "description": { "type": "string" },
121
+ "version": { "type": "string" }
85
122
  }
86
123
  }
87
124
  },
@@ -95,9 +132,15 @@
95
132
  },
96
133
  "migrations": { "type": "array", "items": { "type": "string" } },
97
134
  "rollback": { "type": "array", "items": { "type": "string" } },
98
- "experiment_mode": {
99
- "type": "boolean",
100
- "description": "Enables experimental mode with reduced requirements"
135
+ "experimental_mode": {
136
+ "type": "object",
137
+ "description": "Enables experimental mode with reduced requirements",
138
+ "required": ["enabled", "rationale", "expires_at"],
139
+ "properties": {
140
+ "enabled": { "type": "boolean" },
141
+ "rationale": { "type": "string" },
142
+ "expires_at": { "type": "string" }
143
+ }
101
144
  },
102
145
  "timeboxed_hours": {
103
146
  "type": "integer",
@@ -21,11 +21,13 @@
21
21
  "baseBranch": { "type": "string" },
22
22
  "scope": { "type": ["string", "null"] },
23
23
  "specId": { "type": ["string", "null"] },
24
+ "owner": { "type": ["string", "null"], "description": "CLAUDE_SESSION_ID of the creating agent" },
24
25
  "createdAt": { "type": "string", "format": "date-time" },
25
26
  "destroyedAt": { "type": "string", "format": "date-time" },
27
+ "autoRegistered": { "type": "boolean" },
26
28
  "status": {
27
29
  "type": "string",
28
- "enum": ["active", "orphaned", "missing", "destroyed"]
30
+ "enum": ["fresh", "active", "merged", "orphaned", "missing", "stale-merged", "destroyed"]
29
31
  }
30
32
  },
31
33
  "additionalProperties": false
@@ -1,6 +1,10 @@
1
1
  id: '{{FEATURE_ID}}'
2
2
  title: '{{FEATURE_TITLE}}'
3
- risk_tier: { { TIER } }
3
+ risk_tier: {{TIER}}
4
+ mode: feature
5
+ blast_radius:
6
+ modules: []
7
+ operational_rollback_slo: "30m"
4
8
  scope:
5
9
  in:
6
10
  - '{{SCOPE_ITEM_1}}'
@@ -37,8 +41,8 @@ non_functional:
37
41
  a11y:
38
42
  - '{{ACCESSIBILITY_REQUIREMENT}}'
39
43
  perf:
40
- api_p95_ms: { { PERF_BUDGET } }
41
- lcp_ms: { { LCP_BUDGET } }
44
+ api_p95_ms: {{PERF_BUDGET}}
45
+ lcp_ms: {{LCP_BUDGET}}
42
46
  security:
43
47
  - '{{SECURITY_REQUIREMENT}}'
44
48
  contracts:
File without changes