@huaiyou/hooks-git

> Git 钩子配置，包含 Husky、Commitlint 和 Lint-staged，确保代码质量和提交规范。

📦 安装

``bash
pnpm add -D @huaiyou/hooks-git
`

> 注意：该包会自动处理所有依赖关系，无需手动安装 husky、@commitlint/cli 和 lint-staged。

🚀 快速开始

$3

使用以下命令一键完成所有配置：

`bash
npx hy-hooks-git init
`

该命令将自动：

- 检查并初始化 Git 仓库（如果尚未初始化）
- 安装并配置 Husky
- 添加 commit-msg 和 pre-commit 钩子
- 创建 commitlint.config.js 和 lint-staged.config.js 配置文件
- 更新 package.json 脚本

$3

如需自定义配置，可以使用交互式模式：

`bash
npx hy-hooks-git init --interactive
`

$3

如果需要手动配置，可以按照以下步骤进行：

#### 1. 安装 Husky

在项目根目录运行：

`bash
pnpm prepare
`

#### 2. 复制配置文件

将以下文件复制到项目根目录：

commitlint.config.js:

`javascript
module.exports = require('@huaiyou/hooks-git/commitlint');
`

lint-staged.config.js:

`javascript
const { createLintStagedConfig } = require('@huaiyou/hooks-git/lint-staged');
module.exports = createLintStagedConfig();
`

#### 3. 配置 Husky 钩子

创建 .husky/pre-commit:

`bash
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

pnpm lint-staged
`

创建 .husky/commit-msg:

`bash
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

pnpm commitlint --edit $1
`

#### 4. 添加脚本

在 package.json 中：

`json
{
"scripts": {
"prepare": "husky install"
}
}
`

$3

如果需要回滚所有配置，可以使用以下命令：

`bash
npx hy-hooks-git rollback
`

该命令将自动：

- 删除 .husky 目录及其包含的钩子
- 删除配置文件（commitlint.config.js 和 lint-staged.config.js）
- 从 package.json 中移除 prepare 脚本

✨ 特性

$3

强制执行 Conventional Commits 规范：

- ✅ feat: 新功能
- ✅ fix: Bug 修复
- ✅ docs: 文档更新
- ✅ style: 代码格式（不影响代码运行）
- ✅ refactor: 重构
- ✅ perf: 性能优化
- ✅ test: 测试相关
- ✅ build: 构建系统或依赖
- ✅ ci: CI 配置
- ✅ chore: 其他修改
- ✅ revert: 回退提交

$3

在提交前自动运行代码检查和格式化：

- TypeScript/JavaScript: ESLint + Prettier
- JSON/Markdown/YAML: Prettier

📝 提交消息格式

$3

`
():