[Feature]: Add artifact, optional, and handoffs to the command manifest schema
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức phù hợp với người mới
- 64/100
Hướng nghiên cứu
Bắt đầu với src/specify_cli/extensions/init.py và src/specify_cli/presets/init.py, sau đó kiểm tra relative_extension_path_violation trong src/specify_cli/_utils.py và phần tích hợp Forge. So sánh command frontmatter hiện có trong templates/commands/plan.md với các manifest model và xác định normalized handoff mapping. Được xem là hoàn tất khi validation, precedence, hành vi schema tương thích ngược, Forge stripping và documentation được bao quát bằng việc verification implementation.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
Problem Statement
ExtensionCommand and preset command entries model fields such as type, name, file, description, and strategy, but do not expose artifact (the repo-relative output path a command produces), optional (whether a flow can skip it), or handoffs (declarative follow-on commands).
handoffs currently lives in command frontmatter and is stripped by several markdown integrations, including Forge. This forces downstream consumers such as wizard UIs, flow runners, and pipeline visualizers to re-parse markdown frontmatter and prevents these semantics from being consistently available through the command manifest model.
Proposed Solution
Add optional artifact, optional, and handoffs fields to extension and preset command manifest entries:
commands:
- name: speckit.plan
file: commands/speckit.plan.md
description: "..."
artifact: specs/{feature}/plan.md
optional: false
handoffs:
- to: speckit.tasks
when: "plan.status == 'done'"
message: "Ready to break plan into tasks"
Parse command frontmatter during manifest loading and merge its handoffs into the command entry when the manifest does not declare them. If both sources provide handoffs, the manifest value takes precedence.
Keep handoffs in the in-memory model, while continuing to strip it on the Forge export path. Define how the existing frontmatter shape (label, agent, prompt, send) maps to or coexists with the manifest shape (to, when, message). In other words, add handoffs to the normalized in-memory command model and JSON output. Accept an explicit manifest declaration as an optional override, but derive it from command frontmatter when absent. Authors should not need to duplicate handoffs in both files.
Alternatives Considered
- Leave
handoffsfrontmatter-only and require consumers to parse it. Rejected because downstream consumers would duplicate parsing. - Derive
artifactfrom the command file. Rejected because a command may produce multiple artifacts or none. - Bump
schema_versionwithout a compatibility strategy. Current validators use exact-version matching, so a bump would reject existing manifests. Prefer an additive change under the current version unless compatibility policy is deliberately changed.
Component
Specify CLI (initialization, commands)
AI Agent (if applicable)
Not applicable
Use Cases
- A wizard renders a Spec-Driven Development pipeline graph by walking
handoffsedges without opening markdown files. - A flow runner shows a skip action for commands with
optional: trueand refuses to auto-skip mandatory commands. - An audit joins a command's
artifactpath to files in the repository.
Acceptance Criteria
- Extension and preset command schemas accept optional
artifact(string),optional(bool, defaultfalse), andhandoffs(list of{to, when?, message?}). - The manifest loader merges command-file frontmatter
handoffswhen the manifest does not declare its own value. - Manifest-declared
handoffstakes precedence over frontmatter. - Forge export continues to strip
handoffsfrom exported frontmatter. -
artifactis validated as repo-relative;handoffs[].toresolves to a known command;optionalis validated as a boolean. - The schema-version decision is recorded, with backward-compatible behavior for existing manifests.
- Valid and malformed manifest entries, frontmatter merge precedence, and Forge stripping are covered by the implementation verification.
- The manifest schema and
handoffssemantics are documented in the relevant existing documentation.
Additional Context
Impacts preset info --json / extension info --json, which are tracked separately.
Relevant implementation locations include src/specify_cli/extensions/__init__.py, src/specify_cli/presets/__init__.py, src/specify_cli/_utils.py::relative_extension_path_violation, and src/specify_cli/integrations/forge/__init__.py. Existing command frontmatter examples include templates/commands/plan.md.
- Ngôn ngữ chính
- Python
- Star
- 138k
- Fork
- 12.4k
- Merge trung bình
- 3 ngày 4 giờ
- Pull request đã merge (30 ngày)
- 154
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của github/spec-kit
-
enhancement needs-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
enhancement needs-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
-
enhancement needs-triage
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 68/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
-
enhancement needs-triage triage-can-wait
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 76/100
Tất cả issue của github/spec-kit
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
anthropics/skills#1811 · 1 bình luận ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
speaches-ai/speaches#678 ·
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
datalayer/mcp-compose#42 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
conda-forge/spacy-feedstock#177 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
UKGovernmentBEIS/inspect_evals#2523 ·