如何为基于Maven的Java/Spring Boot项目配置Commitlint与Husky？

Commitlint和Husky本质是Node.js工具，完全可以在Java/Maven项目中复用这套提交规范校验方案，具体配置步骤如下：

1. 初始化Node环境 #

在项目根目录（与pom.xml同级）执行命令，生成package.json：

npm init -y

接着安装所需依赖：

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

2. 配置Commitlint规则 #

在项目根目录创建commitlint.config.js文件，启用通用的Angular风格提交规范：

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

如果需要自定义校验规则，可在该文件中添加rules字段调整，比如修改提交信息的长度限制、类型枚举等。

3. 配置Husky提交钩子 #

首先启用Husky的Git钩子管理：

npx husky install

在package.json中添加prepare脚本，确保其他开发者克隆项目后自动启用Husky：

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

最后添加commit-msg钩子，触发Commitlint校验提交信息：

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

执行完成后，项目根目录会生成.husky/commit-msg文件，里面就是触发校验的脚本逻辑。

4. Maven项目适配注意事项 #

• 在.gitignore中添加node_modules/和package-lock.json（不需要提交依赖锁文件时）
• 要求团队成员统一Node.js版本，推荐用nvm管理，避免环境差异
• 可在package.json的engines字段声明Node版本要求：

{
  "engines": {
    "node": ">=16.0.0"
  }
}

测试验证：尝试提交不符合规范的信息（如git commit -m "改了点代码"），Husky会触发Commitlint报错并阻止提交；使用符合规范的信息（如git commit -m "fix: 修复用户列表分页异常"）则可正常提交。

内容的提问来源于stack exchange，提问作者Sujith