orkeon-code 1.0.0-rc.1 → 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 -1
- package/NOTICE.md +1 -1
- package/README.fr.md +16 -22
- package/README.md +16 -22
- package/config/appsettings.jev.example.json +4 -1
- package/config/appsettings.kev.example.json +4 -1
- package/config/appsettings.liquid.example.json +4 -1
- package/config/appsettings.ollama-whisper.example.json +1 -0
- package/config/appsettings.whisper.example.json +1 -0
- package/mcp/whisper/README.md +2 -1
- package/orkeon-code +206 -11
- package/orkeon-code.ps1 +109 -7
- package/package.json +2 -1
- package/src/commands/.orkeon/orkeon-cli.d.ts +1 -4
- package/src/commands/_lib/args.ts +5 -4
- package/src/commands/_lib/dev/dev-batches.ts +34 -36
- package/src/commands/_lib/dev/dev-implement.ts +11 -14
- package/src/commands/_lib/dev/dev-source.ts +7 -11
- package/src/commands/_lib/dev/dev.ts +34 -37
- 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 +16 -13
- package/src/commands/_lib/dispatch.ts +62 -39
- package/src/commands/_lib/git/branch.ts +9 -10
- package/src/commands/_lib/git/commit.ts +9 -13
- package/src/commands/_lib/git/diff.ts +22 -12
- package/src/commands/_lib/git/messages.ts +54 -0
- package/src/commands/_lib/git/review.ts +9 -10
- package/src/commands/_lib/memory/memory-admit.ts +19 -21
- package/src/commands/_lib/memory/memory.ts +3 -2
- package/src/commands/_lib/memory/messages.ts +32 -0
- package/src/commands/_lib/messages.ts +48 -0
- package/src/commands/_lib/project/messages.ts +8 -0
- package/src/commands/_lib/session/export.ts +3 -2
- 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 +15 -24
- package/src/commands/_lib/session/tasks.ts +20 -23
- package/src/commands/_lib/settings/advisor.ts +11 -16
- package/src/commands/_lib/settings/agents.ts +18 -28
- package/src/commands/_lib/settings/choices.ts +8 -0
- package/src/commands/_lib/settings/config.ts +43 -43
- package/src/commands/_lib/settings/effort.ts +147 -0
- package/src/commands/_lib/settings/hooks.ts +12 -20
- package/src/commands/_lib/settings/messages.ts +408 -0
- package/src/commands/_lib/settings/mode.ts +33 -24
- package/src/commands/_lib/settings/model.ts +71 -36
- package/src/commands/_lib/settings/output-style.ts +39 -0
- package/src/commands/_lib/settings/permissions.ts +71 -93
- package/src/commands/_lib/settings/route.ts +63 -0
- package/src/commands/_lib/settings/skills.ts +53 -11
- 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 +9 -10
- package/src/commands/_lib/speech/transcribe.ts +14 -23
- package/src/commands/_lib/speech/voice.ts +14 -18
- package/src/commands/_lib/status/doctor.ts +47 -28
- package/src/commands/_lib/status/messages.ts +100 -0
- package/src/commands/_lib/status/meta.ts +3 -24
- package/src/commands/_lib/status/status.ts +10 -11
- package/src/commands/_lib/status/usage-tools.ts +2 -3
- package/src/commands/_lib/status/usage.ts +7 -18
- package/src/commands/_lib/view.ts +6 -1
- package/src/commands/dev/dev-batches.cmd.ts +4 -3
- package/src/commands/dev/dev-learn.cmd.ts +3 -3
- package/src/commands/dev/dev-plan.cmd.ts +6 -7
- package/src/commands/dev/dev-spec.cmd.ts +6 -7
- package/src/commands/git/commit.cmd.ts +3 -3
- package/src/commands/git/review.cmd.ts +3 -3
- package/src/commands/memory/memory.cmd.ts +2 -2
- package/src/commands/project/analyze.cmd.ts +3 -3
- package/src/commands/project/debug-tool-call.cmd.ts +4 -9
- package/src/commands/project/init-verifiers.cmd.ts +3 -3
- package/src/commands/project/init.cmd.ts +3 -3
- package/src/commands/project/verify.cmd.ts +2 -2
- package/src/commands/session/assistant.cmd.ts +2 -2
- package/src/commands/session/compact.cmd.ts +1 -1
- package/src/commands/session/copy.cmd.ts +8 -7
- package/src/commands/session/rename.cmd.ts +3 -2
- package/src/commands/session/rewind.cmd.ts +3 -4
- package/src/commands/session/summary.cmd.ts +3 -3
- package/src/commands/session/tasks.cmd.ts +4 -2
- package/src/commands/settings/config.cmd.ts +4 -2
- package/src/commands/settings/effort.cmd.ts +10 -31
- package/src/commands/settings/fast.cmd.ts +2 -1
- package/src/commands/settings/mode.cmd.ts +3 -3
- package/src/commands/settings/model.cmd.ts +3 -2
- package/src/commands/settings/output-style.cmd.ts +9 -38
- package/src/commands/settings/permissions.cmd.ts +2 -2
- package/src/commands/settings/proactive.cmd.ts +2 -1
- package/src/commands/settings/route.cmd.ts +16 -0
- package/src/commands/settings/skills.cmd.ts +3 -3
- package/src/commands/settings/theme.cmd.ts +14 -0
- package/src/commands/speech/say.cmd.ts +2 -2
- package/src/commands/speech/transcribe.cmd.ts +2 -2
- package/src/commands/status/release-notes.cmd.ts +1 -1
- package/src/crews/.orkeon/orkeon.d.ts +538 -93
- package/src/crews/_probe-shared-memory/domain/messages.ts +54 -0
- package/src/crews/_probe-shared-memory/domain/probe-verdict.ts +17 -12
- package/src/crews/_probe-shared-memory/domain/prompts.ts +5 -0
- package/src/crews/_probe-shared-memory/probe.ork.ts +5 -3
- 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 +2 -1
- package/src/crews/advisor/crew.ork.ts +5 -4
- package/src/crews/advisor/domain/advice.ts +7 -23
- 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 +5 -4
- package/src/crews/agent-run/crew.ork.ts +3 -3
- 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 +16 -14
- package/src/crews/analyze/crew.ork.ts +5 -4
- package/src/crews/analyze/domain/harvest.ts +33 -65
- 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 +10 -17
- package/src/crews/code-review/application/review.ts +4 -1
- package/src/crews/code-review/application/run-code-review.ts +13 -15
- package/src/crews/code-review/crew.ork.ts +5 -4
- package/src/crews/code-review/domain/lenses.ts +6 -45
- 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 +5 -6
- package/src/crews/code-review/domain/scope.ts +6 -12
- package/src/crews/dev-batches/application/messages.ts +127 -0
- package/src/crews/dev-batches/application/plan-close.ts +12 -12
- package/src/crews/dev-batches/application/prompts.ts +10 -0
- package/src/crews/dev-batches/application/run-dev-batches.ts +57 -50
- package/src/crews/dev-batches/application/run-wave.ts +24 -22
- package/src/crews/dev-batches/application/seed-harvest.ts +8 -7
- package/src/crews/dev-batches/crew.ork.ts +12 -9
- package/src/crews/dev-batches/domain/batches-log.ts +1 -3
- 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 +3 -2
- package/src/crews/dev-change/application/change-material.ts +44 -0
- package/src/crews/dev-change/application/evidence.ts +25 -22
- package/src/crews/dev-change/application/messages.ts +81 -0
- package/src/crews/dev-change/application/{change-prompt.ts → prompts.ts} +40 -43
- package/src/crews/dev-change/application/run-dev-change.ts +43 -34
- package/src/crews/dev-change/crew.ork.ts +11 -9
- package/src/crews/dev-change/domain/change-answer.ts +24 -20
- package/src/crews/dev-change/domain/change-render.ts +13 -15
- 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 +21 -18
- package/src/crews/dev-implement/application/locate-sheet.ts +7 -5
- package/src/crews/dev-implement/application/messages.ts +161 -0
- package/src/crews/dev-implement/application/observe.ts +4 -2
- package/src/crews/dev-implement/application/prompts.ts +9 -0
- package/src/crews/dev-implement/application/report-writes.ts +14 -9
- package/src/crews/dev-implement/application/run-dev-implement.ts +84 -73
- package/src/crews/dev-implement/application/suite-job.ts +15 -11
- package/src/crews/dev-implement/crew.ork.ts +2 -1
- package/src/crews/dev-implement/domain/contracts.ts +59 -60
- package/src/crews/dev-implement/domain/correction.ts +16 -15
- package/src/crews/dev-implement/domain/cycles.ts +2 -1
- 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 +3 -7
- package/src/crews/dev-implement/domain/sheet-edits.ts +6 -5
- package/src/crews/dev-implement/domain/sheet-ticks.ts +5 -4
- package/src/crews/dev-implement/domain/step-checks.ts +17 -16
- package/src/crews/dev-implement/domain/step-section.ts +6 -4
- 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/{learn-prompt.ts → prompts.ts} +24 -65
- package/src/crews/dev-learn/application/run-dev-learn.ts +37 -32
- package/src/crews/dev-learn/crew.ork.ts +4 -3
- package/src/crews/dev-learn/domain/learn-answer.ts +25 -27
- package/src/crews/dev-learn/domain/messages.ts +65 -0
- package/src/crews/dev-learn/domain/owner-lines.ts +12 -9
- package/src/crews/dev-learn/domain/proposals-render.ts +8 -9
- package/src/crews/dev-plan/application/anchor-paths.ts +57 -20
- package/src/crews/dev-plan/application/inventory.ts +17 -13
- 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/{plan-prompt.ts → prompts.ts} +37 -55
- package/src/crews/dev-plan/application/run-dev-plan.ts +103 -75
- package/src/crews/dev-plan/crew.ork.ts +11 -8
- package/src/crews/dev-plan/domain/inventory-model.ts +3 -3
- 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 +118 -103
- package/src/crews/dev-plan/domain/plan-render.ts +30 -31
- 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/{spec-prompt.ts → prompts.ts} +42 -47
- package/src/crews/dev-spec/application/run-dev-spec.ts +67 -36
- package/src/crews/dev-spec/application/spec-material.ts +42 -0
- package/src/crews/dev-spec/crew.ork.ts +11 -9
- 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 +46 -47
- package/src/crews/dev-spec/domain/spec-render.ts +18 -18
- package/src/crews/dev-verify/application/audit-brief.ts +187 -0
- package/src/crews/dev-verify/application/audit.ts +38 -30
- package/src/crews/dev-verify/application/capture.ts +34 -26
- 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 +60 -46
- package/src/crews/dev-verify/application/run-gate.ts +11 -9
- package/src/crews/dev-verify/crew.ork.ts +6 -6
- package/src/crews/dev-verify/domain/audit-answer.ts +16 -12
- package/src/crews/dev-verify/domain/capture-sections.ts +5 -4
- package/src/crews/dev-verify/domain/commands.ts +3 -3
- package/src/crews/dev-verify/domain/gate.ts +21 -16
- package/src/crews/dev-verify/domain/markers.ts +16 -0
- package/src/crews/dev-verify/domain/mechanical-table.ts +37 -44
- package/src/crews/dev-verify/domain/messages.ts +92 -0
- package/src/crews/dev-verify/domain/verdict.ts +4 -4
- package/src/crews/git-commit/application/draft.ts +16 -37
- 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 +13 -12
- package/src/crews/git-commit/crew.ork.ts +5 -4
- package/src/crews/git-commit/domain/commit.ts +15 -35
- 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 +2 -1
- package/src/crews/init-verifiers/application/messages.ts +13 -0
- package/src/crews/init-verifiers/application/prompts.ts +5 -1
- package/src/crews/init-verifiers/application/run-init-verifiers.ts +3 -2
- package/src/crews/init-verifiers/crew.ork.ts +5 -4
- package/src/crews/main-loop/application/auto-compact.ts +2 -1
- 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 +63 -30
- package/src/crews/main-loop/application/{turn-prompt.ts → turn-context.ts} +7 -8
- package/src/crews/main-loop/crew.ork.ts +12 -7
- package/src/crews/main-loop/domain/prompt-assembly.ts +45 -228
- package/src/crews/main-loop/domain/prompts.ts +336 -0
- package/src/crews/main-loop/domain/turn-chains.ts +10 -9
- package/src/crews/project-init/application/detect.ts +5 -4
- package/src/crews/project-init/application/messages.ts +15 -0
- package/src/crews/project-init/application/prompts.ts +11 -7
- package/src/crews/project-init/crew.ork.ts +5 -4
- package/src/crews/project-init/domain/existing-files.ts +6 -4
- package/src/crews/project-init/domain/messages.ts +13 -0
- package/src/crews/project-init/domain/package-map.ts +3 -3
- 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 +5 -4
- package/src/crews/shared-memory-admit/application/prompts.ts +5 -0
- package/src/crews/shared-memory-admit/crew.ork.ts +3 -2
- 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 +2 -1
- package/src/crews/speech/crew.ork.ts +2 -1
- package/src/shared/application/agents/child-agent.ts +11 -7
- 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 +31 -8
- package/src/shared/application/compaction/compact-session.ts +19 -14
- 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/dev/brief-inventory.ts +6 -4
- package/src/shared/application/dev/close-batch.ts +9 -7
- package/src/shared/application/dev/find-repo-pack.ts +4 -3
- package/src/shared/application/dev/learn-decision.ts +20 -18
- package/src/shared/application/dev/load-dev-context.ts +7 -8
- package/src/shared/application/dev/measure-access-cost.ts +5 -4
- 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 +12 -8
- package/src/shared/application/dev/preflight.ts +8 -8
- package/src/shared/application/dev/prompts.ts +34 -0
- package/src/shared/application/dev/question-round.ts +25 -17
- package/src/shared/application/dev/resolve-work-folder.ts +4 -3
- package/src/shared/application/dev/settle-questions.ts +4 -2
- package/src/shared/application/dev/source-review.ts +12 -8
- package/src/shared/application/dev/source-step.ts +12 -10
- package/src/shared/application/dev/spend.ts +17 -4
- package/src/shared/application/dev/step-precedents.ts +2 -1
- package/src/shared/application/dev/tool-call-policy.ts +9 -11
- package/src/shared/application/dev/tool-callbacks.ts +52 -5
- package/src/shared/application/dev/tool-trace-recorder.ts +2 -1
- package/src/shared/application/dev/verdict-sources.ts +5 -3
- package/src/shared/application/dev/wrapped-tools.ts +4 -2
- package/src/shared/application/extra-tools.ts +2 -1
- package/src/shared/application/git/batch-worktree.ts +22 -17
- package/src/shared/application/git/commit-files.ts +24 -19
- package/src/shared/application/git/merge-batch.ts +11 -7
- package/src/shared/application/git/messages.ts +75 -0
- package/src/shared/application/git/open-pull-request.ts +4 -3
- package/src/shared/application/host-context.ts +59 -0
- package/src/shared/application/host-layout-store.ts +45 -0
- package/src/shared/application/llm-profile.ts +4 -3
- package/src/shared/application/messages.ts +14 -0
- package/src/shared/application/permission-rules.ts +10 -0
- package/src/shared/application/ports/decision.ts +14 -0
- package/src/shared/application/ports/human.ts +25 -0
- package/src/shared/application/ports/llm.ts +32 -3
- package/src/shared/application/ports/memory.ts +1 -1
- package/src/shared/application/ports/theme.ts +11 -0
- package/src/shared/application/ports.ts +4 -2
- package/src/shared/application/session-io.ts +2 -1
- package/src/shared/application/shared-memory/admit-entries.ts +16 -14
- package/src/shared/application/shared-memory/harvest-after-gaps.ts +5 -8
- package/src/shared/application/shared-memory/harvest-mistakes.ts +3 -2
- package/src/shared/application/shared-memory/import-agent-memory.ts +9 -7
- package/src/shared/application/shared-memory/memory-files.ts +2 -1
- package/src/shared/application/shared-memory/memory-settings.ts +2 -1
- package/src/shared/application/shared-memory/messages.ts +63 -0
- package/src/shared/application/shared-memory/push-candidate.ts +14 -11
- package/src/shared/application/shared-memory/recall-precedents.ts +2 -1
- package/src/shared/application/skills/messages.ts +4 -0
- package/src/shared/application/skills/suggest-skills.ts +102 -0
- package/src/shared/application/workflow/messages.ts +8 -0
- package/src/shared/application/workflow/workflow-state.ts +7 -6
- package/src/shared/domain/agent-policy/behavior-flags.ts +4 -10
- package/src/shared/domain/agent-policy/extra-tools.ts +2 -4
- package/src/shared/domain/agent-policy/messages.ts +66 -0
- package/src/shared/domain/agent-policy/path-rules.ts +299 -0
- package/src/shared/domain/agent-policy/permission.ts +20 -18
- 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 +18 -14
- package/src/shared/domain/agent-policy/tool-access.ts +17 -3
- package/src/shared/domain/agent-registry.ts +6 -5
- package/src/shared/domain/agents/chain.ts +2 -2
- package/src/shared/domain/agents/charter.ts +8 -5
- package/src/shared/domain/agents/exclusive.ts +2 -1
- package/src/shared/domain/agents/instances.ts +18 -15
- 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 +5 -4
- package/src/shared/domain/code-intel-routing.ts +8 -61
- package/src/shared/domain/compact-outcome.ts +5 -3
- package/src/shared/domain/compaction-thresholds.ts +2 -1
- package/src/shared/domain/compaction.ts +22 -113
- package/src/shared/domain/config-schema.ts +94 -81
- 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 +19 -15
- package/src/shared/domain/dev/batches-concurrency.ts +5 -6
- package/src/shared/domain/dev/build-commands.ts +5 -4
- package/src/shared/domain/dev/call-guard.ts +29 -28
- package/src/shared/domain/dev/carried-text.ts +3 -5
- package/src/shared/domain/dev/learn-proposals.ts +5 -4
- package/src/shared/domain/dev/learn-state.ts +3 -2
- package/src/shared/domain/dev/markers.ts +107 -0
- package/src/shared/domain/dev/messages.ts +259 -0
- package/src/shared/domain/dev/phase-timing.ts +50 -0
- package/src/shared/domain/dev/plan-checks.ts +24 -23
- package/src/shared/domain/dev/plan-format.ts +14 -24
- package/src/shared/domain/dev/project-files.ts +1 -15
- package/src/shared/domain/dev/prompts/brief-blocks.ts +20 -0
- package/src/shared/domain/dev/{review-prompt.ts → prompts.ts} +91 -61
- package/src/shared/domain/dev/questions.ts +33 -15
- package/src/shared/domain/dev/repo-pack.ts +12 -9
- package/src/shared/domain/dev/review-answer.ts +40 -17
- package/src/shared/domain/dev/review-brief.ts +54 -0
- package/src/shared/domain/dev/reviewer-charter.ts +4 -0
- package/src/shared/domain/dev/sheet-facts.ts +2 -4
- package/src/shared/domain/dev/spec-format.ts +13 -14
- package/src/shared/domain/dev/step-budget.ts +4 -2
- package/src/shared/domain/dev/step-rules.ts +3 -4
- package/src/shared/domain/dev/test-commands.ts +14 -10
- package/src/shared/domain/dev/tool-guards.ts +4 -3
- package/src/shared/domain/dev/trait-pattern.ts +14 -10
- package/src/shared/domain/dev/verdict-format.ts +14 -21
- package/src/shared/domain/dev/whitespace.ts +3 -2
- package/src/shared/domain/dev/work-folder.ts +4 -3
- package/src/shared/domain/dev/yaml-subset.ts +8 -26
- package/src/shared/domain/error-text.ts +13 -0
- package/src/shared/domain/git/close.ts +5 -4
- package/src/shared/domain/git/messages.ts +20 -0
- package/src/shared/domain/git/pull-request.ts +5 -5
- package/src/shared/domain/host-layout.ts +147 -0
- package/src/shared/domain/host-paths.ts +399 -0
- package/src/shared/domain/llm-failure.ts +35 -7
- package/src/shared/domain/llm-profile.ts +22 -3
- package/src/shared/domain/marked-message.ts +1 -5
- package/src/shared/domain/markers.ts +30 -0
- package/src/shared/domain/messages.ts +291 -0
- package/src/shared/domain/model-catalog.ts +2 -9
- package/src/shared/domain/permission-modes.ts +4 -8
- package/src/shared/domain/prelude.ts +2 -2
- package/src/shared/domain/project-manifests.ts +3 -2
- package/src/shared/domain/prompts.ts +233 -0
- package/src/shared/domain/search-routing.ts +3 -11
- package/src/shared/domain/secret-patterns.ts +3 -2
- package/src/shared/domain/session-keys.ts +7 -0
- package/src/shared/domain/session-start.ts +3 -2
- package/src/shared/domain/shared-memory/agent-memory-import.ts +4 -2
- package/src/shared/domain/shared-memory/candidates.ts +3 -4
- package/src/shared/domain/shared-memory/entry.ts +26 -20
- package/src/shared/domain/shared-memory/front-matter.ts +17 -13
- package/src/shared/domain/shared-memory/gate.ts +4 -3
- package/src/shared/domain/shared-memory/harvest.ts +9 -6
- package/src/shared/domain/shared-memory/layout.ts +11 -8
- 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 +4 -15
- package/src/shared/domain/shared-memory/prompts.ts +28 -0
- package/src/shared/domain/shared-memory/refused.ts +3 -3
- 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 +2 -14
- package/src/shared/domain/speech.ts +2 -1
- package/src/shared/domain/tool-trace.ts +5 -7
- package/src/shared/domain/verifiers.ts +7 -11
- package/src/shared/domain/vfs.ts +8 -1
- package/src/shared/domain/workflow/prompts.ts +15 -0
- package/src/shared/domain/workflow/state-file.ts +14 -12
- package/src/shared/infrastructure/globals.ts +7 -2
- package/src/shared/infrastructure/orkeon/child-agents.ts +11 -16
- package/src/shared/infrastructure/orkeon/chooser.ts +32 -0
- package/src/shared/infrastructure/orkeon/decision-model.ts +31 -0
- package/src/shared/infrastructure/orkeon/dev-deps.ts +21 -14
- package/src/shared/infrastructure/orkeon/files.ts +24 -6
- package/src/shared/infrastructure/orkeon/github-pull-requests.ts +3 -2
- package/src/shared/infrastructure/orkeon/host-context.ts +36 -0
- package/src/shared/infrastructure/orkeon/human-input.ts +1 -5
- package/src/shared/infrastructure/orkeon/llm-profile.ts +36 -16
- package/src/shared/infrastructure/orkeon/llm.ts +85 -30
- package/src/shared/infrastructure/orkeon/markers.ts +6 -0
- package/src/shared/infrastructure/orkeon/memory-store.ts +1 -1
- package/src/shared/infrastructure/orkeon/memory-tools.ts +18 -20
- package/src/shared/infrastructure/orkeon/messages.ts +15 -0
- package/src/shared/infrastructure/orkeon/prompts.ts +47 -0
- package/src/shared/infrastructure/orkeon/reasoning.ts +40 -0
- package/src/shared/infrastructure/orkeon/script-tools.ts +14 -19
- package/src/shared/infrastructure/orkeon/session-store.ts +7 -51
- package/src/shared/infrastructure/orkeon/shell-jobs.ts +13 -7
- package/src/shared/infrastructure/orkeon/shell.ts +13 -5
- package/src/shared/infrastructure/orkeon/tool-catalogue.ts +3 -2
- package/src/shared/infrastructure/orkeon/wiring.ts +68 -12
- package/src/crews/dev-verify/application/auditor-prompt.ts +0 -323
- package/src/shared/domain/session-summary.ts +0 -13
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
// The spec writer's prompt, assembled for one extract call: the head (instructions, mode, problems, decisions), then
|
|
2
|
+
// the material cut to the room the cap leaves - past the cap the current file is cut first, then the request, then
|
|
3
|
+
// the inventory. The text is ./prompts.ts's.
|
|
4
|
+
import type { Decision } from "../../../shared/domain/dev/questions.ts";
|
|
5
|
+
import { NO_INVENTORY, cutByCode, specPromptHead, specPromptMaterial } from "./prompts.ts";
|
|
6
|
+
import type { SpecPromptMode } from "./prompts.ts";
|
|
7
|
+
|
|
8
|
+
export interface SpecPromptInput {
|
|
9
|
+
mode: SpecPromptMode;
|
|
10
|
+
code: string;
|
|
11
|
+
/** The brief of a new spec, or the request typed after the code on a revision; "" when none. */
|
|
12
|
+
request: string;
|
|
13
|
+
/** The spec as it is on disk (revision) or as just written (fold); "" for a draft. */
|
|
14
|
+
current: string;
|
|
15
|
+
decisions: readonly Decision[];
|
|
16
|
+
/** The decisions of this run, which a fold writes into the body. */
|
|
17
|
+
fresh: readonly Decision[];
|
|
18
|
+
inventory: string;
|
|
19
|
+
/** The "## Precedents" block the step recalled (T1), "" or absent when none: material, placed last. */
|
|
20
|
+
precedents?: string;
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
const MAX_SPEC_PROMPT_CHARS = 60_000;
|
|
24
|
+
const MIN_PART = 2_000;
|
|
25
|
+
|
|
26
|
+
function cut(text: string, max: number): string {
|
|
27
|
+
if (text.length <= max) return text;
|
|
28
|
+
return cutByCode(text.slice(0, Math.max(0, max - 20)));
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
export function buildSpecPrompt(input: SpecPromptInput, problems: readonly string[]): string {
|
|
32
|
+
const head = specPromptHead(input.code, input.mode, problems, input.decisions, input.fresh);
|
|
33
|
+
const precedents = (input.precedents ?? "").trimEnd();
|
|
34
|
+
const fixed = head.join("\n").length + precedents.length + 400;
|
|
35
|
+
let room = MAX_SPEC_PROMPT_CHARS - fixed;
|
|
36
|
+
const inventory = cut(input.inventory.trimEnd() || NO_INVENTORY, Math.max(MIN_PART, Math.floor(room / 4)));
|
|
37
|
+
room -= inventory.length;
|
|
38
|
+
const request = cut(input.request.trim(), Math.max(MIN_PART, Math.floor(room / 3)));
|
|
39
|
+
room -= request.length;
|
|
40
|
+
const current = cut(input.current.trimEnd(), Math.max(MIN_PART, room));
|
|
41
|
+
return [...head, ...specPromptMaterial(input.mode, current, request, inventory, precedents)].join("\n");
|
|
42
|
+
}
|
|
@@ -7,8 +7,7 @@
|
|
|
7
7
|
// a time through human_input (each answer written before the next question), folds the answers into the body, then
|
|
8
8
|
// has the read-only reviewer question the spec once. Unattended, the questions stay in the file: BLOCKED.
|
|
9
9
|
// The reviewer's act runs in a background child, `dev-reviewer` (its charter: read tools only, plan mode), which
|
|
10
|
-
// /tasks lists and stops while it runs, as /dev-plan's (A-3, approach A2)
|
|
11
|
-
// it runs inline.
|
|
10
|
+
// /tasks lists and stops while it runs, as /dev-plan's (A-3, approach A2).
|
|
12
11
|
//
|
|
13
12
|
// Input (globalThis.inputs): { code: string, request?: string (the brief, a path to it, or a revision request),
|
|
14
13
|
// hooks?: the /hooks registry, effort?: "low" | "medium" | "high" | "xhigh" | "max" | null,
|
|
@@ -23,6 +22,7 @@
|
|
|
23
22
|
|
|
24
23
|
import { CrewBuilder, publishCrew, inputs, ToolBuilder } from "../../shared/infrastructure/globals.ts";
|
|
25
24
|
import {
|
|
25
|
+
orkeonActRoute, orkeonPrunedLlm,
|
|
26
26
|
orkeonAgent,
|
|
27
27
|
orkeonClock,
|
|
28
28
|
orkeonCodeIndex,
|
|
@@ -35,7 +35,7 @@ import {
|
|
|
35
35
|
orkeonShell,
|
|
36
36
|
} from "../../shared/infrastructure/orkeon/wiring.ts";
|
|
37
37
|
import { memoryReadTools, memoryRecallOn, memoryRecallTools } from "../../shared/infrastructure/orkeon/memory-tools.ts";
|
|
38
|
-
import {
|
|
38
|
+
import { agentLlm } from "../../shared/infrastructure/orkeon/llm.ts";
|
|
39
39
|
import { providerEffort } from "../../shared/domain/agent-policy/behavior-flags.ts";
|
|
40
40
|
import { memoryDirOf } from "../../shared/application/shared-memory/memory-settings.ts";
|
|
41
41
|
import { devToolCallbacks } from "../../shared/application/dev/tool-callbacks.ts";
|
|
@@ -43,9 +43,11 @@ import { childAgentBody, openChildAct } from "../../shared/infrastructure/orkeon
|
|
|
43
43
|
import { charterCatalogue } from "../../shared/domain/agents/charter.ts";
|
|
44
44
|
import { instanceLimits } from "../../shared/domain/agents/instances.ts";
|
|
45
45
|
import { REVIEWER_CHARTER } from "../../shared/domain/dev/reviewer-charter.ts";
|
|
46
|
+
import { reviewerCallbacks } from "../../shared/application/dev/spend.ts";
|
|
46
47
|
import { STEP_BUDGETS } from "../../shared/domain/dev/step-budget.ts";
|
|
47
48
|
import { stepPrecedents } from "../../shared/application/dev/step-precedents.ts";
|
|
48
49
|
import { runDevSpec } from "./application/run-dev-spec.ts";
|
|
50
|
+
import { SPEC_REVIEW_TASK, SPEC_WRITER_GOAL } from "./application/messages.ts";
|
|
49
51
|
|
|
50
52
|
const ports = { shell: orkeonShell(), files: orkeonFiles(), config: orkeonConfigStore(), index: orkeonCodeIndex(), human: orkeonHumanInput() };
|
|
51
53
|
// memory_recall is attached unless a session rule denies every call of it (the command says so).
|
|
@@ -53,7 +55,7 @@ const memoryOn = memoryRecallOn(inputs());
|
|
|
53
55
|
const effort = providerEffort(inputs().effort);
|
|
54
56
|
const session = orkeonSessionIo();
|
|
55
57
|
const limits = instanceLimits(inputs());
|
|
56
|
-
//
|
|
58
|
+
// These callbacks, then the host's gate on the input they return (Orkeon #303): the step's rule sets again and the /hooks the command passed.
|
|
57
59
|
const callbacksFor = (ctx: any) => devToolCallbacks(
|
|
58
60
|
{ step: "dev-spec", hooks: inputs().hooks, readTools: memoryReadTools(memoryOn) }, { shell: ports.shell, log: ctx.log, memoryDir: memoryDirOf(ports.config) },
|
|
59
61
|
);
|
|
@@ -67,14 +69,14 @@ const reviewer = () => {
|
|
|
67
69
|
.tools(charterCatalogue(REVIEWER_CHARTER))
|
|
68
70
|
.withAutonomousTools(memoryRecallTools(ToolBuilder, orkeonMemoryToolPorts, memoryOn))
|
|
69
71
|
.maxIterations(REVIEWER_CHARTER.maxIterations)
|
|
70
|
-
.body(childAgentBody(callbacksFor));
|
|
72
|
+
.body(childAgentBody((ctx: any) => reviewerCallbacks(callbacksFor(ctx)), (llm, ctx) => orkeonPrunedLlm(llm, ctx.log, ctx.tools)));
|
|
71
73
|
return effort === undefined ? builder : builder.effort(effort);
|
|
72
74
|
};
|
|
73
75
|
|
|
74
76
|
const builder = orkeonAgent()
|
|
75
77
|
.name("dev-spec-writer")
|
|
76
78
|
.role("Business analyst")
|
|
77
|
-
.goal(
|
|
79
|
+
.goal(SPEC_WRITER_GOAL)
|
|
78
80
|
// The catalogue is the reviewer's: read tools only. The spec itself is an extract call, which offers none.
|
|
79
81
|
.tools(charterCatalogue(REVIEWER_CHARTER))
|
|
80
82
|
.withAutonomousTools(memoryRecallTools(ToolBuilder, orkeonMemoryToolPorts, memoryOn))
|
|
@@ -82,14 +84,14 @@ const builder = orkeonAgent()
|
|
|
82
84
|
.body(async (_input: any, ctx: any) => {
|
|
83
85
|
const clock = orkeonClock();
|
|
84
86
|
const child = openChildAct(
|
|
85
|
-
|
|
87
|
+
agentLlm(ctx, callbacksFor(ctx), { effort }), ctx, crew, { state: session, clock, log: ctx.log, effort },
|
|
86
88
|
{ crew: "dev-spec", step: "dev-spec" },
|
|
87
|
-
{ agent: REVIEWER_CHARTER.name, charter: REVIEWER_CHARTER.name, task:
|
|
89
|
+
{ agent: REVIEWER_CHARTER.name, charter: REVIEWER_CHARTER.name, task: SPEC_REVIEW_TASK, builder: reviewer },
|
|
88
90
|
);
|
|
89
91
|
try {
|
|
90
92
|
// T1: the shared memory's precedents in the draft's prompt, unless memory_recall is denied.
|
|
91
93
|
const precedents = stepPrecedents({ ...ports, memory: orkeonSharedMemory(), log: ctx.log }, { on: memoryOn });
|
|
92
|
-
return await runDevSpec(inputs(), { ...ports, llm: child.llm, log: ctx.log, clock, precedents });
|
|
94
|
+
return await runDevSpec(inputs(), { ...ports, llm: child.llm, log: ctx.log, clock, precedents, route: orkeonActRoute(ctx.log) });
|
|
93
95
|
} finally {
|
|
94
96
|
await child.close();
|
|
95
97
|
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
// The markers of a spec file: the headings and table headers the renderer writes and /dev-plan, the review and the
|
|
2
|
+
// question round read back by their number (ADR 0026).
|
|
3
|
+
|
|
4
|
+
export const SPEC_DECISIONS_SECTION = "## 13. Decisions";
|
|
5
|
+
export const SPEC_QUESTIONS_SECTION = "## 12. Open questions";
|
|
6
|
+
|
|
7
|
+
/** The template's sections, numbered as /dev-plan expects them. */
|
|
8
|
+
export const SPEC_SECTIONS = {
|
|
9
|
+
context: "## 1. Context",
|
|
10
|
+
vocabulary: "## 2. Vocabulary",
|
|
11
|
+
overview: "## 3. Overview",
|
|
12
|
+
useCases: "## 4. Use cases",
|
|
13
|
+
rules: "## 5. Business rules",
|
|
14
|
+
data: "## 6. Data",
|
|
15
|
+
states: "## 7. States and transitions",
|
|
16
|
+
crossCutting: "## 8. Cross-cutting behaviours",
|
|
17
|
+
relations: "## 9. Relations",
|
|
18
|
+
outOfScope: "## 10. Out of scope",
|
|
19
|
+
assumptions: "## 11. Assumptions",
|
|
20
|
+
} as const;
|
|
21
|
+
|
|
22
|
+
/** The column headers of the template's tables. */
|
|
23
|
+
export const SPEC_COLUMNS = {
|
|
24
|
+
vocabulary: ["Term", "Definition"],
|
|
25
|
+
data: ["Datum", "Description", "Source", "Importance"],
|
|
26
|
+
states: ["State", "Event", "Next state", "Condition"],
|
|
27
|
+
relations: ["Upstream", "Downstream"],
|
|
28
|
+
outOfScope: ["Exclusion", "Reason"],
|
|
29
|
+
assumptions: ["#", "Assumption", "To be validated by"],
|
|
30
|
+
} as const;
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
// The messages of dev-spec's domain: the problems the check of a spec answer reports, which the model reads back on
|
|
2
|
+
// a re-ask and the person in the refusal (ADR 0026).
|
|
3
|
+
|
|
4
|
+
/** Words of a technical document, never of a business spec (the template's business purity), each with what it is. */
|
|
5
|
+
export const TECHNICAL: ReadonlyArray<[RegExp, string]> = [
|
|
6
|
+
[/`/, "a code mark (`)"],
|
|
7
|
+
[/\b[A-Za-z_][A-Za-z0-9_]*\(\)/, "a call such as name()"],
|
|
8
|
+
[/\b[\w-]+\.(ts|tsx|js|mjs|cs|py|java|go|rs|rb|php|json|ya?ml|sql|xml|csproj)\b/i, "a file name"],
|
|
9
|
+
[/\bHTTP\b|\b[1-5]\d\d (OK|Not Found|Bad Request|Unauthorized|Forbidden)\b/, "an HTTP status"],
|
|
10
|
+
[/\bexit code\b/i, "an exit code"],
|
|
11
|
+
[/\bstack trace\b/i, "a stack trace"],
|
|
12
|
+
[/\bendpoints?\b/i, "an endpoint"],
|
|
13
|
+
[/\b(class|interface|enum|DTO|repository pattern|framework)\b/, "a type or a framework"],
|
|
14
|
+
];
|
|
15
|
+
|
|
16
|
+
// ── The problems of a spec answer ───────────────────────────────────────
|
|
17
|
+
|
|
18
|
+
export const cellSpansLines = (name: string, row: number, key: string): string => `${name} ${row}: ${key} is one line, no '|'`;
|
|
19
|
+
export const NO_SUMMARY = "summary: two or three sentences: what, for whom, why";
|
|
20
|
+
export const NO_CONTEXT = "context: the problem, for whom, the cost of doing nothing";
|
|
21
|
+
export const NO_USE_CASE = "useCases: at least one use case";
|
|
22
|
+
export const tooManyUseCases = (max: number): string => `useCases: at most ${max}`;
|
|
23
|
+
export const noActor = (id: string): string => `${id}: no actor`;
|
|
24
|
+
export const noIntent = (id: string): string => `${id}: no intent`;
|
|
25
|
+
export const noWhere = (id: string): string => `${id}: no Where: the surface and the moment the actor meets it`;
|
|
26
|
+
export const scenarioSteps = (id: string, max: number): string => `${id}: the nominal scenario has 1 to ${max} steps`;
|
|
27
|
+
export const fieldSpansLines = (id: string): string => `${id}: a field or a step spans lines`;
|
|
28
|
+
export const tooManyRules = (max: number): string => `rules: at most ${max}`;
|
|
29
|
+
export const noOrigin = (id: string): string =>
|
|
30
|
+
`${id}: no origin (regulation, standard, practice, product choice, existing behaviour)`;
|
|
31
|
+
export const severityIs = (id: string): string => `${id}: severity is blocking, warning or informational`;
|
|
32
|
+
export const appliesToNamesIds = (id: string): string => `${id}: appliesTo names UC-nn ids or cross-cutting`;
|
|
33
|
+
export const appliesToUnknown = (id: string, target: string): string => `${id}: appliesTo '${target}' is no use case of the answer`;
|
|
34
|
+
export const dataSourceIs = (datum: string, sources: string): string => `data '${datum}': source is ${sources}`;
|
|
35
|
+
export const dataImportanceIs = (datum: string, importance: string): string => `data '${datum}': importance is ${importance}`;
|
|
36
|
+
export const tooManyRows = (name: string, max: number): string => `${name}: at most ${max} rows`;
|
|
37
|
+
export const OVERVIEW_IS_FLOWCHART = "overview: the lines of one mermaid flowchart, without the fence, or \"\"";
|
|
38
|
+
export const termUsedNowhere = (term: string): string => `vocabulary: '${term}' is used nowhere else`;
|
|
39
|
+
export const businessPurity = (what: string, hit: string): string => `business purity: ${what} in "${hit}"; say it in business words`;
|
|
@@ -4,8 +4,12 @@
|
|
|
4
4
|
// severity, applied to use cases that exist; every vocabulary term is used; a TBD has its open question; nothing
|
|
5
5
|
// technical is named; every cell fits its table. Ids are code's: UC-nn and BR-nn by position. Pure, no IO.
|
|
6
6
|
import type { Checked } from "../../../shared/domain/agents/charter.ts";
|
|
7
|
-
import { MAX_QUESTIONS, QUESTION_SCHEMA, breaksCell, draftQuestionProblems } from "../../../shared/domain/dev/questions.ts";
|
|
7
|
+
import { MAX_QUESTIONS, QUESTION_SCHEMA, breaksCell, draftQuestionProblems, tidyOptions } from "../../../shared/domain/dev/questions.ts";
|
|
8
8
|
import type { DraftQuestion } from "../../../shared/domain/dev/questions.ts";
|
|
9
|
+
import { NO_CONTEXT, NO_SUMMARY, NO_USE_CASE, OVERVIEW_IS_FLOWCHART, TECHNICAL, appliesToNamesIds, appliesToUnknown, businessPurity, cellSpansLines, dataImportanceIs, dataSourceIs, fieldSpansLines, noActor, noIntent, noOrigin, noWhere, scenarioSteps, severityIs, termUsedNowhere, tooManyRows, tooManyRules, tooManyUseCases } from "./messages.ts";
|
|
10
|
+
import {
|
|
11
|
+
ANSWER_NOT_AN_OBJECT as NOT_AN_OBJECT, idNameOneLine, nameOneLine, rowIsEmpty, statementOneLine, TBD_WITHOUT_QUESTION, tooManyQuestions,
|
|
12
|
+
} from "../../../shared/domain/dev/messages.ts";
|
|
9
13
|
|
|
10
14
|
export interface SpecUseCase {
|
|
11
15
|
name: string; actor: string; intent: string; frequency: string; where: string;
|
|
@@ -87,18 +91,6 @@ export const SPEC_ANSWER_SCHEMA: object = {
|
|
|
87
91
|
],
|
|
88
92
|
};
|
|
89
93
|
|
|
90
|
-
/** Words of a technical document, never of a business spec (the template's business purity). */
|
|
91
|
-
const TECHNICAL: ReadonlyArray<[RegExp, string]> = [
|
|
92
|
-
[/`/, "a code mark (`)"],
|
|
93
|
-
[/\b[A-Za-z_][A-Za-z0-9_]*\(\)/, "a call such as name()"],
|
|
94
|
-
[/\b[\w-]+\.(ts|tsx|js|mjs|cs|py|java|go|rs|rb|php|json|ya?ml|sql|xml|csproj)\b/i, "a file name"],
|
|
95
|
-
[/\bHTTP\b|\b[1-5]\d\d (OK|Not Found|Bad Request|Unauthorized|Forbidden)\b/, "an HTTP status"],
|
|
96
|
-
[/\bexit code\b/i, "an exit code"],
|
|
97
|
-
[/\bstack trace\b/i, "a stack trace"],
|
|
98
|
-
[/\bendpoints?\b/i, "an endpoint"],
|
|
99
|
-
[/\b(class|interface|enum|DTO|repository pattern|framework)\b/, "a type or a framework"],
|
|
100
|
-
];
|
|
101
|
-
|
|
102
94
|
const isObject = (v: unknown): v is Record<string, unknown> => typeof v === "object" && v !== null && !Array.isArray(v);
|
|
103
95
|
const text = (v: unknown): string => (typeof v === "string" ? v.trim() : "");
|
|
104
96
|
const list = (v: unknown): unknown[] => (Array.isArray(v) ? v : []);
|
|
@@ -111,11 +103,15 @@ function rows<K extends string>(v: unknown, keys: readonly K[]): Array<Record<K,
|
|
|
111
103
|
});
|
|
112
104
|
}
|
|
113
105
|
|
|
106
|
+
/** `value` in lower case when it is one of `allowed`, none otherwise: a column the model filled with a word of its own
|
|
107
|
+
* is left empty, which the template allows, instead of costing a second call. */
|
|
108
|
+
const oneOf = (value: string, allowed: readonly string[]): string => (allowed.includes(value.toLowerCase()) ? value.toLowerCase() : "");
|
|
109
|
+
|
|
114
110
|
/** The value read leniently: every field present, strings trimmed, missing lists empty. */
|
|
115
111
|
function readSpecAnswer(value: unknown): SpecAnswer {
|
|
116
112
|
const o = isObject(value) ? value : {};
|
|
117
113
|
return {
|
|
118
|
-
name: text(o.name), summary: text(o.summary), context: text(o.context),
|
|
114
|
+
name: text(o.name).replace(/\s*—\s*/g, " - "), summary: text(o.summary), context: text(o.context),
|
|
119
115
|
vocabulary: rows(o.vocabulary, ["term", "definition"]),
|
|
120
116
|
overview: typeof o.overview === "string" ? o.overview.trim() : "",
|
|
121
117
|
useCases: list(o.useCases).map((u) => {
|
|
@@ -133,7 +129,9 @@ function readSpecAnswer(value: unknown): SpecAnswer {
|
|
|
133
129
|
severity: text(x.severity).toLowerCase() as RuleSeverity, appliesTo: textList(x.appliesTo), example: text(x.example),
|
|
134
130
|
};
|
|
135
131
|
}),
|
|
136
|
-
data: rows(o.data, ["datum", "description", "source", "importance"])
|
|
132
|
+
data: rows(o.data, ["datum", "description", "source", "importance"]).map((d) => ({
|
|
133
|
+
...d, source: oneOf(d.source, DATA_SOURCES), importance: oneOf(d.importance, DATA_IMPORTANCE),
|
|
134
|
+
})),
|
|
137
135
|
states: rows(o.states, ["state", "event", "next", "condition"]),
|
|
138
136
|
crossCutting: textList(o.crossCutting),
|
|
139
137
|
relations: rows(o.relations, ["upstream", "downstream"]),
|
|
@@ -141,7 +139,7 @@ function readSpecAnswer(value: unknown): SpecAnswer {
|
|
|
141
139
|
assumptions: rows(o.assumptions, ["assumption", "validatedBy"]),
|
|
142
140
|
questions: list(o.questions).map((q) => {
|
|
143
141
|
const x = isObject(q) ? q : {};
|
|
144
|
-
return { severity: text(x.severity), question: text(x.question), impact: text(x.impact), options: textList(x.options) };
|
|
142
|
+
return { severity: text(x.severity), question: text(x.question), impact: text(x.impact), options: tidyOptions(textList(x.options)) };
|
|
145
143
|
}),
|
|
146
144
|
};
|
|
147
145
|
}
|
|
@@ -150,7 +148,9 @@ const oneLine = (t: string): boolean => !/[\r\n]/.test(t);
|
|
|
150
148
|
export const useCaseId = (k: number): string => `UC-${String(k + 1).padStart(2, "0")}`;
|
|
151
149
|
export const ruleId = (k: number): string => `BR-${String(k + 1).padStart(2, "0")}`;
|
|
152
150
|
|
|
153
|
-
/** Every text of the answer
|
|
151
|
+
/** Every text of the answer's body, but the overview (a flowchart's syntax) and the vocabulary. The questions are
|
|
152
|
+
* left out: a question is asked to a person, not specified, it may name what it is about, and the fold lists the
|
|
153
|
+
* ones the reviewer wrote, which no purity rule held. */
|
|
154
154
|
function bodyTexts(a: SpecAnswer): string[] {
|
|
155
155
|
return [
|
|
156
156
|
a.name, a.summary, a.context,
|
|
@@ -162,57 +162,56 @@ function bodyTexts(a: SpecAnswer): string[] {
|
|
|
162
162
|
...a.relations.flatMap((r) => [r.upstream, r.downstream]),
|
|
163
163
|
...a.outOfScope.flatMap((r) => [r.exclusion, r.reason]),
|
|
164
164
|
...a.assumptions.flatMap((r) => [r.assumption, r.validatedBy]),
|
|
165
|
-
...a.questions.flatMap((q) => [q.question, q.impact, ...q.options]),
|
|
166
165
|
];
|
|
167
166
|
}
|
|
168
167
|
|
|
169
168
|
function cellProblems(name: string, items: ReadonlyArray<Record<string, string>>, problems: string[]): void {
|
|
170
169
|
items.forEach((row, i) => {
|
|
171
170
|
for (const [key, value] of Object.entries(row)) {
|
|
172
|
-
if (breaksCell(value)) { problems.push(
|
|
171
|
+
if (breaksCell(value)) { problems.push(cellSpansLines(name, i + 1, key)); return; }
|
|
173
172
|
}
|
|
174
|
-
if (Object.values(row).every((v) => v === "")) problems.push(
|
|
173
|
+
if (Object.values(row).every((v) => v === "")) problems.push(rowIsEmpty(name, i + 1));
|
|
175
174
|
});
|
|
176
175
|
}
|
|
177
176
|
|
|
178
177
|
export function checkSpecAnswer(value: unknown): Checked<SpecAnswer> {
|
|
179
|
-
if (!isObject(value)) return { ok: false, problems: [
|
|
178
|
+
if (!isObject(value)) return { ok: false, problems: [NOT_AN_OBJECT] };
|
|
180
179
|
const a = readSpecAnswer(value);
|
|
181
180
|
const problems: string[] = [];
|
|
182
181
|
|
|
183
182
|
if (a.name === "" || !oneLine(a.name) || a.name.length > MAX_NAME_CHARS || a.name.includes("—")) {
|
|
184
|
-
problems.push(
|
|
183
|
+
problems.push(nameOneLine(MAX_NAME_CHARS));
|
|
185
184
|
}
|
|
186
|
-
if (a.summary === "") problems.push(
|
|
187
|
-
if (a.context === "") problems.push(
|
|
185
|
+
if (a.summary === "") problems.push(NO_SUMMARY);
|
|
186
|
+
if (a.context === "") problems.push(NO_CONTEXT);
|
|
188
187
|
|
|
189
|
-
if (a.useCases.length === 0) problems.push(
|
|
190
|
-
if (a.useCases.length > MAX_USE_CASES) problems.push(
|
|
188
|
+
if (a.useCases.length === 0) problems.push(NO_USE_CASE);
|
|
189
|
+
if (a.useCases.length > MAX_USE_CASES) problems.push(tooManyUseCases(MAX_USE_CASES));
|
|
191
190
|
a.useCases.forEach((u, i) => {
|
|
192
191
|
const id = useCaseId(i);
|
|
193
|
-
if (u.name === "" || !oneLine(u.name) || u.name.length > MAX_NAME_CHARS) problems.push(
|
|
194
|
-
if (u.actor === "") problems.push(
|
|
195
|
-
if (u.intent === "") problems.push(
|
|
196
|
-
if (u.where === "") problems.push(
|
|
192
|
+
if (u.name === "" || !oneLine(u.name) || u.name.length > MAX_NAME_CHARS) problems.push(idNameOneLine(id, MAX_NAME_CHARS));
|
|
193
|
+
if (u.actor === "") problems.push(noActor(id));
|
|
194
|
+
if (u.intent === "") problems.push(noIntent(id));
|
|
195
|
+
if (u.where === "") problems.push(noWhere(id));
|
|
197
196
|
if (u.scenario.length === 0 || u.scenario.length > MAX_SCENARIO_STEPS) {
|
|
198
|
-
problems.push(
|
|
197
|
+
problems.push(scenarioSteps(id, MAX_SCENARIO_STEPS));
|
|
199
198
|
}
|
|
200
|
-
if ([u.actor, u.intent, u.frequency, u.where, ...u.scenario].some((t) => !oneLine(t))) problems.push(
|
|
199
|
+
if ([u.actor, u.intent, u.frequency, u.where, ...u.scenario].some((t) => !oneLine(t))) problems.push(fieldSpansLines(id));
|
|
201
200
|
});
|
|
202
201
|
|
|
203
202
|
const ucIds = new Set(a.useCases.map((_, i) => useCaseId(i)));
|
|
204
|
-
if (a.rules.length > MAX_RULES) problems.push(
|
|
203
|
+
if (a.rules.length > MAX_RULES) problems.push(tooManyRules(MAX_RULES));
|
|
205
204
|
a.rules.forEach((r, i) => {
|
|
206
205
|
const id = ruleId(i);
|
|
207
|
-
if (r.name === "" || !oneLine(r.name) || r.name.length > MAX_NAME_CHARS) problems.push(
|
|
206
|
+
if (r.name === "" || !oneLine(r.name) || r.name.length > MAX_NAME_CHARS) problems.push(idNameOneLine(id, MAX_NAME_CHARS));
|
|
208
207
|
if (r.statement === "" || !oneLine(r.statement) || r.statement.length > MAX_STATEMENT_CHARS || r.statement.includes(" · ")) {
|
|
209
|
-
problems.push(
|
|
208
|
+
problems.push(statementOneLine(id, MAX_STATEMENT_CHARS));
|
|
210
209
|
}
|
|
211
|
-
if (r.origin === "") problems.push(
|
|
212
|
-
if (!RULE_SEVERITIES.includes(r.severity)) problems.push(
|
|
213
|
-
if (r.appliesTo.length === 0) problems.push(
|
|
210
|
+
if (r.origin === "") problems.push(noOrigin(id));
|
|
211
|
+
if (!RULE_SEVERITIES.includes(r.severity)) problems.push(severityIs(id));
|
|
212
|
+
if (r.appliesTo.length === 0) problems.push(appliesToNamesIds(id));
|
|
214
213
|
for (const t of r.appliesTo) {
|
|
215
|
-
if (t !== "cross-cutting" && !ucIds.has(t)) problems.push(
|
|
214
|
+
if (t !== "cross-cutting" && !ucIds.has(t)) problems.push(appliesToUnknown(id, t));
|
|
216
215
|
}
|
|
217
216
|
});
|
|
218
217
|
|
|
@@ -223,30 +222,30 @@ export function checkSpecAnswer(value: unknown): Checked<SpecAnswer> {
|
|
|
223
222
|
cellProblems("outOfScope", a.outOfScope, problems);
|
|
224
223
|
cellProblems("assumptions", a.assumptions, problems);
|
|
225
224
|
for (const d of a.data) {
|
|
226
|
-
if (d.source !== "" && !(DATA_SOURCES as readonly string[]).includes(d.source)) problems.push(
|
|
225
|
+
if (d.source !== "" && !(DATA_SOURCES as readonly string[]).includes(d.source)) problems.push(dataSourceIs(d.datum, DATA_SOURCES.join(", ")));
|
|
227
226
|
if (d.importance !== "" && !(DATA_IMPORTANCE as readonly string[]).includes(d.importance)) {
|
|
228
|
-
problems.push(
|
|
227
|
+
problems.push(dataImportanceIs(d.datum, DATA_IMPORTANCE.join(", ")));
|
|
229
228
|
}
|
|
230
229
|
}
|
|
231
230
|
for (const [name, n] of [["crossCutting", a.crossCutting.length], ["vocabulary", a.vocabulary.length], ["data", a.data.length]] as const) {
|
|
232
|
-
if (n > MAX_LIST) problems.push(
|
|
231
|
+
if (n > MAX_LIST) problems.push(tooManyRows(name, MAX_LIST));
|
|
233
232
|
}
|
|
234
233
|
if (a.overview !== "" && (a.overview.includes("```") || !/^(flowchart|graph|stateDiagram)/.test(a.overview))) {
|
|
235
|
-
problems.push(
|
|
234
|
+
problems.push(OVERVIEW_IS_FLOWCHART);
|
|
236
235
|
}
|
|
237
236
|
|
|
238
237
|
const body = bodyTexts(a).join("\n");
|
|
239
238
|
const lower = body.toLowerCase();
|
|
240
239
|
for (const v of a.vocabulary) {
|
|
241
|
-
if (v.term !== "" && !lower.includes(v.term.toLowerCase())) problems.push(
|
|
240
|
+
if (v.term !== "" && !lower.includes(v.term.toLowerCase())) problems.push(termUsedNowhere(v.term));
|
|
242
241
|
}
|
|
243
|
-
if (/\bTBD\b/.test(body) && a.questions.length === 0) problems.push(
|
|
242
|
+
if (/\bTBD\b/.test(body) && a.questions.length === 0) problems.push(TBD_WITHOUT_QUESTION);
|
|
244
243
|
for (const [pattern, what] of TECHNICAL) {
|
|
245
244
|
const hit = bodyTexts(a).find((t) => pattern.test(t));
|
|
246
|
-
if (hit !== undefined) problems.push(
|
|
245
|
+
if (hit !== undefined) problems.push(businessPurity(what, hit.slice(0, 60)));
|
|
247
246
|
}
|
|
248
247
|
|
|
249
|
-
if (a.questions.length > MAX_QUESTIONS) problems.push(
|
|
248
|
+
if (a.questions.length > MAX_QUESTIONS) problems.push(tooManyQuestions(MAX_QUESTIONS));
|
|
250
249
|
a.questions.forEach((q, i) => problems.push(...draftQuestionProblems(q, i + 1)));
|
|
251
250
|
|
|
252
251
|
return problems.length > 0 ? { ok: false, problems } : { ok: true, value: a };
|
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
// template (sections 1 to 12) with a section 13 of decisions, a section left out when it has nothing to say (the
|
|
3
3
|
// numbers stay the template's, so a reader and /dev-plan find each section where they expect it). A use case and a
|
|
4
4
|
// rule carry a `- **Statement**:` line first, which spec-format.ts reads for /dev-plan. Pure, no IO.
|
|
5
|
+
import { STATEMENT } from "../../../shared/domain/dev/markers.ts";
|
|
5
6
|
import { decisionTable, questionTable } from "../../../shared/domain/dev/questions.ts";
|
|
6
7
|
import type { Decision, Question } from "../../../shared/domain/dev/questions.ts";
|
|
7
8
|
import { ruleId, useCaseId } from "./spec-answer.ts";
|
|
8
9
|
import type { SpecAnswer } from "./spec-answer.ts";
|
|
10
|
+
import { SPEC_COLUMNS, SPEC_DECISIONS_SECTION, SPEC_QUESTIONS_SECTION, SPEC_SECTIONS } from "./markers.ts";
|
|
9
11
|
|
|
10
12
|
export const specFileName = (code: string): string => `SPEC-${code}.md`;
|
|
11
|
-
export const SPEC_DECISIONS_SECTION = "## 13. Decisions";
|
|
12
|
-
export const SPEC_QUESTIONS_SECTION = "## 12. Open questions";
|
|
13
13
|
|
|
14
14
|
export interface SpecRenderInput { code: string; answer: SpecAnswer; open: readonly Question[]; decisions: readonly Decision[] }
|
|
15
15
|
|
|
@@ -23,7 +23,7 @@ const sentence = (t: string): string => (t === "" || /[.!?]$/.test(t) ? t : `${t
|
|
|
23
23
|
|
|
24
24
|
function useCaseBlock(a: SpecAnswer): string[] {
|
|
25
25
|
return a.useCases.flatMap((u, i) => {
|
|
26
|
-
const head = [
|
|
26
|
+
const head = [`${STATEMENT}: ${u.intent}`, `**Actor**: ${u.actor}`];
|
|
27
27
|
if (u.frequency !== "") head.push(`**Frequency**: ${u.frequency}`);
|
|
28
28
|
const lines = [`### ${useCaseId(i)} — ${u.name}`, `- ${head.join(" · ")}`, `- **Where**: ${u.where}`, "- **Nominal scenario**:"];
|
|
29
29
|
u.scenario.forEach((s, k) => lines.push(` ${k + 1}. ${s}`));
|
|
@@ -40,7 +40,7 @@ function ruleBlock(a: SpecAnswer): string[] {
|
|
|
40
40
|
const applies = r.appliesTo.join(", ");
|
|
41
41
|
const lines = [
|
|
42
42
|
`### ${ruleId(i)} — ${r.name}`,
|
|
43
|
-
`-
|
|
43
|
+
`- ${STATEMENT}: ${r.statement} · **Origin**: ${r.origin} · **Severity**: ${r.severity}`,
|
|
44
44
|
`- **Applies to**: ${applies}`,
|
|
45
45
|
];
|
|
46
46
|
if (r.example !== "") lines.push(`- **Example**: ${r.example}`);
|
|
@@ -53,22 +53,22 @@ export function renderSpec(input: SpecRenderInput): string {
|
|
|
53
53
|
const a = input.answer;
|
|
54
54
|
const lines: string[] = [`# ${input.code} — ${a.name}`, ""];
|
|
55
55
|
if (a.summary !== "") lines.push(...a.summary.split(/\r?\n/).map((l) => `> ${l}`.trimEnd()), "");
|
|
56
|
-
lines.push(...section(
|
|
57
|
-
lines.push(...section(
|
|
58
|
-
lines.push(...section(
|
|
59
|
-
lines.push(
|
|
60
|
-
if (a.rules.length > 0) lines.push(
|
|
61
|
-
lines.push(...section(
|
|
62
|
-
|
|
56
|
+
lines.push(...section(SPEC_SECTIONS.context, [a.context]));
|
|
57
|
+
lines.push(...section(SPEC_SECTIONS.vocabulary, table(SPEC_COLUMNS.vocabulary, a.vocabulary.map((v) => [v.term, v.definition]))));
|
|
58
|
+
lines.push(...section(SPEC_SECTIONS.overview, a.overview === "" ? [] : ["```mermaid", a.overview, "```"]));
|
|
59
|
+
lines.push(SPEC_SECTIONS.useCases, "", ...useCaseBlock(a));
|
|
60
|
+
if (a.rules.length > 0) lines.push(SPEC_SECTIONS.rules, "", ...ruleBlock(a));
|
|
61
|
+
lines.push(...section(SPEC_SECTIONS.data, table(
|
|
62
|
+
SPEC_COLUMNS.data, a.data.map((d) => [d.datum, d.description, d.source, d.importance]),
|
|
63
63
|
)));
|
|
64
|
-
lines.push(...section(
|
|
65
|
-
|
|
64
|
+
lines.push(...section(SPEC_SECTIONS.states, table(
|
|
65
|
+
SPEC_COLUMNS.states, a.states.map((s) => [s.state, s.event, s.next, s.condition]),
|
|
66
66
|
)));
|
|
67
|
-
lines.push(...section(
|
|
68
|
-
lines.push(...section(
|
|
69
|
-
lines.push(...section(
|
|
70
|
-
lines.push(...section(
|
|
71
|
-
|
|
67
|
+
lines.push(...section(SPEC_SECTIONS.crossCutting, a.crossCutting.map((c) => `- ${sentence(c)}`)));
|
|
68
|
+
lines.push(...section(SPEC_SECTIONS.relations, table(SPEC_COLUMNS.relations, a.relations.map((r) => [r.upstream, r.downstream]))));
|
|
69
|
+
lines.push(...section(SPEC_SECTIONS.outOfScope, table(SPEC_COLUMNS.outOfScope, a.outOfScope.map((r) => [r.exclusion, r.reason]))));
|
|
70
|
+
lines.push(...section(SPEC_SECTIONS.assumptions, table(
|
|
71
|
+
SPEC_COLUMNS.assumptions, a.assumptions.map((r, i) => [`A${i + 1}`, r.assumption, r.validatedBy]),
|
|
72
72
|
)));
|
|
73
73
|
lines.push(...section(SPEC_QUESTIONS_SECTION, questionTable(input.open)));
|
|
74
74
|
lines.push(...section(SPEC_DECISIONS_SECTION, decisionTable(input.decisions)));
|