setup-pre-commit

1# 设置 Pre-Commit Hooks
2 
3## 这会配置什么
4 
5- **Husky** pre-commit hook
6- **lint-staged** 对所有 staged files 运行 Prettier
7- **Prettier** config（如果缺失）
8- pre-commit hook 中的 **typecheck** 和 **test** scripts
9 
10## 步骤
11 
12### 1. 检测 package manager
13 
14检查 `package-lock.json` (npm)、`pnpm-lock.yaml` (pnpm)、`yarn.lock` (yarn)、`bun.lockb` (bun)。使用存在的那个。不清楚时默认 npm。
15 
16### 2. 安装依赖
17 
18作为 devDependencies 安装：
19 
20```
21husky lint-staged prettier
22```
23 
24### 3. 初始化 Husky
25 
26```bash
27npx husky init
28```
29 
30这会创建 `.husky/` dir，并向 package.json 添加 `prepare: "husky"`。
31 
32### 4. 创建 `.husky/pre-commit`
33 
34写入这个文件（Husky v9+ 不需要 shebang）：
35 
36```
37npx lint-staged
38npm run typecheck
39npm run test
40```
41 
42**Adapt**：把 `npm` 替换为检测到的 package manager。如果 repo 的 package.json 没有 `typecheck` 或 `test` script，就省略对应行并告知用户。
43 
44### 5. 创建 `.lintstagedrc`
45 
46```json
47{
48  "*": "prettier --ignore-unknown --write"
49}
50```
51 
52### 6. 创建 `.prettierrc`（如果缺失）
53 
54只有没有 Prettier config 时才创建。使用这些 defaults：
55 
56```json
57{
58  "useTabs": false,
59  "tabWidth": 2,
60  "printWidth": 80,
61  "singleQuote": false,
62  "trailingComma": "es5",
63  "semi": true,
64  "arrowParens": "always"
65}
66```
67 
68### 7. 验证
69 
70- [ ] `.husky/pre-commit` 存在且可执行
71- [ ] `.lintstagedrc` 存在
72- [ ] package.json 中的 `prepare` script 是 `"husky"`
73- [ ] prettier config 存在
74- [ ] 运行 `npx lint-staged` 验证可用
75 
76### 8. 提交
77 
78Stage 所有 changed/created files，并用 message 提交：`Add pre-commit hooks (husky + lint-staged + prettier)`
79 
80这会经过新的 pre-commit hooks，是一个不错的 smoke test。
81 
82## 备注
83 
84- Husky v9+ 不需要 hook files 中的 shebangs
85…