@git-ai/husky-commit

一个用于强制执行约定式提交格式的 Husky 提交消息验证器。

功能特性

• ✅ 验证 Git 提交消息是否符合约定式提交格式
• ✅ 支持多种提交类型：feat、fix、docs、style、refactor、perf、test、build、ci、chore、revert
• ✅ 允许中文和英文用户名
• ✅ 自动跳过合并提交（Merge branch 和 Merge remote-tracking）
• ✅ 简单易用，与 Husky 完美集成

安装

npm install --save-dev @git-ai/husky-commit

使用方法

1. 配置提交钩子

在 .husky/commit-msg 文件中添加以下内容：

npx husky-commit "$1"

提交消息格式

提交消息必须遵循以下格式：

<type>(<scope>): <description>

支持的提交类型

• feat: 新功能
• fix: 修复 bug
• docs: 文档更新
• style: 代码格式调整（不影响代码逻辑）
• refactor: 代码重构
• perf: 性能优化
• test: 测试相关
• build: 构建系统或外部依赖变更
• ci: CI 配置变更
• chore: 其他杂项
• revert: 回滚提交

示例

✅ 有效的提交消息：

feat(user): 添加用户登录功能
fix(auth): 修复认证逻辑错误
docs(readme): 更新安装说明
refactor(api): 重构 API 接口
chore: 更新依赖包

❌ 无效的提交消息：

修复bug
update
随便写写

配置选项

目前该工具使用默认配置，支持以下提交类型：

• feat - 新功能
• fix - 修复 bug
• docs - 文档更新
• style - 代码格式调整
• refactor - 代码重构
• perf - 性能优化
• test - 测试相关
• build - 构建系统变更
• ci - CI 配置变更
• chore - 杂项任务
• revert - 回滚提交

许可证

MIT License

作者

Baran - [email protected]

仓库地址

• GitHub: https://github.com/code-ba/git-ai
• Issues: https://github.com/code-ba/git-ai/issues
• Homepage: https://github.com/code-ba/git-ai#readme