Husky 提交钩子配置
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @kunlungrowth/setup-pre-commit。
技能介绍
为什么需要 Pre-Commit Hooks
在多人协作或高频提交的仓库中,常见的痛点是「格式化代码忘了跑」或「类型报错没看见就推上去」。靠 CI 拦截虽然可行,但反馈链路太长。更直接的做法是在 git commit 执行前,本地先跑一遍校验,把低级错误拦在进入 Git 历史之前。
核心能力与工作流
该技能扮演工程配置助手的角色,专注于在当前仓库落地一套基于 Husky + lint-staged + Prettier 的预提交体系,不涉及业务逻辑改动。
核心能力:
- 提交前自动格式化暂存文件
- 提交前自动执行类型检查与测试
- 自动识别包管理器与初始化配置
关键步骤:
- 通过锁文件识别项目使用的包管理器(如
package-lock.json或pnpm-lock.yaml),不明则默认 npm - 在 devDependencies 中安装所需依赖
- 运行
npx husky init初始化.husky/目录并配置prepare脚本 - 编写
.husky/pre-commit,调用 lint-staged 及项目的 typecheck/test 脚本(Husky v9+ 不再需要 shebang) - 配置
.lintstagedrc对所有暂存文件执行prettier --ignore-unknown --write - 如缺失 Prettier 配置,则生成一套通用默认规则
- 执行
npx lint-staged验证配置有效性,并完成首次提交
适用边界与注意点
- 脚本缺失处理:如果仓库没有
typecheck或test脚本,技能会自动省略对应行并给予提示,不强行添加空脚本 - 非 Node 项目:本技能基于 Node 生态,非 Node 项目需自行替换为等价工具
- 职责限定:只负责配置钩子环境,不修改具体的业务代码逻辑
使用场景
- 多人协作的 Node.js 项目需要统一代码格式,避免提交时出现风格不一致的 diff
- CI 流水线频繁因格式或类型错误失败,需要本地提交前拦截这些问题
- 接手没有测试或类型检查的项目,想要逐步引入质量保障机制
- 开源项目维护者希望贡献者提交的代码自动符合项目规范,减少 review 时的基础问题
适合人员
- 前端工程师希望减少代码 review 中因格式问题被退回的次数
- 技术负责人需要在团队中推行统一的代码质量规范
- 开源项目维护者想要降低贡献者提交代码的基础质量问题
- 后端开发者接手遗留项目时想快速补上提交前自动校验