設定 Pre-Commit 鉤子
前置需求
開始前,請確認:
- Git 儲存庫存在 — 檢查是否有
.git/目錄。如果找不到,通知使用者並停止。 - 套件管理工具可用 — 偵測後(見下方),確認相關工具已安裝:
- Python:執行
uv --version以確認uv可用 - JS/TS:執行
npx --version以確認npx可用
- Python:執行
如果前置需求失敗,請告知使用者缺少什麼以及如何安裝。
步驟 1:偵測專案類型
檢查專案根目錄是否有:
| 信號 | 結果 |
|---|---|
存在 pyproject.toml,無 package.json | Python → 讀取 python-setup.md |
存在 package.json,無 pyproject.toml | JS/TS → 讀取 js-setup.md |
| 兩者都存在 | 詢問使用者(見下方) |
| 兩者都不存在 | 告知使用者:未偵測到支援的專案,停止 |
兩者都存在
使用 AskUserQuestion 提供三個選項:
- A) 僅 Python — 遵循
python-setup.md - B) 僅 JS/TS — 遵循
js-setup.md - C) 兩者 — 遵循
python-setup.md,包含「雙語言模式」章節
步驟 2:詢問使用者要啟用哪些檢查
委派給語言專屬的設定檔案。每個檔案會透過 AskUserQuestion 呈現可用的檢查。
如果使用者未選擇任何檢查:告知使用者不會安裝任何鉤子,並正常結束。
步驟 3:安裝框架
遵循語言專屬的設定檔案。
步驟 4:產生設定
遵循語言專屬的設定檔案,根據使用者的選擇建立設定檔。
步驟 5:安裝鉤子
遵循語言專屬的設定檔案,在 Git 中啟用鉤子。
步驟 6:驗證
對整個程式碼庫執行鉤子,以確認它們正常運作。
步驟 7:處理驗證失敗
- 如果發現 lint/格式違規,在可能的情況下自動修復(
ruff --fix、ruff format、prettier --write)並重新執行。 - 如果發生型別或測試失敗,告知使用者,然後僅提交鉤子設定檔。
步驟 8:提交
暫存並提交所有已建立或修改的設定檔。