precommit-setup

为项目配置统一的代码质量检查与测试钩子

安装使用

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

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

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

使用示例

'帮我在当前React项目中配置pre-commit钩子,集成ESLint、Prettier和Jest测试。',它会生成或修改`.pre-commit-config.yaml`文件,并指导你安装必要的依赖。之后,每次执行`git commit`时,系统会自动运行这些检查,确保代码质量和风格统一。

介绍

这个Skill解决了开发团队在代码提交前,手动执行代码检查、格式化、类型检查和测试所带来的效率低下和规范执行不一致的问题。它通过配置pre-commit钩子,在开发者执行git commit命令时自动触发一系列质量检查任务,确保只有符合规范的代码才能被提交到仓库。

使用方式非常简单,开发者只需在项目中运行Skill提供的安装命令,即可将预定义好的检查流程集成到本地Git钩子中。之后每次提交代码时,系统会自动运行如ESLint、Prettier、TypeScript类型检查、单元测试等任务,如果检查失败,提交将被阻止,并给出明确的错误提示。

它非常适合需要统一代码风格、保证代码质量的前后端开发团队、全栈工程师以及项目负责人。对于个人开发者,也能帮助其养成良好的编码习惯,确保项目代码的整洁与可维护性。

建议在项目初期或引入新成员时配置此Skill,以快速建立团队规范。需要注意的是,配置的检查规则应与团队实际使用的技术栈和编码规范相匹配,避免因规则过于严格或宽松而影响开发效率或失去检查意义。初次配置后,建议进行一次全量代码扫描和修复。

核心特点

与仅配置单一工具(如只做代码格式化)的Skill不同,它提供了一套开箱即用的、集成了代码静态分析(linting)、类型检查、代码格式化(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-2/raw/index.md 读取 precommit-setup 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。