specdojo 0.7.0 → 0.9.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 +7 -3
- package/CHANGELOG.md +217 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/catalog.js +16 -14
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/agent.js +5 -3
- package/dist/commands/build.js +69 -10
- package/dist/commands/git.js +206 -0
- package/dist/commands/init.js +9 -3
- package/dist/commands/night-orchestrator.js +6 -4
- package/dist/commands/where.js +25 -0
- package/dist/dashboard/dashboard-timeline.js +18 -16
- package/dist/dashboard/dashboard.js +616 -261
- package/dist/dashboard/epic-plan.js +81 -0
- package/dist/dashboard/exec-records.js +16 -20
- package/dist/dashboard/routines.js +11 -12
- package/dist/dashboard/timeline-build.js +5 -9
- package/dist/dashboard/timeline.js +23 -18
- package/dist/devcontainer/scaffold.js +18 -0
- package/dist/docs/frontmatter-namespace.js +1 -48
- package/dist/docs/index-command.js +2 -2
- package/dist/docs/yaml-business-tables.js +243 -0
- package/dist/docs/yaml-interface-tables.js +106 -0
- package/dist/docs/yaml-pages-command.js +5 -3
- package/dist/docs/yaml-pages.js +268 -3
- package/dist/docs/yaml-table-shared.js +70 -0
- package/dist/docs/yaml-tables.js +39 -0
- package/dist/exec/agent-config.js +31 -0
- package/dist/exec/agent-plan.js +3 -2
- package/dist/exec/agent-protected-config.js +2 -0
- package/dist/exec/commands.js +100 -39
- package/dist/exec/commit-hook-skips.js +78 -0
- package/dist/exec/core.js +19 -7
- package/dist/exec/events.js +179 -8
- package/dist/exec/evidence.js +77 -19
- 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 +209 -15
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +45 -19
- package/dist/exec/plans-generation.js +52 -30
- 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/post-integration.js +162 -0
- package/dist/exec/queue-command.js +166 -0
- package/dist/exec/queue.js +285 -0
- package/dist/exec/register-foreign-wait.js +84 -0
- package/dist/exec/register-resume.js +55 -56
- package/dist/exec/register.js +26 -22
- package/dist/exec/repo-integration-sync.js +21 -5
- package/dist/exec/repo-integration.js +21 -1
- package/dist/exec/reporter.js +121 -23
- package/dist/exec/results.js +106 -25
- package/dist/exec/review-completion.js +47 -0
- package/dist/exec/review-kata.js +112 -0
- package/dist/exec/run/agent-pipeline.js +78 -8
- package/dist/exec/run/agent.js +32 -13
- package/dist/exec/run/change-scope.js +365 -0
- package/dist/exec/run/deferred-cleanup.js +31 -0
- package/dist/exec/run/in-place.js +73 -33
- package/dist/exec/run/job-lock.js +66 -0
- package/dist/exec/run/job-sequence.js +137 -0
- package/dist/exec/run/job.js +135 -41
- package/dist/exec/run/lifecycle-commands.js +189 -37
- package/dist/exec/run/lock.js +22 -1
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +14 -15
- package/dist/exec/run/register-core.js +20 -13
- package/dist/exec/run/register-mode.js +77 -17
- package/dist/exec/run/register-post-review.js +21 -9
- package/dist/exec/run/register-resume.js +95 -31
- package/dist/exec/run/register-state.js +23 -15
- package/dist/exec/run/register-worktree.js +184 -139
- package/dist/exec/run/schedule-mode.js +79 -18
- package/dist/exec/run/schedule-prepare.js +204 -59
- package/dist/exec/run/schedule-task.js +203 -49
- package/dist/exec/run/shared.js +9 -3
- package/dist/exec/run/trailing-records.js +35 -0
- package/dist/exec/run-records.js +2 -0
- package/dist/exec/schedule/schedule.js +116 -4
- package/dist/exec/shared.js +1 -1
- package/dist/exec/smoke.js +190 -0
- package/dist/exec/strategy.js +14 -3
- package/dist/exec/task-view.js +6 -4
- package/dist/exec/trailing-records.js +242 -0
- package/dist/exec/trial-commands.js +8 -4
- package/dist/exec/trial-core.js +6 -1
- package/dist/exec/validate-records-commit.js +110 -0
- package/dist/exec/validate-records.js +148 -0
- package/dist/exec/validation-metrics.js +181 -0
- package/dist/exec/worktree-cleanup-lock.js +26 -0
- package/dist/exec/worktree-command.js +38 -17
- package/dist/exec/worktree-ops-commit.js +119 -48
- package/dist/exec/worktree-ops-lifecycle.js +77 -48
- package/dist/exec/worktree-ops-merge.js +13 -2
- package/dist/exec/worktree-ops.js +2 -2
- package/dist/exec/worktree.js +32 -4
- package/dist/grade/apply.js +32 -6
- package/dist/grade/command-apply.js +3 -3
- package/dist/grade/command-inspect.js +7 -5
- package/dist/grade/command-plan.js +1 -1
- package/dist/grade/command-run.js +7 -1
- 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 +87 -11
- package/dist/grade/target-discovery.js +17 -4
- package/dist/grade/targets.js +12 -11
- package/dist/job/definition.js +84 -8
- package/dist/job/job.js +109 -39
- package/dist/job/noop.js +104 -0
- package/dist/register/authoring-sources.js +22 -16
- 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 +6 -3
- package/dist/register/planning.js +7 -14
- package/dist/register/register.js +74 -16
- 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 +13 -3
- package/dist/routine/failure.js +30 -0
- package/dist/routine/routine.js +189 -71
- package/dist/routine/status.js +62 -0
- package/dist/routine/storage.js +33 -0
- package/dist/schedule/schedule.js +39 -39
- 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 +7 -0
- package/dist/shared/condense-records.js +25 -0
- package/dist/shared/cross-process-lock.js +9 -1
- package/dist/shared/deprecation.js +8 -0
- package/dist/shared/dist-freshness.js +8 -2
- 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-environment.js +2 -1
- package/dist/shared/git.js +186 -16
- package/dist/shared/grade-result.js +17 -1
- package/dist/shared/lefthook-scaffold.js +3 -0
- package/dist/shared/local-config.js +244 -0
- 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/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +73 -41
- package/dist/shared/specdojo-gitignore.js +1 -0
- package/dist/shared/text.js +74 -6
- package/dist/shared/timeline-index.js +2 -0
- package/dist/shared/where-alias.js +13 -0
- package/dist/specdojo.js +4 -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 +12 -0
- package/docs/ja/specdojo/guides/docs-structure-guide.md +48 -15
- package/docs/ja/specdojo/guides/exec-config-guide.md +69 -19
- package/docs/ja/specdojo/guides/exec-operation-guide.md +97 -18
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- package/docs/ja/specdojo/guides/job-sequence-guide.md +77 -0
- 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 +73 -17
- package/docs/ja/specdojo/guides/register-operation-guide.md +26 -6
- package/docs/ja/specdojo/guides/remote-host-development-guide.md +2 -0
- package/docs/ja/specdojo/guides/review-guide.md +22 -19
- package/docs/ja/specdojo/guides/routine-operation-guide.md +23 -12
- package/docs/ja/specdojo/guides/ryu-guide.md +23 -13
- package/docs/ja/specdojo/guides/schedule-design-guide.md +27 -21
- package/docs/ja/specdojo/guides/schedule-operation-guide.md +27 -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 +92 -155
- package/docs/ja/specdojo/guides/waza-guide.md +12 -8
- package/docs/ja/specdojo/recipes/bac-recipe.md +111 -0
- package/docs/ja/specdojo/recipes/bes-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/bps-recipe.md +88 -139
- package/docs/ja/specdojo/recipes/br-recipe.md +77 -0
- package/docs/ja/specdojo/recipes/cdfd-overview-recipe.md +97 -109
- package/docs/ja/specdojo/recipes/cdfd-recipe.md +85 -146
- package/docs/ja/specdojo/recipes/cdfd-uc-recipe.md +92 -99
- package/docs/ja/specdojo/recipes/cnd-recipe.md +135 -0
- package/docs/ja/specdojo/recipes/cpd-recipe.md +140 -0
- package/docs/ja/specdojo/recipes/cxd-recipe.md +162 -0
- package/docs/ja/specdojo/recipes/ifd-recipe.md +145 -0
- package/docs/ja/specdojo/recipes/ifx-cmd-recipe.md +112 -90
- package/docs/ja/specdojo/recipes/ifx-index-recipe.md +164 -0
- package/docs/ja/specdojo/recipes/pm-communication-plan-recipe.md +60 -49
- package/docs/ja/specdojo/recipes/pm-members-recipe.md +50 -51
- package/docs/ja/specdojo/recipes/pm-organization-recipe.md +59 -48
- package/docs/ja/specdojo/recipes/pm-plan-recipe.md +72 -50
- package/docs/ja/specdojo/recipes/pm-quality-management-plan-recipe.md +40 -49
- package/docs/ja/specdojo/recipes/pm-raci-recipe.md +42 -48
- package/docs/ja/specdojo/recipes/pm-roles-recipe.md +52 -81
- package/docs/ja/specdojo/recipes/prj-assumptions-constraints-dependencies-recipe.md +64 -91
- package/docs/ja/specdojo/recipes/prj-charter-recipe.md +71 -106
- package/docs/ja/specdojo/recipes/prj-comparison-of-alternatives-recipe.md +78 -156
- package/docs/ja/specdojo/recipes/prj-issues-and-approach-recipe.md +62 -111
- package/docs/ja/specdojo/recipes/prj-scope-recipe.md +67 -123
- package/docs/ja/specdojo/recipes/prj-stakeholder-register-recipe.md +60 -96
- package/docs/ja/specdojo/recipes/prj-success-criteria-and-acceptance-criteria-recipe.md +61 -105
- package/docs/ja/specdojo/recipes/stsd-recipe.md +88 -80
- package/docs/ja/specdojo/recipes/sysd-critical-flows-recipe.md +129 -0
- package/docs/ja/specdojo/recipes/sysd-cross-cutting-policy-recipe.md +146 -0
- package/docs/ja/specdojo/recipes/sysd-index-recipe.md +141 -0
- package/docs/ja/specdojo/recipes/tsd-recipe.md +149 -129
- package/docs/ja/specdojo/references/command-reference.md +303 -148
- package/docs/ja/specdojo/references/deliverables-reference.md +30 -16
- package/docs/ja/specdojo/references/directory-layout-reference.md +3 -2
- package/docs/ja/specdojo/references/specdojo-config-reference.md +54 -18
- package/docs/ja/specdojo/rulebooks/atc-index-rulebook.md +101 -257
- package/docs/ja/specdojo/rulebooks/atc-rulebook.md +102 -228
- package/docs/ja/specdojo/rulebooks/bac-rulebook.md +63 -290
- package/docs/ja/specdojo/rulebooks/bdd-rulebook.md +162 -80
- package/docs/ja/specdojo/rulebooks/bds-rulebook.md +118 -155
- package/docs/ja/specdojo/rulebooks/bes-index-rulebook.md +128 -60
- package/docs/ja/specdojo/rulebooks/bes-rulebook.md +70 -94
- package/docs/ja/specdojo/rulebooks/bps-rulebook.md +24 -56
- package/docs/ja/specdojo/rulebooks/br-rulebook.md +58 -103
- package/docs/ja/specdojo/rulebooks/ccd-mermaid-rulebook.md +103 -223
- package/docs/ja/specdojo/rulebooks/cdfd-d2-rulebook.md +18 -93
- package/docs/ja/specdojo/rulebooks/cdfd-mermaid-rulebook.md +18 -52
- package/docs/ja/specdojo/rulebooks/cdfd-overview-rulebook.md +109 -147
- package/docs/ja/specdojo/rulebooks/cdfd-rulebook.md +80 -108
- package/docs/ja/specdojo/rulebooks/cdfd-uc-rulebook.md +51 -55
- package/docs/ja/specdojo/rulebooks/cdr-rulebook.md +144 -0
- package/docs/ja/specdojo/rulebooks/cdsd-rulebook.md +81 -68
- package/docs/ja/specdojo/rulebooks/cdt-rulebook.md +139 -0
- package/docs/ja/specdojo/rulebooks/cld-rulebook.md +9 -184
- package/docs/ja/specdojo/rulebooks/clis-rulebook.md +170 -0
- package/docs/ja/specdojo/rulebooks/cnd-mermaid-rulebook.md +33 -86
- package/docs/ja/specdojo/rulebooks/cnd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cop-index-rulebook.md +45 -131
- package/docs/ja/specdojo/rulebooks/cop-rulebook.md +69 -275
- package/docs/ja/specdojo/rulebooks/cpd-mermaid-rulebook.md +20 -112
- package/docs/ja/specdojo/rulebooks/cpd-rulebook.md +79 -249
- package/docs/ja/specdojo/rulebooks/cxd-mermaid-rulebook.md +12 -145
- package/docs/ja/specdojo/rulebooks/cxd-rulebook.md +115 -256
- package/docs/ja/specdojo/rulebooks/dct-index-rulebook.md +79 -109
- package/docs/ja/specdojo/rulebooks/dct-rulebook.md +119 -174
- package/docs/ja/specdojo/rulebooks/dec-rulebook.md +6 -14
- package/docs/ja/specdojo/rulebooks/dmd-index-rulebook.md +22 -66
- package/docs/ja/specdojo/rulebooks/dmd-rulebook.md +36 -94
- package/docs/ja/specdojo/rulebooks/dss-rulebook.md +171 -0
- package/docs/ja/specdojo/rulebooks/etc-index-rulebook.md +31 -131
- package/docs/ja/specdojo/rulebooks/etc-rulebook.md +50 -104
- package/docs/ja/specdojo/rulebooks/gl-rulebook.md +93 -57
- package/docs/ja/specdojo/rulebooks/ifd-mermaid-rulebook.md +63 -253
- package/docs/ja/specdojo/rulebooks/ifx-api-rulebook.md +14 -20
- package/docs/ja/specdojo/rulebooks/ifx-cmd-rulebook.md +79 -76
- package/docs/ja/specdojo/rulebooks/ifx-file-rulebook.md +182 -237
- package/docs/ja/specdojo/rulebooks/ifx-index-rulebook.md +111 -40
- package/docs/ja/specdojo/rulebooks/ifx-msg-rulebook.md +14 -22
- package/docs/ja/specdojo/rulebooks/imp-business-rulebook.md +23 -46
- package/docs/ja/specdojo/rulebooks/imp-data-rulebook.md +41 -64
- package/docs/ja/specdojo/rulebooks/imp-interface-rulebook.md +16 -40
- package/docs/ja/specdojo/rulebooks/imp-operations-rulebook.md +34 -61
- package/docs/ja/specdojo/rulebooks/imp-test-rulebook.md +27 -50
- package/docs/ja/specdojo/rulebooks/itc-index-rulebook.md +70 -199
- package/docs/ja/specdojo/rulebooks/itc-rulebook.md +65 -153
- package/docs/ja/specdojo/rulebooks/mip-index-rulebook.md +74 -150
- package/docs/ja/specdojo/rulebooks/mm-rulebook.md +12 -23
- package/docs/ja/specdojo/rulebooks/mtp-rulebook.md +99 -176
- package/docs/ja/specdojo/rulebooks/nfr-availability-rulebook.md +35 -61
- package/docs/ja/specdojo/rulebooks/nfr-index-rulebook.md +75 -117
- package/docs/ja/specdojo/rulebooks/nfr-integrity-rulebook.md +31 -60
- package/docs/ja/specdojo/rulebooks/nfr-maintainability-rulebook.md +26 -81
- package/docs/ja/specdojo/rulebooks/nfr-operations-rulebook.md +32 -70
- package/docs/ja/specdojo/rulebooks/nfr-performance-rulebook.md +45 -87
- package/docs/ja/specdojo/rulebooks/nfr-reliability-rulebook.md +48 -101
- package/docs/ja/specdojo/rulebooks/nfr-security-safety-rulebook.md +44 -80
- package/docs/ja/specdojo/rulebooks/nfr-usability-rulebook.md +59 -127
- package/docs/ja/specdojo/rulebooks/opd-index-rulebook.md +31 -50
- package/docs/ja/specdojo/rulebooks/opd-rulebook.md +42 -109
- package/docs/ja/specdojo/rulebooks/opr-index-rulebook.md +29 -42
- package/docs/ja/specdojo/rulebooks/opr-rulebook.md +29 -87
- package/docs/ja/specdojo/rulebooks/otp-index-rulebook.md +62 -84
- package/docs/ja/specdojo/rulebooks/otp-rulebook.md +11 -61
- package/docs/ja/specdojo/rulebooks/pjr-rulebook.md +92 -102
- package/docs/ja/specdojo/rulebooks/pm-change-request-log-rulebook.md +25 -34
- package/docs/ja/specdojo/rulebooks/pm-communication-plan-rulebook.md +30 -53
- package/docs/ja/specdojo/rulebooks/pm-issue-log-rulebook.md +23 -35
- package/docs/ja/specdojo/rulebooks/pm-members-rulebook.md +27 -45
- package/docs/ja/specdojo/rulebooks/pm-organization-rulebook.md +45 -59
- package/docs/ja/specdojo/rulebooks/pm-plan-rulebook.md +56 -66
- package/docs/ja/specdojo/rulebooks/pm-quality-management-plan-rulebook.md +54 -62
- package/docs/ja/specdojo/rulebooks/pm-raci-rulebook.md +46 -65
- package/docs/ja/specdojo/rulebooks/pm-risk-register-rulebook.md +28 -35
- package/docs/ja/specdojo/rulebooks/pm-roles-rulebook.md +65 -97
- package/docs/ja/specdojo/rulebooks/pr-rulebook.md +6 -18
- package/docs/ja/specdojo/rulebooks/prj-assumptions-constraints-dependencies-rulebook.md +48 -78
- package/docs/ja/specdojo/rulebooks/prj-charter-rulebook.md +23 -97
- package/docs/ja/specdojo/rulebooks/prj-comparison-of-alternatives-rulebook.md +61 -153
- package/docs/ja/specdojo/rulebooks/prj-issues-and-approach-rulebook.md +43 -116
- package/docs/ja/specdojo/rulebooks/prj-scope-rulebook.md +16 -51
- package/docs/ja/specdojo/rulebooks/prj-stakeholder-register-rulebook.md +47 -92
- package/docs/ja/specdojo/rulebooks/prj-success-criteria-and-acceptance-criteria-rulebook.md +25 -84
- package/docs/ja/specdojo/rulebooks/sac-rulebook.md +44 -107
- package/docs/ja/specdojo/rulebooks/sf-index-rulebook.md +106 -32
- package/docs/ja/specdojo/rulebooks/sf-rulebook.md +111 -61
- package/docs/ja/specdojo/rulebooks/sld-rulebook.md +129 -59
- package/docs/ja/specdojo/rulebooks/stc-index-rulebook.md +90 -189
- package/docs/ja/specdojo/rulebooks/stc-rulebook.md +45 -105
- package/docs/ja/specdojo/rulebooks/stsd-mermaid-rulebook.md +46 -40
- package/docs/ja/specdojo/rulebooks/stsd-rulebook.md +104 -68
- package/docs/ja/specdojo/rulebooks/sysd-critical-flows-rulebook.md +64 -330
- package/docs/ja/specdojo/rulebooks/sysd-cross-cutting-policy-rulebook.md +70 -263
- package/docs/ja/specdojo/rulebooks/sysd-index-rulebook.md +58 -200
- package/docs/ja/specdojo/rulebooks/sysd-rulebook.md +47 -60
- package/docs/ja/specdojo/rulebooks/tml-rulebook.md +4 -9
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-specs-rulebook.md +69 -71
- package/docs/ja/specdojo/rulebooks/trc-requirements-to-tests-rulebook.md +65 -72
- package/docs/ja/specdojo/rulebooks/tsd-index-rulebook.md +35 -46
- package/docs/ja/specdojo/rulebooks/tsd-rulebook.md +49 -66
- package/docs/ja/specdojo/rulebooks/tsp-index-rulebook.md +64 -139
- package/docs/ja/specdojo/rulebooks/uis-rulebook.md +91 -161
- package/docs/ja/specdojo/rulebooks/utc-index-rulebook.md +49 -144
- package/docs/ja/specdojo/rulebooks/utc-rulebook.md +67 -155
- 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 +87 -21
- package/docs/ja/specdojo/samples/bes-index-sample.md +42 -20
- package/docs/ja/specdojo/samples/bes-sample.md +70 -21
- package/docs/ja/specdojo/samples/bps-sample.md +42 -54
- package/docs/ja/specdojo/samples/br-sample.md +57 -15
- package/docs/ja/specdojo/samples/ccd-sample.md +80 -19
- package/docs/ja/specdojo/samples/cdfd-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
- package/docs/ja/specdojo/samples/cdr-sample.md +78 -0
- package/docs/ja/specdojo/samples/cdsd-sample.md +73 -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 +125 -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/dec-sample.md +2 -3
- 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-api-sample.yaml +0 -2
- 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/ifx-msg-sample.yaml +0 -2
- package/docs/ja/specdojo/samples/job-sequence.yaml +67 -0
- package/docs/ja/specdojo/samples/mip-index-sample.md +98 -20
- package/docs/ja/specdojo/samples/pm-communication-plan-sample.md +26 -19
- package/docs/ja/specdojo/samples/pm-members-sample.yaml +37 -13
- package/docs/ja/specdojo/samples/pm-organization-sample.md +42 -21
- package/docs/ja/specdojo/samples/pm-plan-sample.md +78 -26
- package/docs/ja/specdojo/samples/pm-quality-management-plan-sample.md +41 -22
- package/docs/ja/specdojo/samples/pm-raci-sample.md +63 -28
- package/docs/ja/specdojo/samples/pm-roles-sample.yaml +13 -12
- package/docs/ja/specdojo/samples/prj-assumptions-constraints-dependencies-sample.md +33 -25
- package/docs/ja/specdojo/samples/prj-charter-sample.md +42 -59
- package/docs/ja/specdojo/samples/prj-comparison-of-alternatives-sample.md +83 -62
- package/docs/ja/specdojo/samples/prj-success-criteria-and-acceptance-criteria-sample.md +30 -33
- package/docs/ja/specdojo/samples/sf-index-sample.md +47 -20
- package/docs/ja/specdojo/samples/sf-sample.md +109 -21
- package/docs/ja/specdojo/samples/sld-sample.md +88 -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 +141 -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/job-definition-standard.md +24 -9
- 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-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
- package/docs/ja/specdojo/templates/cdr-template.md +58 -0
- 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 +5 -1
- package/docs/specdojo/schemas/v1/exec-defaults.schema.yaml +95 -8
- package/docs/specdojo/schemas/v1/exec-evidence.schema.yaml +38 -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/job-run.schema.yaml +23 -0
- package/docs/specdojo/schemas/v1/job.schema.yaml +63 -2
- 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/sch-strategy.schema.yaml +2 -2
- package/package.json +10 -7
- package/templates/antigravity/orchestrator.md +7 -3
- package/templates/claude/agents/specdojo-orchestrator.md +7 -3
- package/templates/codex/agents/specdojo-orchestrator.toml +7 -3
- package/templates/codex/orchestrator.md +7 -3
- package/templates/devcontainer/tmux.conf +6 -0
- package/templates/init-exec-defaults.yaml +13 -0
- package/templates/lefthook/tools/specdojo-pre-commit.mjs +8 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +8 -4
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
import { code, properties, records, recordTable, TableBody, valueText, } from "./yaml-table-shared.js";
|
|
2
|
+
export function renderBdd(doc) {
|
|
3
|
+
const body = new TableBody();
|
|
4
|
+
for (const entity of records(doc.entities)) {
|
|
5
|
+
body.section(valueText(entity.logical_name), [
|
|
6
|
+
properties(entity, [
|
|
7
|
+
["physical_name", "物理名"],
|
|
8
|
+
["description", "説明"],
|
|
9
|
+
["key_fields", "キー項目"],
|
|
10
|
+
["schema_ref", "正本スキーマ"],
|
|
11
|
+
["type_ref", "正本型定義"],
|
|
12
|
+
["glossary_term_id", "用語 ID"],
|
|
13
|
+
["related_terms", "関連用語"],
|
|
14
|
+
]),
|
|
15
|
+
recordTable(records(entity.fields), [
|
|
16
|
+
["logical_name", "論理名"],
|
|
17
|
+
["physical_name", "物理名"],
|
|
18
|
+
["description", "業務上の意味"],
|
|
19
|
+
["type", "型"],
|
|
20
|
+
["unit", "単位"],
|
|
21
|
+
["constraints", "制約"],
|
|
22
|
+
["allowed_values", "許容値"],
|
|
23
|
+
["allowed_values_detailed", "許容値と業務ラベル"],
|
|
24
|
+
["example", "例"],
|
|
25
|
+
["glossary_term_id", "用語 ID"],
|
|
26
|
+
]),
|
|
27
|
+
].join("\n\n"));
|
|
28
|
+
}
|
|
29
|
+
return body.render();
|
|
30
|
+
}
|
|
31
|
+
export function renderRoles(doc) {
|
|
32
|
+
const body = new TableBody();
|
|
33
|
+
body.section("採用ロール", recordTable(records(doc.roles), [
|
|
34
|
+
["code", "ロールコード"],
|
|
35
|
+
["name", "名称"],
|
|
36
|
+
["project_note", "プロジェクトでの責務・補足"],
|
|
37
|
+
]));
|
|
38
|
+
return body.render();
|
|
39
|
+
}
|
|
40
|
+
export function renderMembers(doc) {
|
|
41
|
+
const body = new TableBody();
|
|
42
|
+
body.section("メンバー", recordTable(records(doc.members), [
|
|
43
|
+
["nickname", "実行主体 ID"],
|
|
44
|
+
["display_name", "表示名"],
|
|
45
|
+
["roles", "ロール"],
|
|
46
|
+
["type", "種別"],
|
|
47
|
+
["focus", "担当領域"],
|
|
48
|
+
["note", "補足"],
|
|
49
|
+
]));
|
|
50
|
+
if (Array.isArray(doc.rules))
|
|
51
|
+
body.section("運用ルール", recordTable(doc.rules.map((rule) => ({ rule })), [["rule", "ルール"]]));
|
|
52
|
+
return body.render();
|
|
53
|
+
}
|
|
54
|
+
export function renderTimeline(doc) {
|
|
55
|
+
const body = new TableBody();
|
|
56
|
+
body.section("計画の前提", properties(doc, [
|
|
57
|
+
["planned_start_date", "予定開始日"],
|
|
58
|
+
["notes", "注記"],
|
|
59
|
+
]));
|
|
60
|
+
body.section("トラック順序", recordTable(records(doc.tracks), [
|
|
61
|
+
["track", "トラック"],
|
|
62
|
+
["domains", "ドメイン"],
|
|
63
|
+
["catalog_status", "カタログ状態"],
|
|
64
|
+
["catalog_duration_estimate_days", "カタログ整備の見積日数"],
|
|
65
|
+
["order", "順序"],
|
|
66
|
+
["parallel_group", "並行グループ"],
|
|
67
|
+
["depends_on", "先行トラック"],
|
|
68
|
+
["note", "補足"],
|
|
69
|
+
]));
|
|
70
|
+
return body.render();
|
|
71
|
+
}
|
|
72
|
+
export function renderMilestones(doc) {
|
|
73
|
+
const body = new TableBody();
|
|
74
|
+
body.section("マイルストーン", recordTable(records(doc.milestones), [
|
|
75
|
+
["id", "ID"],
|
|
76
|
+
["name", "名称"],
|
|
77
|
+
["artifact_name", "対象成果物"],
|
|
78
|
+
["depends_on", "先行タスク"],
|
|
79
|
+
["owner", "担当ロール"],
|
|
80
|
+
["date_hint", "目安日"],
|
|
81
|
+
["tags", "タグ"],
|
|
82
|
+
["notes", "注記"],
|
|
83
|
+
]));
|
|
84
|
+
if (Array.isArray(doc.tasks))
|
|
85
|
+
body.section("概要タスク", recordTable(records(doc.tasks), [
|
|
86
|
+
["id", "ID"],
|
|
87
|
+
["name", "名称"],
|
|
88
|
+
["owner", "担当ロール"],
|
|
89
|
+
["depends_on", "先行タスク"],
|
|
90
|
+
]));
|
|
91
|
+
return body.render();
|
|
92
|
+
}
|
|
93
|
+
export function renderViewpoints(doc) {
|
|
94
|
+
const body = new TableBody();
|
|
95
|
+
if (typeof doc.extends === "string") {
|
|
96
|
+
body.section("共通定義の継承", `共通定義: [[${doc.extends}]]。以下の表はこの YAML が宣言する差分です。同じ ID・ロールは上書きし、新しい値は追加します。空の表は差分なしを表します。`);
|
|
97
|
+
}
|
|
98
|
+
for (const [key, title, columns] of [
|
|
99
|
+
[
|
|
100
|
+
"categories",
|
|
101
|
+
"分類",
|
|
102
|
+
[
|
|
103
|
+
["id", "ID"],
|
|
104
|
+
["name", "名称"],
|
|
105
|
+
],
|
|
106
|
+
],
|
|
107
|
+
[
|
|
108
|
+
"coverage_types",
|
|
109
|
+
"確認対象の分類",
|
|
110
|
+
[
|
|
111
|
+
["id", "ID"],
|
|
112
|
+
["name", "名称"],
|
|
113
|
+
["description", "説明"],
|
|
114
|
+
["applies_to", "適用先"],
|
|
115
|
+
],
|
|
116
|
+
],
|
|
117
|
+
[
|
|
118
|
+
"severity_levels",
|
|
119
|
+
"重大度",
|
|
120
|
+
[
|
|
121
|
+
["id", "ID"],
|
|
122
|
+
["description", "意味・扱い"],
|
|
123
|
+
],
|
|
124
|
+
],
|
|
125
|
+
[
|
|
126
|
+
"verdict_definitions",
|
|
127
|
+
"判定",
|
|
128
|
+
[
|
|
129
|
+
["id", "ID"],
|
|
130
|
+
["description", "意味・次の対応"],
|
|
131
|
+
],
|
|
132
|
+
],
|
|
133
|
+
[
|
|
134
|
+
"viewpoints",
|
|
135
|
+
"レビュー観点",
|
|
136
|
+
[
|
|
137
|
+
["id", "ID"],
|
|
138
|
+
["role", "ロール"],
|
|
139
|
+
["category", "分類"],
|
|
140
|
+
["title", "観点"],
|
|
141
|
+
["check", "確認内容"],
|
|
142
|
+
["evidence", "根拠"],
|
|
143
|
+
["default_severity", "重大度"],
|
|
144
|
+
["evaluation", "評価方法"],
|
|
145
|
+
],
|
|
146
|
+
],
|
|
147
|
+
[
|
|
148
|
+
"role_viewpoint_sets",
|
|
149
|
+
"ロール別観点",
|
|
150
|
+
[
|
|
151
|
+
["role", "ロール"],
|
|
152
|
+
["viewpoints", "観点 ID"],
|
|
153
|
+
],
|
|
154
|
+
],
|
|
155
|
+
]) {
|
|
156
|
+
if (Array.isArray(doc[key]))
|
|
157
|
+
body.section(title, recordTable(records(doc[key]), columns.map(([field, label]) => [field, label])));
|
|
158
|
+
}
|
|
159
|
+
// 適用条件を省くと観点を誤用するため、指定された観点だけ補表で示す。
|
|
160
|
+
const scoped = records(doc.viewpoints).filter((item) => item.document_kinds || item.grade_targets || item.comparison_sources || item.coverage_types);
|
|
161
|
+
if (scoped.length)
|
|
162
|
+
body.section("観点の適用条件", recordTable(scoped, [
|
|
163
|
+
["id", "観点 ID"],
|
|
164
|
+
["coverage_types", "確認対象"],
|
|
165
|
+
["grade_targets", "評価対象"],
|
|
166
|
+
["comparison_sources", "比較元"],
|
|
167
|
+
["document_kinds", "文書種別の条件"],
|
|
168
|
+
]));
|
|
169
|
+
if (doc.disabled !== undefined)
|
|
170
|
+
body.section("無効化する共通定義", properties(doc.disabled));
|
|
171
|
+
if (doc.grade_rubric !== undefined)
|
|
172
|
+
body.section("採点基準", properties(doc.grade_rubric));
|
|
173
|
+
return body.render();
|
|
174
|
+
}
|
|
175
|
+
export function renderDctIndex(doc) {
|
|
176
|
+
const body = new TableBody();
|
|
177
|
+
body.section("カタログの設定", properties(doc, [
|
|
178
|
+
["project_id", "プロジェクト"],
|
|
179
|
+
["size", "規模"],
|
|
180
|
+
]));
|
|
181
|
+
const visit = (groups, parent) => {
|
|
182
|
+
for (const group of groups) {
|
|
183
|
+
const name = [parent, valueText(group.name)].filter(Boolean).join(" / ");
|
|
184
|
+
if (Array.isArray(group.domains))
|
|
185
|
+
body.section(name, recordTable(records(group.domains), [
|
|
186
|
+
["domain", "ドメイン"],
|
|
187
|
+
["name", "名称"],
|
|
188
|
+
["overview", "概要"],
|
|
189
|
+
]));
|
|
190
|
+
visit(records(group.groups), name);
|
|
191
|
+
}
|
|
192
|
+
};
|
|
193
|
+
visit(records(doc.groups), "");
|
|
194
|
+
return body.render();
|
|
195
|
+
}
|
|
196
|
+
export function renderDct(doc) {
|
|
197
|
+
const body = new TableBody();
|
|
198
|
+
body.section("カタログの設定", properties(doc, [
|
|
199
|
+
["project_id", "プロジェクト"],
|
|
200
|
+
["domain", "ドメイン"],
|
|
201
|
+
["base_path", "基準パス"],
|
|
202
|
+
]));
|
|
203
|
+
const visit = (groups, parent) => {
|
|
204
|
+
for (const group of groups) {
|
|
205
|
+
const name = [parent, group.name ? valueText(group.name) : ""].filter(Boolean).join(" / ");
|
|
206
|
+
const items = records(group.deliverables);
|
|
207
|
+
if (items.length) {
|
|
208
|
+
body.section(name || "成果物", [
|
|
209
|
+
properties(group, [
|
|
210
|
+
["base_path", "配置先(親からの相対パス)"],
|
|
211
|
+
["note", "注記"],
|
|
212
|
+
]),
|
|
213
|
+
recordTable(items, [
|
|
214
|
+
["local_id", "成果物 ID"],
|
|
215
|
+
["name", "名称"],
|
|
216
|
+
["kind", "種別"],
|
|
217
|
+
["depends_on", "根拠"],
|
|
218
|
+
["overview", "概要"],
|
|
219
|
+
]),
|
|
220
|
+
...items
|
|
221
|
+
.filter((item) => item.done_criteria || item.path || item.brief)
|
|
222
|
+
.map((item) => [
|
|
223
|
+
`**${code(String(item.local_id))}**`,
|
|
224
|
+
properties(item, [
|
|
225
|
+
["path", "パス"],
|
|
226
|
+
["rulebook", "準拠ルール"],
|
|
227
|
+
["brief", "作成指示"],
|
|
228
|
+
["note", "注記"],
|
|
229
|
+
]),
|
|
230
|
+
recordTable(records(item.done_criteria), [
|
|
231
|
+
["text", "完了条件"],
|
|
232
|
+
["roles", "確認ロール"],
|
|
233
|
+
["viewpoint", "観点 ID"],
|
|
234
|
+
]),
|
|
235
|
+
].join("\n\n")),
|
|
236
|
+
].join("\n\n"));
|
|
237
|
+
}
|
|
238
|
+
visit(records(group.groups), name);
|
|
239
|
+
}
|
|
240
|
+
};
|
|
241
|
+
visit(records(doc.groups), "");
|
|
242
|
+
return body.render();
|
|
243
|
+
}
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { isRecord, properties, records, recordTable, TableBody, table, valueText, code, } from "./yaml-table-shared.js";
|
|
2
|
+
export function renderCommand(doc) {
|
|
3
|
+
const body = new TableBody();
|
|
4
|
+
body.section("コマンド", properties(doc.command, [
|
|
5
|
+
["executable", "実行ファイル"],
|
|
6
|
+
["subcommands", "サブコマンド"],
|
|
7
|
+
["purpose", "目的"],
|
|
8
|
+
["reference", "仕様の参照先"],
|
|
9
|
+
["version_constraint", "バージョン制約"],
|
|
10
|
+
["shell", "シェル経由"],
|
|
11
|
+
]));
|
|
12
|
+
if (Array.isArray(doc.arguments))
|
|
13
|
+
body.section("引数", recordTable(records(doc.arguments), [
|
|
14
|
+
["name", "名称"],
|
|
15
|
+
["kind", "種別"],
|
|
16
|
+
["position", "位置"],
|
|
17
|
+
["required", "必須"],
|
|
18
|
+
["value_type", "値の型"],
|
|
19
|
+
["value_source", "値の供給元"],
|
|
20
|
+
["description", "説明"],
|
|
21
|
+
["example", "例"],
|
|
22
|
+
]));
|
|
23
|
+
const streams = isRecord(doc.streams) ? doc.streams : {};
|
|
24
|
+
body.section("標準入出力", table(["ストリーム", "モード", "形式", "文字コード", "契約"], Object.entries(streams).map(([name, stream]) => {
|
|
25
|
+
const item = isRecord(stream) ? stream : {};
|
|
26
|
+
return [name, ...[item.mode, item.format, item.encoding, item.description].map(valueText)];
|
|
27
|
+
})));
|
|
28
|
+
const files = isRecord(doc.files) ? doc.files : {};
|
|
29
|
+
for (const [key, title] of [
|
|
30
|
+
["inputs", "入力ファイル"],
|
|
31
|
+
["outputs", "出力ファイル"],
|
|
32
|
+
]) {
|
|
33
|
+
if (Array.isArray(files[key]))
|
|
34
|
+
body.section(title, recordTable(records(files[key]), [
|
|
35
|
+
["path", "パス"],
|
|
36
|
+
["format", "形式"],
|
|
37
|
+
["encoding", "文字コード"],
|
|
38
|
+
["description", "契約"],
|
|
39
|
+
]));
|
|
40
|
+
}
|
|
41
|
+
body.section("終了コード", recordTable(records(doc.exit_codes), [
|
|
42
|
+
["code", "コード"],
|
|
43
|
+
["meaning", "意味・判定条件"],
|
|
44
|
+
["category", "分類"],
|
|
45
|
+
["retryable", "再試行可否"],
|
|
46
|
+
]));
|
|
47
|
+
for (const [key, title] of [
|
|
48
|
+
["authentication", "認証"],
|
|
49
|
+
["execution", "実行制御"],
|
|
50
|
+
["error_handling", "異常時の扱い"],
|
|
51
|
+
])
|
|
52
|
+
body.section(title, properties(doc[key]));
|
|
53
|
+
body.section("副作用", table(["内容"], [[valueText(doc.side_effects)]]));
|
|
54
|
+
return body.render();
|
|
55
|
+
}
|
|
56
|
+
// IFX-FILE には専用 schema がないため、ifx-file-rulebook と正本の契約単位に沿って示す。
|
|
57
|
+
export function renderFileInterface(doc) {
|
|
58
|
+
const body = new TableBody();
|
|
59
|
+
body.section("連携の概要", properties(doc, [
|
|
60
|
+
["source", "連携元"],
|
|
61
|
+
["target", "連携先"],
|
|
62
|
+
["direction", "向き"],
|
|
63
|
+
["format", "形式"],
|
|
64
|
+
["timing", "タイミング"],
|
|
65
|
+
]));
|
|
66
|
+
body.section("受け渡すファイル", recordTable(records(doc.files), [
|
|
67
|
+
["name", "名称"],
|
|
68
|
+
["location", "配置"],
|
|
69
|
+
["description", "説明"],
|
|
70
|
+
["writer", "書き手"],
|
|
71
|
+
["reader", "読み手"],
|
|
72
|
+
["format", "形式"],
|
|
73
|
+
]));
|
|
74
|
+
for (const file of records(doc.files)) {
|
|
75
|
+
body.section(`ファイル契約: ${code(String(file.name))}`, properties(file, [
|
|
76
|
+
["naming_rule", "命名規則"],
|
|
77
|
+
["encoding", "文字コード"],
|
|
78
|
+
["schema_ref", "正本の型"],
|
|
79
|
+
["required_fields", "必須項目"],
|
|
80
|
+
]));
|
|
81
|
+
}
|
|
82
|
+
for (const [key, title] of [
|
|
83
|
+
["transport", "配送・書き込み"],
|
|
84
|
+
["schema", "データ契約"],
|
|
85
|
+
["error_handling", "異常時の扱い"],
|
|
86
|
+
])
|
|
87
|
+
body.section(title, properties(doc[key]));
|
|
88
|
+
const verification = isRecord(doc.verification) ? doc.verification : {};
|
|
89
|
+
body.section("検証方法", properties(verification, [
|
|
90
|
+
["procedure", "手順"],
|
|
91
|
+
["file_checks", "ファイルごとの確認"],
|
|
92
|
+
]));
|
|
93
|
+
body.section("検証ケース", recordTable(records(verification.cases), [
|
|
94
|
+
["id", "ケース ID"],
|
|
95
|
+
["viewpoint", "観点"],
|
|
96
|
+
["expected", "期待結果"],
|
|
97
|
+
]));
|
|
98
|
+
body.section("未決事項", recordTable(records(doc.open_decisions), [
|
|
99
|
+
["id", "ID"],
|
|
100
|
+
["topic", "論点"],
|
|
101
|
+
["impact", "影響"],
|
|
102
|
+
["owner", "担当"],
|
|
103
|
+
["next_action", "次の対応"],
|
|
104
|
+
]));
|
|
105
|
+
return body.render();
|
|
106
|
+
}
|
|
@@ -7,10 +7,12 @@ function printCommandError(error) {
|
|
|
7
7
|
process.exitCode = 1;
|
|
8
8
|
}
|
|
9
9
|
export function registerYamlPagesCommands(program) {
|
|
10
|
-
const cmd = program
|
|
10
|
+
const cmd = program
|
|
11
|
+
.command("yaml-pages", { hidden: true })
|
|
12
|
+
.description("YAML display page commands");
|
|
11
13
|
cmd
|
|
12
|
-
.command("build")
|
|
13
|
-
.description("
|
|
14
|
+
.command("build", { hidden: true })
|
|
15
|
+
.description("Internal compatibility entry for build --only yaml-pages")
|
|
14
16
|
.option("--root <path>", "Root directory to scan", "docs")
|
|
15
17
|
.action((opts) => {
|
|
16
18
|
try {
|
package/dist/docs/yaml-pages.js
CHANGED
|
@@ -3,9 +3,10 @@ import { dirname, join, posix } from "node:path";
|
|
|
3
3
|
import { dump, load } from "../shared/yaml.js";
|
|
4
4
|
import { collectDocIndexEntries } from "./doc-index.js";
|
|
5
5
|
import { isDctTemplateCatalog, renderCatalogTemplateBody } from "../shared/catalog-render.js";
|
|
6
|
+
import { renderTypedYamlTable } from "./yaml-tables.js";
|
|
6
7
|
// YAML は VitePress のページにならないため、doc-index に載っている YAML ごとに
|
|
7
|
-
// 同階層の generated/<name>.md
|
|
8
|
-
//
|
|
8
|
+
// 同階層の generated/<name>.md へ表示用ページを生成する。
|
|
9
|
+
// wikilink・frontmatter リンクはこのページへ解決される。
|
|
9
10
|
// 自前で生成したページの識別マーカー。これを含まない既存ファイル
|
|
10
11
|
// (catalog build が生成する dct-*.md 等)は上書きしない。
|
|
11
12
|
export const YAML_PAGE_MARKER = "<!-- specdojo:generated-by=yaml-pages -->";
|
|
@@ -19,6 +20,242 @@ const PAGE_TARGET_PREFIXES = ["docs/ja/", "docs/en/"];
|
|
|
19
20
|
function isRecord(value) {
|
|
20
21
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
21
22
|
}
|
|
23
|
+
// YAML 内の Markdown(wikilink やインラインコード)は保ち、表の区切りだけを整える。
|
|
24
|
+
function glossaryCell(value) {
|
|
25
|
+
return value
|
|
26
|
+
.replace(/\s*[\r\n]+\s*/g, " ")
|
|
27
|
+
.replace(/(\\*)\|/g, (_match, slashes) => `${slashes}${slashes.length % 2 === 0 ? "\\" : ""}|`);
|
|
28
|
+
}
|
|
29
|
+
function glossaryText(value) {
|
|
30
|
+
return typeof value === "string" ? value : "";
|
|
31
|
+
}
|
|
32
|
+
function escapeAnchorText(value) {
|
|
33
|
+
return value.replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">");
|
|
34
|
+
}
|
|
35
|
+
function glossaryStrings(value) {
|
|
36
|
+
return Array.isArray(value)
|
|
37
|
+
? value.filter((item) => typeof item === "string")
|
|
38
|
+
: [];
|
|
39
|
+
}
|
|
40
|
+
function renderGlossaryBody(doc, terms) {
|
|
41
|
+
const byId = new Map(terms.map((term) => [glossaryText(term.id), term]));
|
|
42
|
+
// ほかの用語の分類として使われる用語は先頭の「分類」の章にまとめ、各用語は 1 か所にだけ出す。
|
|
43
|
+
const categoryIds = new Set(terms.map((term) => glossaryText(term.category)).filter((category) => category !== ""));
|
|
44
|
+
const sections = [];
|
|
45
|
+
const categoryTerms = terms.filter((term) => categoryIds.has(glossaryText(term.id)));
|
|
46
|
+
if (categoryTerms.length > 0)
|
|
47
|
+
sections.push({ label: "分類", terms: categoryTerms });
|
|
48
|
+
const byCategory = new Map();
|
|
49
|
+
const others = [];
|
|
50
|
+
for (const term of terms) {
|
|
51
|
+
if (categoryIds.has(glossaryText(term.id)))
|
|
52
|
+
continue;
|
|
53
|
+
const category = glossaryText(term.category);
|
|
54
|
+
if (category === "") {
|
|
55
|
+
others.push(term);
|
|
56
|
+
continue;
|
|
57
|
+
}
|
|
58
|
+
const group = byCategory.get(category) ?? [];
|
|
59
|
+
group.push(term);
|
|
60
|
+
byCategory.set(category, group);
|
|
61
|
+
}
|
|
62
|
+
for (const [category, group] of byCategory) {
|
|
63
|
+
const categoryTerm = byId.get(category);
|
|
64
|
+
const label = categoryTerm
|
|
65
|
+
? `[${glossaryText(categoryTerm.term).replace(/[[\]\\]/g, "\\$&")}](#${category})(${category})`
|
|
66
|
+
: category;
|
|
67
|
+
sections.push({ label, terms: group });
|
|
68
|
+
}
|
|
69
|
+
if (others.length > 0)
|
|
70
|
+
sections.push({ label: "その他", terms: others });
|
|
71
|
+
const lines = [
|
|
72
|
+
"<!-- prettier-ignore -->",
|
|
73
|
+
"| ID | 言語 | 状態 | 用語の数 |",
|
|
74
|
+
"| --- | --- | --- | --- |",
|
|
75
|
+
`| ${[doc.id, doc.locale, doc.status].map((value) => glossaryCell(glossaryText(value)) || "-").join(" | ")} | ${terms.length} |`,
|
|
76
|
+
];
|
|
77
|
+
let chapter = 0;
|
|
78
|
+
for (const { label, terms: group } of sections) {
|
|
79
|
+
lines.push("", `## ${++chapter}. ${glossaryCell(label)}`, "", "<!-- prettier-ignore -->", "| 用語(ID) | 英語名と別名 | 定義 | 補足 | 関連 |", "| --- | --- | --- | --- | --- |");
|
|
80
|
+
for (const term of group) {
|
|
81
|
+
const id = glossaryText(term.id);
|
|
82
|
+
const names = [
|
|
83
|
+
term.englishName ? `英語名: ${glossaryText(term.englishName)}` : "",
|
|
84
|
+
glossaryStrings(term.aliases).length
|
|
85
|
+
? `別名: ${glossaryStrings(term.aliases).join("、")}`
|
|
86
|
+
: "",
|
|
87
|
+
]
|
|
88
|
+
.filter(Boolean)
|
|
89
|
+
.join(" / ");
|
|
90
|
+
const supplement = [
|
|
91
|
+
["notes", "注記"],
|
|
92
|
+
["example", "用例"],
|
|
93
|
+
["source", "出典"],
|
|
94
|
+
]
|
|
95
|
+
.flatMap(([key, label]) => {
|
|
96
|
+
const text = glossaryText(term[key]);
|
|
97
|
+
// URL 単独の出典は autolink にして MD034 に合わせる。
|
|
98
|
+
return text ? [`${label}: ${/^https?:\/\/\S+$/.test(text) ? `<${text}>` : text}`] : [];
|
|
99
|
+
})
|
|
100
|
+
.join(" / ");
|
|
101
|
+
const related = glossaryStrings(term.relatedTerms)
|
|
102
|
+
.map((ref) => {
|
|
103
|
+
const target = byId.get(ref);
|
|
104
|
+
const text = glossaryText(target?.term) || ref;
|
|
105
|
+
return target ? `[${text.replace(/[[\]\\]/g, "\\$&")}](#${ref})` : `\`${ref}\``;
|
|
106
|
+
})
|
|
107
|
+
.join("、");
|
|
108
|
+
const cells = [
|
|
109
|
+
// 用語名そのものをページ内の飛び先にする。<a> は空要素ではないため閉じタグを省かない。
|
|
110
|
+
`<a id="${id}">${escapeAnchorText(glossaryText(term.term))}</a>(\`${id}\`)`,
|
|
111
|
+
names,
|
|
112
|
+
glossaryText(term.definition),
|
|
113
|
+
supplement,
|
|
114
|
+
related,
|
|
115
|
+
];
|
|
116
|
+
lines.push(`| ${cells.map((cell) => glossaryCell(cell) || "-").join(" | ")} |`);
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
lines.push("", `## ${++chapter}. YAML の正本`, "");
|
|
120
|
+
return lines.join("\n");
|
|
121
|
+
}
|
|
122
|
+
const IFX_MODELINE_RE = /^#\s*(?:yaml-language-server:|specdojo-schema:)/;
|
|
123
|
+
function collectIfxIndexComments(content) {
|
|
124
|
+
const result = { document: [], interfaces: [] };
|
|
125
|
+
let inInterfaces = false;
|
|
126
|
+
let itemIndent = -1;
|
|
127
|
+
let pending = [];
|
|
128
|
+
let group;
|
|
129
|
+
let groupTarget = result.document;
|
|
130
|
+
let previousWasComment = false;
|
|
131
|
+
for (const line of content.split(/\r?\n/)) {
|
|
132
|
+
const trimmed = line.trim();
|
|
133
|
+
const indent = line.length - line.trimStart().length;
|
|
134
|
+
if (trimmed.startsWith("#")) {
|
|
135
|
+
if (IFX_MODELINE_RE.test(trimmed))
|
|
136
|
+
continue;
|
|
137
|
+
// 連携の内側(ダッシュより深い字下げ)は今の連携、ダッシュと同じ字下げは次の連携、
|
|
138
|
+
// 行頭のコメントは一覧全体の注記とする。
|
|
139
|
+
const current = result.interfaces.at(-1);
|
|
140
|
+
const target = !inInterfaces || indent === 0
|
|
141
|
+
? result.document
|
|
142
|
+
: current !== undefined && indent > itemIndent
|
|
143
|
+
? current
|
|
144
|
+
: pending;
|
|
145
|
+
if (!previousWasComment || target !== groupTarget) {
|
|
146
|
+
group = [];
|
|
147
|
+
target.push(group);
|
|
148
|
+
groupTarget = target;
|
|
149
|
+
}
|
|
150
|
+
group?.push(trimmed.replace(/^#\s?/, ""));
|
|
151
|
+
previousWasComment = true;
|
|
152
|
+
continue;
|
|
153
|
+
}
|
|
154
|
+
previousWasComment = false;
|
|
155
|
+
if (trimmed === "")
|
|
156
|
+
continue;
|
|
157
|
+
if (indent === 0) {
|
|
158
|
+
result.document.push(...pending);
|
|
159
|
+
pending = [];
|
|
160
|
+
inInterfaces = /^interfaces:\s*$/.test(line);
|
|
161
|
+
continue;
|
|
162
|
+
}
|
|
163
|
+
if (inInterfaces && trimmed.startsWith("- ") && (itemIndent === -1 || indent === itemIndent)) {
|
|
164
|
+
itemIndent = indent;
|
|
165
|
+
result.interfaces.push(pending);
|
|
166
|
+
pending = [];
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
result.document.push(...pending);
|
|
170
|
+
return result;
|
|
171
|
+
}
|
|
172
|
+
const IFX_DIRECTION_LABELS = {
|
|
173
|
+
source_to_target: "連携元 → 連携先",
|
|
174
|
+
target_to_source: "連携先 → 連携元",
|
|
175
|
+
bidirectional: "双方向",
|
|
176
|
+
};
|
|
177
|
+
const IFX_LABEL_RE = /_(?:TODO|UNDECIDED|ASSUMPTION)_/g;
|
|
178
|
+
function ifxSpecRefCell(specRef, docId) {
|
|
179
|
+
if (specRef === "")
|
|
180
|
+
return "未記入";
|
|
181
|
+
if (specRef === "TBD")
|
|
182
|
+
return "未整備(TBD)";
|
|
183
|
+
// 成果物の wikilink は project 修飾 ID で解決するため、修飾のない参照には一覧の修飾を補う。
|
|
184
|
+
const prefix = docId.includes(":") ? `${docId.slice(0, docId.indexOf(":"))}:` : "";
|
|
185
|
+
return `[[${specRef.includes(":") ? specRef : `${prefix}${specRef}`}]]`;
|
|
186
|
+
}
|
|
187
|
+
function renderIfxIndexBody(doc, interfaces, content) {
|
|
188
|
+
const comments = collectIfxIndexComments(content);
|
|
189
|
+
const docId = glossaryText(doc.id);
|
|
190
|
+
const tbdCount = interfaces.filter((item) => glossaryText(item.spec_ref) === "TBD").length;
|
|
191
|
+
const paragraphs = (groups) => groups.flatMap((lines) => [lines.join("\n"), ""]);
|
|
192
|
+
const lines = [
|
|
193
|
+
"<!-- prettier-ignore -->",
|
|
194
|
+
"| ID | 状態 | 連携の数 | 詳細仕様が未整備(TBD) |",
|
|
195
|
+
"| --- | --- | --- | --- |",
|
|
196
|
+
`| ${[docId, glossaryText(doc.status)].map((value) => glossaryCell(value) || "-").join(" | ")} | ${interfaces.length} | ${tbdCount} |`,
|
|
197
|
+
"",
|
|
198
|
+
"## 1. 連携の一覧",
|
|
199
|
+
"",
|
|
200
|
+
"<!-- prettier-ignore -->",
|
|
201
|
+
"| No | 連携名 | 連携先 | 向き | 種別 | 形式 | 詳細仕様 | 注記 |",
|
|
202
|
+
"| --- | --- | --- | --- | --- | --- | --- | --- |",
|
|
203
|
+
];
|
|
204
|
+
interfaces.forEach((item, index) => {
|
|
205
|
+
const notes = comments.interfaces[index] ?? [];
|
|
206
|
+
const labels = [...new Set(notes.flat().join("\n").match(IFX_LABEL_RE) ?? [])];
|
|
207
|
+
const noteCell = notes.length === 0
|
|
208
|
+
? "-"
|
|
209
|
+
: [
|
|
210
|
+
`[${notes.length} 件](#ifx-${index + 1})`,
|
|
211
|
+
...labels.map((label) => `\`${label}\``),
|
|
212
|
+
].join(" ");
|
|
213
|
+
const direction = glossaryText(item.direction);
|
|
214
|
+
const cells = [
|
|
215
|
+
String(index + 1),
|
|
216
|
+
`[${glossaryText(item.name).replace(/[[\]\\]/g, "\\$&")}](#ifx-${index + 1})`,
|
|
217
|
+
glossaryText(item.target),
|
|
218
|
+
IFX_DIRECTION_LABELS[direction] ?? direction,
|
|
219
|
+
glossaryText(item.kind),
|
|
220
|
+
glossaryText(item.format),
|
|
221
|
+
ifxSpecRefCell(glossaryText(item.spec_ref), docId),
|
|
222
|
+
noteCell,
|
|
223
|
+
];
|
|
224
|
+
lines.push(`| ${cells.map((cell) => glossaryCell(cell) || "-").join(" | ")} |`);
|
|
225
|
+
});
|
|
226
|
+
lines.push("", "## 2. 連携ごとの詳細", "");
|
|
227
|
+
interfaces.forEach((item, index) => {
|
|
228
|
+
const name = glossaryText(item.name);
|
|
229
|
+
const direction = glossaryText(item.direction);
|
|
230
|
+
const rows = [
|
|
231
|
+
["連携名", `<a id="ifx-${index + 1}">${escapeAnchorText(name)}</a>`],
|
|
232
|
+
["連携元", glossaryText(item.source)],
|
|
233
|
+
["連携先", glossaryText(item.target)],
|
|
234
|
+
["向き", IFX_DIRECTION_LABELS[direction] ?? direction],
|
|
235
|
+
["種別", glossaryText(item.kind)],
|
|
236
|
+
["形式", glossaryText(item.format)],
|
|
237
|
+
["タイミング", glossaryText(item.timing)],
|
|
238
|
+
["異常時の扱い", glossaryText(item.error_handling)],
|
|
239
|
+
["詳細仕様", ifxSpecRefCell(glossaryText(item.spec_ref), docId)],
|
|
240
|
+
];
|
|
241
|
+
lines.push(`### 2.${index + 1}. ${glossaryCell(name) || "-"}`, "", "<!-- prettier-ignore -->", "| 項目 | 内容 |", "| --- | --- |", ...rows.map(([label, value]) => `| ${label} | ${glossaryCell(value) || "-"} |`), "");
|
|
242
|
+
const notes = comments.interfaces[index] ?? [];
|
|
243
|
+
if (notes.length > 0)
|
|
244
|
+
lines.push("注記(YAML のコメント):", "", ...paragraphs(notes));
|
|
245
|
+
});
|
|
246
|
+
let chapter = 2;
|
|
247
|
+
if (comments.document.length > 0) {
|
|
248
|
+
lines.push(`## ${++chapter}. 一覧全体の注記`, "", ...paragraphs(comments.document));
|
|
249
|
+
}
|
|
250
|
+
lines.push(`## ${++chapter}. YAML の正本`, "");
|
|
251
|
+
return lines.join("\n");
|
|
252
|
+
}
|
|
253
|
+
function isIfxIndex(yamlRelPath, parsed) {
|
|
254
|
+
return (/^ifx-index(?:-[a-z0-9-]+)?\.ya?ml$/.test(posix.basename(yamlRelPath)) &&
|
|
255
|
+
isRecord(parsed) &&
|
|
256
|
+
parsed.type === "api" &&
|
|
257
|
+
Array.isArray(parsed.interfaces));
|
|
258
|
+
}
|
|
22
259
|
// doc-index の "path:42" 形式から行番号サフィックスを除去する。
|
|
23
260
|
function stripLineSuffix(entry) {
|
|
24
261
|
const colonIndex = entry.lastIndexOf(":");
|
|
@@ -87,7 +324,8 @@ function deriveMeta(yamlRelPath, content) {
|
|
|
87
324
|
...(title ? { title } : {}),
|
|
88
325
|
};
|
|
89
326
|
}
|
|
90
|
-
// 表示ページの Markdown
|
|
327
|
+
// 表示ページの Markdown を組み立てる。用語集は分類ごとの表を描き、
|
|
328
|
+
// YAML 本文はコードブロックで埋め込み、
|
|
91
329
|
// 本文中のバッククォート連続より長いフェンスを使って壊れないようにする。
|
|
92
330
|
export function renderYamlPage(yamlRelPath, content) {
|
|
93
331
|
const { title, ...meta } = deriveMeta(yamlRelPath, content);
|
|
@@ -125,6 +363,33 @@ export function renderYamlPage(yamlRelPath, content) {
|
|
|
125
363
|
const longestRun = backtickRuns.reduce((max, run) => Math.max(max, run.length), 0);
|
|
126
364
|
const fence = "`".repeat(Math.max(3, longestRun + 1));
|
|
127
365
|
const body = content.endsWith("\n") ? content : `${content}\n`;
|
|
366
|
+
// 対応する文書系列は表で本文を描き、YAML の正本を折りたたんで添える。
|
|
367
|
+
const tableBody = isRecord(parsed) && parsed.type === "glossary" && Array.isArray(parsed.terms)
|
|
368
|
+
? renderGlossaryBody(parsed, parsed.terms.filter(isRecord))
|
|
369
|
+
: isIfxIndex(yamlRelPath, parsed)
|
|
370
|
+
? renderIfxIndexBody(parsed, parsed.interfaces.filter(isRecord), content)
|
|
371
|
+
: renderTypedYamlTable(yamlRelPath, parsed);
|
|
372
|
+
if (tableBody !== undefined) {
|
|
373
|
+
return [
|
|
374
|
+
...header,
|
|
375
|
+
`# ${heading}`,
|
|
376
|
+
"",
|
|
377
|
+
note,
|
|
378
|
+
"",
|
|
379
|
+
YAML_PAGE_MARKER,
|
|
380
|
+
"",
|
|
381
|
+
tableBody,
|
|
382
|
+
"<details>",
|
|
383
|
+
"<summary>YAML の正本を表示</summary>",
|
|
384
|
+
"",
|
|
385
|
+
"<!-- prettier-ignore -->",
|
|
386
|
+
`${fence}yaml`,
|
|
387
|
+
`${body}${fence}`,
|
|
388
|
+
"",
|
|
389
|
+
"</details>",
|
|
390
|
+
"",
|
|
391
|
+
].join("\n");
|
|
392
|
+
}
|
|
128
393
|
return [
|
|
129
394
|
...header,
|
|
130
395
|
`# ${heading}`,
|