设置预提交钩子 是做什么的?
前置条件
开始前,请确认:
- Git 仓库已存在 — 检查是否存在
.git/目录。如果不存在,请告知用户并停止。 - 包管理工具可用 — 检测到项目类型后(见下方),确认相关工具已安装:
- Python:运行
uv --version确认uv可用 - JS/TS:运行
npx --version确认npx可用
- Python:运行
如果前置条件不满足,请告知用户缺少什么以及如何安装。
第一步:检测项目类型
检查项目根目录:
| 信号 | 结果 |
|---|---|
存在 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(包含“两种语言模式”部分)
第二步:询问用户启用哪些检查项
交由语言特定的设置文件处理。每个文件通过 AskUserQuestion 展示可用的检查项。
如果用户未选择任何检查项:告知用户不会安装任何钩子,并从正常退出。
第三步:安装框架
按照语言特定的设置文件执行。
第四步:生成配置文件
按照语言特定的设置文件,根据用户的选择创建配置文件。
第五步:安装钩子
按照语言特定的设置文件,在 git 中激活钩子。
第六步:验证
对整个代码库运行钩子,确认它们正常工作。
第七步:处理验证失败
- 如果发现代码检查/格式违规,尽可能自动修复(
ruff --fix、ruff format、prettier --write)并重新运行。 - 如果类型或测试失败,告知用户,并仅提交钩子配置文件。
第八步:提交
暂存并提交所有创建/修改的配置文件。