如何为Angular项目添加husky与commitlint工具

1. 安装依赖 #

在项目根目录执行以下命令，安装所需开发依赖：

npm install husky @commitlint/cli @commitlint/config-conventional --save-dev

2. 配置commitlint #

在项目根目录创建commitlint.config.js文件，写入以下内容，让commitlint遵循常规提交规范：

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

常规提交规范要求提交信息格式为类型: 描述，支持的类型包括feat（新功能）、fix（修复bug）、docs（文档更新）、style（代码格式调整）、refactor（重构）等。

3. 配置husky #

启用husky #

执行命令启用husky的Git钩子功能：

npx husky install

为让其他开发者安装依赖后自动启用husky，在package.json中添加prepare脚本：

npm set-script prepare "husky install"

添加commit-msg钩子 #

添加Git提交信息校验钩子，确保只有符合规范的提交信息才能被提交：

npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'

4. 测试验证 #

• 尝试提交不符合规范的信息，比如：

git commit -m "修改了一些代码"

此时commitlint会抛出错误，阻止提交。

• 尝试符合规范的提交信息，比如：

git commit -m "fix: 修复用户登录时的验证码验证bug"

提交会正常执行。

内容的提问来源于stack exchange，提问作者Raphaël Balet