如何将SonarLint配置为Git预提交钩子？无需SonarQube服务器

核心思路 #

不用部署SonarQube服务器，靠SonarLint CLI（命令行版SonarLint）+ Git预提交钩子 + 仓库内共享配置，就能强制团队提交前完成代码检查。

具体步骤 #

1. 安装SonarLint CLI
   要求团队所有人安装SonarLint CLI（独立于IDE的命令行工具），可通过包管理器（比如brew install sonarlint）或官方二进制包安装，确保终端能直接运行sonarlint命令。

2. 添加仓库共享的SonarLint配置
   在项目根目录创建sonarlint.json文件，配置统一的规则集、Java版本等，把这个文件提交到Git仓库，让所有人用相同的检查规则。示例配置：

   {
     "rules": {
       "java:S100": "OFF",  // 关闭命名规则
       "java:S111": "ERROR", // 空方法定义设为错误级，必须修复
       "java:S125": "WARN"   // 注释里的代码设为警告级
     },
     "java": {
       "sourceVersion": "17" // 指定项目Java版本
     }
   }
   

3. 配置Git预提交钩子

   • 进入项目的.git/hooks目录，复制pre-commit.sample文件为pre-commit（删除.sample后缀）
   • 编辑pre-commit脚本，替换为以下代码，实现只检查暂存的Java文件，一旦SonarLint检测出错误就阻止提交：

     #!/bin/sh
     
     # 获取所有暂存的Java文件
     STAGED_JAVA_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep '\.java$')
     
     # 如果有Java文件要提交，执行SonarLint检查
     if [ -n "$STAGED_JAVA_FILES" ]; then
       sonarlint analyze $STAGED_JAVA_FILES --config ./sonarlint.json
       
       # 检查命令返回值，非0则终止提交
       if [ $? -ne 0 ]; then
         echo "SonarLint检测到必须修复的问题，请修正后再提交"
         exit 1
       fi
     fi
     
     exit 0
     

   • 给pre-commit脚本添加执行权限：chmod +x .git/hooks/pre-commit
   • 由于.git/hooks默认不被Git追踪，可在项目根目录建hooks文件夹存放pre-commit脚本，再写个初始化脚本setup-hooks.sh让成员运行：

     #!/bin/sh
     cp ./hooks/pre-commit .git/hooks/pre-commit
     chmod +x .git/hooks/pre-commit
     

     把hooks/pre-commit和setup-hooks.sh提交到仓库，成员克隆后运行./setup-hooks.sh即可完成钩子配置。

注意事项 #

• 确保团队成员SonarLint CLI版本尽量一致，避免规则差异
• 可在项目README里明确钩子初始化步骤，避免遗漏
• 调整规则只需修改仓库内的sonarlint.json，所有人拉取后自动同步规则

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