# Setup Pre Commit

> 在当前仓库中设置带有 lint-staged（Prettier）、类型检查和测试的 Husky pre-commit 钩子。当用户想要添加 pre-commit 钩子、设置 Husky、配置 lint-staged 或添加提交时格式化/类型检查/测试时使用。

- Skill: `karasukaigan/setup-pre-commit` (Agent Skill)
- Install (CLI): `npx skillmds@latest add karasukaigan/setup-pre-commit`
- Raw SKILL.md: https://api.skillmd.com/api/skills/karasukaigan/setup-pre-commit/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: karasukaigan (https://skillmd.com/u/karasukaigan)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/karasukaigan/setup-pre-commit

---


# 设置 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

```bash
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`

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

### 6. 创建 `.prettierrc`（如果缺失）

仅在不存在 Prettier 配置时创建。使用这些默认值：

```json
{
  "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+ 在钩子文件中不需要 shebangs
- `prettier --ignore-unknown` 跳过 Prettier 无法解析的文件（图像等）
- pre-commit 首先运行 lint-staged（快速，仅暂存），然后运行完整类型检查和测试