agentleFS
WenWuZhiDaoWenWuZhiDao/mattpocock-skills-zh/skills/misc/setup-pre-commit/SKILL.md

setup-pre-commit

Skill27 starsChanged 3 months agoMITView on GitHub

在当前仓库中设置 Husky pre-commit 钩子,配合 lint-staged(Prettier)、类型检查和测试。当用户想添加 pre-commit 钩子、设置 Husky、配置 lint-staged,或在提交时添加格式化/类型检查/测试时使用。

Files
SKILL.md

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

这会设置什么

  • 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(快速,仅针对暂存文件),然后运行完整的类型检查和测试

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.