precommit-setup
为代码仓库配置统一的预提交检查钩子
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:precommit-setup。 它的用途是:为代码仓库配置统一的预提交检查钩子 完整的 Skill 内容见:https://321skill.com/skills/precommit-setup-x-3/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'请为我的TypeScript React项目配置pre-commit钩子,需要包含ESLint代码检查、Prettier代码格式化以及运行单元测试。',它会生成一个详细的`.pre-commit-config.yaml`配置文件,并给出安装和启用步骤。你只需复制配置并运行安装命令,即可在下次提交时自动触发这些质量关卡。
介绍
这个Skill解决了开发团队在代码提交前手动执行代码质量检查的繁琐和遗漏问题。它通过配置pre-commit框架,在开发者执行git commit命令时自动触发一系列检查,包括代码格式化、静态分析、类型检查和单元测试等,确保只有符合规范的代码才能被提交到版本库。
使用方式非常简单,开发者只需在项目根目录下运行Skill提供的安装命令,即可生成或更新.pre-commit-config.yaml配置文件。之后,每次提交代码时,配置好的钩子就会自动运行,如果检查失败,提交将被阻止,并给出明确的错误信息,引导开发者修复问题。
它非常适合需要维护代码质量、统一团队编码风格的前端、后端及全栈开发工程师。对于项目经理和团队负责人而言,这也是一个低成本、自动化的代码质量管控工具,能有效减少代码评审时的低级错误。
建议在项目初期就引入此Skill,以便尽早建立规范。对于已有项目,可以逐步添加检查项,避免一次性引入过多规则导致团队不适应。需要注意的是,部分检查可能增加提交耗时,对于大型文件或复杂项目,可以配置只检查变更部分以提升效率。
核心特点
该Skill提供了一个开箱即用的、针对现代Web开发技术栈(如TypeScript、ESLint、Prettier、Jest)的预提交钩子配置方案,相比手动配置或通用模板,它集成了更贴合实际项目需求的、经过验证的检查规则组合。
注意事项
不适合对提交速度有极致要求或项目结构非常特殊、无法适配标准检查工具链的场景。
常见问题
如何跳过pre-commit检查?
使用 `git commit --no-verify` 命令可以跳过钩子执行,但不建议常规使用。
可以自定义检查项吗?
可以,安装后直接编辑生成的 `.pre-commit-config.yaml` 文件,增删或修改钩子即可。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/precommit-setup-x-3/raw/index.md 读取 precommit-setup 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/precommit-setup-x-3/raw/index.md(查看排版版本)