@paths.design/caws-cli 10.1.0 → 11.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +125 -374
- package/dist/index.js +43 -756
- package/dist/shell/binding/resolve-binding.d.ts +4 -0
- package/dist/shell/binding/resolve-binding.d.ts.map +1 -0
- package/dist/shell/binding/resolve-binding.js +228 -0
- package/dist/shell/binding/resolve-binding.js.map +1 -0
- package/dist/shell/binding/types.d.ts +42 -0
- package/dist/shell/binding/types.d.ts.map +1 -0
- package/dist/shell/binding/types.js +21 -0
- package/dist/shell/binding/types.js.map +1 -0
- package/dist/shell/commands/claim.d.ts +14 -0
- package/dist/shell/commands/claim.d.ts.map +1 -0
- package/dist/shell/commands/claim.js +197 -0
- package/dist/shell/commands/claim.js.map +1 -0
- package/dist/shell/commands/doctor.d.ts +13 -0
- package/dist/shell/commands/doctor.d.ts.map +1 -0
- package/dist/shell/commands/doctor.js +97 -0
- package/dist/shell/commands/doctor.js.map +1 -0
- package/dist/shell/commands/evidence.d.ts +28 -0
- package/dist/shell/commands/evidence.d.ts.map +1 -0
- package/dist/shell/commands/evidence.js +166 -0
- package/dist/shell/commands/evidence.js.map +1 -0
- package/dist/shell/commands/gates.d.ts +19 -0
- package/dist/shell/commands/gates.d.ts.map +1 -0
- package/dist/shell/commands/gates.js +181 -0
- package/dist/shell/commands/gates.js.map +1 -0
- package/dist/shell/commands/init.d.ts +8 -0
- package/dist/shell/commands/init.d.ts.map +1 -0
- package/dist/shell/commands/init.js +64 -0
- package/dist/shell/commands/init.js.map +1 -0
- package/dist/shell/commands/scope.d.ts +11 -0
- package/dist/shell/commands/scope.d.ts.map +1 -0
- package/dist/shell/commands/scope.js +92 -0
- package/dist/shell/commands/scope.js.map +1 -0
- package/dist/shell/commands/status.d.ts +15 -0
- package/dist/shell/commands/status.d.ts.map +1 -0
- package/dist/shell/commands/status.js +106 -0
- package/dist/shell/commands/status.js.map +1 -0
- package/dist/shell/commands/waiver.d.ts +38 -0
- package/dist/shell/commands/waiver.d.ts.map +1 -0
- package/dist/shell/commands/waiver.js +240 -0
- package/dist/shell/commands/waiver.js.map +1 -0
- package/dist/shell/gates/disposition.d.ts +23 -0
- package/dist/shell/gates/disposition.d.ts.map +1 -0
- package/dist/shell/gates/disposition.js +87 -0
- package/dist/shell/gates/disposition.js.map +1 -0
- package/dist/shell/gates/gate-result-contract.d.ts +39 -0
- package/dist/shell/gates/gate-result-contract.d.ts.map +1 -0
- package/dist/shell/gates/gate-result-contract.js +150 -0
- package/dist/shell/gates/gate-result-contract.js.map +1 -0
- package/dist/shell/gates/quality-gates-adapter.d.ts +55 -0
- package/dist/shell/gates/quality-gates-adapter.d.ts.map +1 -0
- package/dist/shell/gates/quality-gates-adapter.js +161 -0
- package/dist/shell/gates/quality-gates-adapter.js.map +1 -0
- package/dist/shell/gates/waiver-filter.d.ts +58 -0
- package/dist/shell/gates/waiver-filter.d.ts.map +1 -0
- package/dist/shell/gates/waiver-filter.js +119 -0
- package/dist/shell/gates/waiver-filter.js.map +1 -0
- package/dist/shell/index.d.ts +50 -0
- package/dist/shell/index.d.ts.map +1 -0
- package/dist/shell/index.js +73 -0
- package/dist/shell/index.js.map +1 -0
- package/dist/shell/register.d.ts +11 -0
- package/dist/shell/register.d.ts.map +1 -0
- package/dist/shell/register.js +274 -0
- package/dist/shell/register.js.map +1 -0
- package/dist/shell/render/claim.d.ts +22 -0
- package/dist/shell/render/claim.d.ts.map +1 -0
- package/dist/shell/render/claim.js +75 -0
- package/dist/shell/render/claim.js.map +1 -0
- package/dist/shell/render/decision.d.ts +15 -0
- package/dist/shell/render/decision.d.ts.map +1 -0
- package/dist/shell/render/decision.js +66 -0
- package/dist/shell/render/decision.js.map +1 -0
- package/dist/shell/render/diagnostic.d.ts +19 -0
- package/dist/shell/render/diagnostic.d.ts.map +1 -0
- package/dist/shell/render/diagnostic.js +76 -0
- package/dist/shell/render/diagnostic.js.map +1 -0
- package/dist/shell/render/finding.d.ts +15 -0
- package/dist/shell/render/finding.d.ts.map +1 -0
- package/dist/shell/render/finding.js +57 -0
- package/dist/shell/render/finding.js.map +1 -0
- package/dist/shell/render/gates.d.ts +3 -0
- package/dist/shell/render/gates.d.ts.map +1 -0
- package/dist/shell/render/gates.js +56 -0
- package/dist/shell/render/gates.js.map +1 -0
- package/dist/shell/render/init.d.ts +11 -0
- package/dist/shell/render/init.d.ts.map +1 -0
- package/dist/shell/render/init.js +32 -0
- package/dist/shell/render/init.js.map +1 -0
- package/dist/shell/render/status.d.ts +26 -0
- package/dist/shell/render/status.d.ts.map +1 -0
- package/dist/shell/render/status.js +143 -0
- package/dist/shell/render/status.js.map +1 -0
- package/dist/shell/render/waiver.d.ts +21 -0
- package/dist/shell/render/waiver.d.ts.map +1 -0
- package/dist/shell/render/waiver.js +94 -0
- package/dist/shell/render/waiver.js.map +1 -0
- package/dist/shell/rules.d.ts +37 -0
- package/dist/shell/rules.d.ts.map +1 -0
- package/dist/shell/rules.js +51 -0
- package/dist/shell/rules.js.map +1 -0
- package/dist/shell/session/actor.d.ts +14 -0
- package/dist/shell/session/actor.d.ts.map +1 -0
- package/dist/shell/session/actor.js +34 -0
- package/dist/shell/session/actor.js.map +1 -0
- package/dist/shell/session/resolve-session.d.ts +5 -0
- package/dist/shell/session/resolve-session.d.ts.map +1 -0
- package/dist/shell/session/resolve-session.js +239 -0
- package/dist/shell/session/resolve-session.js.map +1 -0
- package/dist/shell/session/types.d.ts +56 -0
- package/dist/shell/session/types.d.ts.map +1 -0
- package/dist/shell/session/types.js +15 -0
- package/dist/shell/session/types.js.map +1 -0
- package/dist/store/agents-store.d.ts +3 -0
- package/dist/store/agents-store.d.ts.map +1 -0
- package/dist/store/agents-store.js +63 -0
- package/dist/store/agents-store.js.map +1 -0
- package/dist/store/apply-patch.d.ts +16 -0
- package/dist/store/apply-patch.d.ts.map +1 -0
- package/dist/store/apply-patch.js +191 -0
- package/dist/store/apply-patch.js.map +1 -0
- package/dist/store/atomic-write.d.ts +16 -0
- package/dist/store/atomic-write.d.ts.map +1 -0
- package/dist/store/atomic-write.js +132 -0
- package/dist/store/atomic-write.js.map +1 -0
- package/dist/store/doctor-snapshot.d.ts +20 -0
- package/dist/store/doctor-snapshot.d.ts.map +1 -0
- package/dist/store/doctor-snapshot.js +176 -0
- package/dist/store/doctor-snapshot.js.map +1 -0
- package/dist/store/events-store.d.ts +33 -0
- package/dist/store/events-store.d.ts.map +1 -0
- package/dist/store/events-store.js +297 -0
- package/dist/store/events-store.js.map +1 -0
- package/dist/store/index.d.ts +21 -0
- package/dist/store/index.d.ts.map +1 -0
- package/dist/store/index.js +47 -0
- package/dist/store/index.js.map +1 -0
- package/dist/store/init-store.d.ts +21 -0
- package/dist/store/init-store.d.ts.map +1 -0
- package/dist/store/init-store.js +295 -0
- package/dist/store/init-store.js.map +1 -0
- package/dist/store/json-store.d.ts +3 -0
- package/dist/store/json-store.d.ts.map +1 -0
- package/dist/store/json-store.js +65 -0
- package/dist/store/json-store.js.map +1 -0
- package/dist/store/policy-store.d.ts +3 -0
- package/dist/store/policy-store.d.ts.map +1 -0
- package/dist/store/policy-store.js +65 -0
- package/dist/store/policy-store.js.map +1 -0
- package/dist/store/repo-root.d.ts +46 -0
- package/dist/store/repo-root.d.ts.map +1 -0
- package/dist/store/repo-root.js +145 -0
- package/dist/store/repo-root.js.map +1 -0
- package/dist/store/rules.d.ts +53 -0
- package/dist/store/rules.d.ts.map +1 -0
- package/dist/store/rules.js +78 -0
- package/dist/store/rules.js.map +1 -0
- package/dist/store/specs-store.d.ts +3 -0
- package/dist/store/specs-store.d.ts.map +1 -0
- package/dist/store/specs-store.js +131 -0
- package/dist/store/specs-store.js.map +1 -0
- package/dist/store/types.d.ts +84 -0
- package/dist/store/types.d.ts.map +1 -0
- package/dist/store/types.js +14 -0
- package/dist/store/types.js.map +1 -0
- package/dist/store/waivers-store.d.ts +25 -0
- package/dist/store/waivers-store.d.ts.map +1 -0
- package/dist/store/waivers-store.js +232 -0
- package/dist/store/waivers-store.js.map +1 -0
- package/dist/store/worktrees-store.d.ts +3 -0
- package/dist/store/worktrees-store.d.ts.map +1 -0
- package/dist/store/worktrees-store.js +62 -0
- package/dist/store/worktrees-store.js.map +1 -0
- package/dist/store/yaml-store.d.ts +9 -0
- package/dist/store/yaml-store.d.ts.map +1 -0
- package/dist/store/yaml-store.js +121 -0
- package/dist/store/yaml-store.js.map +1 -0
- package/package.json +15 -13
- package/dist/budget-derivation.js +0 -751
- package/dist/cicd-optimizer.js +0 -504
- package/dist/commands/archive.js +0 -500
- package/dist/commands/burnup.js +0 -198
- package/dist/commands/diagnose.js +0 -525
- package/dist/commands/evaluate.js +0 -314
- package/dist/commands/gates.js +0 -149
- package/dist/commands/init.js +0 -857
- package/dist/commands/iterate.js +0 -417
- package/dist/commands/mode.js +0 -269
- package/dist/commands/parallel.js +0 -242
- package/dist/commands/plan.js +0 -438
- package/dist/commands/provenance.js +0 -1143
- package/dist/commands/quality-monitor.js +0 -284
- package/dist/commands/scope.js +0 -264
- package/dist/commands/session.js +0 -312
- package/dist/commands/sidecar.js +0 -74
- package/dist/commands/specs.js +0 -1448
- package/dist/commands/status.js +0 -1151
- package/dist/commands/templates.js +0 -237
- package/dist/commands/tool.js +0 -136
- package/dist/commands/tutorial.js +0 -480
- package/dist/commands/validate.js +0 -357
- package/dist/commands/verify-acs.js +0 -443
- package/dist/commands/waivers.js +0 -599
- package/dist/commands/workflow.js +0 -243
- package/dist/commands/worktree.js +0 -386
- package/dist/config/lite-scope.js +0 -158
- package/dist/config/modes.js +0 -347
- package/dist/constants/spec-types.js +0 -65
- package/dist/gates/budget-limit.js +0 -121
- package/dist/gates/feedback.js +0 -260
- package/dist/gates/format.js +0 -179
- package/dist/gates/god-object.js +0 -117
- package/dist/gates/pipeline.js +0 -167
- package/dist/gates/scope-boundary.js +0 -93
- package/dist/gates/spec-completeness.js +0 -109
- package/dist/gates/todo-detection.js +0 -205
- package/dist/generators/jest-config-generator.js +0 -242
- package/dist/generators/working-spec.js +0 -237
- package/dist/minimal-cli.js +0 -88
- package/dist/parallel/parallel-manager.js +0 -433
- package/dist/policy/PolicyManager.js +0 -465
- package/dist/scaffold/claude-hooks.js +0 -443
- package/dist/scaffold/cursor-hooks.js +0 -177
- package/dist/scaffold/git-hooks.js +0 -928
- package/dist/scaffold/index.js +0 -794
- package/dist/session/session-manager.js +0 -653
- package/dist/sidecars/index.js +0 -33
- package/dist/sidecars/listeners.js +0 -40
- package/dist/sidecars/provenance-summary.js +0 -238
- package/dist/sidecars/quality-gaps.js +0 -258
- package/dist/sidecars/schema.js +0 -149
- package/dist/sidecars/spec-drift.js +0 -151
- package/dist/sidecars/waiver-draft.js +0 -176
- package/dist/spec/SpecFileManager.js +0 -419
- package/dist/templates/.caws/schemas/policy.schema.json +0 -112
- package/dist/templates/.caws/schemas/scope.schema.json +0 -52
- package/dist/templates/.caws/schemas/waivers.schema.json +0 -106
- package/dist/templates/.caws/schemas/working-spec.schema.json +0 -340
- package/dist/templates/.caws/schemas/worktrees.schema.json +0 -38
- package/dist/templates/.caws/templates/working-spec.template.yml +0 -80
- package/dist/templates/.caws/tools/README.md +0 -18
- package/dist/templates/.caws/tools/scope-guard.js +0 -203
- package/dist/templates/.caws/tools-allow.json +0 -331
- package/dist/templates/.caws/waivers.yml +0 -19
- package/dist/templates/.claude/README.md +0 -190
- package/dist/templates/.claude/hooks/audit.sh +0 -121
- package/dist/templates/.claude/hooks/block-dangerous.sh +0 -203
- package/dist/templates/.claude/hooks/classify_command.py +0 -592
- package/dist/templates/.claude/hooks/doc-frontmatter-check.sh +0 -173
- package/dist/templates/.claude/hooks/lite-sprawl-check.sh +0 -145
- package/dist/templates/.claude/hooks/naming-check.sh +0 -100
- package/dist/templates/.claude/hooks/protected-paths.sh +0 -39
- package/dist/templates/.claude/hooks/quality-check.sh +0 -81
- package/dist/templates/.claude/hooks/scan-secrets.sh +0 -85
- package/dist/templates/.claude/hooks/scope-guard.sh +0 -381
- package/dist/templates/.claude/hooks/session-caws-status.sh +0 -117
- package/dist/templates/.claude/hooks/session-log.sh +0 -634
- package/dist/templates/.claude/hooks/simplification-guard.sh +0 -92
- package/dist/templates/.claude/hooks/stop-worktree-check.sh +0 -46
- package/dist/templates/.claude/hooks/test_classify_command.py +0 -370
- package/dist/templates/.claude/hooks/test_wrapper_smoke.sh +0 -96
- package/dist/templates/.claude/hooks/validate-spec.sh +0 -76
- package/dist/templates/.claude/hooks/worktree-guard.sh +0 -220
- package/dist/templates/.claude/hooks/worktree-write-guard.sh +0 -190
- package/dist/templates/.claude/rules/git-safety.md +0 -26
- package/dist/templates/.claude/rules/worktree-isolation.md +0 -83
- package/dist/templates/.claude/settings.json +0 -141
- package/dist/templates/.cursor/README.md +0 -299
- package/dist/templates/.cursor/hooks/audit.sh +0 -55
- package/dist/templates/.cursor/hooks/block-dangerous.sh +0 -84
- package/dist/templates/.cursor/hooks/caws-quality-check.sh +0 -52
- package/dist/templates/.cursor/hooks/caws-scope-guard.sh +0 -130
- package/dist/templates/.cursor/hooks/format.sh +0 -38
- package/dist/templates/.cursor/hooks/naming-check.sh +0 -64
- package/dist/templates/.cursor/hooks/scan-secrets.sh +0 -51
- package/dist/templates/.cursor/hooks/scope-guard.sh +0 -52
- package/dist/templates/.cursor/hooks/session-log.sh +0 -924
- package/dist/templates/.cursor/hooks/validate-spec.sh +0 -83
- package/dist/templates/.cursor/hooks.json +0 -76
- package/dist/templates/.cursor/rules/00-claims-verification.mdc +0 -144
- package/dist/templates/.cursor/rules/01-working-style.mdc +0 -50
- package/dist/templates/.cursor/rules/02-quality-gates.mdc +0 -368
- package/dist/templates/.cursor/rules/03-naming-and-refactor.mdc +0 -33
- package/dist/templates/.cursor/rules/04-logging-language-style.mdc +0 -23
- package/dist/templates/.cursor/rules/05-safe-defaults-guards.mdc +0 -23
- package/dist/templates/.cursor/rules/06-typescript-conventions.mdc +0 -36
- package/dist/templates/.cursor/rules/07-process-ops.mdc +0 -20
- package/dist/templates/.cursor/rules/08-solid-and-architecture.mdc +0 -16
- package/dist/templates/.cursor/rules/09-docstrings.mdc +0 -89
- package/dist/templates/.cursor/rules/10-documentation-quality-standards.mdc +0 -385
- package/dist/templates/.cursor/rules/11-scope-management-waivers.mdc +0 -381
- package/dist/templates/.cursor/rules/12-implementation-completeness.mdc +0 -516
- package/dist/templates/.cursor/rules/13-language-agnostic-standards.mdc +0 -578
- package/dist/templates/.cursor/rules/README.md +0 -148
- package/dist/templates/.github/copilot-instructions.md +0 -82
- package/dist/templates/.idea/runConfigurations/CAWS_Evaluate.xml +0 -5
- package/dist/templates/.idea/runConfigurations/CAWS_Validate.xml +0 -5
- package/dist/templates/.junie/guidelines.md +0 -73
- package/dist/templates/.vscode/launch.json +0 -17
- package/dist/templates/.vscode/settings.json +0 -95
- package/dist/templates/.windsurf/rules/caws-quality-standards.md +0 -54
- package/dist/templates/.windsurf/workflows/caws-guided-development.md +0 -92
- package/dist/templates/CLAUDE.md +0 -174
- package/dist/templates/COMMIT_CONVENTIONS.md +0 -86
- package/dist/templates/OIDC_SETUP.md +0 -300
- package/dist/templates/agents.md +0 -145
- package/dist/templates/codemod/README.md +0 -1
- package/dist/templates/codemod/test.js +0 -93
- package/dist/templates/docs/README.md +0 -151
- package/dist/templates/scripts/new_feature.sh +0 -80
- package/dist/templates/scripts/quality-gates/check-god-objects.js +0 -146
- package/dist/templates/scripts/quality-gates/run-quality-gates.js +0 -50
- package/dist/templates/scripts/v3/analysis/todo_analyzer.py +0 -1997
- package/dist/test-analysis.js +0 -786
- package/dist/tool-interface.js +0 -314
- package/dist/tool-loader.js +0 -303
- package/dist/tool-validator.js +0 -393
- package/dist/utils/agent-session.js +0 -202
- package/dist/utils/async-utils.js +0 -188
- package/dist/utils/command-wrapper.js +0 -200
- package/dist/utils/event-log.js +0 -584
- package/dist/utils/event-renderer.js +0 -521
- package/dist/utils/finalization.js +0 -230
- package/dist/utils/git-lock.js +0 -119
- package/dist/utils/gitignore-updater.js +0 -158
- package/dist/utils/ide-detection.js +0 -133
- package/dist/utils/lifecycle-events.js +0 -94
- package/dist/utils/project-analysis.js +0 -367
- package/dist/utils/promise-utils.js +0 -72
- package/dist/utils/quality-gates-errors.js +0 -520
- package/dist/utils/quality-gates-utils.js +0 -387
- package/dist/utils/schema-validator.js +0 -50
- package/dist/utils/spec-resolver.js +0 -711
- package/dist/utils/typescript-detector.js +0 -369
- package/dist/utils/working-state.js +0 -530
- package/dist/utils/yaml-validation.js +0 -156
- package/dist/validation/spec-validation.js +0 -921
- package/dist/waivers-manager.js +0 -732
- package/dist/worktree/worktree-manager.js +0 -1374
- package/templates/.caws/schemas/policy.schema.json +0 -112
- package/templates/.caws/schemas/scope.schema.json +0 -52
- package/templates/.caws/schemas/waivers.schema.json +0 -106
- package/templates/.caws/schemas/working-spec.schema.json +0 -340
- package/templates/.caws/schemas/worktrees.schema.json +0 -38
- package/templates/.caws/templates/working-spec.template.yml +0 -80
- package/templates/.caws/tools/README.md +0 -18
- package/templates/.caws/tools/scope-guard.js +0 -203
- package/templates/.caws/tools-allow.json +0 -331
- package/templates/.caws/waivers.yml +0 -19
- package/templates/.claude/README.md +0 -190
- package/templates/.claude/hooks/audit.sh +0 -121
- package/templates/.claude/hooks/block-dangerous.sh +0 -203
- package/templates/.claude/hooks/classify_command.py +0 -592
- package/templates/.claude/hooks/doc-frontmatter-check.sh +0 -173
- package/templates/.claude/hooks/lite-sprawl-check.sh +0 -145
- package/templates/.claude/hooks/naming-check.sh +0 -100
- package/templates/.claude/hooks/protected-paths.sh +0 -39
- package/templates/.claude/hooks/quality-check.sh +0 -81
- package/templates/.claude/hooks/scan-secrets.sh +0 -85
- package/templates/.claude/hooks/scope-guard.sh +0 -381
- package/templates/.claude/hooks/session-caws-status.sh +0 -117
- package/templates/.claude/hooks/session-log.sh +0 -634
- package/templates/.claude/hooks/simplification-guard.sh +0 -92
- package/templates/.claude/hooks/stop-worktree-check.sh +0 -46
- package/templates/.claude/hooks/test_classify_command.py +0 -370
- package/templates/.claude/hooks/test_wrapper_smoke.sh +0 -96
- package/templates/.claude/hooks/validate-spec.sh +0 -76
- package/templates/.claude/hooks/worktree-guard.sh +0 -220
- package/templates/.claude/hooks/worktree-write-guard.sh +0 -190
- package/templates/.claude/rules/git-safety.md +0 -26
- package/templates/.claude/rules/worktree-isolation.md +0 -83
- package/templates/.claude/settings.json +0 -141
- package/templates/.cursor/README.md +0 -299
- package/templates/.cursor/hooks/audit.sh +0 -55
- package/templates/.cursor/hooks/block-dangerous.sh +0 -84
- package/templates/.cursor/hooks/caws-quality-check.sh +0 -52
- package/templates/.cursor/hooks/caws-scope-guard.sh +0 -130
- package/templates/.cursor/hooks/format.sh +0 -38
- package/templates/.cursor/hooks/naming-check.sh +0 -64
- package/templates/.cursor/hooks/scan-secrets.sh +0 -51
- package/templates/.cursor/hooks/scope-guard.sh +0 -52
- package/templates/.cursor/hooks/session-log.sh +0 -924
- package/templates/.cursor/hooks/validate-spec.sh +0 -83
- package/templates/.cursor/hooks.json +0 -76
- package/templates/.cursor/rules/00-claims-verification.mdc +0 -144
- package/templates/.cursor/rules/01-working-style.mdc +0 -50
- package/templates/.cursor/rules/02-quality-gates.mdc +0 -368
- package/templates/.cursor/rules/03-naming-and-refactor.mdc +0 -33
- package/templates/.cursor/rules/04-logging-language-style.mdc +0 -23
- package/templates/.cursor/rules/05-safe-defaults-guards.mdc +0 -23
- package/templates/.cursor/rules/06-typescript-conventions.mdc +0 -36
- package/templates/.cursor/rules/07-process-ops.mdc +0 -20
- package/templates/.cursor/rules/08-solid-and-architecture.mdc +0 -16
- package/templates/.cursor/rules/09-docstrings.mdc +0 -89
- package/templates/.cursor/rules/10-documentation-quality-standards.mdc +0 -385
- package/templates/.cursor/rules/11-scope-management-waivers.mdc +0 -381
- package/templates/.cursor/rules/12-implementation-completeness.mdc +0 -516
- package/templates/.cursor/rules/13-language-agnostic-standards.mdc +0 -578
- package/templates/.cursor/rules/README.md +0 -148
- package/templates/.github/copilot-instructions.md +0 -82
- package/templates/.idea/runConfigurations/CAWS_Evaluate.xml +0 -5
- package/templates/.idea/runConfigurations/CAWS_Validate.xml +0 -5
- package/templates/.junie/guidelines.md +0 -73
- package/templates/.vscode/launch.json +0 -17
- package/templates/.vscode/settings.json +0 -95
- package/templates/.windsurf/rules/caws-quality-standards.md +0 -54
- package/templates/.windsurf/workflows/caws-guided-development.md +0 -92
- package/templates/CLAUDE.md +0 -174
- package/templates/COMMIT_CONVENTIONS.md +0 -86
- package/templates/OIDC_SETUP.md +0 -300
- package/templates/agents.md +0 -145
- package/templates/codemod/README.md +0 -1
- package/templates/codemod/test.js +0 -93
- package/templates/docs/README.md +0 -151
- package/templates/scripts/new_feature.sh +0 -80
- package/templates/scripts/quality-gates/check-god-objects.js +0 -146
- package/templates/scripts/quality-gates/run-quality-gates.js +0 -50
- package/templates/scripts/v3/analysis/todo_analyzer.py +0 -1997
package/dist/gates/pipeline.js
DELETED
|
@@ -1,167 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @fileoverview Central gate evaluation pipeline
|
|
3
|
-
* Auto-discovers gate modules and evaluates them against policy configuration.
|
|
4
|
-
* @author @darianrosebrook
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
const fs = require('fs-extra');
|
|
8
|
-
const path = require('path');
|
|
9
|
-
const { PolicyManager } = require('../policy/PolicyManager');
|
|
10
|
-
const WaiversManager = require('../waivers-manager');
|
|
11
|
-
const { lifecycle, EVENTS } = require('../utils/lifecycle-events');
|
|
12
|
-
|
|
13
|
-
/**
|
|
14
|
-
* Auto-discover gate modules from the gates directory
|
|
15
|
-
* Skips pipeline.js and format.js; requires each module to export `name` and `run`.
|
|
16
|
-
* @returns {Object} Map of gate name to gate module
|
|
17
|
-
*/
|
|
18
|
-
function loadGates() {
|
|
19
|
-
const gateDir = __dirname;
|
|
20
|
-
const gates = {};
|
|
21
|
-
for (const file of fs.readdirSync(gateDir)) {
|
|
22
|
-
if (file === 'pipeline.js' || file === 'format.js' || !file.endsWith('.js')) continue;
|
|
23
|
-
try {
|
|
24
|
-
const gate = require(path.join(gateDir, file));
|
|
25
|
-
if (gate.name && typeof gate.run === 'function') {
|
|
26
|
-
gates[gate.name] = gate;
|
|
27
|
-
}
|
|
28
|
-
} catch { /* skip broken gate modules */ }
|
|
29
|
-
}
|
|
30
|
-
return gates;
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
/**
|
|
34
|
-
* Evaluate all configured gates against staged files and spec
|
|
35
|
-
* @param {Object} params - Evaluation parameters
|
|
36
|
-
* @param {string} params.projectRoot - Project root directory
|
|
37
|
-
* @param {string[]} params.stagedFiles - List of staged file paths
|
|
38
|
-
* @param {Object} [params.spec] - Working spec object
|
|
39
|
-
* @param {Object} [params.context] - Additional context
|
|
40
|
-
* @returns {Promise<Object>} Evaluation report with gate results and summary
|
|
41
|
-
*/
|
|
42
|
-
async function evaluateGates({ projectRoot, stagedFiles, spec, context }) {
|
|
43
|
-
const policyManager = new PolicyManager();
|
|
44
|
-
const policy = await policyManager.loadPolicy(projectRoot);
|
|
45
|
-
const riskTier = spec?.risk_tier || policy?.risk_tiers?.default || 2;
|
|
46
|
-
const usingDefaults = !!policy?._isDefault;
|
|
47
|
-
|
|
48
|
-
const availableGates = loadGates();
|
|
49
|
-
const gateConfigs = policy?.gates || {};
|
|
50
|
-
const results = [];
|
|
51
|
-
const waiversManager = new WaiversManager({ projectRoot });
|
|
52
|
-
|
|
53
|
-
for (const [gateName, config] of Object.entries(gateConfigs)) {
|
|
54
|
-
if (!config.enabled) continue;
|
|
55
|
-
|
|
56
|
-
const mode = config.mode || 'warn';
|
|
57
|
-
if (mode === 'skip') {
|
|
58
|
-
results.push({ name: gateName, mode, status: 'skipped', waived: false, messages: [], duration: 0 });
|
|
59
|
-
continue;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
// Check waivers
|
|
63
|
-
let waived = false;
|
|
64
|
-
let waiverId = null;
|
|
65
|
-
try {
|
|
66
|
-
const waiverResult = await waiversManager.getActiveWaiverForGate(gateName);
|
|
67
|
-
if (waiverResult) {
|
|
68
|
-
waived = true;
|
|
69
|
-
waiverId = waiverResult.waiverId;
|
|
70
|
-
results.push({ name: gateName, mode, status: 'pass', waived: true, waiverId, messages: [`Waived: ${waiverResult.reason}`], duration: 0 });
|
|
71
|
-
continue;
|
|
72
|
-
}
|
|
73
|
-
} catch (err) {
|
|
74
|
-
// Waiver check failed — log it so the failure is visible, then proceed without waiver
|
|
75
|
-
results.push({
|
|
76
|
-
name: gateName, mode, status: 'fail', waived: false,
|
|
77
|
-
messages: [`Waiver check error (fail-closed): ${err.message}`], duration: 0,
|
|
78
|
-
});
|
|
79
|
-
continue;
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
const gate = availableGates[gateName];
|
|
83
|
-
if (!gate) {
|
|
84
|
-
// Fail-closed for block/warn mode: a gate referenced in policy but not found is a config error
|
|
85
|
-
const status = mode === 'block' ? 'fail' : 'warn';
|
|
86
|
-
results.push({
|
|
87
|
-
name: gateName, mode, status, waived: false,
|
|
88
|
-
messages: [`Gate "${gateName}" is configured in policy but not implemented. Check for typos in policy.yaml.`],
|
|
89
|
-
duration: 0,
|
|
90
|
-
});
|
|
91
|
-
continue;
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
const start = Date.now();
|
|
95
|
-
try {
|
|
96
|
-
const result = await gate.run({ stagedFiles, spec, policy, projectRoot, riskTier, thresholds: config.thresholds, context });
|
|
97
|
-
results.push({
|
|
98
|
-
name: gateName,
|
|
99
|
-
mode,
|
|
100
|
-
status: result.status,
|
|
101
|
-
waived,
|
|
102
|
-
waiverId,
|
|
103
|
-
messages: result.messages || [],
|
|
104
|
-
duration: Date.now() - start,
|
|
105
|
-
});
|
|
106
|
-
} catch (err) {
|
|
107
|
-
results.push({
|
|
108
|
-
name: gateName,
|
|
109
|
-
mode,
|
|
110
|
-
status: 'fail',
|
|
111
|
-
waived: false,
|
|
112
|
-
messages: [`Gate error: ${err.message}`],
|
|
113
|
-
duration: Date.now() - start,
|
|
114
|
-
});
|
|
115
|
-
}
|
|
116
|
-
}
|
|
117
|
-
|
|
118
|
-
const blocked = results.filter(r => r.mode === 'block' && r.status === 'fail' && !r.waived);
|
|
119
|
-
const warned = results.filter(r => r.status === 'warn' || (r.mode === 'warn' && r.status === 'fail'));
|
|
120
|
-
const passed = results.filter(r => r.status === 'pass');
|
|
121
|
-
const skipped = results.filter(r => r.status === 'skipped');
|
|
122
|
-
const waivedGates = results.filter(r => r.waived);
|
|
123
|
-
|
|
124
|
-
const report = {
|
|
125
|
-
passed: blocked.length === 0,
|
|
126
|
-
gates: results,
|
|
127
|
-
summary: {
|
|
128
|
-
blocked: blocked.length,
|
|
129
|
-
warned: warned.length,
|
|
130
|
-
passed: passed.length,
|
|
131
|
-
skipped: skipped.length,
|
|
132
|
-
waived: waivedGates.length,
|
|
133
|
-
},
|
|
134
|
-
};
|
|
135
|
-
|
|
136
|
-
if (usingDefaults) {
|
|
137
|
-
report.warnings = report.warnings || [];
|
|
138
|
-
report.warnings.push('No policy.yaml found — using built-in defaults. Create .caws/policy.yaml for project-specific gate configuration.');
|
|
139
|
-
}
|
|
140
|
-
|
|
141
|
-
// Emit lifecycle events
|
|
142
|
-
try {
|
|
143
|
-
if (blocked.length > 0) {
|
|
144
|
-
for (const b of blocked) {
|
|
145
|
-
lifecycle.emit(EVENTS.GATES_BLOCKED, {
|
|
146
|
-
specId: spec?.id || null,
|
|
147
|
-
gateName: b.name,
|
|
148
|
-
mode: b.mode,
|
|
149
|
-
messages: b.messages,
|
|
150
|
-
context,
|
|
151
|
-
timestamp: new Date().toISOString(),
|
|
152
|
-
});
|
|
153
|
-
}
|
|
154
|
-
} else {
|
|
155
|
-
lifecycle.emit(EVENTS.GATES_PASSED, {
|
|
156
|
-
specId: spec?.id || null,
|
|
157
|
-
summary: report.summary,
|
|
158
|
-
context,
|
|
159
|
-
timestamp: new Date().toISOString(),
|
|
160
|
-
});
|
|
161
|
-
}
|
|
162
|
-
} catch { /* non-fatal */ }
|
|
163
|
-
|
|
164
|
-
return report;
|
|
165
|
-
}
|
|
166
|
-
|
|
167
|
-
module.exports = { evaluateGates, loadGates };
|
|
@@ -1,93 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @fileoverview Scope enforcement gate
|
|
3
|
-
* Validates staged files against spec.scope.in and spec.scope.out patterns.
|
|
4
|
-
* @author @darianrosebrook
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
const picomatch = require('picomatch');
|
|
8
|
-
|
|
9
|
-
const name = 'scope_boundary';
|
|
10
|
-
|
|
11
|
-
/**
|
|
12
|
-
* Check if a file path matches any of the given glob patterns.
|
|
13
|
-
* Uses picomatch for correct glob semantics (** matches zero or more segments).
|
|
14
|
-
* @param {string} filePath - File path to check
|
|
15
|
-
* @param {string[]} patterns - Glob patterns
|
|
16
|
-
* @returns {boolean} Whether the file matches any pattern
|
|
17
|
-
*/
|
|
18
|
-
function matchesAny(filePath, patterns) {
|
|
19
|
-
if (!patterns || patterns.length === 0) return false;
|
|
20
|
-
return picomatch.isMatch(filePath, patterns, { dot: true });
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
/**
|
|
24
|
-
* Check if a file is an infrastructure file that always passes scope checks.
|
|
25
|
-
* Root-level files are exempt UNLESS they match an explicit scope.out pattern.
|
|
26
|
-
* @param {string} filePath - File path to check
|
|
27
|
-
* @returns {boolean} Whether the file is exempt from scope.in checks
|
|
28
|
-
*/
|
|
29
|
-
function isExempt(filePath) {
|
|
30
|
-
// .caws and .claude directories always pass (infrastructure)
|
|
31
|
-
if (filePath.startsWith('.caws/') || filePath.startsWith('.claude/')) return true;
|
|
32
|
-
return false;
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
/**
|
|
36
|
-
* Check if a file is a root-level file (no directory separator).
|
|
37
|
-
* Root-level files skip scope.in checks but still respect scope.out.
|
|
38
|
-
* @param {string} filePath - File path to check
|
|
39
|
-
* @returns {boolean} Whether the file is root-level
|
|
40
|
-
*/
|
|
41
|
-
function isRootLevel(filePath) {
|
|
42
|
-
return !filePath.includes('/');
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
/**
|
|
46
|
-
* Run the scope boundary gate
|
|
47
|
-
* @param {Object} params - Gate parameters
|
|
48
|
-
* @param {string[]} params.stagedFiles - Staged file paths
|
|
49
|
-
* @param {Object} params.spec - Working spec with scope.in/scope.out
|
|
50
|
-
* @returns {Promise<Object>} Gate result with status and messages
|
|
51
|
-
*/
|
|
52
|
-
async function run({ stagedFiles, spec }) {
|
|
53
|
-
const messages = [];
|
|
54
|
-
const violations = [];
|
|
55
|
-
|
|
56
|
-
const scopeIn = spec?.scope?.in || [];
|
|
57
|
-
const scopeOut = spec?.scope?.out || [];
|
|
58
|
-
|
|
59
|
-
// If no scope defined, pass
|
|
60
|
-
if (scopeIn.length === 0 && scopeOut.length === 0) {
|
|
61
|
-
return { status: 'pass', messages: ['No scope boundaries defined'] };
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
for (const file of stagedFiles) {
|
|
65
|
-
// Infrastructure dirs are always exempt
|
|
66
|
-
if (isExempt(file)) continue;
|
|
67
|
-
|
|
68
|
-
// Check scope.out first (explicit exclusion) — applies to ALL files including root-level
|
|
69
|
-
if (scopeOut.length > 0 && matchesAny(file, scopeOut)) {
|
|
70
|
-
violations.push(file);
|
|
71
|
-
messages.push(`Out of scope (excluded): ${file}`);
|
|
72
|
-
continue;
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
// Root-level files skip scope.in checks (but scope.out above still applies)
|
|
76
|
-
if (isRootLevel(file)) continue;
|
|
77
|
-
|
|
78
|
-
// Check scope.in (must match if defined)
|
|
79
|
-
if (scopeIn.length > 0 && !matchesAny(file, scopeIn)) {
|
|
80
|
-
violations.push(file);
|
|
81
|
-
messages.push(`Out of scope (not in allowed paths): ${file}`);
|
|
82
|
-
}
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
if (violations.length > 0) {
|
|
86
|
-
messages.unshift(`${violations.length} file(s) outside spec scope boundaries`);
|
|
87
|
-
return { status: 'fail', messages };
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
return { status: 'pass', messages };
|
|
91
|
-
}
|
|
92
|
-
|
|
93
|
-
module.exports = { name, run };
|
|
@@ -1,109 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @fileoverview Schema validation gate
|
|
3
|
-
* Validates the working spec against the CAWS schema.
|
|
4
|
-
* @author @darianrosebrook
|
|
5
|
-
*/
|
|
6
|
-
|
|
7
|
-
const fs = require('fs-extra');
|
|
8
|
-
const path = require('path');
|
|
9
|
-
const yaml = require('js-yaml');
|
|
10
|
-
const Ajv = require('ajv');
|
|
11
|
-
|
|
12
|
-
const name = 'spec_completeness';
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
* Run the spec completeness gate
|
|
16
|
-
* @param {Object} params - Gate parameters
|
|
17
|
-
* @param {string} params.projectRoot - Project root
|
|
18
|
-
* @returns {Promise<Object>} Gate result with status and messages
|
|
19
|
-
*/
|
|
20
|
-
async function run({ projectRoot, spec }) {
|
|
21
|
-
const messages = [];
|
|
22
|
-
|
|
23
|
-
let specObject = spec;
|
|
24
|
-
if (!specObject) {
|
|
25
|
-
const specPath = path.join(projectRoot, '.caws', 'working-spec.yaml');
|
|
26
|
-
if (!await fs.pathExists(specPath)) {
|
|
27
|
-
return {
|
|
28
|
-
status: 'fail',
|
|
29
|
-
messages: ['No working-spec.yaml found. Create one with: caws init or caws specs create <id>'],
|
|
30
|
-
};
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
try {
|
|
34
|
-
const content = await fs.readFile(specPath, 'utf8');
|
|
35
|
-
specObject = yaml.load(content);
|
|
36
|
-
} catch (err) {
|
|
37
|
-
return { status: 'fail', messages: [`Failed to parse working-spec.yaml: ${err.message}`] };
|
|
38
|
-
}
|
|
39
|
-
}
|
|
40
|
-
|
|
41
|
-
if (!specObject) {
|
|
42
|
-
return { status: 'fail', messages: ['Resolved spec is empty'] };
|
|
43
|
-
}
|
|
44
|
-
|
|
45
|
-
// Try to find and load the schema.
|
|
46
|
-
// CAWSFIX-03: The canonical project-level schema lives at
|
|
47
|
-
// `.caws/working-spec.schema.json` (flat layout, matches the pattern used for
|
|
48
|
-
// policy.schema.json and waiver.schema.json). Older projects may still have
|
|
49
|
-
// a `.caws/schemas/` directory from scaffolded templates, so we check both.
|
|
50
|
-
// Bundled fallbacks cover packaged installs.
|
|
51
|
-
const schemaPaths = [
|
|
52
|
-
path.join(projectRoot, '.caws', 'working-spec.schema.json'),
|
|
53
|
-
path.join(projectRoot, '.caws', 'schemas', 'working-spec.schema.json'),
|
|
54
|
-
path.join(projectRoot, 'node_modules', '@caws', 'cli', 'templates', '.caws', 'schemas', 'working-spec.schema.json'),
|
|
55
|
-
path.join(projectRoot, 'node_modules', '@paths.design', 'caws-cli', 'templates', '.caws', 'schemas', 'working-spec.schema.json'),
|
|
56
|
-
];
|
|
57
|
-
|
|
58
|
-
let schema = null;
|
|
59
|
-
for (const schemaPath of schemaPaths) {
|
|
60
|
-
if (await fs.pathExists(schemaPath)) {
|
|
61
|
-
try {
|
|
62
|
-
const schemaContent = await fs.readFile(schemaPath, 'utf8');
|
|
63
|
-
schema = JSON.parse(schemaContent);
|
|
64
|
-
break;
|
|
65
|
-
} catch {
|
|
66
|
-
// Try next path
|
|
67
|
-
}
|
|
68
|
-
}
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
if (!schema) {
|
|
72
|
-
// No schema available; do basic structural validation
|
|
73
|
-
const requiredFields = ['title', 'risk_tier'];
|
|
74
|
-
const missing = requiredFields.filter(f => !(f in specObject));
|
|
75
|
-
if (missing.length > 0) {
|
|
76
|
-
messages.push(`Missing required fields: ${missing.join(', ')}`);
|
|
77
|
-
return { status: 'fail', messages };
|
|
78
|
-
}
|
|
79
|
-
return { status: 'pass', messages: ['Basic structure valid (no schema file found for full validation)'] };
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
// Validate with AJV — use 2020-12 draft if schema requires it
|
|
83
|
-
try {
|
|
84
|
-
const isDraft2020 = schema.$schema && schema.$schema.includes('2020-12');
|
|
85
|
-
let ajv;
|
|
86
|
-
if (isDraft2020) {
|
|
87
|
-
const Ajv2020 = require('ajv/dist/2020');
|
|
88
|
-
ajv = new Ajv2020({ allErrors: true, strict: false });
|
|
89
|
-
} else {
|
|
90
|
-
ajv = new Ajv({ allErrors: true, strict: false });
|
|
91
|
-
}
|
|
92
|
-
const validate = ajv.compile(schema);
|
|
93
|
-
const valid = validate(specObject);
|
|
94
|
-
|
|
95
|
-
if (!valid) {
|
|
96
|
-
for (const error of validate.errors) {
|
|
97
|
-
const location = error.instancePath || '/';
|
|
98
|
-
messages.push(`${location}: ${error.message}`);
|
|
99
|
-
}
|
|
100
|
-
return { status: 'fail', messages };
|
|
101
|
-
}
|
|
102
|
-
|
|
103
|
-
return { status: 'pass', messages };
|
|
104
|
-
} catch (err) {
|
|
105
|
-
return { status: 'fail', messages: [`Schema validation error: ${err.message}`] };
|
|
106
|
-
}
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
module.exports = { name, run };
|
|
@@ -1,205 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* @fileoverview TODO/FIXME scanning gate
|
|
3
|
-
* Detects actionable TODO, FIXME, HACK, XXX markers in comments.
|
|
4
|
-
* Filters out false positives: string literals, regex definitions, test assertions,
|
|
5
|
-
* and documentation about the TODO system itself.
|
|
6
|
-
* Context-aware: commit context scans staged diff, cli/edit context scans file content.
|
|
7
|
-
* @author @darianrosebrook
|
|
8
|
-
*/
|
|
9
|
-
|
|
10
|
-
const { execSync } = require('child_process');
|
|
11
|
-
const fs = require('fs');
|
|
12
|
-
const path = require('path');
|
|
13
|
-
|
|
14
|
-
const name = 'todo_detection';
|
|
15
|
-
|
|
16
|
-
const TODO_MARKERS = /\b(TODO|FIXME|HACK|XXX)\b/g;
|
|
17
|
-
|
|
18
|
-
/**
|
|
19
|
-
* Comment patterns for languages we scan.
|
|
20
|
-
* A line is a "comment TODO" if the TODO marker appears after a comment introducer.
|
|
21
|
-
*/
|
|
22
|
-
const COMMENT_TODO = /(?:\/\/|#|\/?\*|\{\/\*)\s*\b(TODO|FIXME|HACK|XXX)\b/;
|
|
23
|
-
|
|
24
|
-
/**
|
|
25
|
-
* Patterns that indicate the line is ABOUT the TODO system, not an actual TODO.
|
|
26
|
-
* These are lines where TODO appears as data, not as intent.
|
|
27
|
-
*/
|
|
28
|
-
const FALSE_POSITIVE_PATTERNS = [
|
|
29
|
-
/TODO_PATTERN/, // regex variable name
|
|
30
|
-
/TODO\/FIXME/, // describing the pattern itself
|
|
31
|
-
/\btoMatch\b|\btoContain\b|\bexpect\(/, // test assertions
|
|
32
|
-
/writeFileSync.*TODO/, // test fixture data
|
|
33
|
-
/\bdescribe\(.*TODO|\btest\(.*TODO|\bit\(.*TODO/, // test names
|
|
34
|
-
/Pattern.*TODO|regex.*TODO/i, // documentation about patterns
|
|
35
|
-
/["'`].*\bTODO\b.*["'`]/, // string literals containing TODO
|
|
36
|
-
];
|
|
37
|
-
|
|
38
|
-
/** Directories to skip when scanning files directly */
|
|
39
|
-
const EXCLUDE_DIRS = ['node_modules/', 'dist/', 'dist-bundle/', 'build/', '.next/', 'coverage/', 'vendor/', '__pycache__/'];
|
|
40
|
-
|
|
41
|
-
/** Files that are part of the TODO detection system itself — skip to avoid self-analysis */
|
|
42
|
-
const SELF_FILES = ['todo-detection.js', 'todo_detection.js', 'todo_analyzer.py', 'todo-analyzer'];
|
|
43
|
-
|
|
44
|
-
/** Extensions to scan */
|
|
45
|
-
const SOURCE_EXTENSIONS = ['.js', '.ts', '.tsx', '.jsx', '.py', '.rs', '.go', '.java', '.rb', '.cs', '.sh'];
|
|
46
|
-
|
|
47
|
-
/**
|
|
48
|
-
* Check if a file should be excluded from scanning.
|
|
49
|
-
* @param {string} filePath - Relative file path
|
|
50
|
-
* @returns {boolean}
|
|
51
|
-
*/
|
|
52
|
-
function isExcluded(filePath) {
|
|
53
|
-
for (const dir of EXCLUDE_DIRS) {
|
|
54
|
-
if (filePath.startsWith(dir) || filePath.includes('/' + dir)) return true;
|
|
55
|
-
}
|
|
56
|
-
// Skip the gate's own implementation files
|
|
57
|
-
const basename = path.basename(filePath);
|
|
58
|
-
for (const self of SELF_FILES) {
|
|
59
|
-
if (basename === self || basename.includes(self)) return true;
|
|
60
|
-
}
|
|
61
|
-
return false;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
/**
|
|
65
|
-
* Check if a line contains a real TODO comment (not a false positive).
|
|
66
|
-
* Returns the marker name if real, null if false positive.
|
|
67
|
-
* @param {string} line - Source line
|
|
68
|
-
* @returns {string|null} The marker found, or null
|
|
69
|
-
*/
|
|
70
|
-
function findRealTodo(line) {
|
|
71
|
-
const trimmed = line.trim();
|
|
72
|
-
|
|
73
|
-
// Must contain a marker at all
|
|
74
|
-
TODO_MARKERS.lastIndex = 0;
|
|
75
|
-
if (!TODO_MARKERS.test(trimmed)) return null;
|
|
76
|
-
|
|
77
|
-
// Filter out false positives
|
|
78
|
-
for (const fp of FALSE_POSITIVE_PATTERNS) {
|
|
79
|
-
if (fp.test(trimmed)) return null;
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
// Must look like a comment containing the marker — not just any line with TODO in it
|
|
83
|
-
if (!COMMENT_TODO.test(trimmed)) return null;
|
|
84
|
-
|
|
85
|
-
// Extract which marker
|
|
86
|
-
TODO_MARKERS.lastIndex = 0;
|
|
87
|
-
const match = TODO_MARKERS.exec(trimmed);
|
|
88
|
-
return match ? match[1] : null;
|
|
89
|
-
}
|
|
90
|
-
|
|
91
|
-
/**
|
|
92
|
-
* Scan staged diff for newly-added TODO markers.
|
|
93
|
-
* Used in commit context — only flags markers being added, not pre-existing ones.
|
|
94
|
-
*/
|
|
95
|
-
function scanStagedDiff(projectRoot) {
|
|
96
|
-
const messages = [];
|
|
97
|
-
let totalCount = 0;
|
|
98
|
-
|
|
99
|
-
const diff = execSync('git diff --cached -U0', {
|
|
100
|
-
cwd: projectRoot,
|
|
101
|
-
encoding: 'utf8',
|
|
102
|
-
stdio: ['ignore', 'pipe', 'pipe'],
|
|
103
|
-
});
|
|
104
|
-
|
|
105
|
-
let currentFile = null;
|
|
106
|
-
let lineNum = 0;
|
|
107
|
-
|
|
108
|
-
for (const line of diff.split('\n')) {
|
|
109
|
-
if (line.startsWith('+++ b/')) {
|
|
110
|
-
currentFile = line.slice(6);
|
|
111
|
-
continue;
|
|
112
|
-
}
|
|
113
|
-
if (line.startsWith('@@')) {
|
|
114
|
-
const match = line.match(/@@ -\d+(?:,\d+)? \+(\d+)/);
|
|
115
|
-
if (match) {
|
|
116
|
-
lineNum = parseInt(match[1], 10) - 1;
|
|
117
|
-
}
|
|
118
|
-
continue;
|
|
119
|
-
}
|
|
120
|
-
if (line.startsWith('+') && !line.startsWith('+++')) {
|
|
121
|
-
lineNum++;
|
|
122
|
-
const content = line.slice(1); // remove the leading +
|
|
123
|
-
const marker = findRealTodo(content);
|
|
124
|
-
if (marker) {
|
|
125
|
-
totalCount++;
|
|
126
|
-
messages.push(`${currentFile}:${lineNum}: ${marker} found`);
|
|
127
|
-
}
|
|
128
|
-
} else if (!line.startsWith('-')) {
|
|
129
|
-
lineNum++;
|
|
130
|
-
}
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
return { totalCount, messages };
|
|
134
|
-
}
|
|
135
|
-
|
|
136
|
-
/**
|
|
137
|
-
* Scan file contents directly for TODO markers.
|
|
138
|
-
* Used in cli/edit context — reports all existing markers in the given files.
|
|
139
|
-
*/
|
|
140
|
-
function scanFiles(stagedFiles, projectRoot) {
|
|
141
|
-
const messages = [];
|
|
142
|
-
let totalCount = 0;
|
|
143
|
-
|
|
144
|
-
const filesToScan = stagedFiles.filter(f =>
|
|
145
|
-
SOURCE_EXTENSIONS.some(ext => f.endsWith(ext)) && !isExcluded(f)
|
|
146
|
-
);
|
|
147
|
-
|
|
148
|
-
for (const file of filesToScan) {
|
|
149
|
-
try {
|
|
150
|
-
const fullPath = path.resolve(projectRoot, file);
|
|
151
|
-
if (!fs.existsSync(fullPath)) continue;
|
|
152
|
-
|
|
153
|
-
const content = fs.readFileSync(fullPath, 'utf8');
|
|
154
|
-
const lines = content.split('\n');
|
|
155
|
-
|
|
156
|
-
for (let i = 0; i < lines.length; i++) {
|
|
157
|
-
const marker = findRealTodo(lines[i]);
|
|
158
|
-
if (marker) {
|
|
159
|
-
totalCount++;
|
|
160
|
-
messages.push(`${file}:${i + 1}: ${marker} found`);
|
|
161
|
-
}
|
|
162
|
-
}
|
|
163
|
-
} catch {
|
|
164
|
-
// Skip unreadable files
|
|
165
|
-
}
|
|
166
|
-
}
|
|
167
|
-
|
|
168
|
-
return { totalCount, messages };
|
|
169
|
-
}
|
|
170
|
-
|
|
171
|
-
/**
|
|
172
|
-
* Run the TODO detection gate
|
|
173
|
-
* @param {Object} params - Gate parameters
|
|
174
|
-
* @param {string[]} params.stagedFiles - File paths to check
|
|
175
|
-
* @param {string} params.projectRoot - Project root
|
|
176
|
-
* @param {string} [params.context] - Execution context (commit, cli, edit)
|
|
177
|
-
* @returns {Promise<Object>} Gate result with status and messages
|
|
178
|
-
*/
|
|
179
|
-
async function run({ stagedFiles, projectRoot, context }) {
|
|
180
|
-
try {
|
|
181
|
-
let result;
|
|
182
|
-
|
|
183
|
-
if (context === 'commit') {
|
|
184
|
-
// Commit context: scan only newly-added lines in staged diff
|
|
185
|
-
result = scanStagedDiff(projectRoot);
|
|
186
|
-
} else {
|
|
187
|
-
// CLI/edit context: scan file contents directly
|
|
188
|
-
result = scanFiles(stagedFiles, projectRoot);
|
|
189
|
-
}
|
|
190
|
-
|
|
191
|
-
if (result.totalCount > 0) {
|
|
192
|
-
result.messages.unshift(`Found ${result.totalCount} TODO/FIXME/HACK/XXX marker(s)${context === 'commit' ? ' in staged changes' : ''}`);
|
|
193
|
-
return { status: 'warn', messages: result.messages };
|
|
194
|
-
}
|
|
195
|
-
|
|
196
|
-
return { status: 'pass', messages: [] };
|
|
197
|
-
} catch (err) {
|
|
198
|
-
return {
|
|
199
|
-
status: 'warn',
|
|
200
|
-
messages: [`Cannot scan for TODO markers: ${err.message}`],
|
|
201
|
-
};
|
|
202
|
-
}
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
module.exports = { name, run };
|