设置预提交钩子(Pre-Commit Hooks)

SkillDev tools

Set up a Husky pre-commit hook in the current repository with lint-staged (Prettier), type checking, and tests. Use when the user wants to add a pre-commit hook, set up Husky, configure lint-staged, or add formatting/type checking/tests on commit.

Available today. Use it from your connected AI after setup.

Add ahel to your AI once: Claude, ChatGPT, Cursor, Claude Code or Codex. Then ask it to use this.

Then ask your AI: use the 设置预提交钩子(Pre-Commit Hooks) skill

What this skill tells your AI

The instructions your AI receives, as published by wenwuzhidao/mattpocock-skills-zh in skills/misc/setup-pre-commit/SKILL.md and read by ahel’s review.

这会设置什么

  • Husky 预提交钩子
  • lint-staged 对所有暂存文件运行 Prettier
  • Prettier 配置(如果缺失)
  • 预提交钩子中的 typecheck 和 test 脚本

步骤

1. 检测包管理器

检查 package-lock.json(npm)、pnpm-lock.yaml(pnpm)、yarn.lock(yarn)、bun.lockb(bun)。使用存在的那个。不明确时默认用 npm。

2. 安装依赖

作为 devDependencies 安装:

husky lint-staged prettier

3. 初始化 Husky

npx husky init

这会创建 .husky/ 目录,并向 package.json 添加 prepare: "husky"。

4. 创建 .husky/pre-commit

写入此文件(Husky v9+ 无需 shebang):

npx lint-staged
npm run typecheck
npm run test

适配:将 npm 替换为检测到的包管理器。如果仓库的 package.json 中没有 typecheck 或 test 脚本,则省略相应行并告知用户。

5. 创建 .lintstagedrc

{
  "*": "prettier --ignore-unknown --write"
}

6. 创建 .prettierrc(如果缺失)

仅在不存在 Prettier 配置时创建。使用以下默认值:

{
  "useTabs": false,
  "tabWidth": 2,
  "printWidth": 80,
  "singleQuote": false,
  "trailingComma": "es5",
  "semi": true,
  "arrowParens": "always"
}

7. 验证

  • .husky/pre-commit 存在且可执行
  • .lintstagedrc 存在
  • package.json 中的 prepare 脚本为 "husky"
  • prettier 配置存在
  • 运行 npx lint-staged 验证其正常工作

8. 提交

暂存所有更改/创建的文件,并以这条信息提交:Add pre-commit hooks (husky + lint-staged + prettier)

这会跑一遍新的预提交钩子 —— 是验证一切正常的良好冒烟测试。

注意事项

  • Husky v9+ 的钩子文件不需要 shebang
  • prettier --ignore-unknown 会跳过 Prettier 无法解析的文件(图片等)
  • 预提交会先运行 lint-staged(快速,仅针对暂存文件),然后运行完整的类型检查和测试

Signals

GitHub stars
23
Forks
4
Last commit
Aug 2026
Advanced
Item type
skill
Key
setup-pre-commit-wenwuzhidao
Source
github.com/wenwuzhidao/mattpocock-skills-zh