设置 Pre-Commit 钩子

会设置什么

• Husky pre-commit 钩子
• lint-staged 对所有暂存文件运行 Prettier
• Prettier 配置（若缺失）
• pre-commit 钩子中的 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)

这会经过新的 pre-commit 钩子——很好的冒烟测试，确认一切正常。

备注

• Husky v9+ 的钩子文件不需要 shebang
• prettier --ignore-unknown 会跳过 Prettier 无法解析的文件（图片等）
• pre-commit 先运行 lint-staged（快，仅暂存文件），再运行完整 typecheck 和测试