使用者輸入
$ARGUMENTS
在繼續之前,你必須考慮使用者輸入(若非空白)。
執行前檢查
檢查擴充掛鉤(實作前):
- 檢查專案根目錄是否存在
.specify/extensions.yml。 - 若存在,讀取該檔案並查找
hooks.before_implement鍵下的條目。 - 若 YAML 無法解析或無效,請勿直接跳過:告知使用者無法讀取
.specify/extensions.yml(包含剖析錯誤),並且表示未檢查任何掛鉤(包含任何註冊為必要 (optional: false) 的掛鉤),然後正常繼續。 - 過濾掉
enabled明確為false的掛鉤。對於沒有enabled欄位的掛鉤,預設視為啟用。 - 對於剩餘的每個掛鉤,不要嘗試解讀或評估掛鉤的
condition表達式:- 若掛鉤沒有
condition欄位,或該欄位為 null/空白,則將該掛鉤視為可執行。 - 若掛鉤定義了非空白的
condition,則跳過該掛鉤,並將條件評估留給 HookExecutor 實作。
- 若掛鉤沒有
- 從掛鉤命令名稱建構命令調用時,將點號 (
.) 替換為連字號 (-)。例如,speckit.git.commit→/speckit-git-commit。 - 對於每個可執行的掛鉤,根據其
optional旗標輸出以下內容:- 可選掛鉤 (
optional: true):## 擴充掛鉤 **可選前掛鉤**:{extension} 命令:`/{command}` 說明:{description} 提示:{prompt} 要執行:`/{command}` - 必要掛鉤 (
optional: false):
輸出上述區塊後,你必須實際調用該掛鉤並等待其完成後再繼續。以其在此代理程式/工作階段中執行命令的相同方式執行(調用方式可能與上方顯示的文字## 擴充掛鉤 **自動前掛鉤**:{extension} 正在執行:`/{command}` EXECUTE_COMMAND:{command} 在繼續執行大綱之前,請等待掛鉤命令的結果。{command}ID 不同,例如 skills 模式的代理程式會以/skill:speckit-...或$speckit-...執行)。僅輸出區塊並不會實際執行掛鉤。
- 可選掛鉤 (
- 如果沒有註冊任何掛鉤,或
.specify/extensions.yml不存在,則直接跳過。
大綱
-
從儲存庫根目錄執行
.specify/scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks,並解析FEATURE_DIR和AVAILABLE_DOCS清單。所有路徑都必須是絕對路徑。對於引數中的單引號(例如 "I'm Groot"),請使用跳脫語法:例如 'I'''m Groot'(或在可能的情況下使用雙引號:"I'm Groot")。 -
檢查檢查清單狀態(若
FEATURE_DIR/checklists/存在):-
將檢查清單標記視為唯讀關卡:掃描核取方塊狀態、回報狀態,並在需要時詢問後再繼續;不要修改檢查清單檔案或標記。
-
checklists/requirements.md是由/speckit-specify和/speckit-clarify維護的內建規格品質檢查清單;由/speckit-checklist產生的自訂檢查清單是審查者擁有的需求品質審查成品。 -
對於自訂檢查清單,
[x]表示審查者判定需求品質準則已滿足;並非表示實作工作已完成。 -
掃描
checklists/目錄中的所有檢查清單檔案。 -
對於每個檢查清單,計算:
- 總項目:所有符合
- [ ]或- [X]或- [x]的行。 - 已檢查項目:符合
- [X]或- [x]的行。 - 未檢查項目:符合
- [ ]的行。
- 總項目:所有符合
-
建立狀態表格:
| 檢查清單 | 總數 | 已檢查 | 未檢查 | 狀態 | |-----------|-------|---------|-----------|--------| | ux.md | 12 | 12 | 0 | ✓ PASS | | test.md | 8 | 5 | 3 | ✗ FAIL | | security.md | 6 | 6 | 0 | ✓ PASS | -
計算整體狀態:
- PASS:所有檢查清單的未檢查項目皆為 0。
- FAIL:一個或多個檢查清單有未檢查項目。
-
如果有任何檢查清單有未檢查項目:
- 顯示包含未檢查項目數量的表格。
- 暫停並詢問:「部分檢查清單有未檢查項目。您是否仍要繼續進行實作?(是/否)」
- 等待使用者回應後再繼續。
- 若使用者回答「否」或「等待」或「停止」,終止執行。
- 若使用者回答「是」或「繼續」或「前進」,則進行步驟 3。
-
如果所有檢查清單都已檢查:
- 顯示所有檢查清單皆通過的表格。
- 自動進行步驟 3。
-
-
載入並分析實作上下文:
- 必要:讀取 tasks.md 以取得完整的任務清單和執行計畫。
- 必要:讀取 plan.md 以取得技術堆疊、架構和檔案結構。
- 若存在:讀取 data-model.md 以取得實體和關係。
- 若存在:讀取 contracts/ 以取得 API 規格和測試需求。
- 若存在:讀取 research.md 以取得技術決策和限制。
- 若存在:讀取 .specify/memory/constitution.md 以取得治理限制。
- 若存在:讀取 quickstart.md 以取得整合情境。
-
專案設定驗證:
- 必要:根據實際專案設定建立/驗證忽略檔案:
偵測與建立邏輯:
-
檢查以下命令是否成功執行,以判斷儲存庫是否為 git 儲存庫(若是,則建立/驗證 .gitignore):
git rev-parse --git-dir 2>/dev/null -
檢查是否存在 Dockerfile* 或 plan.md 中是否有 Docker → 建立/驗證 .dockerignore
-
檢查是否存在 .eslintrc* → 建立/驗證 .eslintignore
-
檢查是否存在 eslint.config.* → 確保設定的
ignores項目涵蓋必要模式 -
檢查是否存在 .prettierrc* → 建立/驗證 .prettierignore
-
檢查是否存在 .npmrc 或 package.json → 建立/驗證 .npmignore(若需發布)
-
檢查是否存在 terraform 檔案 (*.tf) → 建立/驗證 .terraformignore
-
檢查是否需要 .helmignore(存在 helm chart) → 建立/驗證 .helmignore
若忽略檔案已存在:確認它包含必要的模式,僅附加遺漏的重要模式。 若忽略檔案遺失:為偵測到的技術建立包含完整模式集的檔案。
按技術分類的常見模式(依據 plan.md 的技術堆疊):
- Node.js/JavaScript/TypeScript:
node_modules/,dist/,build/,*.log,.env* - Python:
__pycache__/,*.pyc,.venv/,venv/,dist/,*.egg-info/ - Java:
target/,*.class,*.jar,.gradle/,build/ - C#/.NET:
bin/,obj/,*.user,*.suo,packages/ - Go:
*.exe,*.test,vendor/,*.out - Ruby:
.bundle/,log/,tmp/,*.gem,vendor/bundle/ - PHP:
vendor/,*.log,*.cache,*.env - Rust:
target/,debug/,release/,*.rs.bk,*.rlib,*.prof*,.idea/,*.log,.env* - Kotlin:
build/,out/,.gradle/,.idea/,*.class,*.jar,*.iml,*.log,.env* - C++:
build/,bin/,obj/,out/,*.o,*.so,*.a,*.exe,*.dll,.idea/,*.log,.env* - C:
build/,bin/,obj/,out/,*.o,*.a,*.so,*.exe,*.dll,autom4te.cache/,config.status,config.log,.idea/,*.log,.env* - Swift:
.build/,DerivedData/,*.swiftpm/,Packages/ - R:
.Rproj.user/,.Rhistory,.RData,.Ruserdata,*.Rproj,packrat/,renv/ - 通用:
.DS_Store,Thumbs.db,*.tmp,*.swp,.vscode/,.idea/
工具特定模式:
- Docker:
node_modules/,.git/,Dockerfile*,.dockerignore,*.log*,.env*,coverage/ - ESLint:
node_modules/,dist/,build/,coverage/,*.min.js - Prettier:
node_modules/,dist/,build/,coverage/,package-lock.json,yarn.lock,pnpm-lock.yaml - Terraform:
.terraform/,*.tfstate*,*.tfvars,.terraform.lock.hcl - Kubernetes/k8s:
*.secret.yaml,secrets/,.kube/,kubeconfig*,*.key,*.crt
-
解析 tasks.md 結構並擷取:
- 任務階段:設定、測試、核心、整合、打磨。
- 任務相依性:順序執行與平行執行規則。
- 任務詳細資料:ID、說明、檔案路徑、平行標記 [P]。
- 執行流程:順序和相依性要求。
-
依照任務計畫執行實作:
- 逐階段執行:完成每個階段後再進入下一階段。
- 尊重相依性:順序任務依序執行,平行任務 [P] 可同時執行。
- 遵循 TDD 方法:在對應的實作任務之前執行測試任務。
- 基於檔案的協調:影響相同檔案的任務必須依序執行。
- 驗證檢查點:在繼續前驗證每個階段的完成。
-
實作執行規則:
- 先設定:初始化專案結構、相依性、組態。
- 先測試後程式碼:若需要為合約、實體和整合情境撰寫測試。
- 核心開發:實作模型、服務、CLI 命令、端點。
- 整合工作:資料庫連線、中介軟體、日誌記錄、外部服務。
- 打磨與驗證:單元測試、效能最佳化、文件。
-
進度追蹤與錯誤處理:
- 在每個任務完成後回報進度。
- 若任何非平行任務失敗,則終止執行。
- 對於平行任務 [P],繼續執行成功的任務,並回報失敗的任務。
- 提供包含偵錯上下文的明確錯誤訊息。
- 若實作無法繼續,建議後續步驟。
- 重要:對於已完成的任務,請記得在 tasks 檔案中將任務標記為 [X]。
-
完成驗證:
- 驗證所有必要任務皆已完成。
- 檢查實作的功能是否符合原始規格。
- 驗證測試通過且涵蓋率符合要求。
- 確認實作遵循技術計畫。
注意:此命令假設 tasks.md 中存在完整的任務分解。若任務不完整或遺失,建議先執行 /speckit-tasks 以重新產生任務清單。
強制性執行後掛鉤
在向使用者回報完成之前,你必須完成此區段。
檢查專案根目錄是否存在 .specify/extensions.yml。
- 若不存在,或
hooks.after_implement下沒有註冊任何掛鉤,則跳至完成報告。 - 若存在,讀取該檔案並查找
hooks.after_implement鍵下的條目。 - 若 YAML 無法解析或無效,請勿直接跳過:告知使用者無法讀取
.specify/extensions.yml(包含剖析錯誤),並且表示未檢查任何掛鉤(包含任何註冊為必要 (optional: false) 的掛鉤),然後繼續進行完成報告。 - 過濾掉
enabled明確為false的掛鉤。對於沒有enabled欄位的掛鉤,預設視為啟用。 - 對於剩餘的每個掛鉤,不要嘗試解讀或評估掛鉤的
condition表達式:- 若掛鉤沒有
condition欄位,或該欄位為 null/空白,則將該掛鉤視為可執行。 - 若掛鉤定義了非空白的
condition,則跳過該掛鉤,並將條件評估留給 HookExecutor 實作。
- 若掛鉤沒有
- 從掛鉤命令名稱建構命令調用時,將點號 (
.) 替換為連字號 (-)。例如,speckit.git.commit→/speckit-git-commit。 - 對於每個可執行的掛鉤,根據其
optional旗標輸出以下內容:- 必要掛鉤 (
optional: false) — 你必須為每個必要掛鉤輸出EXECUTE_COMMAND::
輸出上述區塊後,你必須實際調用該掛鉤並等待其完成後再繼續。以其在此代理程式/工作階段中執行命令的相同方式執行(調用方式可能與上方顯示的文字## 擴充掛鉤 **自動掛鉤**:{extension} 正在執行:`/{command}` EXECUTE_COMMAND:{command}{command}ID 不同,例如 skills 模式的代理程式會以/skill:speckit-...或$speckit-...執行)。僅輸出區塊並不會實際執行掛鉤。 - 可選掛鉤 (
optional: true):## 擴充掛鉤 **可選掛鉤**:{extension} 命令:`/{command}` 說明:{description} 提示:{prompt} 要執行:`/{command}`
- 必要掛鉤 (
完成報告
回報最終狀態,並附上已完成工作的摘要。
完成條件
- tasks.md 中的所有任務皆已完成並標記為
[X] - 實作已根據規格、計畫和測試涵蓋率驗證
- 擴充掛鉤已根據上述「強制性執行後掛鉤」中的規則分派或跳過
- 已向使用者回報完成,並附上已完成工作的摘要