告别 Git 提交乱象：使用 Commitizen + husky + Git Hooks 一键规范
2023-09-11 21:34:51
引言：
在当今敏捷的软件开发世界中，Git 作为分布式版本控制系统扮演着至关重要的角色。它不仅让团队成员可以轻松协作和跟踪代码更改，还为项目的演进和历史提供了宝贵的洞察。然而，如果不加以规范，Git 提交日志往往会杂乱无章，影响团队协作的效率和项目的可追溯性。
规范 Git 提交信息，势在必行！
要解决 Git 提交混乱的问题，关键在于规范提交信息。规范化的提交信息不仅使开发人员更容易理解代码更改的意图，也有助于自动化工具（如 CI/CD 系统）更好地处理提交。
Commitizen：让提交信息井然有序
Commitizen 是一个命令行工具，它提供了预定义的提交消息模板，帮助开发者编写符合特定约定（如 Conventional Commits）的提交信息。Conventional Commits 规范定义了提交信息的结构，包括类型（feat、fix、refactor 等）、范围和。
husky：自动化提交检查
husky 是一个 Git 钩子框架，允许开发者在提交前、提交中和提交后执行自定义脚本。通过使用 husky，我们可以设置钩子，在提交前检查提交信息是否符合规范，并根据需要阻止不符合规范的提交。
Git Hooks：增强提交流程
Git Hooks 是一种强大的机制，允许开发者在 Git 工作流的关键点处执行自定义脚本。我们可以利用 Git Hooks 进一步增强提交流程，例如：
- 在提交前运行 linter 或测试，以确保代码质量。
- 自动更新 CHANGELOG 或版本号。
- 发送通知给团队成员，告知有新的提交。
示例：构建规范化的提交流程
下面是一个示例，展示了如何使用 Commitizen、husky 和 Git Hooks 来构建规范化的提交流程：
- 安装 Commitizen 和 husky：
npm install -g commitizen husky
- 初始化 Commitizen：
commitizen init cz-conventional-changelog
- 创建 husky 钩子：
在项目根目录下创建 .huskyrc 文件，并添加以下内容：
{
"hooks": {
"pre-commit": "lint-staged",
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
- 安装 linter 和 commitlint：
npm install --save-dev lint-staged commitlint @commitlint/config-conventional
- 配置 linter 和 commitlint：
在项目根目录下创建 .lintrc.js 和 .commitlintrc.js 文件，并添加以下内容：
// .lintrc.js
module.exports = {
"*.js": ["eslint --fix"]
};
// .commitlintrc.js
module.exports = {
extends: ["@commitlint/config-conventional"]
};
现在，每当开发者尝试提交代码时，husky 钩子会自动运行 linter 和 commitlint。如果提交信息不符合规范，husky 会阻止提交，并提示开发者更正。
结语：
规范化 Git 提交日志至关重要，因为它可以改善团队协作，增强代码管理，并提高项目可追溯性。通过利用 Commitizen、husky 和 Git Hooks，我们可以轻松构建一个自动化且高效的提交流程，让开发人员专注于编写高质量的代码，而不是纠缠于提交信息格式。拥抱规范化的 Git 提交，让我们的项目更清晰、更可控，为团队合作赋能！
