setup-pre-commit

工程开发 社区 @mattpocock
信任分
88/100
兼容 Agent
1
速查档案 只列事实:领域、Agent、信任分、作者、原文章节。装与不装请看下方作者解读。
领域
工程开发
兼容 Agent
Claude Code
信任分
88 / 100 · 社区维护
作者 / 版本 / 许可
@mattpocock · 未声明 license
安装命令数
1 条

需要注意: 未限定 allowed-tools,默认拥有全部工具权限。

想读作者英文原文? ↓ 滚到正文区切换 · 在 GitHub 查看 ↗

解读由编辑根据原文凝练而成,命令、链接、术语均与作者原文一致;想看完整论述请切到右侧

setup-pre-commit 把仓库的 commit 前质量门一次性装好:Husky 起 pre-commit、lint-staged 跑只 staged 的 Prettier、再串 typechecktest 脚本。落地后每次 git commit 都会先过 staged 文件 lint、再跑全量类型与测试。

设计思路

作者希望「质量门越早越便宜」——staged 文件用 lint-staged 限定 scope,避免每次都全仓 Prettier;类型检查与测试放 commit hook 里,把回归在合并之前抓住。Husky v9 不需要 shebang,hook 文件保持极简。

工作流

检包管理:扫 package-lock.json / pnpm-lock.yaml / yarn.lock / bun.lockb,没匹配默认 npm;② 装依赖husky / lint-staged / prettier 作为 devDeps;③ npx husky init 初始化 .husky/prepare: "husky";④ 写 .husky/pre-commit 三行(npx lint-staged<pm> run typecheck<pm> run test),把 <pm> 替换成检测到的;package.json 没有 typecheck / test 脚本就略掉那两行并明确告诉用户;⑤ 写 .lintstagedrc{"*": "prettier --ignore-unknown --write"};⑥ .prettierrc 缺则建(useTabs:falsetabWidth:2printWidth:80singleQuote:falsetrailingComma:"es5"semi:truearrowParens:"always");⑦ 验:四件套都在、prepare 已配、npx lint-staged 跑得动;⑧ 把变更 commit,借这一次 commit 当 smoke test。

注意

prettier --ignore-unknown 跳过 Prettier 不认的文件(图片等);hook 顺序「lint-staged 先(快、限 staged)→ 全量 typecheck → 全量 test」是为了让最快的反馈先出。

适合的场景

  • 新仓库首次接 commit 时质量门
  • 已有部分 lint 但 commit 时不强制:本技能补齐 hook 部分
  • 希望多人 / 多 agent 在 commit 阶段就看到统一格式

何时不要用

  • 团队偏 server-side hook(GitHub Actions 阻塞合并):客户端 hook 多此一举
  • monorepo 用 Nx / Turborepo / pnpm 自带 hook 体系:用它们的方案而不是再装 Husky

配套

ship(合并前的最终质检入口)、land-and-deploy(合并后的部署入口)、tdd / test-driven-development(让 <pm> run test 真有东西可跑)、receiving-code-review(hook 抓不到的事让 review 抓)。