precommit-setup

一键配置代码提交前自动化检查,保障代码质量

安装使用

复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:

帮我安装这个 AI Skill:precommit-setup。
它的用途是:一键配置代码提交前自动化检查,保障代码质量
完整的 Skill 内容见:https://321skill.com/skills/precommit-setup-x-7/raw/index.md
请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。

提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。

使用示例

'为我的Python项目配置pre-commit hooks,包括flake8、mypy、black和pytest。',它会自动创建.pre-commit-config.yaml文件,安装相关依赖,并确保每次git commit时自动运行这些检查。若代码不符合规范,提交会被阻止并给出具体错误信息。

介绍

precommit-setup 解决开发者在提交代码时容易遗漏 lint、类型检查、格式化、测试等问题,导致低质量代码进入仓库的痛点。它会在每次 git commit 前自动执行配置好的检查钩子(hooks),阻止不符合规范的代码提交,从源头提升代码质量。

使用非常简单:安装后,AI 会根据项目语言和框架自动生成或读取已有的 .pre-commit-config.yaml 配置文件,集成 eslint、pylint、mypy、black、pytest 等常见工具。你只需正常执行 git commit,系统就会自动触发预检查,若检查失败则提交被阻止,并明确提示错误位置和原因。

适合所有使用 git 的开发者,尤其是团队协作项目——可以有效统一代码风格、避免反复人工 review 低级问题。个人开发者用它也能养成良好习惯,减少后期维护成本。

建议首次使用时先运行默认配置,再根据项目实际需求微调 hooks 列表(如移除不需要的检查器或调整参数)。注意 pre-commit 会增加每次提交的等待时间(通常几秒到几十秒),但相比其带来的质量保障,这点代价完全可以接受。配合 CI 流程使用效果更佳。

核心特点

与手动配置 pre-commit 不同,此 skill 能自动识别项目语言和框架,智能推荐并安装最合适的 hooks(如 Python 项目自动配置 flake8 + mypy + black + pytest),无需开发者逐一搜索和编写配置,且支持一键启停和批量更新。

注意事项

不适合对提交速度要求极高(如秒级提交)或已使用全自动 CI 校验且无需本地检查的场景。

常见问题

如何跳过本次 pre-commit 检查?

在执行 git commit 时添加 --no-verify 参数即可跳过,但建议仅在紧急情况下使用。

如何添加自定义的 hook?

编辑项目根目录下的 .pre-commit-config.yaml 文件,在 repos 列表中添加对应的 hook 配置即可。

给 AI 助手的安装指引

如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:

请访问 https://321skill.com/skills/precommit-setup-x-7/raw/index.md 读取 precommit-setup 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。