precommit-setup
为项目配置统一的代码质量检查与自动化测试钩子。
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:precommit-setup。 它的用途是:为项目配置统一的代码质量检查与自动化测试钩子。 完整的 Skill 内容见:https://321skill.com/skills/precommit-setup-x-10/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
‘为我的Python项目配置pre-commit,让它能自动格式化代码、进行类型检查并运行pytest。’,它会引导你安装pre-commit,并生成一个包含black、mypy和pytest钩子的配置文件。之后每次你尝试`git commit`时,这些检查都会自动运行,确保代码质量。
介绍
此技能旨在解决开发团队中代码风格不一、低级错误频发、测试遗漏等问题。它通过集成 pre-commit 框架,在开发者提交代码前自动运行一系列检查,包括代码格式化(如 black, prettier)、静态分析(如 flake8, pylint)、类型检查(如 mypy)以及单元测试,确保只有符合规范的代码才能进入仓库。
使用方式非常简单,开发者只需在项目中安装并配置此技能,之后每次执行 git commit 命令时,配置好的钩子就会自动触发,执行预设的检查任务。如果检查失败,提交会被阻止,并给出具体的错误信息,引导开发者修复问题。
它非常适合任何规模的软件开发团队,尤其是追求代码质量、希望统一团队编码规范、并希望通过自动化减少人工审查成本的项目。无论是前端、后端还是全栈项目,只要使用 Git 进行版本控制,都可以从中受益。
建议在项目初期就引入此技能,以便从一开始就建立良好的开发习惯。需要注意的是,配置的检查工具和规则应与团队的技术栈和约定保持一致,避免因规则过于严苛而影响开发效率。初次配置时,建议先在小范围试用,逐步完善检查项。
核心特点
与仅配置单一检查(如仅格式化)的技能不同,它提供了一套开箱即用的、集成了格式化、静态分析、类型检查和测试的完整质量保障工作流,并针对 Python 和 JavaScript/TypeScript 等常见技术栈进行了预配置优化。
注意事项
不适合对提交速度要求极高或项目历史遗留代码过多、暂时无法通过现有检查规则的场景。
常见问题
如何跳过 pre-commit 检查?
使用 `git commit --no-verify` 命令可以跳过钩子检查,但不推荐常规使用。
可以自定义检查的工具和规则吗?
可以,通过修改项目根目录下的 `.pre-commit-config.yaml` 文件来增删或配置检查钩子。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/precommit-setup-x-10/raw/index.md 读取 precommit-setup 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/precommit-setup-x-10/raw/index.md(查看排版版本)