specdojo 0.7.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 +153 -0
- package/dist/catalog/build.js +24 -1
- package/dist/catalog/plan.js +1 -1
- package/dist/catalog/scaffold.js +4 -1
- package/dist/commands/init.js +5 -1
- package/dist/commands/night-orchestrator.js +6 -4
- 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/scaffold.js +18 -0
- 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/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 +153 -12
- package/dist/exec/pipeline-state.js +27 -5
- package/dist/exec/plans-condense-findings.js +89 -0
- package/dist/exec/plans-core.js +24 -17
- package/dist/exec/plans-generation.js +48 -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 +55 -56
- 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 +188 -36
- package/dist/exec/run/mode-shared.js +11 -3
- package/dist/exec/run/register-command.js +6 -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 +4 -4
- package/dist/exec/run/schedule-prepare.js +201 -59
- package/dist/exec/run/schedule-task.js +129 -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 +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 +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 +43 -9
- 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 +142 -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/run-records.js +224 -0
- package/dist/shared/specdojo-config.js +39 -21
- package/dist/shared/text.js +65 -5
- package/dist/shared/timeline-index.js +2 -0
- package/docs/ja/specdojo/defaults/pm-review-viewpoints.yaml +9 -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 +47 -16
- package/docs/ja/specdojo/guides/exec-operation-guide.md +53 -17
- package/docs/ja/specdojo/guides/exec-worktree-guide.md +20 -11
- 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 +70 -14
- package/docs/ja/specdojo/guides/register-operation-guide.md +25 -5
- 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 +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 +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/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-uc-recipe.md +36 -24
- 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 +79 -64
- 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-uc-rulebook.md +56 -35
- 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-sample.md +172 -99
- package/docs/ja/specdojo/samples/cdfd-uc-sample.md +9 -7
- 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-template.md +81 -54
- package/docs/ja/specdojo/templates/cdfd-uc-template.md +9 -5
- 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 +53 -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/package.json +2 -2
- package/templates/antigravity/orchestrator.md +3 -2
- 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/tmux.conf +6 -0
- package/templates/opencode/agents/specdojo-orchestrator.md +3 -2
|
@@ -1,107 +1,138 @@
|
|
|
1
1
|
# yaml-language-server: $schema=../../../specdojo/schemas/v1/ifx-cmd.schema.yaml
|
|
2
2
|
id: specdojo:ifx-cmd-sample
|
|
3
3
|
type: api
|
|
4
|
-
status:
|
|
5
|
-
title:
|
|
4
|
+
status: ready
|
|
5
|
+
title: 駄菓子屋きぬや レシート印刷コマンド連携仕様サンプル
|
|
6
6
|
rulebook: specdojo:ifx-cmd-rulebook
|
|
7
7
|
version: 1
|
|
8
|
-
based_on:
|
|
8
|
+
based_on:
|
|
9
|
+
- specdojo:clis-sample
|
|
10
|
+
|
|
11
|
+
# _ASSUMPTION_: receipt-print は学習用の架空 CLI。本例では USB 直結・同期印字とし、
|
|
12
|
+
# 1 回の起動上限を 30 秒、同時起動を店舗端末全体で 1 件とする。
|
|
13
|
+
# 未同梱のリファレンスと印字形式の識別子は参照名だけを示し、実在するリンクにしない。
|
|
9
14
|
|
|
10
15
|
command:
|
|
11
|
-
executable:
|
|
12
|
-
|
|
13
|
-
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
16
|
+
executable: receipt-print
|
|
17
|
+
purpose: >-
|
|
18
|
+
[[specdojo:clis-sample|販売管理 CLI 仕様サンプル]] の会計完了時に、
|
|
19
|
+
確定済みレシートを店舗プリンタで印刷し、呼び出し元が印字結果を判定できる状態にする。
|
|
20
|
+
売上登録や会計確定の再実行はこの連携に含めない。
|
|
21
|
+
印字失敗時も会計を取り消さず、販売 CLI は警告を表示して未印字の控えを保持する。
|
|
22
|
+
reference: >-
|
|
23
|
+
`receipt-print-reference` v1 の「ファイル印刷」を起動方法の正本とする。
|
|
24
|
+
入力パスの渡し方、結果 JSON と診断の構造、送信前失敗の識別条件は同リファレンス、
|
|
25
|
+
印字内容は `kinuya-receipt-format-schema` を参照する。
|
|
26
|
+
version_constraint: ">=1.0.0 <2.0.0"
|
|
17
27
|
shell: false
|
|
18
28
|
|
|
19
|
-
arguments:
|
|
20
|
-
- name: --file
|
|
21
|
-
kind: option
|
|
22
|
-
required: true
|
|
23
|
-
value_type: path
|
|
24
|
-
value_source: generated
|
|
25
|
-
description: 発注 ID、商品 ID、数量を含む JSON ファイルのパス
|
|
26
|
-
example: tmp/orders/ORD-0001.json
|
|
27
|
-
- name: --request-id
|
|
28
|
-
kind: option
|
|
29
|
-
required: true
|
|
30
|
-
value_type: string
|
|
31
|
-
value_source: generated
|
|
32
|
-
description: 同じ発注の重複登録を防ぐリクエスト ID
|
|
33
|
-
example: req-order-0001
|
|
34
|
-
- name: --output
|
|
35
|
-
kind: option
|
|
36
|
-
required: true
|
|
37
|
-
value_type: string
|
|
38
|
-
value_source: literal
|
|
39
|
-
description: 機械処理する出力形式
|
|
40
|
-
example: json
|
|
41
|
-
|
|
42
29
|
streams:
|
|
43
30
|
stdin:
|
|
44
31
|
mode: none
|
|
45
32
|
format: none
|
|
33
|
+
description: 入力はファイルで渡す。呼び出し元は stdin を閉じ、対話入力を要求しない。
|
|
46
34
|
stdout:
|
|
47
35
|
format: json
|
|
48
36
|
encoding: UTF-8
|
|
49
|
-
description:
|
|
37
|
+
description: >-
|
|
38
|
+
起動ごとに結果 JSON を 1 件返す。呼び出し元は対象取引と印字完了を照合する。
|
|
39
|
+
進捗は混在させず、結果の詳細構造は `receipt-print-reference` の「結果」を参照する。
|
|
40
|
+
exit 0 でも報告が欠落・不正・対象不一致なら印字完了扱いにしない。
|
|
50
41
|
stderr:
|
|
51
42
|
format: text
|
|
52
43
|
encoding: UTF-8
|
|
53
|
-
description:
|
|
44
|
+
description: >-
|
|
45
|
+
進捗、警告、失敗診断。送信前失敗の機械判定は `receipt-print-reference` の「診断」に従う。
|
|
46
|
+
可変の説明文や stderr が空であることを成功の根拠にしない。
|
|
47
|
+
|
|
48
|
+
files:
|
|
49
|
+
inputs:
|
|
50
|
+
- path: receipts/receipt-YYYYMMDD-NNNN.txt
|
|
51
|
+
format: text
|
|
52
|
+
encoding: UTF-8
|
|
53
|
+
description: >-
|
|
54
|
+
呼び出し元の販売 CLI([[specdojo:clis-sample|販売管理 CLI 仕様サンプル]])が会計確定時に作成する印字用テキスト。
|
|
55
|
+
パスは店舗データディレクトリを基準とし、可変部の日付 `YYYYMMDD`(会計確定日・8桁)と連番 `NNNN`(当日取引連番・4桁)は確定済み取引情報から解決する。
|
|
56
|
+
印字テキストの内容仕様は `kinuya-receipt-format-schema` を参照する。印刷 CLI は読み取りのみを行い、変更・削除は行わない。
|
|
57
|
+
# 印刷 CLI はファイルを作らない。電子控え、未印字状態、実行ログの保存は呼び出し元の責務。
|
|
58
|
+
outputs: []
|
|
59
|
+
|
|
60
|
+
side_effects:
|
|
61
|
+
- プリンタへ印字データを送り、用紙を消費する。途中失敗でも紙面の一部が印字される場合がある
|
|
62
|
+
- 売上・在庫・つけ残高および入力レシートは変更しない。外部サービスの利用枠・課金は発生しない
|
|
54
63
|
|
|
55
64
|
exit_codes:
|
|
56
65
|
- code: 0
|
|
57
|
-
meaning:
|
|
66
|
+
meaning: >-
|
|
67
|
+
プリンタが印字完了を通知し、CLI が正常終了した。
|
|
68
|
+
呼び出し元は stdout の対象取引と完了状態も確認して印字済みにする。
|
|
69
|
+
会計全体の完了判定は販売 CLI が行う。
|
|
58
70
|
category: success
|
|
59
71
|
retryable: false
|
|
60
72
|
- code: 2
|
|
61
|
-
meaning:
|
|
73
|
+
meaning: >-
|
|
74
|
+
入力ファイルがない、読めない、または印字形式に適合しない。プリンタへは送信していない。
|
|
75
|
+
開発担当が入力生成とファイル権限を修正してから再実行する
|
|
62
76
|
category: input_error
|
|
63
77
|
retryable: false
|
|
64
|
-
- code: 4
|
|
65
|
-
meaning: 認証情報が未設定、失効、または有効期限切れ
|
|
66
|
-
category: authentication_error
|
|
67
|
-
retryable: false
|
|
68
78
|
- code: 5
|
|
69
|
-
meaning:
|
|
79
|
+
meaning: ローカルのプリンタデバイスへのアクセス権がない。権限を直すまで再試行しない
|
|
70
80
|
category: authorization_error
|
|
71
81
|
retryable: false
|
|
72
|
-
- code:
|
|
73
|
-
meaning:
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
- code: 75
|
|
77
|
-
meaning: 仕入先サービスが一時的に利用できない
|
|
82
|
+
- code: 1
|
|
83
|
+
meaning: >-
|
|
84
|
+
exit 1 かつ送信前にプリンタが一時的なビジー状態であると診断で確認できた場合。
|
|
85
|
+
exit 1 の分類ではこの条件を先に評価し、一致する場合に限り自動再試行する
|
|
78
86
|
category: transient_failure
|
|
79
87
|
retryable: true
|
|
88
|
+
- code: 1
|
|
89
|
+
meaning: >-
|
|
90
|
+
上記の送信前失敗と識別できない汎用失敗。送信開始後の用紙切れ・切断、
|
|
91
|
+
診断欠落、および未定義の非ゼロ終了もこの扱いとする。
|
|
92
|
+
印字の有無を断定せず、自動再試行を止めて店頭利用者の確認へ進む
|
|
93
|
+
category: permanent_failure
|
|
94
|
+
retryable: false
|
|
80
95
|
|
|
81
96
|
authentication:
|
|
82
|
-
method:
|
|
97
|
+
method: none
|
|
83
98
|
injection:
|
|
84
|
-
mechanism:
|
|
99
|
+
mechanism: none
|
|
85
100
|
names:
|
|
86
|
-
-
|
|
87
|
-
secret_source:
|
|
88
|
-
|
|
101
|
+
- none
|
|
102
|
+
secret_source: >-
|
|
103
|
+
USB 直結のため認証情報は不要で、秘密値の供給元・注入対象はない。
|
|
104
|
+
OS のデバイス権限は開発担当が管理し、認可失敗は exit 5 として扱う。
|
|
105
|
+
log_policy: >-
|
|
106
|
+
起動引数と標準入力に秘密値を含めず、環境変数の値とレシート本文をログへ記録しない。
|
|
107
|
+
呼び出し元は stdout・stderr の診断を保存する前に秘密値をマスクし、
|
|
108
|
+
取引識別子と印字結果だけを実行記録へ残す。
|
|
89
109
|
|
|
90
110
|
execution:
|
|
91
|
-
working_directory:
|
|
92
|
-
timeout_seconds:
|
|
93
|
-
network_required:
|
|
111
|
+
working_directory: 店舗データディレクトリ(販売 CLI と共通。入力パスはこの配下に限定する)
|
|
112
|
+
timeout_seconds: 30
|
|
113
|
+
network_required: false
|
|
94
114
|
max_parallel: 1
|
|
95
115
|
idempotency:
|
|
96
|
-
guaranteed:
|
|
97
|
-
condition:
|
|
116
|
+
guaranteed: false
|
|
117
|
+
condition: >-
|
|
118
|
+
同じ取引を再実行しても CLI・プリンタによる重複排除はなく、二重印字になり得る。
|
|
119
|
+
印字結果が不明なときは店頭利用者が紙面とプリンタ状態を確認してから手動再印刷する。
|
|
120
|
+
再印刷は保存済みレシートだけを使い、会計や売上送信を再実行しない。
|
|
98
121
|
|
|
99
122
|
error_handling:
|
|
100
123
|
retry:
|
|
101
124
|
on_categories:
|
|
102
125
|
- transient_failure
|
|
126
|
+
# 初回起動を含む最大 3 回、待機は 1 秒・2 秒。上限後は自動起動を止め、利用者へ通知する。
|
|
103
127
|
max_attempts: 3
|
|
104
128
|
backoff: exponential
|
|
105
|
-
timeout_action:
|
|
106
|
-
|
|
107
|
-
|
|
129
|
+
timeout_action: >-
|
|
130
|
+
呼び出し元は 30 秒で子プロセスとその子孫を終了し、不完全な stdout を結果として採用しない。
|
|
131
|
+
送信済みデータの印字は停止できたとみなさず、自動再試行せずに印字結果不明として通知する。
|
|
132
|
+
保存済みレシートを保持し、店頭利用者による紙面・プリンタ状態の確認後に手動再印刷する。
|
|
133
|
+
malformed_output_action: >-
|
|
134
|
+
JSON の欠落・解析失敗・対象不一致・完了状態の矛盾は印字結果不明として扱う。
|
|
135
|
+
自動再試行せず、既存のレシートとマスク済み診断を保持して店頭利用者へ確認を依頼する。
|
|
136
|
+
authentication_failure_action: >-
|
|
137
|
+
認証は不要。認証要求が現れた場合は想定外の実行環境として自動再試行を止め、
|
|
138
|
+
開発担当へ実行ファイルと接続方式の確認を依頼する。OS 権限不足は認可失敗として同担当へ依頼する。
|