orkeon-code 0.0.0-stage → 1.0.0-rc.2
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/.orkeon-runtime +10 -0
- package/.orkeon-version +1 -0
- package/LICENSE.md +21 -0
- package/NOTICE.md +17 -0
- package/README.fr.md +163 -0
- package/README.md +156 -2
- package/config/appsettings.anthropic.example.json +77 -0
- package/config/appsettings.example.json +71 -0
- package/config/appsettings.jev.example.json +131 -0
- package/config/appsettings.kev.example.json +133 -0
- package/config/appsettings.liquid.example.json +132 -0
- package/config/appsettings.ollama-whisper.example.json +93 -0
- package/config/appsettings.ollama.example.json +70 -0
- package/config/appsettings.whisper.example.json +32 -0
- package/mcp/whisper/README.md +294 -0
- package/mcp/whisper/pyproject.toml +32 -0
- package/mcp/whisper/uv.lock +1641 -0
- package/mcp/whisper/whisper_mcp.py +1053 -0
- package/orkeon-code +1092 -0
- package/orkeon-code.mjs +71 -0
- package/orkeon-code.ps1 +939 -0
- package/package.json +58 -4
- package/scripts/install.ps1 +156 -0
- package/scripts/install.sh +148 -0
- package/scripts/session-start.ork.ts +90 -0
- package/scripts/session-start.sh +74 -0
- package/scripts/setup-fixture.sh +88 -0
- package/src/commands/.orkeon/orkeon-cli.d.ts +559 -0
- package/src/commands/_lib/args.ts +194 -0
- package/src/commands/_lib/dev/dev-batches.ts +366 -0
- package/src/commands/_lib/dev/dev-implement.ts +185 -0
- package/src/commands/_lib/dev/dev-source.ts +61 -0
- package/src/commands/_lib/dev/dev.ts +341 -0
- package/src/commands/_lib/dev/markers.ts +7 -0
- package/src/commands/_lib/dev/messages.ts +112 -0
- package/src/commands/_lib/dev-step.ts +145 -0
- package/src/commands/_lib/dispatch.ts +254 -0
- package/src/commands/_lib/effort.ts +15 -0
- package/src/commands/_lib/git/branch.ts +94 -0
- package/src/commands/_lib/git/commit.ts +90 -0
- package/src/commands/_lib/git/diff.ts +107 -0
- package/src/commands/_lib/git/messages.ts +54 -0
- package/src/commands/_lib/git/review.ts +108 -0
- package/src/commands/_lib/memory/memory-admit.ts +148 -0
- package/src/commands/_lib/memory/memory.ts +52 -0
- package/src/commands/_lib/memory/messages.ts +32 -0
- package/src/commands/_lib/messages.ts +48 -0
- package/src/commands/_lib/pr-context.ts +32 -0
- package/src/commands/_lib/project/analyze.ts +24 -0
- package/src/commands/_lib/project/messages.ts +8 -0
- package/src/commands/_lib/session/export.ts +105 -0
- package/src/commands/_lib/session/messages.ts +87 -0
- package/src/commands/_lib/session/prompts.ts +4 -0
- package/src/commands/_lib/session/resume.ts +151 -0
- package/src/commands/_lib/session/tasks.ts +181 -0
- package/src/commands/_lib/settings/advisor.ts +75 -0
- package/src/commands/_lib/settings/agents.ts +137 -0
- package/src/commands/_lib/settings/choices.ts +8 -0
- package/src/commands/_lib/settings/config.ts +141 -0
- package/src/commands/_lib/settings/effort.ts +147 -0
- package/src/commands/_lib/settings/hooks.ts +50 -0
- package/src/commands/_lib/settings/messages.ts +408 -0
- package/src/commands/_lib/settings/mode.ts +100 -0
- package/src/commands/_lib/settings/model.ts +181 -0
- package/src/commands/_lib/settings/output-style.ts +39 -0
- package/src/commands/_lib/settings/permissions.ts +287 -0
- package/src/commands/_lib/settings/route.ts +63 -0
- package/src/commands/_lib/settings/session-config.ts +49 -0
- package/src/commands/_lib/settings/skills.ts +93 -0
- package/src/commands/_lib/settings/theme.ts +42 -0
- package/src/commands/_lib/speech/messages.ts +58 -0
- package/src/commands/_lib/speech/prompts.ts +4 -0
- package/src/commands/_lib/speech/say.ts +95 -0
- package/src/commands/_lib/speech/transcribe.ts +121 -0
- package/src/commands/_lib/speech/voice.ts +142 -0
- package/src/commands/_lib/status/cache.ts +31 -0
- package/src/commands/_lib/status/context.ts +57 -0
- package/src/commands/_lib/status/doctor.ts +205 -0
- package/src/commands/_lib/status/messages.ts +100 -0
- package/src/commands/_lib/status/meta.ts +24 -0
- package/src/commands/_lib/status/status.ts +128 -0
- package/src/commands/_lib/status/usage-tools.ts +48 -0
- package/src/commands/_lib/status/usage.ts +128 -0
- package/src/commands/_lib/view.ts +34 -0
- package/src/commands/dev/dev-batches.cmd.ts +109 -0
- package/src/commands/dev/dev-learn.cmd.ts +29 -0
- package/src/commands/dev/dev-plan.cmd.ts +51 -0
- package/src/commands/dev/dev-spec.cmd.ts +54 -0
- package/src/commands/dev/dev-status.cmd.ts +16 -0
- package/src/commands/git/branch.cmd.ts +27 -0
- package/src/commands/git/commit.cmd.ts +48 -0
- package/src/commands/git/diff.cmd.ts +26 -0
- package/src/commands/git/review.cmd.ts +36 -0
- package/src/commands/memory/memory.cmd.ts +48 -0
- package/src/commands/project/analyze.cmd.ts +32 -0
- package/src/commands/project/debug-tool-call.cmd.ts +62 -0
- package/src/commands/project/files.cmd.ts +22 -0
- package/src/commands/project/init-verifiers.cmd.ts +14 -0
- package/src/commands/project/init.cmd.ts +14 -0
- package/src/commands/project/verify.cmd.ts +27 -0
- package/src/commands/session/assistant.cmd.ts +40 -0
- package/src/commands/session/btw.cmd.ts +18 -0
- package/src/commands/session/clear.cmd.ts +19 -0
- package/src/commands/session/compact.cmd.ts +16 -0
- package/src/commands/session/copy.cmd.ts +45 -0
- package/src/commands/session/exit.cmd.ts +9 -0
- package/src/commands/session/export.cmd.ts +28 -0
- package/src/commands/session/rename.cmd.ts +18 -0
- package/src/commands/session/resume.cmd.ts +19 -0
- package/src/commands/session/rewind.cmd.ts +25 -0
- package/src/commands/session/summary.cmd.ts +27 -0
- package/src/commands/session/tasks.cmd.ts +46 -0
- package/src/commands/settings/advisor.cmd.ts +38 -0
- package/src/commands/settings/agents.cmd.ts +19 -0
- package/src/commands/settings/config.cmd.ts +19 -0
- package/src/commands/settings/effort.cmd.ts +19 -0
- package/src/commands/settings/fast.cmd.ts +18 -0
- package/src/commands/settings/hooks.cmd.ts +17 -0
- package/src/commands/settings/mode.cmd.ts +20 -0
- package/src/commands/settings/model.cmd.ts +21 -0
- package/src/commands/settings/output-style.cmd.ts +19 -0
- package/src/commands/settings/permissions.cmd.ts +25 -0
- package/src/commands/settings/proactive.cmd.ts +16 -0
- package/src/commands/settings/route.cmd.ts +16 -0
- package/src/commands/settings/skills.cmd.ts +17 -0
- package/src/commands/settings/theme.cmd.ts +14 -0
- package/src/commands/speech/say.cmd.ts +24 -0
- package/src/commands/speech/transcribe.cmd.ts +29 -0
- package/src/commands/speech/voice.cmd.ts +30 -0
- package/src/commands/status/context.cmd.ts +18 -0
- package/src/commands/status/doctor.cmd.ts +27 -0
- package/src/commands/status/release-notes.cmd.ts +9 -0
- package/src/commands/status/status.cmd.ts +25 -0
- package/src/commands/status/usage.cmd.ts +21 -0
- package/src/crews/.orkeon/orkeon.d.ts +4391 -0
- package/src/crews/_probe-shared-memory/domain/messages.ts +54 -0
- package/src/crews/_probe-shared-memory/domain/probe-verdict.ts +188 -0
- package/src/crews/_probe-shared-memory/domain/prompts.ts +5 -0
- package/src/crews/_probe-shared-memory/probe.ork.ts +100 -0
- package/src/crews/advisor/application/messages.ts +4 -0
- package/src/crews/advisor/application/prompts.ts +4 -0
- package/src/crews/advisor/application/run-advisor.ts +41 -0
- package/src/crews/advisor/crew.ork.ts +44 -0
- package/src/crews/advisor/domain/advice.ts +119 -0
- package/src/crews/advisor/domain/messages.ts +8 -0
- package/src/crews/advisor/domain/prompts.ts +26 -0
- package/src/crews/agent-run/application/messages.ts +18 -0
- package/src/crews/agent-run/application/run-agent-run.ts +43 -0
- package/src/crews/agent-run/crew.ork.ts +67 -0
- package/src/crews/analyze/application/messages.ts +27 -0
- package/src/crews/analyze/application/prompts.ts +4 -0
- package/src/crews/analyze/application/run-analyze.ts +120 -0
- package/src/crews/analyze/crew.ork.ts +41 -0
- package/src/crews/analyze/domain/harvest.ts +269 -0
- package/src/crews/analyze/domain/prompts.ts +86 -0
- package/src/crews/code-review/application/lens-material.ts +24 -0
- package/src/crews/code-review/application/messages.ts +17 -0
- package/src/crews/code-review/application/prompts.ts +126 -0
- package/src/crews/code-review/application/review.ts +74 -0
- package/src/crews/code-review/application/run-code-review.ts +121 -0
- package/src/crews/code-review/crew.ork.ts +52 -0
- package/src/crews/code-review/domain/lenses.ts +154 -0
- package/src/crews/code-review/domain/messages.ts +25 -0
- package/src/crews/code-review/domain/prompts.ts +58 -0
- package/src/crews/code-review/domain/report.ts +58 -0
- package/src/crews/code-review/domain/scope.ts +106 -0
- package/src/crews/dev-batches/application/messages.ts +127 -0
- package/src/crews/dev-batches/application/plan-close.ts +181 -0
- package/src/crews/dev-batches/application/prompts.ts +10 -0
- package/src/crews/dev-batches/application/run-dev-batches.ts +676 -0
- package/src/crews/dev-batches/application/run-wave.ts +452 -0
- package/src/crews/dev-batches/application/seed-harvest.ts +163 -0
- package/src/crews/dev-batches/crew.ork.ts +146 -0
- package/src/crews/dev-batches/domain/batch-waves.ts +70 -0
- package/src/crews/dev-batches/domain/batches-budget.ts +52 -0
- package/src/crews/dev-batches/domain/batches-log.ts +52 -0
- package/src/crews/dev-batches/domain/markers.ts +5 -0
- package/src/crews/dev-batches/domain/messages.ts +6 -0
- package/src/crews/dev-batches/domain/wave-order.ts +44 -0
- package/src/crews/dev-change/application/change-material.ts +44 -0
- package/src/crews/dev-change/application/evidence.ts +172 -0
- package/src/crews/dev-change/application/messages.ts +81 -0
- package/src/crews/dev-change/application/prompts.ts +101 -0
- package/src/crews/dev-change/application/run-dev-change.ts +324 -0
- package/src/crews/dev-change/crew.ork.ts +114 -0
- package/src/crews/dev-change/domain/change-answer.ts +163 -0
- package/src/crews/dev-change/domain/change-render.ts +77 -0
- package/src/crews/dev-change/domain/markers.ts +28 -0
- package/src/crews/dev-change/domain/messages.ts +16 -0
- package/src/crews/dev-implement/application/close.ts +186 -0
- package/src/crews/dev-implement/application/count-open-steps.ts +24 -0
- package/src/crews/dev-implement/application/locate-sheet.ts +82 -0
- package/src/crews/dev-implement/application/messages.ts +161 -0
- package/src/crews/dev-implement/application/observe.ts +52 -0
- package/src/crews/dev-implement/application/prompts.ts +9 -0
- package/src/crews/dev-implement/application/report-writes.ts +46 -0
- package/src/crews/dev-implement/application/run-dev-implement.ts +822 -0
- package/src/crews/dev-implement/application/run-role.ts +27 -0
- package/src/crews/dev-implement/application/suite-job.ts +122 -0
- package/src/crews/dev-implement/application/touched.ts +74 -0
- package/src/crews/dev-implement/crew.ork.ts +69 -0
- package/src/crews/dev-implement/domain/contracts.ts +255 -0
- package/src/crews/dev-implement/domain/correction.ts +103 -0
- package/src/crews/dev-implement/domain/cycles.ts +36 -0
- package/src/crews/dev-implement/domain/implement-budget.ts +29 -0
- package/src/crews/dev-implement/domain/markers.ts +23 -0
- package/src/crews/dev-implement/domain/messages.ts +58 -0
- package/src/crews/dev-implement/domain/prompts.ts +93 -0
- package/src/crews/dev-implement/domain/roles.ts +49 -0
- package/src/crews/dev-implement/domain/sheet-edits.ts +76 -0
- package/src/crews/dev-implement/domain/sheet-ticks.ts +23 -0
- package/src/crews/dev-implement/domain/step-checks.ts +137 -0
- package/src/crews/dev-implement/domain/step-section.ts +129 -0
- package/src/crews/dev-learn/application/learn-backlog.ts +58 -0
- package/src/crews/dev-learn/application/learn-prompt-fit.ts +63 -0
- package/src/crews/dev-learn/application/messages.ts +51 -0
- package/src/crews/dev-learn/application/prompts.ts +99 -0
- package/src/crews/dev-learn/application/run-dev-learn.ts +558 -0
- package/src/crews/dev-learn/crew.ork.ts +53 -0
- package/src/crews/dev-learn/domain/learn-answer.ts +233 -0
- package/src/crews/dev-learn/domain/messages.ts +65 -0
- package/src/crews/dev-learn/domain/owner-lines.ts +89 -0
- package/src/crews/dev-learn/domain/proposals-render.ts +95 -0
- package/src/crews/dev-plan/application/anchor-paths.ts +113 -0
- package/src/crews/dev-plan/application/inventory.ts +174 -0
- package/src/crews/dev-plan/application/messages.ts +88 -0
- package/src/crews/dev-plan/application/plan-prompt-fit.ts +44 -0
- package/src/crews/dev-plan/application/prompts.ts +141 -0
- package/src/crews/dev-plan/application/run-dev-plan.ts +483 -0
- package/src/crews/dev-plan/crew.ork.ts +112 -0
- package/src/crews/dev-plan/domain/inventory-model.ts +95 -0
- package/src/crews/dev-plan/domain/markers.ts +18 -0
- package/src/crews/dev-plan/domain/messages.ts +118 -0
- package/src/crews/dev-plan/domain/plan-answer.ts +753 -0
- package/src/crews/dev-plan/domain/plan-render.ts +306 -0
- package/src/crews/dev-plan/domain/prompts.ts +44 -0
- package/src/crews/dev-spec/application/messages.ts +30 -0
- package/src/crews/dev-spec/application/prompts.ts +93 -0
- package/src/crews/dev-spec/application/run-dev-spec.ts +237 -0
- package/src/crews/dev-spec/application/spec-material.ts +42 -0
- package/src/crews/dev-spec/crew.ork.ts +110 -0
- package/src/crews/dev-spec/domain/markers.ts +30 -0
- package/src/crews/dev-spec/domain/messages.ts +39 -0
- package/src/crews/dev-spec/domain/spec-answer.ts +252 -0
- package/src/crews/dev-spec/domain/spec-render.ts +76 -0
- package/src/crews/dev-verify/application/audit-brief.ts +187 -0
- package/src/crews/dev-verify/application/audit.ts +267 -0
- package/src/crews/dev-verify/application/capture.ts +311 -0
- package/src/crews/dev-verify/application/messages.ts +119 -0
- package/src/crews/dev-verify/application/prompts.ts +209 -0
- package/src/crews/dev-verify/application/run-dev-verify.ts +423 -0
- package/src/crews/dev-verify/application/run-gate.ts +204 -0
- package/src/crews/dev-verify/crew.ork.ts +103 -0
- package/src/crews/dev-verify/domain/audit-answer.ts +154 -0
- package/src/crews/dev-verify/domain/auditor-charter.ts +21 -0
- package/src/crews/dev-verify/domain/capture-sections.ts +138 -0
- package/src/crews/dev-verify/domain/commands.ts +103 -0
- package/src/crews/dev-verify/domain/gate.ts +131 -0
- package/src/crews/dev-verify/domain/markers.ts +16 -0
- package/src/crews/dev-verify/domain/mechanical-table.ts +156 -0
- package/src/crews/dev-verify/domain/messages.ts +92 -0
- package/src/crews/dev-verify/domain/runtime-cut.ts +13 -0
- package/src/crews/dev-verify/domain/sheet-facts.ts +4 -0
- package/src/crews/dev-verify/domain/text.ts +20 -0
- package/src/crews/dev-verify/domain/verdict.ts +127 -0
- package/src/crews/git-commit/application/draft.ts +133 -0
- package/src/crews/git-commit/application/messages.ts +15 -0
- package/src/crews/git-commit/application/prompts.ts +47 -0
- package/src/crews/git-commit/application/run-git-commit.ts +117 -0
- package/src/crews/git-commit/crew.ork.ts +53 -0
- package/src/crews/git-commit/domain/commit.ts +200 -0
- package/src/crews/git-commit/domain/markers.ts +4 -0
- package/src/crews/git-commit/domain/messages.ts +48 -0
- package/src/crews/init-verifiers/application/authoring.ts +90 -0
- package/src/crews/init-verifiers/application/messages.ts +13 -0
- package/src/crews/init-verifiers/application/prompts.ts +107 -0
- package/src/crews/init-verifiers/application/run-init-verifiers.ts +26 -0
- package/src/crews/init-verifiers/crew.ork.ts +35 -0
- package/src/crews/init-verifiers/domain/commands-section.ts +36 -0
- package/src/crews/init-verifiers/domain/readiness.ts +23 -0
- package/src/crews/main-loop/application/auto-compact.ts +78 -0
- package/src/crews/main-loop/application/context-gather.ts +133 -0
- package/src/crews/main-loop/application/messages.ts +81 -0
- package/src/crews/main-loop/application/prompts.ts +12 -0
- package/src/crews/main-loop/application/run-main-loop.ts +383 -0
- package/src/crews/main-loop/application/turn-context.ts +111 -0
- package/src/crews/main-loop/crew.ork.ts +124 -0
- package/src/crews/main-loop/domain/autocompact.ts +27 -0
- package/src/crews/main-loop/domain/prompt-assembly.ts +338 -0
- package/src/crews/main-loop/domain/prompts.ts +336 -0
- package/src/crews/main-loop/domain/turn-chains.ts +130 -0
- package/src/crews/project-init/application/detect.ts +123 -0
- package/src/crews/project-init/application/messages.ts +15 -0
- package/src/crews/project-init/application/prompts.ts +105 -0
- package/src/crews/project-init/application/run-project-init.ts +31 -0
- package/src/crews/project-init/crew.ork.ts +36 -0
- package/src/crews/project-init/domain/conventions.ts +36 -0
- package/src/crews/project-init/domain/existing-files.ts +65 -0
- package/src/crews/project-init/domain/messages.ts +13 -0
- package/src/crews/project-init/domain/package-map.ts +73 -0
- package/src/crews/project-init/domain/prompts.ts +10 -0
- package/src/crews/session-compact/application/prompts.ts +5 -0
- package/src/crews/session-compact/crew.ork.ts +56 -0
- package/src/crews/shared-memory-admit/application/prompts.ts +5 -0
- package/src/crews/shared-memory-admit/crew.ork.ts +49 -0
- package/src/crews/speech/application/messages.ts +3 -0
- package/src/crews/speech/application/prompts.ts +3 -0
- package/src/crews/speech/application/run-speech.ts +26 -0
- package/src/crews/speech/crew.ork.ts +38 -0
- package/src/shared/application/agents/child-agent.ts +259 -0
- package/src/shared/application/agents/messages.ts +35 -0
- package/src/shared/application/agents/route-agent.ts +115 -0
- package/src/shared/application/agents/run-sub-agent.ts +119 -0
- package/src/shared/application/answer-language.ts +14 -0
- package/src/shared/application/attached-skills.ts +36 -0
- package/src/shared/application/compaction/compact-session.ts +242 -0
- package/src/shared/application/compaction/extract-memories.ts +38 -0
- package/src/shared/application/compaction/messages.ts +20 -0
- package/src/shared/application/compaction/prune-context.ts +94 -0
- package/src/shared/application/compaction/pruned-llm.ts +35 -0
- package/src/shared/application/compaction/restore-context.ts +78 -0
- package/src/shared/application/config-store.ts +123 -0
- package/src/shared/application/dev/brief-inventory.ts +115 -0
- package/src/shared/application/dev/close-batch.ts +85 -0
- package/src/shared/application/dev/find-repo-pack.ts +78 -0
- package/src/shared/application/dev/learn-decision.ts +254 -0
- package/src/shared/application/dev/load-dev-context.ts +265 -0
- package/src/shared/application/dev/measure-access-cost.ts +69 -0
- package/src/shared/application/dev/messages.ts +132 -0
- package/src/shared/application/dev/phase-timer.ts +54 -0
- package/src/shared/application/dev/plan-source.ts +116 -0
- package/src/shared/application/dev/preflight.ts +71 -0
- package/src/shared/application/dev/project-files.ts +17 -0
- package/src/shared/application/dev/prompts.ts +34 -0
- package/src/shared/application/dev/question-round.ts +60 -0
- package/src/shared/application/dev/resolve-work-folder.ts +134 -0
- package/src/shared/application/dev/script-tool-slot.ts +27 -0
- package/src/shared/application/dev/settle-questions.ts +57 -0
- package/src/shared/application/dev/source-review.ts +67 -0
- package/src/shared/application/dev/source-step.ts +152 -0
- package/src/shared/application/dev/spend.ts +55 -0
- package/src/shared/application/dev/step-precedents.ts +90 -0
- package/src/shared/application/dev/tool-call-policy.ts +87 -0
- package/src/shared/application/dev/tool-callbacks.ts +262 -0
- package/src/shared/application/dev/tool-trace-recorder.ts +46 -0
- package/src/shared/application/dev/verdict-sources.ts +50 -0
- package/src/shared/application/dev/wrapped-tools.ts +147 -0
- package/src/shared/application/extra-tools.ts +71 -0
- package/src/shared/application/git/batch-worktree.ts +102 -0
- package/src/shared/application/git/commit-files.ts +191 -0
- package/src/shared/application/git/merge-batch.ts +67 -0
- package/src/shared/application/git/messages.ts +75 -0
- package/src/shared/application/git/open-pull-request.ts +52 -0
- package/src/shared/application/host-context.ts +59 -0
- package/src/shared/application/host-layout-store.ts +45 -0
- package/src/shared/application/instructions-file.ts +19 -0
- package/src/shared/application/json-file.ts +34 -0
- package/src/shared/application/llm-profile.ts +36 -0
- package/src/shared/application/messages.ts +14 -0
- package/src/shared/application/permission-rules.ts +169 -0
- package/src/shared/application/ports/approvals.ts +20 -0
- package/src/shared/application/ports/clock.ts +5 -0
- package/src/shared/application/ports/code-index.ts +93 -0
- package/src/shared/application/ports/crew.ts +60 -0
- package/src/shared/application/ports/decision.ts +14 -0
- package/src/shared/application/ports/files.ts +21 -0
- package/src/shared/application/ports/human.ts +38 -0
- package/src/shared/application/ports/llm.ts +83 -0
- package/src/shared/application/ports/memory.ts +30 -0
- package/src/shared/application/ports/progress.ts +23 -0
- package/src/shared/application/ports/runtime.ts +15 -0
- package/src/shared/application/ports/session.ts +74 -0
- package/src/shared/application/ports/shared-memory.ts +26 -0
- package/src/shared/application/ports/shell.ts +40 -0
- package/src/shared/application/ports/telemetry.ts +45 -0
- package/src/shared/application/ports/theme.ts +11 -0
- package/src/shared/application/ports/tools.ts +46 -0
- package/src/shared/application/ports/usage.ts +45 -0
- package/src/shared/application/ports.ts +29 -0
- package/src/shared/application/project-manifests.ts +106 -0
- package/src/shared/application/session-io.ts +85 -0
- package/src/shared/application/session-state.ts +36 -0
- package/src/shared/application/shared-memory/admit-entries.ts +179 -0
- package/src/shared/application/shared-memory/harvest-after-gaps.ts +69 -0
- package/src/shared/application/shared-memory/harvest-mistakes.ts +45 -0
- package/src/shared/application/shared-memory/import-agent-memory.ts +119 -0
- package/src/shared/application/shared-memory/memory-files.ts +111 -0
- package/src/shared/application/shared-memory/memory-settings.ts +94 -0
- package/src/shared/application/shared-memory/messages.ts +63 -0
- package/src/shared/application/shared-memory/push-candidate.ts +149 -0
- package/src/shared/application/shared-memory/recall-precedents.ts +70 -0
- package/src/shared/application/skills/messages.ts +4 -0
- package/src/shared/application/skills/suggest-skills.ts +102 -0
- package/src/shared/application/state-snapshot.ts +38 -0
- package/src/shared/application/workflow/messages.ts +8 -0
- package/src/shared/application/workflow/workflow-state.ts +136 -0
- package/src/shared/domain/agent-policy/behavior-flags.ts +162 -0
- package/src/shared/domain/agent-policy/extra-tools.ts +67 -0
- package/src/shared/domain/agent-policy/memory-categories.ts +6 -0
- package/src/shared/domain/agent-policy/messages.ts +66 -0
- package/src/shared/domain/agent-policy/mode-policy.ts +51 -0
- package/src/shared/domain/agent-policy/output-styles.ts +11 -0
- package/src/shared/domain/agent-policy/path-rules.ts +299 -0
- package/src/shared/domain/agent-policy/permission.ts +625 -0
- package/src/shared/domain/agent-policy/prompts.ts +17 -0
- package/src/shared/domain/agent-policy/reasoning.ts +59 -0
- package/src/shared/domain/agent-policy/rule-sets.ts +416 -0
- package/src/shared/domain/agent-policy/tool-access.ts +91 -0
- package/src/shared/domain/agent-registry.ts +143 -0
- package/src/shared/domain/agents/built-in-charters.ts +43 -0
- package/src/shared/domain/agents/chain.ts +30 -0
- package/src/shared/domain/agents/charter.ts +64 -0
- package/src/shared/domain/agents/exclusive.ts +25 -0
- package/src/shared/domain/agents/instances.ts +252 -0
- package/src/shared/domain/agents/messages.ts +39 -0
- package/src/shared/domain/agents/model-route.ts +199 -0
- package/src/shared/domain/agents/prompts.ts +20 -0
- package/src/shared/domain/code-intel-contract.ts +357 -0
- package/src/shared/domain/code-intel-routing.ts +60 -0
- package/src/shared/domain/compact-outcome.ts +46 -0
- package/src/shared/domain/compaction-thresholds.ts +162 -0
- package/src/shared/domain/compaction.ts +288 -0
- package/src/shared/domain/config-schema.ts +434 -0
- package/src/shared/domain/context-prune.ts +176 -0
- package/src/shared/domain/decision/questions.ts +102 -0
- package/src/shared/domain/dev/access-cost.ts +230 -0
- package/src/shared/domain/dev/artefacts.ts +50 -0
- package/src/shared/domain/dev/batches-concurrency.ts +35 -0
- package/src/shared/domain/dev/batches-state.ts +49 -0
- package/src/shared/domain/dev/build-commands.ts +45 -0
- package/src/shared/domain/dev/call-guard.ts +342 -0
- package/src/shared/domain/dev/carried-text.ts +47 -0
- package/src/shared/domain/dev/design-rules.ts +100 -0
- package/src/shared/domain/dev/learn-proposals.ts +176 -0
- package/src/shared/domain/dev/learn-state.ts +94 -0
- package/src/shared/domain/dev/markers.ts +107 -0
- package/src/shared/domain/dev/messages.ts +259 -0
- package/src/shared/domain/dev/path-args.ts +42 -0
- package/src/shared/domain/dev/path-rebase.ts +93 -0
- package/src/shared/domain/dev/phase-timing.ts +50 -0
- package/src/shared/domain/dev/plan-checks.ts +191 -0
- package/src/shared/domain/dev/plan-format.ts +170 -0
- package/src/shared/domain/dev/project-files.ts +29 -0
- package/src/shared/domain/dev/prompts/brief-blocks.ts +20 -0
- package/src/shared/domain/dev/prompts.ts +251 -0
- package/src/shared/domain/dev/questions.ts +267 -0
- package/src/shared/domain/dev/reading-rule.ts +41 -0
- package/src/shared/domain/dev/repo-pack.ts +240 -0
- package/src/shared/domain/dev/review-answer.ts +173 -0
- package/src/shared/domain/dev/review-brief.ts +54 -0
- package/src/shared/domain/dev/reviewer-charter.ts +35 -0
- package/src/shared/domain/dev/sheet-facts.ts +81 -0
- package/src/shared/domain/dev/spec-format.ts +182 -0
- package/src/shared/domain/dev/step-budget.ts +74 -0
- package/src/shared/domain/dev/step-rules.ts +109 -0
- package/src/shared/domain/dev/test-commands.ts +94 -0
- package/src/shared/domain/dev/test-output.ts +33 -0
- package/src/shared/domain/dev/test-paths.ts +40 -0
- package/src/shared/domain/dev/tool-guards.ts +65 -0
- package/src/shared/domain/dev/trait-pattern.ts +87 -0
- package/src/shared/domain/dev/verdict-format.ts +162 -0
- package/src/shared/domain/dev/whitespace.ts +35 -0
- package/src/shared/domain/dev/work-folder.ts +68 -0
- package/src/shared/domain/dev/yaml-subset.ts +385 -0
- package/src/shared/domain/error-text.ts +13 -0
- package/src/shared/domain/git/close.ts +274 -0
- package/src/shared/domain/git/messages.ts +20 -0
- package/src/shared/domain/git/pull-request.ts +96 -0
- package/src/shared/domain/git/worktree.ts +46 -0
- package/src/shared/domain/host-layout.ts +147 -0
- package/src/shared/domain/host-paths.ts +399 -0
- package/src/shared/domain/index-languages.ts +16 -0
- package/src/shared/domain/instructions-file.ts +18 -0
- package/src/shared/domain/iso-day.ts +4 -0
- package/src/shared/domain/llm-failure.ts +134 -0
- package/src/shared/domain/llm-profile.ts +44 -0
- package/src/shared/domain/marked-message.ts +29 -0
- package/src/shared/domain/markers.ts +30 -0
- package/src/shared/domain/messages.ts +291 -0
- package/src/shared/domain/model-catalog.ts +79 -0
- package/src/shared/domain/permission-modes.ts +99 -0
- package/src/shared/domain/prelude.ts +92 -0
- package/src/shared/domain/project-manifests.ts +84 -0
- package/src/shared/domain/prompts.ts +233 -0
- package/src/shared/domain/search-routing.ts +77 -0
- package/src/shared/domain/secret-patterns.ts +46 -0
- package/src/shared/domain/session-keys.ts +92 -0
- package/src/shared/domain/session-start.ts +61 -0
- package/src/shared/domain/severity.ts +72 -0
- package/src/shared/domain/sha1.ts +61 -0
- package/src/shared/domain/shared-memory/agent-memory-import.ts +145 -0
- package/src/shared/domain/shared-memory/candidates.ts +40 -0
- package/src/shared/domain/shared-memory/entry.ts +151 -0
- package/src/shared/domain/shared-memory/front-matter.ts +187 -0
- package/src/shared/domain/shared-memory/gate.ts +45 -0
- package/src/shared/domain/shared-memory/harvest.ts +64 -0
- package/src/shared/domain/shared-memory/layout.ts +190 -0
- package/src/shared/domain/shared-memory/markers.ts +9 -0
- package/src/shared/domain/shared-memory/messages.ts +66 -0
- package/src/shared/domain/shared-memory/precedents-block.ts +82 -0
- package/src/shared/domain/shared-memory/prompts.ts +28 -0
- package/src/shared/domain/shared-memory/refused.ts +84 -0
- package/src/shared/domain/shared-memory/verdict-rows.ts +134 -0
- package/src/shared/domain/skills/prompts.ts +4 -0
- package/src/shared/domain/skills/shortlist.ts +149 -0
- package/src/shared/domain/snip-turns.ts +33 -0
- package/src/shared/domain/speech.ts +21 -0
- package/src/shared/domain/strip.ts +88 -0
- package/src/shared/domain/tool-trace.ts +120 -0
- package/src/shared/domain/types.ts +67 -0
- package/src/shared/domain/verifiers.ts +33 -0
- package/src/shared/domain/vfs.ts +16 -0
- package/src/shared/domain/workflow/prompts.ts +15 -0
- package/src/shared/domain/workflow/state-file.ts +142 -0
- package/src/shared/infrastructure/globals.ts +57 -0
- package/src/shared/infrastructure/orkeon/approvals.ts +24 -0
- package/src/shared/infrastructure/orkeon/child-agents.ts +122 -0
- package/src/shared/infrastructure/orkeon/chooser.ts +32 -0
- package/src/shared/infrastructure/orkeon/code-index.ts +120 -0
- package/src/shared/infrastructure/orkeon/crew-host.ts +27 -0
- package/src/shared/infrastructure/orkeon/crew-memory.ts +12 -0
- package/src/shared/infrastructure/orkeon/decision-model.ts +31 -0
- package/src/shared/infrastructure/orkeon/dev-deps.ts +179 -0
- package/src/shared/infrastructure/orkeon/files.ts +58 -0
- package/src/shared/infrastructure/orkeon/github-pull-requests.ts +30 -0
- package/src/shared/infrastructure/orkeon/host-context.ts +36 -0
- package/src/shared/infrastructure/orkeon/host-provider.ts +22 -0
- package/src/shared/infrastructure/orkeon/human-input.ts +55 -0
- package/src/shared/infrastructure/orkeon/llm-profile.ts +58 -0
- package/src/shared/infrastructure/orkeon/llm.ts +164 -0
- package/src/shared/infrastructure/orkeon/markers.ts +6 -0
- package/src/shared/infrastructure/orkeon/memory-store.ts +41 -0
- package/src/shared/infrastructure/orkeon/memory-tools.ts +129 -0
- package/src/shared/infrastructure/orkeon/messages.ts +15 -0
- package/src/shared/infrastructure/orkeon/permission-rules.ts +42 -0
- package/src/shared/infrastructure/orkeon/progress.ts +24 -0
- package/src/shared/infrastructure/orkeon/prompts.ts +47 -0
- package/src/shared/infrastructure/orkeon/reasoning.ts +40 -0
- package/src/shared/infrastructure/orkeon/run-state.ts +17 -0
- package/src/shared/infrastructure/orkeon/runtime-info.ts +30 -0
- package/src/shared/infrastructure/orkeon/runtime-tools.ts +60 -0
- package/src/shared/infrastructure/orkeon/script-tools.ts +129 -0
- package/src/shared/infrastructure/orkeon/session-store.ts +94 -0
- package/src/shared/infrastructure/orkeon/session-switch.ts +23 -0
- package/src/shared/infrastructure/orkeon/shared-memory.ts +61 -0
- package/src/shared/infrastructure/orkeon/shell-jobs.ts +81 -0
- package/src/shared/infrastructure/orkeon/shell.ts +39 -0
- package/src/shared/infrastructure/orkeon/telemetry.ts +63 -0
- package/src/shared/infrastructure/orkeon/tool-catalogue.ts +76 -0
- package/src/shared/infrastructure/orkeon/tool-results.ts +120 -0
- package/src/shared/infrastructure/orkeon/usage.ts +74 -0
- package/src/shared/infrastructure/orkeon/wiring.ts +174 -0
|
@@ -0,0 +1,753 @@
|
|
|
1
|
+
// The planner's answer: the JSON schema the plan is extracted into, and the check that
|
|
2
|
+
// turns the extraction into a PlanAnswer or the list of what is wrong with it. Pure, no
|
|
3
|
+
// IO. The model decides the batches, steps, tests and anchors; code derives what it must
|
|
4
|
+
// not decide (batch ids, the Ids cells, the traceability batches, the build step, the
|
|
5
|
+
// anchors' path:line). Whether a path exists in the repository is not checked here: the
|
|
6
|
+
// application lists the folders once this check has passed.
|
|
7
|
+
|
|
8
|
+
import type { Checked } from "../../../shared/domain/agents/charter.ts";
|
|
9
|
+
import { DESIGN_RULE_IDS } from "../../../shared/domain/dev/design-rules.ts";
|
|
10
|
+
import type { ChangeKind, SourceKind } from "../../../shared/domain/dev/spec-format.ts";
|
|
11
|
+
import { BUILD_STEP } from "../../../shared/domain/dev/markers.ts";
|
|
12
|
+
import { ANCHOR_KINDS, DESIGN_RULE_ID, ELEMENT_LAYERS, FEATURE_EMPTY, LAYERS_EMPTY, NOT_RELATIVE, TEST_LEVELS, TOOLS_FOLDER, WORK_FOLDER, anchorNeedsPath, anchorNotShown, anchorPathColon, appliedAndNa, batchCount, cannotBeAnchored, docsAndCode, elementHoldsBody, elementTooLong, featureTooLong, holdsBreak, holdsCodeBreak, holdsLabel, inInventory, memberIsNot, missingOrNot, moreProblems, naTwice, naWithoutReason, nameEmpty, nameRepeats, nameTooLong, namesNoId, neitherAppliedNorNa, noCharacterisation, noCodeElement, noCodeOwner, noProductionAnchor, noTest, noTestAnchor, noTestCarries, notBatchOfPlan, notDesignRuleId, notEarlierBatch, notInFirstStep, notUnpinnedRow, ownerIsPath, pinnedNotInPlan, projectEmpty, refAnchorNeedsRef, reuseNotShown, shareUnordered, startsWithMarker, stepCount, titleEmpty, titleIsBuildStep, titleRepeats, titleTooLong, traceNotSourceId, traceTwice } from "./messages.ts";
|
|
13
|
+
import {
|
|
14
|
+
ANSWER_NOT_AN_OBJECT as NOT_AN_OBJECT, fieldEmpty, notASourceId as notSourceId,
|
|
15
|
+
} from "../../../shared/domain/dev/messages.ts";
|
|
16
|
+
import { PLAN_FIELDS } from "./prompts.ts";
|
|
17
|
+
|
|
18
|
+
export type TestLevel = "unit" | "integration" | "pinned";
|
|
19
|
+
export type ElementLayer = "domain" | "application" | "adapter" | "test";
|
|
20
|
+
/** ref: an inventory entry shown to the model (ref set, path absent); create: a file to create (path set);
|
|
21
|
+
* existing: a file of the repository the index does not hold — .md, .json, .yaml… (path set). */
|
|
22
|
+
export type AnchorKind = "ref" | "create" | "existing";
|
|
23
|
+
export interface AnchorRef { kind: AnchorKind; ref?: string; path?: string; member?: string }
|
|
24
|
+
export interface PlanTest { name: string; level: TestLevel; project: string; ids: string[]; covers: string[] } // covers: "U<n>" of unpinned rows
|
|
25
|
+
export interface PlanStep {
|
|
26
|
+
title: string;
|
|
27
|
+
tests: PlanTest[];
|
|
28
|
+
note: string; // "" or ≤ 2 lines: what merges into one cycle, what needs a container
|
|
29
|
+
anchors: { tests: AnchorRef[]; doubles: AnchorRef[]; production: AnchorRef[] };
|
|
30
|
+
}
|
|
31
|
+
export interface PlanBatch {
|
|
32
|
+
name: string; intent: string; reason: string; // reason: the summary's Reason cell
|
|
33
|
+
documentation: boolean;
|
|
34
|
+
dependsOn: string[]; // "F<n>" of earlier batches
|
|
35
|
+
design: { appliedRules: string[]; aggregate: string; invariants: string; consistency: string; events: string; accessCost: string };
|
|
36
|
+
decisions: string[];
|
|
37
|
+
declarative: string[]; // artefacts written without a red test first; [] = none
|
|
38
|
+
steps: PlanStep[]; // behaviour steps only, 2..5 (1..5 for documentation)
|
|
39
|
+
buildScope: string; // the "Build and tests — scope:" text
|
|
40
|
+
testPolicy: { fast: string; integration: string; notRun: string };
|
|
41
|
+
elements: Array<{ layer: ElementLayer; signature: string; rule: string }>;
|
|
42
|
+
}
|
|
43
|
+
export interface PlanAnswer {
|
|
44
|
+
feature: string;
|
|
45
|
+
layers: string[];
|
|
46
|
+
reuse: string[]; // inventory refs
|
|
47
|
+
outOfScope: string[];
|
|
48
|
+
assumptions: string[]; // the Scope line's; the sheets' ## Assumptions stay empty
|
|
49
|
+
nonApplicable: Array<{ id: string; reason: string }>;
|
|
50
|
+
traceability: Array<{ id: string; owners: string[] }>;
|
|
51
|
+
design: Array<{ ids: string[]; aggregate: string; invariant: string; consistency: string; batch: number }>; // batch: 1-based
|
|
52
|
+
batches: PlanBatch[];
|
|
53
|
+
}
|
|
54
|
+
export interface PlanCheckContext {
|
|
55
|
+
sourceIds: readonly string[]; // UC/BR/CH of the source
|
|
56
|
+
shownRefs: ReadonlySet<string>; // the inventory refs the prompt showed
|
|
57
|
+
refPaths: ReadonlyMap<string, string>; // ref → relative path (shared-anchor check)
|
|
58
|
+
refNames: ReadonlyMap<string, string>; // ref → entry name (a production ref anchor's member)
|
|
59
|
+
kind: SourceKind; changeKind?: ChangeKind;
|
|
60
|
+
pinned: readonly string[]; // pinnedBy of "what must not change" rows
|
|
61
|
+
unpinned: readonly string[]; // "U1".."Un"
|
|
62
|
+
/** The work folder, relative (e.g. "workbench"): a created or existing anchor may not sit under it. */
|
|
63
|
+
workFolder?: string;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export const MAX_BATCHES = 8;
|
|
67
|
+
const MAX_PROBLEMS = 60;
|
|
68
|
+
export const MAX_TITLE = 100;
|
|
69
|
+
export const MAX_TEST_NAME = 120;
|
|
70
|
+
export const MAX_SIGNATURE = 200;
|
|
71
|
+
export const MAX_FEATURE = 80;
|
|
72
|
+
export const MIN_NA_REASON = 10;
|
|
73
|
+
const LEVELS: readonly TestLevel[] = ["unit", "integration", "pinned"];
|
|
74
|
+
const LAYERS: readonly ElementLayer[] = ["domain", "application", "adapter", "test"];
|
|
75
|
+
const KINDS: readonly AnchorKind[] = ["ref", "create", "existing"];
|
|
76
|
+
/** The folders that hold the tools' own settings: a plan never anchors there. */
|
|
77
|
+
const TOOLS_FOLDERS = [".claude", ".orkeon"];
|
|
78
|
+
/** Whether `path` is `folder` or lies under it. */
|
|
79
|
+
const within = (path: string, folder: string): boolean => path === folder || path.startsWith(`${folder}/`);
|
|
80
|
+
const DOC_PATH = /\.(md|mdx|rst|adoc|txt)$/i;
|
|
81
|
+
const LABELS = /Applied rules|Non-applicable rules/;
|
|
82
|
+
const LINE_BREAK = /\r\n|\r|\n/;
|
|
83
|
+
/** A line the harness or the parser reads as structure: a heading, a TDD line, a table row, a box, a quote. */
|
|
84
|
+
const LINE_MARKER = /^(#|TDD:|\||- \[|> )/;
|
|
85
|
+
/** A path:line, or a path: what an owner of the traceability may not be. */
|
|
86
|
+
const OWNER_PATH = /:\d|\//;
|
|
87
|
+
|
|
88
|
+
const STRING = { type: "string" };
|
|
89
|
+
const STRINGS = { type: "array", items: STRING };
|
|
90
|
+
/** A field of the schema with what it holds, in a few words: the runtime prints the schema whole after the prompt,
|
|
91
|
+
* so a field whose name says what it holds goes without one. */
|
|
92
|
+
const said = (schema: object, description: string): object => ({ ...schema, description });
|
|
93
|
+
const text = (description: string): object => said(STRING, description);
|
|
94
|
+
const texts = (description: string): object => said(STRINGS, description);
|
|
95
|
+
const listOf = (items: object, description?: string): object =>
|
|
96
|
+
description === undefined ? { type: "array", items } : said({ type: "array", items }, description);
|
|
97
|
+
const objectOf = (properties: Record<string, object>, description?: string): object => {
|
|
98
|
+
const schema = { type: "object", properties, required: Object.keys(properties) };
|
|
99
|
+
return description === undefined ? schema : said(schema, description);
|
|
100
|
+
};
|
|
101
|
+
/** An anchor; its fields are described once, on the anchors object, as the schema repeats it per list. */
|
|
102
|
+
const ANCHOR = {
|
|
103
|
+
type: "object",
|
|
104
|
+
properties: {
|
|
105
|
+
kind: { type: "string", enum: [...KINDS] },
|
|
106
|
+
ref: STRING,
|
|
107
|
+
path: STRING,
|
|
108
|
+
member: STRING,
|
|
109
|
+
},
|
|
110
|
+
required: ["kind"],
|
|
111
|
+
};
|
|
112
|
+
const ANCHORS = listOf(ANCHOR);
|
|
113
|
+
|
|
114
|
+
export const PLAN_ANSWER_SCHEMA: object = objectOf({
|
|
115
|
+
feature: text(PLAN_FIELDS.feature(MAX_FEATURE)),
|
|
116
|
+
layers: texts(PLAN_FIELDS.layers),
|
|
117
|
+
reuse: texts(PLAN_FIELDS.reuse),
|
|
118
|
+
outOfScope: STRINGS,
|
|
119
|
+
assumptions: texts(PLAN_FIELDS.assumptions),
|
|
120
|
+
nonApplicable: listOf(objectOf({
|
|
121
|
+
id: { type: "string", enum: [...DESIGN_RULE_IDS] },
|
|
122
|
+
reason: text(PLAN_FIELDS.naReason(MIN_NA_REASON)),
|
|
123
|
+
}), PLAN_FIELDS.nonApplicable),
|
|
124
|
+
traceability: listOf(objectOf({
|
|
125
|
+
id: STRING,
|
|
126
|
+
owners: texts(PLAN_FIELDS.owners),
|
|
127
|
+
}), PLAN_FIELDS.traceability),
|
|
128
|
+
design: listOf(objectOf({
|
|
129
|
+
ids: texts(PLAN_FIELDS.designIds),
|
|
130
|
+
aggregate: STRING,
|
|
131
|
+
invariant: STRING,
|
|
132
|
+
consistency: STRING,
|
|
133
|
+
batch: said({ type: "integer" }, PLAN_FIELDS.designBatch),
|
|
134
|
+
})),
|
|
135
|
+
batches: listOf(objectOf({
|
|
136
|
+
name: STRING,
|
|
137
|
+
intent: text(PLAN_FIELDS.intent),
|
|
138
|
+
reason: text(PLAN_FIELDS.reason),
|
|
139
|
+
documentation: said({ type: "boolean" }, PLAN_FIELDS.documentation),
|
|
140
|
+
dependsOn: texts(PLAN_FIELDS.dependsOn),
|
|
141
|
+
design: objectOf({
|
|
142
|
+
appliedRules: STRINGS,
|
|
143
|
+
aggregate: STRING,
|
|
144
|
+
invariants: STRING,
|
|
145
|
+
consistency: STRING,
|
|
146
|
+
events: STRING,
|
|
147
|
+
accessCost: text(PLAN_FIELDS.accessCost),
|
|
148
|
+
}, PLAN_FIELDS.batchDesign),
|
|
149
|
+
decisions: texts(PLAN_FIELDS.decisions),
|
|
150
|
+
declarative: texts(PLAN_FIELDS.declarative),
|
|
151
|
+
steps: listOf(objectOf({
|
|
152
|
+
title: text(PLAN_FIELDS.stepTitle(MAX_TITLE)),
|
|
153
|
+
tests: listOf(objectOf({
|
|
154
|
+
name: text(PLAN_FIELDS.testName(MAX_TEST_NAME)),
|
|
155
|
+
level: said({ type: "string", enum: [...LEVELS] }, PLAN_FIELDS.level),
|
|
156
|
+
project: STRING,
|
|
157
|
+
ids: texts(PLAN_FIELDS.testIds),
|
|
158
|
+
covers: texts(PLAN_FIELDS.covers),
|
|
159
|
+
})),
|
|
160
|
+
note: text(PLAN_FIELDS.note),
|
|
161
|
+
anchors: objectOf({
|
|
162
|
+
tests: ANCHORS,
|
|
163
|
+
doubles: ANCHORS,
|
|
164
|
+
production: ANCHORS,
|
|
165
|
+
}, PLAN_FIELDS.anchors),
|
|
166
|
+
}), PLAN_FIELDS.steps),
|
|
167
|
+
buildScope: text(PLAN_FIELDS.buildScope),
|
|
168
|
+
testPolicy: objectOf({
|
|
169
|
+
fast: STRING,
|
|
170
|
+
integration: STRING,
|
|
171
|
+
notRun: text(PLAN_FIELDS.notRun),
|
|
172
|
+
}, PLAN_FIELDS.testPolicy),
|
|
173
|
+
elements: listOf(objectOf({
|
|
174
|
+
layer: { type: "string", enum: [...LAYERS] },
|
|
175
|
+
signature: text(PLAN_FIELDS.signature(MAX_SIGNATURE)),
|
|
176
|
+
rule: text(PLAN_FIELDS.rule),
|
|
177
|
+
})),
|
|
178
|
+
}), PLAN_FIELDS.batches(MAX_BATCHES)),
|
|
179
|
+
}, PLAN_FIELDS.answer);
|
|
180
|
+
|
|
181
|
+
// ---- rule 1: the shape --------------------------------------------------------------
|
|
182
|
+
|
|
183
|
+
type Obj = Record<string, unknown>;
|
|
184
|
+
const isObj = (v: unknown): v is Obj => typeof v === "object" && v !== null && !Array.isArray(v);
|
|
185
|
+
|
|
186
|
+
/** Reads one field of the right type, or records `<field> is missing or not a <type>`. */
|
|
187
|
+
class Reader {
|
|
188
|
+
readonly problems: string[] = [];
|
|
189
|
+
|
|
190
|
+
private miss(field: string, type: string): void {
|
|
191
|
+
const what = type.startsWith("one of") ? type : `${/^[aeiou]/.test(type) ? "an" : "a"} ${type}`;
|
|
192
|
+
this.problems.push(missingOrNot(field, what));
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
str(o: Obj, key: string, at: string): string {
|
|
196
|
+
const v = o[key];
|
|
197
|
+
if (typeof v !== "string") { this.miss(at + key, "string"); return ""; }
|
|
198
|
+
return v;
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
optStr(o: Obj, key: string, at: string): string | undefined {
|
|
202
|
+
const v = o[key];
|
|
203
|
+
if (v === undefined) return undefined;
|
|
204
|
+
if (typeof v !== "string") { this.miss(at + key, "string"); return undefined; }
|
|
205
|
+
return v;
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
bool(o: Obj, key: string, at: string): boolean {
|
|
209
|
+
const v = o[key];
|
|
210
|
+
if (typeof v !== "boolean") { this.miss(at + key, "boolean"); return false; }
|
|
211
|
+
return v;
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
int(o: Obj, key: string, at: string): number {
|
|
215
|
+
const v = o[key];
|
|
216
|
+
if (typeof v !== "number" || !Number.isInteger(v)) { this.miss(at + key, "integer"); return 0; }
|
|
217
|
+
return v;
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
oneOf<T extends string>(o: Obj, key: string, at: string, values: readonly T[], type: string): T {
|
|
221
|
+
const v = o[key];
|
|
222
|
+
if (typeof v !== "string" || !values.includes(v.trim() as T)) { this.miss(at + key, type); return values[0]; }
|
|
223
|
+
return v.trim() as T;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
obj(o: Obj, key: string, at: string): Obj {
|
|
227
|
+
const v = o[key];
|
|
228
|
+
if (!isObj(v)) { this.miss(at + key, "object"); return {}; }
|
|
229
|
+
return v;
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
list<T>(o: Obj, key: string, at: string, item: (v: unknown, at: string) => T | undefined): T[] {
|
|
233
|
+
const v = o[key];
|
|
234
|
+
if (!Array.isArray(v)) { this.miss(at + key, "list"); return []; }
|
|
235
|
+
const out: T[] = [];
|
|
236
|
+
v.forEach((x, i) => {
|
|
237
|
+
const r = item(x, `${at}${key}[${i}]`);
|
|
238
|
+
if (r !== undefined) out.push(r);
|
|
239
|
+
});
|
|
240
|
+
return out;
|
|
241
|
+
}
|
|
242
|
+
|
|
243
|
+
strings(o: Obj, key: string, at: string): string[] {
|
|
244
|
+
return this.list(o, key, at, (x, here) => {
|
|
245
|
+
if (typeof x !== "string") { this.miss(here, "string"); return undefined; }
|
|
246
|
+
return x;
|
|
247
|
+
});
|
|
248
|
+
}
|
|
249
|
+
|
|
250
|
+
objects<T>(o: Obj, key: string, at: string, read: (item: Obj, at: string) => T): T[] {
|
|
251
|
+
return this.list(o, key, at, (x, here) => {
|
|
252
|
+
if (!isObj(x)) { this.miss(here, "object"); return undefined; }
|
|
253
|
+
return read(x, `${here}.`);
|
|
254
|
+
});
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
function readAnswer(value: Obj, r: Reader): PlanAnswer {
|
|
259
|
+
const anchor = (a: Obj, at: string): AnchorRef => {
|
|
260
|
+
const out: AnchorRef = { kind: r.oneOf(a, "kind", at, KINDS, ANCHOR_KINDS) };
|
|
261
|
+
const ref = r.optStr(a, "ref", at);
|
|
262
|
+
const path = r.optStr(a, "path", at);
|
|
263
|
+
const member = r.optStr(a, "member", at);
|
|
264
|
+
if (ref !== undefined) out.ref = ref;
|
|
265
|
+
if (path !== undefined) out.path = path;
|
|
266
|
+
if (member !== undefined) out.member = member;
|
|
267
|
+
return out;
|
|
268
|
+
};
|
|
269
|
+
const test = (t: Obj, at: string): PlanTest => ({
|
|
270
|
+
name: r.str(t, "name", at),
|
|
271
|
+
level: r.oneOf(t, "level", at, LEVELS, TEST_LEVELS),
|
|
272
|
+
project: r.str(t, "project", at),
|
|
273
|
+
ids: r.strings(t, "ids", at),
|
|
274
|
+
covers: r.strings(t, "covers", at),
|
|
275
|
+
});
|
|
276
|
+
const step = (s: Obj, at: string): PlanStep => {
|
|
277
|
+
const anchors = r.obj(s, "anchors", at);
|
|
278
|
+
const here = `${at}anchors.`;
|
|
279
|
+
return {
|
|
280
|
+
title: r.str(s, "title", at),
|
|
281
|
+
tests: r.objects(s, "tests", at, test),
|
|
282
|
+
note: r.str(s, "note", at),
|
|
283
|
+
anchors: {
|
|
284
|
+
tests: r.objects(anchors, "tests", here, anchor),
|
|
285
|
+
doubles: r.objects(anchors, "doubles", here, anchor),
|
|
286
|
+
production: r.objects(anchors, "production", here, anchor),
|
|
287
|
+
},
|
|
288
|
+
};
|
|
289
|
+
};
|
|
290
|
+
const batch = (b: Obj, at: string): PlanBatch => {
|
|
291
|
+
const design = r.obj(b, "design", at);
|
|
292
|
+
const policy = r.obj(b, "testPolicy", at);
|
|
293
|
+
const d = `${at}design.`;
|
|
294
|
+
const p = `${at}testPolicy.`;
|
|
295
|
+
return {
|
|
296
|
+
name: r.str(b, "name", at),
|
|
297
|
+
intent: r.str(b, "intent", at),
|
|
298
|
+
reason: r.str(b, "reason", at),
|
|
299
|
+
documentation: r.bool(b, "documentation", at),
|
|
300
|
+
dependsOn: r.strings(b, "dependsOn", at),
|
|
301
|
+
design: {
|
|
302
|
+
appliedRules: r.strings(design, "appliedRules", d),
|
|
303
|
+
aggregate: r.str(design, "aggregate", d),
|
|
304
|
+
invariants: r.str(design, "invariants", d),
|
|
305
|
+
consistency: r.str(design, "consistency", d),
|
|
306
|
+
events: r.str(design, "events", d),
|
|
307
|
+
accessCost: r.str(design, "accessCost", d),
|
|
308
|
+
},
|
|
309
|
+
decisions: r.strings(b, "decisions", at),
|
|
310
|
+
declarative: r.strings(b, "declarative", at),
|
|
311
|
+
steps: r.objects(b, "steps", at, step),
|
|
312
|
+
buildScope: r.str(b, "buildScope", at),
|
|
313
|
+
testPolicy: { fast: r.str(policy, "fast", p), integration: r.str(policy, "integration", p), notRun: r.str(policy, "notRun", p) },
|
|
314
|
+
elements: r.objects(b, "elements", at, (e, here) => ({
|
|
315
|
+
layer: r.oneOf(e, "layer", here, LAYERS, ELEMENT_LAYERS),
|
|
316
|
+
signature: r.str(e, "signature", here),
|
|
317
|
+
rule: r.str(e, "rule", here),
|
|
318
|
+
})),
|
|
319
|
+
};
|
|
320
|
+
};
|
|
321
|
+
return {
|
|
322
|
+
feature: r.str(value, "feature", ""),
|
|
323
|
+
layers: r.strings(value, "layers", ""),
|
|
324
|
+
reuse: r.strings(value, "reuse", ""),
|
|
325
|
+
outOfScope: r.strings(value, "outOfScope", ""),
|
|
326
|
+
assumptions: r.strings(value, "assumptions", ""),
|
|
327
|
+
nonApplicable: r.objects(value, "nonApplicable", "", (n, at) => ({
|
|
328
|
+
id: r.oneOf(n, "id", at, DESIGN_RULE_IDS, DESIGN_RULE_ID),
|
|
329
|
+
reason: r.str(n, "reason", at),
|
|
330
|
+
})),
|
|
331
|
+
traceability: r.objects(value, "traceability", "", (t, at) => ({ id: r.str(t, "id", at), owners: r.strings(t, "owners", at) })),
|
|
332
|
+
design: r.objects(value, "design", "", (d, at) => ({
|
|
333
|
+
ids: r.strings(d, "ids", at),
|
|
334
|
+
aggregate: r.str(d, "aggregate", at),
|
|
335
|
+
invariant: r.str(d, "invariant", at),
|
|
336
|
+
consistency: r.str(d, "consistency", at),
|
|
337
|
+
batch: r.int(d, "batch", at),
|
|
338
|
+
})),
|
|
339
|
+
batches: r.objects(value, "batches", "", batch),
|
|
340
|
+
};
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
// ---- trimming ----------------------------------------------------------------------
|
|
344
|
+
|
|
345
|
+
const trimAll = (xs: readonly string[]): string[] => xs.map((x) => x.trim());
|
|
346
|
+
const trimNote = (note: string): string => note.trim().split(LINE_BREAK).map((l) => l.trimEnd()).join("\n");
|
|
347
|
+
|
|
348
|
+
/** A path in one spelling, so every rule compares the same string: no `./` segment, no doubled or trailing `/`
|
|
349
|
+
* (a leading `/` is kept, for rule 14 to refuse it). */
|
|
350
|
+
function normalPath(raw: string): string {
|
|
351
|
+
const path = raw.trim();
|
|
352
|
+
const segments = path.split("/").filter((s) => s !== "" && s !== ".");
|
|
353
|
+
return (path.startsWith("/") ? "/" : "") + segments.join("/");
|
|
354
|
+
}
|
|
355
|
+
|
|
356
|
+
function trimAnchor(a: AnchorRef): AnchorRef {
|
|
357
|
+
const out: AnchorRef = { kind: a.kind };
|
|
358
|
+
if (a.ref !== undefined) out.ref = a.ref.trim();
|
|
359
|
+
if (a.path !== undefined) out.path = normalPath(a.path);
|
|
360
|
+
if (a.member !== undefined) out.member = a.member.trim();
|
|
361
|
+
return out;
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
/** The slips a model makes in the shape, mended where they have a single reading: a source id
|
|
365
|
+
* written in a test's covers moves to its ids, a ref anchor's path equal to its ref's path is
|
|
366
|
+
* dropped, a reuse entry that starts with a shown ref ("I3 class Account") keeps the ref alone. */
|
|
367
|
+
function mended(a: PlanAnswer, ctx: PlanCheckContext): PlanAnswer {
|
|
368
|
+
const test = (t: PlanTest): PlanTest => {
|
|
369
|
+
const moved = t.covers.filter((u) => !ctx.unpinned.includes(u) && ctx.sourceIds.includes(u));
|
|
370
|
+
if (moved.length === 0) return t;
|
|
371
|
+
return { ...t, ids: [...t.ids, ...moved.filter((id) => !t.ids.includes(id))], covers: t.covers.filter((u) => !moved.includes(u)) };
|
|
372
|
+
};
|
|
373
|
+
const anchor = (x: AnchorRef): AnchorRef => {
|
|
374
|
+
if (x.kind !== "ref" || x.ref === undefined || x.path === undefined || ctx.refPaths.get(x.ref) !== x.path) return x;
|
|
375
|
+
const { path: _path, ...rest } = x;
|
|
376
|
+
return rest;
|
|
377
|
+
};
|
|
378
|
+
const reuse = (r: string): string => {
|
|
379
|
+
const lead = /^(I\d+)\b/.exec(r)?.[1];
|
|
380
|
+
return lead !== undefined && lead !== r && ctx.shownRefs.has(lead) ? lead : r;
|
|
381
|
+
};
|
|
382
|
+
return {
|
|
383
|
+
...a,
|
|
384
|
+
reuse: a.reuse.map(reuse),
|
|
385
|
+
batches: a.batches.map((b) => ({
|
|
386
|
+
...b,
|
|
387
|
+
steps: b.steps.map((s) => ({
|
|
388
|
+
...s,
|
|
389
|
+
tests: s.tests.map(test),
|
|
390
|
+
anchors: { tests: s.anchors.tests.map(anchor), doubles: s.anchors.doubles.map(anchor), production: s.anchors.production.map(anchor) },
|
|
391
|
+
})),
|
|
392
|
+
})),
|
|
393
|
+
};
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
function trimmed(a: PlanAnswer): PlanAnswer {
|
|
397
|
+
return {
|
|
398
|
+
feature: a.feature.trim(),
|
|
399
|
+
layers: trimAll(a.layers),
|
|
400
|
+
reuse: trimAll(a.reuse),
|
|
401
|
+
outOfScope: trimAll(a.outOfScope),
|
|
402
|
+
assumptions: trimAll(a.assumptions),
|
|
403
|
+
nonApplicable: a.nonApplicable.map((n) => ({ id: n.id.trim(), reason: n.reason.trim() })),
|
|
404
|
+
traceability: a.traceability.map((t) => ({ id: t.id.trim(), owners: trimAll(t.owners) })),
|
|
405
|
+
design: a.design.map((d) => ({
|
|
406
|
+
ids: trimAll(d.ids), aggregate: d.aggregate.trim(), invariant: d.invariant.trim(), consistency: d.consistency.trim(), batch: d.batch,
|
|
407
|
+
})),
|
|
408
|
+
batches: a.batches.map((b) => ({
|
|
409
|
+
name: b.name.trim(), intent: b.intent.trim(), reason: b.reason.trim(), documentation: b.documentation,
|
|
410
|
+
dependsOn: trimAll(b.dependsOn),
|
|
411
|
+
design: {
|
|
412
|
+
appliedRules: trimAll(b.design.appliedRules), aggregate: b.design.aggregate.trim(), invariants: b.design.invariants.trim(),
|
|
413
|
+
consistency: b.design.consistency.trim(), events: b.design.events.trim(), accessCost: b.design.accessCost.trim(),
|
|
414
|
+
},
|
|
415
|
+
decisions: trimAll(b.decisions),
|
|
416
|
+
declarative: trimAll(b.declarative),
|
|
417
|
+
steps: b.steps.map((s) => ({
|
|
418
|
+
title: s.title.trim(),
|
|
419
|
+
tests: s.tests.map((t) => ({ name: t.name.trim(), level: t.level, project: t.project.trim(), ids: trimAll(t.ids), covers: trimAll(t.covers) })),
|
|
420
|
+
note: trimNote(s.note),
|
|
421
|
+
anchors: { tests: s.anchors.tests.map(trimAnchor), doubles: s.anchors.doubles.map(trimAnchor), production: s.anchors.production.map(trimAnchor) },
|
|
422
|
+
})),
|
|
423
|
+
buildScope: b.buildScope.trim(),
|
|
424
|
+
testPolicy: { fast: b.testPolicy.fast.trim(), integration: b.testPolicy.integration.trim(), notRun: b.testPolicy.notRun.trim() },
|
|
425
|
+
elements: b.elements.map((e) => ({ layer: e.layer, signature: e.signature.trim(), rule: e.rule.trim() })),
|
|
426
|
+
})),
|
|
427
|
+
};
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
// ---- the cells ---------------------------------------------------------------------
|
|
431
|
+
|
|
432
|
+
type CellKind = "code" | "prose" | "note";
|
|
433
|
+
interface Cell { where: string; field: string; value: string; kind: CellKind }
|
|
434
|
+
|
|
435
|
+
/** The longest batch name or step title a problem's label quotes: the re-ask names what the model wrote,
|
|
436
|
+
* not only an index of an answer it no longer sees. */
|
|
437
|
+
export const LABEL_QUOTE = 60;
|
|
438
|
+
/** A `"` of the text becomes `'`, so the quote it sits in ends where the name ends. */
|
|
439
|
+
const quoted = (text: string): string => {
|
|
440
|
+
const one = text.replace(/\s+/g, " ").replace(/"/g, "'").trim();
|
|
441
|
+
if (one === "") return "";
|
|
442
|
+
const chars = Array.from(one);
|
|
443
|
+
return ` "${chars.length > LABEL_QUOTE ? `${chars.slice(0, LABEL_QUOTE).join("")}…` : one}"`;
|
|
444
|
+
};
|
|
445
|
+
/** Where a signature's body opens: its first "{" that does not open a shell expansion "${…}", else -1. A variable
|
|
446
|
+
* of a script (`${QUIET:-0}`) is not a body. */
|
|
447
|
+
const bodyOpening = (signature: string): number => {
|
|
448
|
+
for (let i = 0; i < signature.length; i++) if (signature[i] === "{" && signature[i - 1] !== "$") return i;
|
|
449
|
+
return -1;
|
|
450
|
+
};
|
|
451
|
+
/** `F1 "<name>"`, the name left out when empty: a batch is named as dependsOn and the rendered plan name it. */
|
|
452
|
+
const batchLabel = (b: PlanBatch, k: number): string => `F${k + 1}${quoted(b.name)}`;
|
|
453
|
+
/** `F1 "<name>" S2 "<title>"`; the anchor path check labels its problems the same way. */
|
|
454
|
+
export const stepLabel = (b: PlanBatch, k: number, j: number): string => `${batchLabel(b, k)} S${j + 1}${quoted(b.steps[j]?.title ?? "")}`;
|
|
455
|
+
const testLabel = (b: PlanBatch, k: number, j: number, m: number): string => `${stepLabel(b, k, j)} T${m + 1}`;
|
|
456
|
+
/** `design row 2 (<first id>)`, the id left out when the row has none. */
|
|
457
|
+
const designRow = (d: PlanAnswer["design"][number], i: number): string => {
|
|
458
|
+
const first = d.ids.find((id) => id !== "");
|
|
459
|
+
return `design row ${i + 1}${first === undefined ? "" : ` (${first})`}`;
|
|
460
|
+
};
|
|
461
|
+
|
|
462
|
+
function cellsOf(a: PlanAnswer): Cell[] {
|
|
463
|
+
const cells: Cell[] = [];
|
|
464
|
+
const add = (where: string, field: string, value: string, kind: CellKind): void => { cells.push({ where, field, value, kind }); };
|
|
465
|
+
add("plan", "feature", a.feature, "prose");
|
|
466
|
+
a.layers.forEach((v, i) => add("plan", `layers[${i}]`, v, "prose"));
|
|
467
|
+
a.outOfScope.forEach((v, i) => add("plan", `outOfScope[${i}]`, v, "prose"));
|
|
468
|
+
a.assumptions.forEach((v, i) => add("plan", `assumptions[${i}]`, v, "prose"));
|
|
469
|
+
a.nonApplicable.forEach((n, i) => add("plan", `nonApplicable[${i}].reason`, n.reason, "prose"));
|
|
470
|
+
a.traceability.forEach((t, i) => t.owners.forEach((o, j) => add("plan", `traceability[${i}].owners[${j}]`, o, "code")));
|
|
471
|
+
a.design.forEach((d, i) => {
|
|
472
|
+
const where = designRow(d, i);
|
|
473
|
+
add(where, "aggregate", d.aggregate, "code");
|
|
474
|
+
add(where, "invariant", d.invariant, "prose");
|
|
475
|
+
add(where, "consistency", d.consistency, "prose");
|
|
476
|
+
});
|
|
477
|
+
a.batches.forEach((b, k) => {
|
|
478
|
+
const where = batchLabel(b, k);
|
|
479
|
+
for (const f of ["name", "intent", "reason", "buildScope"] as const) add(where, f, b[f], "prose");
|
|
480
|
+
for (const f of ["aggregate", "invariants", "consistency", "events", "accessCost"] as const) add(where, `design.${f}`, b.design[f], "prose");
|
|
481
|
+
for (const f of ["fast", "integration", "notRun"] as const) add(where, `testPolicy.${f}`, b.testPolicy[f], "prose");
|
|
482
|
+
b.decisions.forEach((v, i) => add(where, `decisions[${i}]`, v, "prose"));
|
|
483
|
+
b.declarative.forEach((v, i) => add(where, `declarative[${i}]`, v, "prose"));
|
|
484
|
+
b.elements.forEach((e, i) => {
|
|
485
|
+
add(where, `elements[${i}].signature`, e.signature, "code");
|
|
486
|
+
add(where, `elements[${i}].rule`, e.rule, "prose");
|
|
487
|
+
});
|
|
488
|
+
b.steps.forEach((s, j) => {
|
|
489
|
+
const at = stepLabel(b, k, j);
|
|
490
|
+
add(at, "title", s.title, "prose");
|
|
491
|
+
add(at, "note", s.note, "note");
|
|
492
|
+
for (const column of ["tests", "doubles", "production"] as const) {
|
|
493
|
+
s.anchors[column].forEach((x, i) => {
|
|
494
|
+
if (x.path !== undefined) add(at, `anchors.${column}[${i}].path`, x.path, "code");
|
|
495
|
+
if (x.member !== undefined) add(at, `anchors.${column}[${i}].member`, x.member, "code");
|
|
496
|
+
});
|
|
497
|
+
}
|
|
498
|
+
s.tests.forEach((t, m) => {
|
|
499
|
+
add(testLabel(b, k, j, m), "name", t.name, "code");
|
|
500
|
+
add(testLabel(b, k, j, m), "project", t.project, "code");
|
|
501
|
+
});
|
|
502
|
+
});
|
|
503
|
+
});
|
|
504
|
+
return cells;
|
|
505
|
+
}
|
|
506
|
+
|
|
507
|
+
function cellProblems(cells: readonly Cell[]): string[] {
|
|
508
|
+
const out: string[] = [];
|
|
509
|
+
for (const c of cells) {
|
|
510
|
+
const head = `${c.where}: ${c.field}`;
|
|
511
|
+
if (c.kind === "code" && /[|`\r\n]/.test(c.value)) out.push(holdsCodeBreak(head));
|
|
512
|
+
if (c.kind === "prose" && /[|\r\n]/.test(c.value)) out.push(holdsBreak(head));
|
|
513
|
+
if (c.kind === "note" && (c.value.includes("|") || c.value.split(LINE_BREAK).length > 2)) {
|
|
514
|
+
out.push(holdsBreak(head));
|
|
515
|
+
}
|
|
516
|
+
if (LABELS.test(c.value)) out.push(holdsLabel(head));
|
|
517
|
+
if (c.value.split(LINE_BREAK).some((l) => LINE_MARKER.test(l.trimStart()))) {
|
|
518
|
+
out.push(startsWithMarker(head));
|
|
519
|
+
}
|
|
520
|
+
}
|
|
521
|
+
return out;
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
// ---- the plan's rules --------------------------------------------------------------
|
|
525
|
+
|
|
526
|
+
const isDocPath = (path: string): boolean => DOC_PATH.test(path) || path.startsWith("docs/");
|
|
527
|
+
|
|
528
|
+
function allAnchors(s: PlanStep): AnchorRef[] {
|
|
529
|
+
return [...s.anchors.tests, ...s.anchors.doubles, ...s.anchors.production];
|
|
530
|
+
}
|
|
531
|
+
|
|
532
|
+
function pathOf(a: AnchorRef, ctx: PlanCheckContext): string | undefined {
|
|
533
|
+
return a.kind === "ref" ? (a.ref === undefined ? undefined : ctx.refPaths.get(a.ref)) : a.path;
|
|
534
|
+
}
|
|
535
|
+
|
|
536
|
+
function anchorProblems(a: AnchorRef, at: string, ctx: PlanCheckContext, inventoryPaths: ReadonlySet<string>): string[] {
|
|
537
|
+
if (a.kind === "ref") {
|
|
538
|
+
if (a.ref === undefined || a.path !== undefined) return [refAnchorNeedsRef(at)];
|
|
539
|
+
return ctx.shownRefs.has(a.ref) ? [] : [anchorNotShown(at, a.ref)];
|
|
540
|
+
}
|
|
541
|
+
if (a.path === undefined || a.ref !== undefined) return [anchorNeedsPath(at, a.kind)];
|
|
542
|
+
const path = a.path;
|
|
543
|
+
const work = ctx.workFolder?.replace(/^\/+|\/+$/g, "");
|
|
544
|
+
if (path === "" || path.startsWith("/") || /^[A-Za-z]:/.test(path) || path.includes("\\") || path.split("/").includes("..")) {
|
|
545
|
+
return [cannotBeAnchored(at, path, NOT_RELATIVE)];
|
|
546
|
+
}
|
|
547
|
+
if (TOOLS_FOLDERS.some((f) => within(path, f))) return [cannotBeAnchored(at, path, TOOLS_FOLDER)];
|
|
548
|
+
if (work && within(path, work)) return [cannotBeAnchored(at, path, WORK_FOLDER)];
|
|
549
|
+
if (path.includes(":")) return [anchorPathColon(at, path)];
|
|
550
|
+
if (a.kind === "existing" && inventoryPaths.has(path)) return [inInventory(at, path)];
|
|
551
|
+
return [];
|
|
552
|
+
}
|
|
553
|
+
|
|
554
|
+
function stepProblems(b: PlanBatch, k: number, ctx: PlanCheckContext, inventoryPaths: ReadonlySet<string>): string[] {
|
|
555
|
+
const out: string[] = [];
|
|
556
|
+
const titles = new Map<string, number>();
|
|
557
|
+
b.steps.forEach((s, j) => {
|
|
558
|
+
const at = stepLabel(b, k, j);
|
|
559
|
+
// 5: the title.
|
|
560
|
+
if (s.title === "") out.push(titleEmpty(at));
|
|
561
|
+
else if (s.title.length > MAX_TITLE) out.push(titleTooLong(at, s.title.length, MAX_TITLE));
|
|
562
|
+
else if (s.title === BUILD_STEP) out.push(titleIsBuildStep(at, BUILD_STEP));
|
|
563
|
+
const first = titles.get(s.title);
|
|
564
|
+
if (s.title !== "" && first !== undefined) out.push(titleRepeats(at, first + 1));
|
|
565
|
+
else titles.set(s.title, j);
|
|
566
|
+
// 6, 7: the tests.
|
|
567
|
+
if (s.tests.length === 0) out.push(noTest(at));
|
|
568
|
+
s.tests.forEach((t, m) => {
|
|
569
|
+
const here = testLabel(b, k, j, m);
|
|
570
|
+
if (t.name === "") out.push(nameEmpty(here));
|
|
571
|
+
else if (t.name.length > MAX_TEST_NAME) out.push(nameTooLong(here, t.name.length, MAX_TEST_NAME));
|
|
572
|
+
if (t.project === "") out.push(projectEmpty(here));
|
|
573
|
+
for (const id of t.ids) if (!ctx.sourceIds.includes(id)) out.push(notSourceId(here, id));
|
|
574
|
+
for (const u of t.covers) if (!ctx.unpinned.includes(u)) out.push(notUnpinnedRow(here, u));
|
|
575
|
+
// A documentation step's test is the repository's documentation command: it proves no id of the source.
|
|
576
|
+
if (!b.documentation && t.ids.length === 0 && t.covers.length === 0) out.push(namesNoId(here));
|
|
577
|
+
});
|
|
578
|
+
// 13, 14, 26: each anchor.
|
|
579
|
+
for (const a of allAnchors(s)) out.push(...anchorProblems(a, at, ctx, inventoryPaths));
|
|
580
|
+
// 27: a production ref anchor's member is the entry, or the entry's last dotted segment.
|
|
581
|
+
for (const a of s.anchors.production) {
|
|
582
|
+
const name = a.kind === "ref" && a.ref !== undefined ? ctx.refNames.get(a.ref) : undefined;
|
|
583
|
+
if (name === undefined || a.member === undefined || a.member === "") continue;
|
|
584
|
+
if (a.member !== name && a.member !== name.slice(name.lastIndexOf(".") + 1)) {
|
|
585
|
+
out.push(memberIsNot(at, a.ref, a.member, name));
|
|
586
|
+
}
|
|
587
|
+
}
|
|
588
|
+
// 15: the columns a step needs.
|
|
589
|
+
if (!b.documentation && s.anchors.tests.length === 0) out.push(noTestAnchor(at));
|
|
590
|
+
if (s.anchors.production.length === 0) out.push(noProductionAnchor(at));
|
|
591
|
+
});
|
|
592
|
+
return out;
|
|
593
|
+
}
|
|
594
|
+
|
|
595
|
+
function batchProblems(b: PlanBatch, k: number, ctx: PlanCheckContext, inventoryPaths: ReadonlySet<string>): string[] {
|
|
596
|
+
const out: string[] = [];
|
|
597
|
+
const at = batchLabel(b, k);
|
|
598
|
+
// 3: the fields a sheet prints.
|
|
599
|
+
const fields: Array<[string, string]> = [
|
|
600
|
+
["name", b.name], ["intent", b.intent], ["reason", b.reason], ["buildScope", b.buildScope],
|
|
601
|
+
["testPolicy.fast", b.testPolicy.fast], ["testPolicy.integration", b.testPolicy.integration], ["testPolicy.notRun", b.testPolicy.notRun],
|
|
602
|
+
["design.aggregate", b.design.aggregate], ["design.invariants", b.design.invariants], ["design.consistency", b.design.consistency],
|
|
603
|
+
["design.events", b.design.events], ["design.accessCost", b.design.accessCost],
|
|
604
|
+
];
|
|
605
|
+
for (const [field, value] of fields) if (value === "") out.push(fieldEmpty(at, field));
|
|
606
|
+
// 4: the step count.
|
|
607
|
+
const min = b.documentation ? 1 : 2;
|
|
608
|
+
if (b.steps.length < min || b.steps.length > 5) {
|
|
609
|
+
out.push(stepCount(at, b.steps.length));
|
|
610
|
+
}
|
|
611
|
+
out.push(...stepProblems(b, k, ctx, inventoryPaths));
|
|
612
|
+
// 11: applied rules are design rule ids.
|
|
613
|
+
for (const id of b.design.appliedRules) if (!DESIGN_RULE_IDS.includes(id)) out.push(notDesignRuleId(at, id));
|
|
614
|
+
// 12: earlier batches only.
|
|
615
|
+
for (const dep of b.dependsOn) {
|
|
616
|
+
const m = /^F(\d+)$/.exec(dep);
|
|
617
|
+
if (m === null || Number(m[1]) < 1 || Number(m[1]) > k) out.push(notEarlierBatch(at, dep));
|
|
618
|
+
}
|
|
619
|
+
// 16: documentation stands alone (production paths).
|
|
620
|
+
const production = b.steps.flatMap((s) => s.anchors.production).map((a) => pathOf(a, ctx)).filter((p): p is string => p !== undefined);
|
|
621
|
+
const docs = production.filter(isDocPath);
|
|
622
|
+
if ((docs.length > 0 && !b.documentation) || (b.documentation && docs.length < production.length)) {
|
|
623
|
+
out.push(docsAndCode(at, [...new Set(docs)].join(", "), [...new Set(production.filter((p) => !isDocPath(p)))].join(", ")));
|
|
624
|
+
}
|
|
625
|
+
// 20, 21: the code elements.
|
|
626
|
+
if (!b.documentation && b.elements.length === 0) out.push(noCodeElement(at));
|
|
627
|
+
b.elements.forEach((e, i) => {
|
|
628
|
+
if (e.signature.length > MAX_SIGNATURE) out.push(elementTooLong(at, i + 1, e.signature.length, MAX_SIGNATURE));
|
|
629
|
+
const body = bodyOpening(e.signature);
|
|
630
|
+
if (body >= 0) out.push(elementHoldsBody(at, i + 1, quoted(e.signature.slice(body))));
|
|
631
|
+
});
|
|
632
|
+
return out;
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
function traceProblems(a: PlanAnswer, ctx: PlanCheckContext): string[] {
|
|
636
|
+
const out: string[] = [];
|
|
637
|
+
// 8: every source id carried by a test.
|
|
638
|
+
const carried = new Set(a.batches.flatMap((b) => b.steps.flatMap((s) => s.tests.flatMap((t) => t.ids))));
|
|
639
|
+
for (const id of ctx.sourceIds) if (!carried.has(id)) out.push(noTestCarries(id));
|
|
640
|
+
// 9: every source id owned by code.
|
|
641
|
+
const rows = new Map<string, number>();
|
|
642
|
+
for (const t of a.traceability) {
|
|
643
|
+
// 28: an owner names a type or a member, never a path.
|
|
644
|
+
for (const o of t.owners) if (OWNER_PATH.test(o)) out.push(ownerIsPath(o));
|
|
645
|
+
if (!ctx.sourceIds.includes(t.id)) { out.push(traceNotSourceId(t.id)); continue; }
|
|
646
|
+
if (rows.has(t.id)) { out.push(traceTwice(t.id)); continue; }
|
|
647
|
+
rows.set(t.id, t.owners.filter((o) => o !== "").length);
|
|
648
|
+
}
|
|
649
|
+
for (const id of ctx.sourceIds) if ((rows.get(id) ?? 0) === 0) out.push(noCodeOwner(id));
|
|
650
|
+
return out;
|
|
651
|
+
}
|
|
652
|
+
|
|
653
|
+
function designRuleProblems(a: PlanAnswer): string[] {
|
|
654
|
+
const out: string[] = [];
|
|
655
|
+
const applied = new Set(a.batches.flatMap((b) => b.design.appliedRules));
|
|
656
|
+
for (const id of DESIGN_RULE_IDS) {
|
|
657
|
+
const na = a.nonApplicable.filter((n) => n.id === id);
|
|
658
|
+
if (applied.has(id) && na.length > 0) out.push(appliedAndNa(id));
|
|
659
|
+
else if (!applied.has(id) && na.length === 0) out.push(neitherAppliedNorNa(id));
|
|
660
|
+
else if (na.length > 1) out.push(naTwice(id));
|
|
661
|
+
else if (na.length === 1 && na[0].reason.length < MIN_NA_REASON) out.push(naWithoutReason(id));
|
|
662
|
+
}
|
|
663
|
+
return out;
|
|
664
|
+
}
|
|
665
|
+
|
|
666
|
+
/** 17: two batches sharing an anchor path are ordered, directly or through others. */
|
|
667
|
+
function sharedAnchorProblems(a: PlanAnswer, ctx: PlanCheckContext): string[] {
|
|
668
|
+
const out: string[] = [];
|
|
669
|
+
const before: Array<Set<number>> = [];
|
|
670
|
+
a.batches.forEach((b, k) => {
|
|
671
|
+
const reach = new Set<number>();
|
|
672
|
+
for (const dep of b.dependsOn) {
|
|
673
|
+
const m = /^F(\d+)$/.exec(dep);
|
|
674
|
+
const i = m === null ? -1 : Number(m[1]) - 1;
|
|
675
|
+
if (i < 0 || i >= k) continue;
|
|
676
|
+
reach.add(i);
|
|
677
|
+
for (const x of before[i]) reach.add(x);
|
|
678
|
+
}
|
|
679
|
+
before.push(reach);
|
|
680
|
+
});
|
|
681
|
+
const paths = a.batches.map((b) => new Set(b.steps.flatMap(allAnchors).map((x) => pathOf(x, ctx)).filter((p): p is string => p !== undefined)));
|
|
682
|
+
for (let k = 0; k < paths.length; k++) {
|
|
683
|
+
for (let m = k + 1; m < paths.length; m++) {
|
|
684
|
+
const shared = [...paths[k]].filter((p) => paths[m].has(p)).sort();
|
|
685
|
+
if (shared.length > 0 && !before[m].has(k)) out.push(shareUnordered(batchLabel(a.batches[k], k), batchLabel(a.batches[m], m), shared[0]));
|
|
686
|
+
}
|
|
687
|
+
}
|
|
688
|
+
return out;
|
|
689
|
+
}
|
|
690
|
+
|
|
691
|
+
function changeProblems(a: PlanAnswer, ctx: PlanCheckContext): string[] {
|
|
692
|
+
if (ctx.kind !== "change") return [];
|
|
693
|
+
const out: string[] = [];
|
|
694
|
+
const tests = a.batches.flatMap((b) => b.steps.flatMap((s, j) => s.tests.map((t) => ({ t, first: j === 0 }))));
|
|
695
|
+
// 22: every pinned behaviour keeps its pinned test.
|
|
696
|
+
for (const name of ctx.pinned) {
|
|
697
|
+
const n = name.trim();
|
|
698
|
+
if (!tests.some(({ t }) => t.level === "pinned" && t.name === n)) out.push(pinnedNotInPlan(n));
|
|
699
|
+
}
|
|
700
|
+
// 23: every unpinned row gets a characterisation test, first in its batch.
|
|
701
|
+
for (const u of ctx.unpinned) {
|
|
702
|
+
const covering = tests.filter(({ t }) => t.covers.includes(u));
|
|
703
|
+
if (covering.length === 0) out.push(noCharacterisation(u));
|
|
704
|
+
else if (!covering.some(({ first }) => first)) out.push(notInFirstStep(u));
|
|
705
|
+
}
|
|
706
|
+
return out;
|
|
707
|
+
}
|
|
708
|
+
|
|
709
|
+
function capped(problems: readonly string[]): string[] {
|
|
710
|
+
if (problems.length <= MAX_PROBLEMS) return [...problems];
|
|
711
|
+
return [...problems.slice(0, MAX_PROBLEMS), moreProblems(problems.length - MAX_PROBLEMS)];
|
|
712
|
+
}
|
|
713
|
+
|
|
714
|
+
export function checkPlanAnswer(value: unknown, ctx: PlanCheckContext): Checked<PlanAnswer> {
|
|
715
|
+
if (!isObj(value)) return { ok: false, problems: [NOT_AN_OBJECT] };
|
|
716
|
+
const reader = new Reader();
|
|
717
|
+
const read = readAnswer(value, reader);
|
|
718
|
+
if (reader.problems.length > 0) return { ok: false, problems: capped(reader.problems) };
|
|
719
|
+
const a = mended(trimmed(read), ctx);
|
|
720
|
+
const problems: string[] = [];
|
|
721
|
+
// 24: the plan's own fields.
|
|
722
|
+
if (a.feature === "") problems.push(FEATURE_EMPTY);
|
|
723
|
+
else if (a.feature.length > MAX_FEATURE) problems.push(featureTooLong(a.feature.length, MAX_FEATURE));
|
|
724
|
+
if (a.layers.filter((l) => l !== "").length === 0) problems.push(LAYERS_EMPTY);
|
|
725
|
+
problems.push(...cellProblems(cellsOf(a)));
|
|
726
|
+
// 2: the batch count.
|
|
727
|
+
if (a.batches.length < 1 || a.batches.length > MAX_BATCHES) {
|
|
728
|
+
problems.push(batchCount(MAX_BATCHES, a.batches.length));
|
|
729
|
+
}
|
|
730
|
+
// 6: test names unique across the plan.
|
|
731
|
+
const names = new Map<string, string>();
|
|
732
|
+
a.batches.forEach((b, k) => b.steps.forEach((s, j) => s.tests.forEach((t, m) => {
|
|
733
|
+
if (t.name === "") return;
|
|
734
|
+
const first = names.get(t.name);
|
|
735
|
+
if (first !== undefined) problems.push(nameRepeats(testLabel(b, k, j, m), first));
|
|
736
|
+
else names.set(t.name, testLabel(b, k, j, m));
|
|
737
|
+
})));
|
|
738
|
+
const inventoryPaths = new Set(ctx.refPaths.values());
|
|
739
|
+
a.batches.forEach((b, k) => problems.push(...batchProblems(b, k, ctx, inventoryPaths)));
|
|
740
|
+
problems.push(...traceProblems(a, ctx));
|
|
741
|
+
problems.push(...designRuleProblems(a));
|
|
742
|
+
problems.push(...sharedAnchorProblems(a, ctx));
|
|
743
|
+
// 18: reuse names shown entries.
|
|
744
|
+
for (const ref of a.reuse) if (!ctx.shownRefs.has(ref)) problems.push(reuseNotShown(ref));
|
|
745
|
+
// 19: design rows.
|
|
746
|
+
a.design.forEach((d, i) => {
|
|
747
|
+
if (d.batch < 1 || d.batch > a.batches.length) problems.push(notBatchOfPlan(designRow(d, i), d.batch));
|
|
748
|
+
for (const id of d.ids) if (!ctx.sourceIds.includes(id)) problems.push(notSourceId(designRow(d, i), id));
|
|
749
|
+
});
|
|
750
|
+
problems.push(...changeProblems(a, ctx));
|
|
751
|
+
if (problems.length > 0) return { ok: false, problems: capped(problems) };
|
|
752
|
+
return { ok: true, value: a };
|
|
753
|
+
}
|