specdojo 0.6.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/agents/specdojo-orchestrator.md +3 -2
- package/CHANGELOG.md +193 -0
- package/README.md +2 -2
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/agent.js +33 -0
- package/dist/commands/init.js +6 -1
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/commands/orchestrator.js +10 -1
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +612 -259
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +8 -6
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +9 -4
- package/dist/devcontainer/command.js +18 -0
- package/dist/devcontainer/host-script.js +21 -0
- package/dist/devcontainer/scaffold.js +22 -3
- package/dist/docs/frontmatter-namespace.js +1 -48
- package/dist/docs/yaml-pages.js +125 -3
- package/dist/exec/agent-config.js +22 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/antigravity-session.js +154 -0
- package/dist/exec/commands.js +69 -21
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +159 -8
- package/dist/exec/evidence.js +64 -16
- package/dist/exec/handoff.js +9 -13
- package/dist/exec/limit.js +1 -1
- package/dist/exec/mechanical-result.js +45 -0
- package/dist/exec/migrate-records.js +249 -0
- package/dist/exec/parent-validation.js +160 -12
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plan-markdownlint.js +89 -0
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +24 -17
- package/dist/exec/plans-generation.js +52 -25
- package/dist/exec/plans-grade-findings.js +8 -3
- package/dist/exec/plans-kata-findings.js +61 -0
- package/dist/exec/plans-planning.js +3 -3
- package/dist/exec/plans-storage.js +12 -24
- package/dist/exec/register-resume.js +69 -42
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +8 -4
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +85 -24
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +109 -0
- package/dist/exec/run/agent-pipeline.js +75 -6
- package/dist/exec/run/agent.js +20 -7
- package/dist/exec/run/in-place.js +69 -32
- package/dist/exec/run/job.js +81 -24
- package/dist/exec/run/lifecycle-commands.js +264 -43
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +12 -10
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +12 -12
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +28 -18
- package/dist/exec/run/register-state.js +10 -7
- package/dist/exec/run/register-worktree.js +60 -30
- package/dist/exec/run/schedule-mode.js +26 -6
- package/dist/exec/run/schedule-prepare.js +228 -45
- package/dist/exec/run/schedule-task.js +132 -25
- package/dist/exec/run/shared.js +4 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -0
- package/dist/exec/strategy.js +1 -0
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +3 -2
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/worktree-command.js +29 -16
- package/dist/exec/worktree-ops-commit.js +118 -59
- package/dist/exec/worktree-ops-lifecycle.js +77 -44
- package/dist/exec/worktree-ops-merge.js +13 -2
- package/dist/exec/worktree-ops.js +2 -2
- package/dist/exec/worktree.js +19 -2
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-inspect.js +2 -2
- package/dist/grade/command-run.js +2 -0
- package/dist/grade/command-shared.js +1 -1
- package/dist/grade/core.js +18 -5
- package/dist/grade/markdown.js +3 -3
- package/dist/grade/pipeline-state.js +15 -11
- package/dist/grade/plan.js +37 -17
- package/dist/grade/result.js +3 -3
- package/dist/grade/run.js +23 -3
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/job.js +31 -17
- package/dist/job/noop.js +104 -0
- package/dist/register/core.js +2 -0
- package/dist/register/create-commands.js +28 -3
- package/dist/register/deliverable-target.js +9 -1
- package/dist/register/epic.js +104 -26
- package/dist/register/event-merge.js +3 -0
- package/dist/register/events.js +4 -0
- package/dist/register/external-project.js +3 -0
- package/dist/register/item.js +6 -0
- package/dist/register/maintenance-commands.js +4 -1
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +74 -32
- package/dist/register/track-domains.js +34 -0
- package/dist/register/track-plan.js +78 -0
- package/dist/register/transition-commands.js +8 -0
- package/dist/register/work-table.js +64 -0
- package/dist/review/grade.js +35 -13
- package/dist/routine/definition.js +4 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +56 -32
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +1 -0
- package/dist/schedule/strategy-generate-document.js +26 -14
- package/dist/schedule/strategy-generate-scope.js +17 -45
- package/dist/schedule/strategy-generate.js +33 -3
- package/dist/schedule/strategy-profiles.js +86 -12
- package/dist/shared/agent-types.js +2 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/deprecation.js +8 -0
- package/dist/shared/document-metadata.js +20 -0
- package/dist/shared/finding-cause.js +20 -0
- package/dist/shared/frontmatter-namespace.js +48 -0
- package/dist/shared/git.js +149 -15
- package/dist/shared/grade-result.js +17 -1
- package/dist/shared/local-state.js +20 -0
- package/dist/shared/markdownlint-config.js +8 -3
- package/dist/shared/plan-conventions.js +129 -0
- package/dist/shared/plan-templates.js +57 -41
- package/dist/shared/provider-scaffold.js +2 -0
- package/dist/shared/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +39 -21
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +65 -5
- package/dist/shared/timeline-index.js +2 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +11 -2
- package/docs/ja/specdojo/exec-templates/xep-common-conventions-template.md +4 -74
- package/docs/ja/specdojo/exec-templates/xep-condense-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xep-draft-template.md +17 -5
- package/docs/ja/specdojo/exec-templates/xep-fully-guided-template.md +16 -3
- package/docs/ja/specdojo/exec-templates/xep-recipe-guided-template.md +15 -5
- package/docs/ja/specdojo/exec-templates/xep-recipe-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-register-template.md +1 -1
- package/docs/ja/specdojo/exec-templates/xep-rulebook-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-sample-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xep-template-maintenance-template.md +6 -0
- package/docs/ja/specdojo/exec-templates/xer-condense-template.md +25 -0
- package/docs/ja/specdojo/exec-templates/xp-common-conventions-template.md +50 -0
- package/docs/ja/specdojo/exec-templates/xrp-common-conventions-template.md +30 -0
- package/docs/ja/specdojo/guides/branch-workflow-guide.md +1 -1
- package/docs/ja/specdojo/guides/docs-editing-guide.md +48 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +61 -28
- package/docs/ja/specdojo/guides/exec-operation-guide.md +61 -13
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/orchestrator-operation-guide.md +4 -2
- package/docs/ja/specdojo/guides/plan-result-lifecycle-guide.md +92 -55
- package/docs/ja/specdojo/guides/project-move-guide.md +381 -0
- package/docs/ja/specdojo/guides/quick-start-guide.md +589 -807
- package/docs/ja/specdojo/guides/register-operation-guide.md +26 -4
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +33 -4
- package/docs/ja/specdojo/guides/review-guide.md +22 -19
- package/docs/ja/specdojo/guides/routine-operation-guide.md +14 -8
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +7 -4
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +41 -3
- package/docs/ja/specdojo/guides/specdojo-overview-guide.md +5 -4
- package/docs/ja/specdojo/guides/timeline-design-guide.md +27 -144
- package/docs/ja/specdojo/guides/use-case-guide.md +471 -74
- package/docs/ja/specdojo/recipes/bac-recipe.md +94 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +105 -0
- package/docs/ja/specdojo/recipes/br-recipe.md +84 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +88 -86
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +108 -122
- package/docs/ja/specdojo/recipes/cnd-recipe.md +125 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +126 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +134 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +135 -86
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +130 -0
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +29 -26
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +35 -26
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +38 -28
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +39 -31
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +26 -28
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +10 -8
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +18 -17
- package/docs/ja/specdojo/recipes/stsd-recipe.md +100 -62
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +106 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +137 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +122 -0
- package/docs/ja/specdojo/references/command-reference.md +146 -99
- package/docs/ja/specdojo/references/deliverables-reference.md +9 -4
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +17 -16
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +72 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +212 -79
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +138 -154
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +147 -59
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +100 -96
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +88 -108
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +126 -211
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +367 -0
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +6 -5
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +96 -100
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +38 -47
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +132 -106
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +102 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +152 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +187 -0
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +93 -247
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +104 -241
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +124 -257
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +87 -98
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +9 -7
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +193 -0
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +100 -54
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +69 -252
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +91 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +252 -226
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +118 -40
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +9 -9
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +4 -4
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +11 -11
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +4 -3
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +34 -29
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +8 -8
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +2 -2
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +50 -56
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +46 -55
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +57 -54
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +50 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +2 -2
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +70 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +2 -1
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +47 -56
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -135
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +116 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +118 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +152 -57
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +51 -39
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +101 -46
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +72 -329
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +74 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +78 -195
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +3 -4
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +3 -3
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +140 -143
- package/docs/ja/specdojo/samples/bac-sample.md +106 -21
- package/docs/ja/specdojo/samples/bdd-sample.yaml +143 -35
- package/docs/ja/specdojo/samples/bds-sample.md +100 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +59 -20
- package/docs/ja/specdojo/samples/bes-sample.md +80 -21
- package/docs/ja/specdojo/samples/br-sample.md +68 -14
- package/docs/ja/specdojo/samples/ccd-sample.md +81 -19
- package/docs/ja/specdojo/samples/cdfd-overview-sample.md +248 -140
- package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +130 -97
- package/docs/ja/specdojo/samples/cdsd-sample.md +89 -20
- package/docs/ja/specdojo/samples/cdt-sample.md +116 -0
- package/docs/ja/specdojo/samples/cld-sample.md +3 -30
- package/docs/ja/specdojo/samples/clis-sample.md +132 -0
- package/docs/ja/specdojo/samples/cnd-sample.md +127 -21
- package/docs/ja/specdojo/samples/cpd-sample.md +136 -22
- package/docs/ja/specdojo/samples/cxd-sample.md +108 -22
- package/docs/ja/specdojo/samples/dct-index-sample.yaml +63 -17
- package/docs/ja/specdojo/samples/dss-sample.md +175 -0
- package/docs/ja/specdojo/samples/gl-sample.yaml +50 -14
- package/docs/ja/specdojo/samples/ifd-sample.md +105 -21
- package/docs/ja/specdojo/samples/ifx-cmd-sample.yaml +91 -60
- package/docs/ja/specdojo/samples/ifx-file-sample.md +462 -21
- package/docs/ja/specdojo/samples/ifx-index-sample.yaml +87 -19
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +52 -20
- package/docs/ja/specdojo/samples/pm-plan-sample.md +84 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +55 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +69 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +50 -26
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +89 -62
- package/docs/ja/specdojo/samples/sf-index-sample.md +89 -20
- package/docs/ja/specdojo/samples/sf-sample.md +121 -21
- package/docs/ja/specdojo/samples/sld-sample.md +107 -21
- package/docs/ja/specdojo/samples/stsd-sample.md +54 -26
- package/docs/ja/specdojo/samples/sysd-critical-flows-sample.md +166 -21
- package/docs/ja/specdojo/samples/sysd-cross-cutting-policy-sample.md +178 -21
- package/docs/ja/specdojo/samples/sysd-index-sample.md +82 -21
- package/docs/ja/specdojo/samples/tml-sample.yaml +4 -1
- package/docs/ja/specdojo/samples/uis-sample.md +164 -20
- package/docs/ja/specdojo/standards/document-metadata-standard.md +33 -4
- package/docs/ja/specdojo/standards/id-and-file-naming-standard.md +3 -1
- package/docs/ja/specdojo/standards/rulebook-authoring-standard.md +1 -0
- package/docs/ja/specdojo/templates/bac-template.md +76 -0
- package/docs/ja/specdojo/templates/bes-template.md +56 -0
- package/docs/ja/specdojo/templates/br-template.md +64 -0
- package/docs/ja/specdojo/templates/cdfd-overview-template.md +161 -83
- package/docs/ja/specdojo/templates/cdfd-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +130 -89
- package/docs/ja/specdojo/templates/cnd-template.md +137 -0
- package/docs/ja/specdojo/templates/cpd-template.md +129 -0
- package/docs/ja/specdojo/templates/cxd-template.md +105 -0
- package/docs/ja/specdojo/templates/dct-data-model-cdt-template.yaml +40 -0
- package/docs/ja/specdojo/templates/dct-data-model-cld-template.yaml +7 -14
- package/docs/ja/specdojo/templates/dct-index-template.md +9 -20
- package/docs/ja/specdojo/templates/dct-project-management-template.yaml +5 -1
- package/docs/ja/specdojo/templates/ifd-template.md +86 -0
- package/docs/ja/specdojo/templates/ifx-cmd-template.yaml +44 -28
- package/docs/ja/specdojo/templates/ifx-index-template.yaml +40 -0
- package/docs/ja/specdojo/templates/opr-template.md +2 -4
- package/docs/ja/specdojo/templates/pm-organization-template.md +9 -3
- package/docs/ja/specdojo/templates/pm-plan-template.md +4 -4
- package/docs/ja/specdojo/templates/pm-quality-management-plan-template.md +17 -9
- package/docs/ja/specdojo/templates/pm-raci-template.md +24 -13
- package/docs/ja/specdojo/templates/pm-roles-template.yaml +3 -2
- package/docs/ja/specdojo/templates/prj-assumptions-constraints-dependencies-template.md +6 -3
- package/docs/ja/specdojo/templates/prj-comparison-of-alternatives-template.md +22 -19
- package/docs/ja/specdojo/templates/stsd-template.md +46 -21
- package/docs/ja/specdojo/templates/sysd-critical-flows-template.md +94 -0
- package/docs/ja/specdojo/templates/sysd-cross-cutting-policy-template.md +122 -0
- package/docs/ja/specdojo/templates/sysd-index-template.md +89 -0
- package/docs/specdojo/lib/yaml-metadata.cjs +7 -0
- package/docs/specdojo/schemas/v1/bdd.schema.yaml +25 -57
- package/docs/specdojo/schemas/v1/condense-records.schema.yaml +26 -0
- package/docs/specdojo/schemas/v1/dct.schema.yaml +10 -0
- package/docs/specdojo/schemas/v1/deliverable-frontmatter.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/esil.schema.yaml +7 -141
- package/docs/specdojo/schemas/v1/exec-common.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +54 -3
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +3 -0
- package/docs/specdojo/schemas/v1/exec-plan-frontmatter.schema.yaml +14 -0
- package/docs/specdojo/schemas/v1/exec-result-frontmatter.schema.yaml +18 -0
- package/docs/specdojo/schemas/v1/finding-cause.schema.yaml +22 -0
- package/docs/specdojo/schemas/v1/grade-pipeline-state.schema.yaml +1 -1
- package/docs/specdojo/schemas/v1/grade-result.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/ifx-cmd.schema.yaml +65 -5
- package/docs/specdojo/schemas/v1/ifx-index.schema.yaml +142 -0
- package/docs/specdojo/schemas/v1/register-events.schema.yaml +2 -0
- package/docs/specdojo/schemas/v1/register-item-frontmatter.schema.yaml +17 -1
- package/docs/specdojo/schemas/v1/specdojo-config.schema.yaml +1 -0
- package/package.json +6 -3
- package/templates/antigravity/README.md +19 -46
- package/templates/antigravity/exec-defaults-snippet.yaml +5 -6
- package/templates/antigravity/orchestrator.md +3 -2
- package/templates/antigravity/settings.edit.json +73 -0
- package/templates/antigravity/settings.orchestrator.json +15 -0
- package/templates/antigravity/settings.report.json +7 -0
- package/templates/antigravity/settings.review.json +7 -0
- package/templates/claude/agents/specdojo-orchestrator.md +3 -2
- package/templates/codex/agents/specdojo-orchestrator.toml +3 -2
- package/templates/codex/orchestrator.md +3 -2
- package/templates/devcontainer/remote-host/devcontainer-tmux.sh +217 -0
- package/templates/devcontainer/remote-host/specdojo-tmux.sh.sample +8 -96
- package/templates/devcontainer/remote-host/ssh-config.sample +3 -1
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/init-agent-members.yaml +1 -0
- package/templates/init-exec-defaults.yaml +1 -1
- package/templates/opencode/agents/specdojo-orchestrator.md +3 -2
|
@@ -14,114 +14,129 @@ specdojo:
|
|
|
14
14
|
|
|
15
15
|
External Command Interface Specification (ECIS) Documentation Rules
|
|
16
16
|
|
|
17
|
-
外部 CLI
|
|
17
|
+
外部 CLI プロセスを起動する連携について、実行契約、入出力の約束(渡すもの・受け取るもの・終了コードの意味・作るファイル・副作用・失敗の扱い)、認証注入を YAML 1 ファイルで定義します。引数・オプションの表は持たず、正本(コマンドリファレンスや設定・ガイド)を参照して実装重複を排除します。
|
|
18
18
|
|
|
19
19
|
## 1. 全体方針
|
|
20
20
|
|
|
21
|
-
- 1
|
|
22
|
-
-
|
|
23
|
-
-
|
|
24
|
-
-
|
|
21
|
+
- **1 連携 1 ファイル**: 一つの実行目的と共通の入出力契約を単位とする。CLI やサブコマンドが同じでも、目的・権限・出力契約が異なる場合は分割する。複数 provider をまとめる場合は、共通契約と差異を解決する正本を示す。
|
|
22
|
+
- **合意境界に絞る**: 渡すもの、受け取るもの、作るファイル、終了状態、副作用、失敗時の処置を定める。引数・オプション表、起動テンプレート全文、内部実装は転載しない。
|
|
23
|
+
- **正本を分担する**: 共通事項は上位の外部 I/F 一覧・設計、値・構文・構造の制約は対応 schema、起動方法は設定・リファレンスを参照する。本書は各キーに必要な判断情報と記述規約を定める。
|
|
24
|
+
- **起動方式を事実に合わせる**: 原則はシェルを経由しない。設定を正本とするシェル起動の例外条件は「コマンドと正本参照」に従い、実装と異なる方式を仕様上だけ宣言しない。
|
|
25
|
+
- **秘密値を持たない**: 認証は注入方式・参照名・管理境界で表す。秘密値を本文、入力例、出力例、ログに含めない。
|
|
25
26
|
|
|
26
|
-
## 2.
|
|
27
|
+
## 2. 位置づけ
|
|
27
28
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
| 起動契約 | 実行可能ファイル、サブコマンド、引数、実行ディレクトリ、タイムアウトの合意 |
|
|
32
|
-
| ストリーム契約 | stdin、stdout、stderr それぞれの使用有無、形式、文字コード、成功時・失敗時の意味 |
|
|
33
|
-
| 認証注入 | シークレットストアや CLI 認証プロファイルから、プロセスに認証状態を渡す方式。秘密値自体は仕様に含めない |
|
|
34
|
-
| 終了カテゴリ | CLI 固有の終了コードを、成功、入力不正、認証失敗、一時失敗など呼び出し元が扱える意味へ分類した値 |
|
|
35
|
-
|
|
36
|
-
ESIL は連携の存在と方向を一覧化し、本仕様は対応する `spec_ref` の先でプロセス起動の契約を定義します。API、ファイル転送、メッセージングが連携の本体であり CLI が単なる操作ツールの場合は、対応する API/ファイル/メッセージ仕様を正本とし、本仕様との責務の重複を避けます。
|
|
29
|
+
- ESIL(外部システム I/F 一覧)は連携の存在・方向・目的を示し、本仕様は `spec_ref` の先でプロセス境界の契約を定める。API・ファイル・メッセージ連携が本体で CLI が操作手段にすぎない場合は、各方式の仕様を正本とする。
|
|
30
|
+
- 起動方法の正本は対象によって選ぶ。SpecDojo 自身のコマンドはコマンドリファレンス、SpecDojo が起動する AI provider CLI は起動設定の `command_template` と [[specdojo:exec-config-guide|exec 設定ガイド]]、その他の外部 CLI は公式リファレンスや製品マニュアルを参照する。
|
|
31
|
+
- ARC は境界・制約・正本分担、DEV は起動と結果判定の実装可能性、QE は正常・異常・再試行の検証可能性、PO / BA は実行目的と副作用の業務上の妥当性を確認する。
|
|
37
32
|
|
|
38
33
|
## 3. ファイル命名・ID規則
|
|
39
34
|
|
|
40
|
-
- ファイル名は `ifx-cmd-<term>.yaml
|
|
41
|
-
- ESIL の `interfaces[].kind` は
|
|
42
|
-
-
|
|
43
|
-
-
|
|
35
|
+
- ファイル名は `ifx-cmd-<term>.yaml`、ID のローカル部分は `ifx-cmd-<term>` とする。`<term>` は連携目的または外部 CLI を表す kebab-case とし、配置と ID の所有範囲は [[specdojo:docs-structure-guide|ドキュメント構成ガイド]] に従う。
|
|
36
|
+
- ESIL の `interfaces[].kind` は `コマンド` とし、`interfaces[].spec_ref` から本仕様の ID を一意に解決できるようにする。詳細仕様が未作成の間だけ `TBD` を使用できる。
|
|
37
|
+
- 同じ CLI の読取・更新など、契約を分ける場合は `ifx-cmd-git-read` / `ifx-cmd-git-write` のように目的を付ける。バージョンや状態は ID に含めない。
|
|
38
|
+
- 同梱の完成例の ID `specdojo:ifx-cmd-sample` は命名上の例外であり、実際の ESIL の参照先には使用しない。
|
|
44
39
|
|
|
45
40
|
## 4. 先頭メタ項目
|
|
46
41
|
|
|
47
|
-
YAML
|
|
42
|
+
- YAML は Frontmatter を持たない。先頭メタ項目の共通原則は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] の「独立 YAML データファイルのメタ情報」に従う。
|
|
43
|
+
- 成果物は `type: api`、再利用可能な雛形は `type: template` とし、`rulebook: specdojo:ifx-cmd-rulebook` を指定する。`title` で対象と実行目的を識別する。項目の必須性・型・許容値は `docs/specdojo/schemas/v1/ifx-cmd.schema.yaml` を正本とする。
|
|
44
|
+
- 成果物の状態(`status`)は `draft`(作成・改訂中)、`ready`(確定・承認済み)、`deprecated`(非推奨・廃止予定)のいずれかを指定する。成果物の状態を agent が独断で確定(`ready`)へ昇格させない。
|
|
45
|
+
- `based_on` には実際に確認した直接の根拠だけを書く。カタログ管理下では `depends_on` の推移閉包内に限定し、起動方法の参照先を示す `command.reference` と役割を混同しない。
|
|
46
|
+
- メタ項目の `version` は呼び出し契約の改版、`command.version_constraint` は CLI の対応バージョンを表す。
|
|
47
|
+
|
|
48
|
+
## 5. 本文要件
|
|
48
49
|
|
|
49
|
-
|
|
50
|
-
| -------- | ------------------------------------------------ | ---- |
|
|
51
|
-
| id | コマンド連携仕様 ID。成果物では `ifx-cmd-<term>` | ○ |
|
|
52
|
-
| type | `api` 固定 | ○ |
|
|
53
|
-
| title | 対象と実行目的が分かる仕様名 | ○ |
|
|
54
|
-
| status | `draft` / `ready` / `deprecated` | ○ |
|
|
55
|
-
| rulebook | `specdojo:ifx-cmd-rulebook` | ○ |
|
|
50
|
+
YAML の構造、入れ子キー、型、列挙値は `docs/specdojo/schemas/v1/ifx-cmd.schema.yaml` を参照する。検証対象・コマンド・期待結果は「成果物の検証手順」に従う。以下は契約として満たす内容要件であり、schema が互換性のため任意としている項目も、ここで必須とした場合は記述する。
|
|
56
51
|
|
|
57
|
-
|
|
|
58
|
-
|
|
|
59
|
-
|
|
|
52
|
+
| 対象キー | 必須性 | 契約として定める内容 |
|
|
53
|
+
| ---------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
|
54
|
+
| `command` | 必須 | 実行目的、実行ファイルの識別方法、起動方式。`reference` に起動方法を解決できる正本を必ず示す |
|
|
55
|
+
| `streams` | 必須 | stdin の要否、stdout の受領内容と解析対象、stderr の診断用途。各ストリームの形式と意味を明示し、テキストは原則 UTF-8 とする |
|
|
56
|
+
| `files` | ファイル入出力がある場合は必須 | 渡すファイルと作るファイルのパスまたは解決規則、形式、用途、作成・更新主体。内容の構造は対応する schema・仕様を参照する |
|
|
57
|
+
| `side_effects` | 副作用の有無の説明が必須 | 外部状態・ローカル環境への変更と利用枠消費。ルートまたは `execution.side_effects` の一方にまとめ、副作用がなければその旨を書く |
|
|
58
|
+
| `exit_codes` | 必須 | 成功と代表的失敗の終了コード、識別条件、共通カテゴリ、自動再試行の可否 |
|
|
59
|
+
| `authentication` | 必須 | 認証方式、注入機構、参照名、供給元の管理境界、マスク方針。認証不要でもその旨を明示する |
|
|
60
|
+
| `execution` | 必須 | 作業ディレクトリ、時間・並列実行・ネットワークの制約、冪等性の成立条件または保証できない理由 |
|
|
61
|
+
| `error_handling` | 必須 | 再試行の対象と上限・待機方式、タイムアウト、出力解析失敗、認証失敗に対する個別の処置 |
|
|
60
62
|
|
|
61
|
-
`
|
|
63
|
+
schema の後方互換性定義として残されている `arguments` の各項目(種別 `kind` の `argument` / `option` / `positional`、値の供給元 `value_source` の `literal` / `generated` / `config` / `secret` / `user_input`)は、過去の既存仕様との互換性のための定義である。新規作成および改訂では引数表を持たず(PJR-4N3R)、正本参照(`command.reference`)および入出力の約束(`streams`・`files`・`exit_codes`・`side_effects`)へ一本化する。
|
|
62
64
|
|
|
63
|
-
##
|
|
65
|
+
## 6. 記述ガイド
|
|
64
66
|
|
|
65
|
-
|
|
66
|
-
| -------------- | -------------------------------------------------------------------------------- | ---- |
|
|
67
|
-
| command | 実行可能ファイル、サブコマンド、用途、バージョン制約、シェル経由の有無 | ○ |
|
|
68
|
-
| arguments | option/positional の種別、必須性、型、値の供給元、説明 | ○ |
|
|
69
|
-
| streams | stdin、stdout、stderr の使用有無、データ形式、文字コード、契約 | ○ |
|
|
70
|
-
| exit_codes | 終了コードと意味、共通カテゴリ、リトライ可否 | ○ |
|
|
71
|
-
| authentication | 認証方式、注入機構、参照名、秘密値の供給元、ログのマスク方針 | ○ |
|
|
72
|
-
| execution | 実行ディレクトリ、タイムアウト、ネットワーク要否、並列実行数、冪等性 | ○ |
|
|
73
|
-
| error_handling | 再試行対象、試行上限、待機方式、タイムアウト時、出力解析失敗時、認証失敗時の処置 | ○ |
|
|
67
|
+
### 6.1. 連携単位とメタ情報
|
|
74
68
|
|
|
75
|
-
|
|
69
|
+
- **判断基準**: ESIL の連携目的と成功後の状態が対応し、1 ファイルを一つの契約として検証できること。共通事項は上位を参照し、同じ provider 一覧や設定値を複数キーへ繰り返さない。
|
|
70
|
+
- **改訂・廃止**: [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] の「文書の改訂・廃止とライフサイクル変更管理」に従う。BA は ESIL の参照行と呼び出し元の業務完了・回復条件、ARC は正本分担と制約、DEV は起動設定・入出力処理、QE は成功・失敗・再試行の検証への影響を確認する。移行の追跡は PM、廃止・置き換えの承認は PO が担う。
|
|
71
|
+
- **良い例**: 読取と更新を別 ID にし、`title` に対象と目的を書く。provider ごとに実行ファイルが変わるときは、`executable` に設定の該当キーから解決する旨を示し、一覧自体は設定へ委ねる。
|
|
72
|
+
- **悪い例**: 一つの仕様に読取・登録・削除を混在させる。設定の provider 一覧を目的・実行ファイル・コメントへそれぞれ転載する。
|
|
76
73
|
|
|
77
|
-
|
|
74
|
+
### 6.2. コマンドと正本参照
|
|
75
|
+
|
|
76
|
+
- **判断基準**: `purpose` で呼び出し元から見た成功後の状態を示し、`reference` で正本の文書・設定キー・対象操作を特定する。通常は実行ファイルとサブコマンドを分け、`shell: false` とする。
|
|
77
|
+
- **シェル起動の例外**: 管理された起動設定を呼び出し元が展開し、その起動契約がシェルを必要とする場合は `shell: true` を認める。シェルを必要とする理由、テンプレートの正本と管理境界、展開する値の検証・制限を確認できる参照先を示す。利用者入力を無制限にシェル構文として評価する契約は認めない。テンプレート全文や複数コマンドの処理手順は仕様へ転載しない。
|
|
78
|
+
- **良い例**: AI provider CLI では `reference` に `.specdojo/exec-defaults.yaml` の `providers.<provider>.command_template` と exec 設定ガイドを示す。`shell: true` の理由を stdin から起動引数への変換として説明し、設定の保護と展開値の検証は同ガイドの契約を参照する。
|
|
79
|
+
- **悪い例**: 実際はシェルを使うのに `false` と書く。「外部 CLI だから」という理由だけで `true` にする。`executable` に引数やパイプを連結し、起動設定と別のコマンド全文を管理する。
|
|
80
|
+
|
|
81
|
+
### 6.3. ストリーム
|
|
82
|
+
|
|
83
|
+
- **判断基準**: stdin は渡す内容と入力終了の約束、stdout は呼び出し元が採用する範囲、stderr は診断の用途を記述する。stdin を使わない場合も要否と形式を明示する。出力内容の詳細構造は正本を参照し、呼び出し元の判定に必要な意味を残す。
|
|
84
|
+
- **良い例**: テキストの進捗が混在する stdout では、末尾の構造化報告を抽出する範囲と、欠落・解析失敗時の扱いを示す。終了コードと報告内容の両方で完了を判断する契約なら、どちらが何を保証するかを書く。
|
|
85
|
+
- **悪い例**: 構造化部分があることを理由に stdout 全体を JSON と記す。「CLI の既定出力」とだけ書く。stderr が空なら成功と判定する。
|
|
78
86
|
|
|
79
|
-
### 6.
|
|
87
|
+
### 6.4. ファイル
|
|
80
88
|
|
|
81
|
-
- `
|
|
82
|
-
- `
|
|
89
|
+
- **判断基準**: 入力と出力を分け、パスの基準ディレクトリ、可変部分の解決方法(供給元と書式)、形式、作成・更新主体と読取主体、内容仕様の正本を特定する。これらは `description` など schema が許容する記入欄で説明し、専用キーや内容のフィールド一覧を追加しない。外部 CLI が作るファイルと呼び出し元が保存する実行記録を区別する。
|
|
90
|
+
- **入出力がない場合**: `files` を記述する場合、CLI がファイルを作成しなければ `outputs: []`、入力ファイルがなければ `inputs: []` と明記する。ファイル入出力を一切行わない CLI では `files` キー自体を省略できる。
|
|
91
|
+
- **良い例**: 入力ファイルについて作業ディレクトリからの相対パス、可変部分の解決元(確定済み取引の識別情報など)、作成主体(呼び出し元プロセス)、内容仕様の正本(schema やフォーマット仕様)を示す。CLI 自身が出力ファイルを作成しない場合は `outputs: []` と明記し、呼び出し元のログ保存と責務境界を分ける。
|
|
92
|
+
- **悪い例**: 出力を「各種ファイル」とだけ書く。呼び出し元が保存するログや別段階で作成する result を、同じ CLI の出力として列挙する。入力ファイルの作成主体や可変部分の解決元が書かれていない。
|
|
83
93
|
|
|
84
|
-
|
|
85
|
-
- positional 引数は `position` を 1 始まりで付け、option 引数は `name` に CLI の表記を記載する。可変値は `example` に実値ではなく公開可能な例を置く。
|
|
94
|
+
### 6.5. 終了状態と識別条件
|
|
86
95
|
|
|
87
|
-
|
|
96
|
+
- **判断基準**: 各終了コードから呼び出し元の次の動作を判断できること。同じコードが複数の意味を持つ場合は、`meaning` に追加信号・判定順・未分類時の扱いを記す。正本に定義された構造化エラーや stdout / stderr の検出条件を参照できればよく、検出パターンの一覧は転載しない。
|
|
97
|
+
- **カテゴリの使い分け**: `success` はプロセスの成功を表し、業務完了に別の条件があれば区別する。`input_error` は入力修正、`authentication_error` は再認証、`authorization_error` は権限の見直し、`permanent_failure` は原因解消を必要とする。`rate_limit` は利用制限、`transient_failure` は一時的障害であり、再試行できる条件を失敗処置で定める。
|
|
98
|
+
- **良い例**: 非ゼロ終了と設定済み検出信号が一致した場合だけ利用制限とし、ほかの非ゼロ終了は汎用失敗として停止する。認証失敗を個別検出できない実装なら、その制約と手動確認の扱いも書く。
|
|
99
|
+
- **悪い例**: 汎用的な exit 1 をすべて一時失敗とする。識別信号がないのに原因別の自動分岐ができると宣言する。exit 0 だけで成果物の検証まで成功したとみなす。
|
|
88
100
|
|
|
89
|
-
|
|
90
|
-
- `streams.stdout` は成功時に呼び出し元が解析する形式と最小契約を記載する。機械処理する場合は `json` または `jsonl` を優先し、人向けの可変文言に依存しない。
|
|
91
|
-
- `streams.stderr` は進捗、警告、失敗詳細のどれが出力されるかを記載する。stderr の文言だけで成否を判定せず、終了コードと構造化出力を優先する。
|
|
92
|
-
- 形式は `text` / `json` / `jsonl` / `yaml` / `binary` / `none` から選び、テキスト形式には原則 `UTF-8` を指定する。
|
|
101
|
+
### 6.6. 副作用と冪等性
|
|
93
102
|
|
|
94
|
-
|
|
103
|
+
- **判断基準**: 永続的な変更、利用枠・課金への影響、変更してはならない範囲を示す。`idempotency` は同一入力での再実行の保証を表し、自動再試行する場合は二重処理を防ぐ条件を明記する。保証がなければ、再開前に既存状態をどう扱うかを書く。
|
|
104
|
+
- **良い例**: 発注登録では同じリクエスト ID による重複排除を条件とする。非決定的な編集処理では冪等性を保証せず、同じ作業ディレクトリの差分を引き継ぎ、確認して再開する条件を示す。
|
|
105
|
+
- **悪い例**: 同じファイル名へ書くという理由だけで業務処理全体が冪等とする。再試行による二重登録や利用枠の追加消費を説明しない。
|
|
95
106
|
|
|
96
|
-
|
|
97
|
-
| ------- | ------------------------------------------ | ---- |
|
|
98
|
-
| code | CLI が返す整数の終了コード | ○ |
|
|
99
|
-
| meaning | CLI 固有の意味と呼び出し元が識別できる条件 | ○ |
|
|
107
|
+
### 6.7. 認証注入
|
|
100
108
|
|
|
101
|
-
|
|
102
|
-
|
|
109
|
+
- **判断基準**: `method` と `injection` は認証の種類と渡し方を分け、`names` には必要な参照名を書く。認証値は起動引数や標準入力へ埋め込まない。`secret_source` には管理境界、`log_policy` には引数・環境変数・stdout・stderr・保存ログのマスク対象とタイミングを書く。認証不要の場合の表現も schema の制約を満たすこと。
|
|
110
|
+
- **良い例**: CLI のログインプロファイルを利用する場合、プロファイル名と保管を担う管理境界を示し、呼び出し元が秘密値を注入しないことを書く。環境変数で渡す場合は変数名だけを示す。
|
|
111
|
+
- **悪い例**: 認証トークンの実値、秘密値入り URL、個人環境の認証ファイルの実パスを例示する。プロファイルを利用するのに環境変数注入と記す。
|
|
103
112
|
|
|
104
|
-
|
|
113
|
+
### 6.8. 実行制約と失敗処置
|
|
105
114
|
|
|
106
|
-
|
|
115
|
+
- **判断基準**: 作業ディレクトリと時間・並列実行・ネットワークの制約は公開契約や確認した実装・設定を根拠にする。設定から決まる上限を架空の固定値へ置き換えない。schema で参照値や上限なしを表せず判断が未了なら、許容されるプレースホルダと共通ラベルで draft に残し、現在動作・不足する判断・次の確認先を記録する。
|
|
116
|
+
- **再試行と回復**: `retryable` と `retry.on_categories` を照合し、対象条件、試行上限の数え方、待機方式を揃える。利用制限でも短時間の制限と利用枠の枯渇を区別し、実際の停止・待機・切替条件は正本へ委ねる。タイムアウト時の子プロセスと部分出力、出力解析失敗時の既存変更、認証失敗時の確認先を個別に定める。
|
|
117
|
+
- **良い例**: タイムアウトが未決定なら、現在は終了まで待つことと、上限・終了処置を決める必要を区別して記す。出力異常時は自動再試行を止め、変更を保持して人の確認または再開に委ねる。
|
|
118
|
+
- **悪い例**: schema を通すためだけに時間や並列数を捏造する。「失敗時はリトライ」とだけ書く。認証・認可・入力不正を待機だけで回復する一時失敗として扱う。
|
|
107
119
|
|
|
108
|
-
|
|
109
|
-
- `injection.mechanism` は `none` / `environment_variable` / `credential_store` / `workload_identity` / `cli_profile` から選び、必要な参照名を `injection.names` に列挙する。
|
|
110
|
-
- `secret_source` に値を供給する管理境界を記載し、`log_policy` に引数、環境変数、stdout/stderr のマスク条件を記載する。
|
|
111
|
-
- 認証トークン、秘密鍵、パスワード、認証プロファイルの実パスを記載しない。コマンド引数への秘密値の埋め込みも許可しない。
|
|
120
|
+
### 6.9. 成果物の検証手順
|
|
112
121
|
|
|
113
|
-
|
|
122
|
+
- **判断基準**: 作成・改訂した仕様 YAML を対象に、構造検証と契約内容の照合を分けて行う。schema の適用と modeline の共通規約は [[specdojo:document-metadata-standard|ドキュメントメタ情報標準]] の「バリデーション」を正本とし、実行する検査は対象リポジトリの `package.json` と hook 設定に従う。
|
|
123
|
+
- **対象と実行方法**: 以下の `<対象YAMLファイルのrepository相対パス>` を実際に変更した仕様のパスに置き換え、repository のルートで実行する。`validate:schema:file` script と Prettier がある場合に各コマンドを使い、別の検証環境では対応する schema を適用する同等の手順を確認する。
|
|
114
124
|
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
125
|
+
```bash
|
|
126
|
+
npm run validate:schema:file -- --schema docs/specdojo/schemas/v1/ifx-cmd.schema.yaml --data '<対象YAMLファイルのrepository相対パス>'
|
|
127
|
+
npx prettier --check '<対象YAMLファイルのrepository相対パス>'
|
|
128
|
+
```
|
|
118
129
|
|
|
119
|
-
-
|
|
130
|
+
- **期待結果とエラー時対応**: schema 検証は対象パスに続く `: valid` と終了コード 0、整形確認は差分なしと終了コード 0 を確認する。エラー時は報告されたキー・型・メタ情報や整形差分を修正し、同じ対象で再実行する。
|
|
131
|
+
- **契約内容の照合**: 構造検証では判定できない正本参照の実在・適用範囲、ファイルの作成主体・可変パス・内容仕様、終了判定と回復条件を照合する。DEV は起動・入出力・報告解析の検証入口、QE は正常・異常・再試行の期待結果、BA は業務完了と副作用を確認できるよう、参照先と結果を実行記録に残す。CLI 自体を起動する検証の詳細は参照先へ委ねる。
|
|
132
|
+
- **良い例**: 変更した YAML と対応 schema を指定し、成功表示と終了コードを記録する。そのうえで、終了コードが同じ失敗の識別や再実行時の副作用を正本と照合する。
|
|
133
|
+
- **悪い例**: schema のパスだけを示す。雛形の構造検証を省略したログを完成した仕様の検証成功とする。schema 合格だけで業務完了や再試行の安全性も保証したとみなす。
|
|
120
134
|
|
|
121
135
|
## 7. 禁止事項
|
|
122
136
|
|
|
123
|
-
-
|
|
124
|
-
-
|
|
125
|
-
-
|
|
126
|
-
-
|
|
127
|
-
-
|
|
137
|
+
- 引数表、起動テンプレート全文、検出パターン一覧、schema の定義を正本と別に管理すること。
|
|
138
|
+
- シェル起動の例外条件を満たさず `shell: true` とすること、または実際の起動方式を隠して `false` とすること。
|
|
139
|
+
- 秘密値、秘密値を含む URL、個人の認証パスを本文・例・ログに含めること。
|
|
140
|
+
- stdout / stderr、プロセス終了 / 業務完了、CLI の生成物 / 呼び出し元の記録を混同すること。
|
|
141
|
+
- 追加信号のない終了コードだけで原因を断定したり、副作用の回復条件がないまま自動再試行したりすること。
|
|
142
|
+
- 内部クラス名、プロセス起動ライブラリの API 呼び出し、スクリプト全文など、合意境界に不要な内部実装を記載すること。
|