规范Git提交之Husky7.0

2023-09-18 09:52:08

在实际开发过程中，团队协作常常是少不了的。为了保证项目有序推进，开发工作流和开发管理显得尤为重要。使用Git作为版本控制工具，我们通常需要遵守一些提交规范。一个规范的Git提交消息，有助于提高团队的协作效率，确保代码提交的质量和一致性。

Husky是一个用于规范Git提交消息的工具，它通过可插拔的插件系统，可以自动检测错误并以预先定义的钩子来进行提示。借助Husky，开发人员在编写提交消息的时候，可以更加轻松地遵循项目的提交规范，避免出现混乱的情况。Husky 7.0作为Husky的最新版本，带来了不少新特性和改进，下面将对这些新特性和使用指南进行介绍，并分享一些常用的提交规范和提交消息模板，帮助开发人员更好地规范Git提交。

Husky 7.0的新特性

新的插件系统： Husky 7.0采用了一个新的插件系统，可以更轻松地添加和配置插件。
支持JavaScript和TypeScript： Husky 7.0支持使用JavaScript和TypeScript编写插件。
新的钩子类型： Husky 7.0引入了新的钩子类型，例如“prepare-commit-msg”和“commit-msg”，允许开发人员在提交消息被提交之前或之后进行额外的处理。
改进的错误处理： Husky 7.0改进了错误处理机制，使错误信息更加清晰易懂。

Husky 7.0的使用指南

安装Husky： 可以使用npm或yarn安装Husky：

npm install husky -D

或

yarn add husky -D

配置Husky： 在项目的根目录下创建一个名为“.husky”的目录，并在其中创建一个名为“husky.config.js”的文件。在这个文件中，我们可以定义Husky的配置。例如，以下配置将启用“commit-msg”钩子，并在提交消息不符合规范时显示错误信息：

module.exports = {
  hooks: {
    'commit-msg': 'commitlint -E HUSKY_GIT_PARAMS'
  }
};

添加提交规范插件： 我们可以通过安装提交规范插件来进一步规范提交消息。例如，以下命令将安装commitlint插件：

npm install commitlint -D

或

yarn add commitlint -D

配置提交规范插件： 在项目的根目录下创建一个名为“.commitlintrc.js”的文件。在这个文件中，我们可以定义提交规范插件的配置。例如，以下配置将使用Angular的提交规范：

module.exports = {
  extends: ['@commitlint/config-angular']
};

使用Husky： 在提交代码之前，Husky会自动运行配置的插件。如果提交消息不符合规范，Husky会显示错误信息并阻止提交。

一些常用的提交规范和提交消息模板

Angular：

提交消息格式：<type>(<scope>): <subject>

例如：

feat(auth): Add a new authentication provider
fix(core): Fix a bug in the core module

Conventional Commits：

提交消息格式：<type>(<scope>): <subject>

例如：

feat: Add a new feature
fix: Fix a bug
docs: Update the documentation

Gitmoji：

提交消息格式：<emoji> <subject>

例如：

✨ Add a new feature
🐛 Fix a bug
📝 Update the documentation

结语

规范Git提交消息不仅对团队协作非常有必要，而且可以帮助开发人员保持良好的编码习惯。Husky是一个非常方便的工具，可以帮助开发人员轻松地规范Git提交消息，提高团队的协作效率。本文介绍了Husky 7.0的新特性和使用指南，并分享了一些常用的提交规范和提交消息模板，希望对开发人员规范Git提交有所帮助。