precommit-setup
为代码仓库自动配置预提交检查钩子,统一团队开发规范。
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:precommit-setup。 它的用途是:为代码仓库自动配置预提交检查钩子,统一团队开发规范。 完整的 Skill 内容见:https://321skill.com/skills/precommit-setup-x-4/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
“请为我的Python项目配置pre-commit hooks,要求包含代码格式化(Black)、导入排序(isort)、静态类型检查(mypy)和单元测试(pytest)。”,它会生成或修改项目中的`.pre-commit-config.yaml`文件,并指导你安装必要的依赖和启用钩子。或者,你可以直接运行它提供的安装命令,一键完成所有配置。
介绍
这个Skill解决了开发团队在代码提交前手动执行代码质量检查(如代码风格、类型、格式、测试)的繁琐和遗漏问题。它通过配置pre-commit钩子,在开发者执行git commit命令时自动触发一系列检查,确保只有符合规范的代码才能被提交到仓库。
使用方式非常简单,开发者只需在项目中运行安装命令,Skill会自动在项目的.git/hooks目录下配置pre-commit钩子,并集成常用的代码检查工具(如linters、formatters、type checkers和测试工具)。之后,每次提交代码都会自动运行这些检查,如果检查失败,提交会被阻止,并给出明确的错误提示。
它非常适合需要维护代码质量、统一团队编码风格的前后端开发团队,特别是那些使用Git进行版本控制的项目。无论是个人开发者希望养成良好的编码习惯,还是团队项目经理希望强制执行代码规范,这个Skill都能提供自动化支持。
建议在项目初期或引入新成员时配置此Skill,以尽早建立规范。需要注意的是,它依赖于项目本身已安装或可安装的检查工具(如ESLint、Prettier、MyPy等),并且主要作用于本地Git钩子,对于已经提交到远程仓库的代码或绕过Git提交的代码变更无法生效。
核心特点
与仅配置单一检查(如仅格式化)的Skill不同,它提供了一套开箱即用的、覆盖代码质量多个维度(代码风格、类型、格式、测试)的完整预提交检查方案。其配置通常针对特定技术栈(如Python/JavaScript)进行了优化,减少了开发者手动集成多个独立工具的工作量。
注意事项
不适合不依赖Git进行版本控制或代码检查流程已完全集成在CI/CD服务器端的项目。
常见问题
pre-commit hooks 是什么?
它是Git在特定操作(如提交)前自动运行的脚本,用于执行检查或任务,确保操作符合预设规则。
这个Skill会覆盖我已有的git hooks吗?
通常它会配置在标准的pre-commit钩子中,如果已有自定义钩子,可能需要手动合并逻辑。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/precommit-setup-x-4/raw/index.md 读取 precommit-setup 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/precommit-setup-x-4/raw/index.md(查看排版版本)