precommit-setup
一键配置代码提交前检查工具链
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:precommit-setup。 它的用途是:一键配置代码提交前检查工具链 完整的 Skill 内容见:https://321skill.com/skills/precommit-setup-x-5/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'为我的Python项目配置pre-commit hooks,包括flake8、mypy、black和pytest',它会自动检测项目根目录,生成`.pre-commit-config.yaml`,运行`pre-commit install`激活hook,之后每次提交代码都会自动检查代码风格、类型标注、格式并运行测试。
介绍
在团队开发中,代码提交前的质量检查(如 linting、类型检查、格式化、测试)常常需要手动配置,流程繁琐且容易遗漏,导致仓库中出现格式不统一、潜在 bug 甚至安全漏洞。precommit-setup 是一个自动化配置工具,它能根据项目类型(Python、JavaScript、Go 等)自动生成 .pre-commit-config.yaml 文件,并安装对应的 hook 脚本,确保每次 git commit 前都会自动执行静态分析、类型检查、代码格式化和单元测试,从而将问题拦截在提交之前。
使用方式非常简单:在项目根目录下运行安装命令后,工具会自动检测项目依赖和语言特点,推荐最合适的 hook 组合(如 flake8、eslint、prettier、mypy、pytest 等),并写入配置文件。你还可以通过交互式命令行选择需要启用的检查项,或直接使用默认的“推荐配置”。配置完成后,执行 git commit 时,这些 hook 会依次运行,只有全部通过才能提交成功。
这个 Skill 适合所有使用 Git 进行版本控制的开发团队,尤其是前端开发、后端开发、全栈开发者以及运维工程师。对于刚起步的项目,它能快速建立代码规范;对于大型项目,它能统一团队检查标准,减少 Code Review 中重复的格式问题讨论。同时,它也适用于个人开源项目,帮助你养成高质量编码习惯。
建议在使用前确保项目已初始化 Git 仓库,并已安装 Python 3.6+ 环境(pre-commit 运行依赖)。如果项目中有特殊的自定义 hook 需求,可以在生成的配置文件基础上手动修改。另外,对于已有 pre-commit 配置的项目,本工具会自动备份原有配置,避免覆盖丢失。注意,本工具不直接运行测试,而是集成测试命令到 hook 中,因此请确保测试命令在项目环境下可正常执行。
核心特点
与手动配置 pre-commit 或使用 cookiecutter 模板相比,precommit-setup 能自动检测项目语言和依赖,智能推荐 hook 组合,并一次性完成安装和激活,省去手动编写 YAML 和安装 hook 的步骤,同时支持交互式定制,降低门槛。
注意事项
不适合不使用 Git 的项目,或需要高度自定义复杂 hook 逻辑(如跨仓库调用、动态脚本)的场景。
常见问题
如何禁用某个 hook?
在 `.pre-commit-config.yaml` 中注释或删除对应 hook 条目,或运行 `pre-commit run --hook-stage manual` 跳过。也可以使用 `SKIP` 环境变量忽略特定 hook。
如何更新 pre-commit hook 版本?
运行 `pre-commit autoupdate` 会自动将 hooks 更新到最新版本,然后提交 `.pre-commit-config.yaml` 变更即可。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/precommit-setup-x-5/raw/index.md 读取 precommit-setup 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/precommit-setup-x-5/raw/index.md(查看排版版本)