precommit-setup

为项目自动配置代码质量检查与测试的预提交钩子

安装使用

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

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

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

使用示例

'请为我的Python项目配置pre-commit钩子,要求包含代码格式化(black)、导入排序(isort)、静态检查(flake8)和单元测试(pytest)。',它会生成或修改 `.pre-commit-config.yaml` 文件,并指导你安装必要的依赖和初始化钩子。之后每次提交代码,这些检查都会自动运行,确保代码质量。

介绍

此技能专为解决开发者在提交代码前,手动执行代码检查、格式化、类型检查和测试等重复性工作的问题。它通过配置预提交钩子(pre-commit hooks),将这些质量保障步骤自动化,确保只有符合规范的代码才能被提交到版本库。

使用时,你只需在项目中运行安装命令,该技能便会自动设置好一套预定义的钩子,包括代码格式化、静态检查、类型验证和单元测试等。每次执行 git commit 时,这些钩子会自动触发,对暂存区的文件进行检查。如果检查失败,提交将被阻止,并给出具体的错误信息,引导开发者修复问题。

该技能非常适合前端开发、后端开发、全栈开发以及任何重视代码质量和团队协作规范的开发者。对于希望统一团队编码风格、减少低级错误、提升代码审查效率的项目团队尤其有价值。

建议在项目初期或重构阶段引入此技能,以尽早建立质量门禁。需要注意的是,钩子中的检查项(如代码风格规则)可能需要根据项目实际情况进行调整。初次配置后,建议团队成员在本地运行一次完整的检查,以熟悉流程并确保环境配置正确。

核心特点

该技能提供了一套开箱即用的、针对现代开发栈(如Python、JavaScript/TypeScript)的预提交钩子配置,集成了linting、type checking、formatting和testing等核心质量检查环节,避免了开发者从零开始手动配置和集成多个独立工具的繁琐过程。

注意事项

不适合对构建速度有极致要求、或需要完全自定义检查流水线且不希望被预设规则约束的场景。

常见问题

如何跳过 pre-commit 检查?

使用 `git commit --no-verify` 命令可以跳过钩子检查,但不建议常规使用。

可以自定义检查规则吗?

可以,通过修改项目根目录下的 `.pre-commit-config.yaml` 文件来增删或配置钩子。

给 AI 助手的安装指引

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

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