precommit-setup

为代码仓库配置统一的预提交检查钩子,自动执行代码质量检查。

安装使用

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

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

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

使用示例

“为我的Python项目配置pre-commit,需要包含代码格式化、导入排序、类型检查和单元测试。”,它会引导你确认项目类型和具体需求,然后生成一份详细的`.pre-commit-config.yaml`配置文件,并给出安装和激活钩子的具体命令。或者,你可以直接说:“安装pre-commit-setup”,它会提供标准的安装指令,帮助你快速初始化。

介绍

这个Skill解决了开发团队在代码提交前手动运行各种检查工具(如代码格式化、静态分析、类型检查)的繁琐和易遗漏问题。它通过配置pre-commit框架,在开发者执行git commit命令时自动触发一系列预设的检查任务,确保只有符合规范的代码才能被提交到版本库。

使用方式非常简单,开发者只需在项目根目录下运行Skill提供的安装命令,即可一键生成或更新.pre-commit-config.yaml配置文件,并安装好所有必要的钩子。之后,每次提交代码时,系统都会自动运行如Black、isort、mypy、pytest等工具,如果检查失败,提交将被阻止。

它非常适合需要维护代码质量和统一风格的开发团队,特别是前端开发、后端开发、全栈开发以及负责代码审查的工程师。对于个人开发者或学生,它也是培养良好编码习惯、确保项目代码整洁性的优秀工具。

建议在项目初期就引入此Skill,以便所有开发者从一开始就遵循同一套标准。需要注意的是,它主要作用于本地提交环节,是CI/CD流程中代码质量检查的前置环节和有力补充,但不能替代完整的CI/CD流水线。初次配置时,请确保本地已安装Python和git环境。

核心特点

该Skill提供了一套开箱即用、覆盖代码格式化、静态检查、类型检查和单元测试的完整预提交钩子配置模板,无需开发者从零开始研究和组合各种工具。它特别注重工具链的版本兼容性和执行顺序的优化,避免了常见配置冲突。

注意事项

不适合仅需简单格式化或无需严格类型检查的快速原型、脚本类微型项目。

常见问题

pre-commit hooks 会影响提交速度吗?

会,但通常影响很小。钩子只检查本次提交的变更文件,且可以配置跳过某些耗时检查或仅在特定分支启用。

如何跳过 pre-commit 检查?

可以使用 `git commit --no-verify` 命令临时跳过,但不建议常规使用,这会破坏质量门禁。

给 AI 助手的安装指引

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

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