什么是SonarQube?
SonarQube是一个开源的代码质量分析工具,它可以帮助开发者检测代码中的潜在问题,如bug,漏洞,坏味道,重复代码等,并提供改进建议。SonarQube可以支持多种编程语言,如Java,Python,C#等,并且可以集成到各种开发环境和持续集成工具中。
为什么要用SonarQube?
代码质量是软件开发中的一个重要因素,它影响着软件的功能,性能,安全,可维护性等方面。如果代码质量不高,可能会导致软件出现各种问题,如崩溃,漏洞,错误等,并且难以修改和扩展。因此,提高代码质量是每个开发者的责任和目标。
使用SonarQube可以帮助开发者提高代码质量,因为它可以:
- 在编码过程中实时检测代码中的问题,并给出修复建议。
- 在代码提交后进行全面的分析,并生成详细的报告和指标。
- 在团队协作中统一代码规范和质量标准,并监控代码质量的变化趋势。
资料清单🧾
- JDK11+
- Docker
- SonqrQube
- Vscode
- SonarLint
JDK下载
在华为云下载JDK 下载完成以后进行安装
Docker下载
在Docker官网下载Docker
双击Docker.dmg进行安装就好了
下载SonarQube
在终端执行,使用Docker下载sonarqube
docker pull sonarqube
打开Docker客户,运行SonarQube
SonarQube启动成功,点击访问按钮,访问SonarQube
登录成功以后,我们先安装汉化插件
安装完成以后,重启SonarQube服务就好了
重新登录成功以后,创建一个项目,这里选择本地创建
创建一个令牌(注意,令牌只会显示一次,记得保管好)
选择扫描器的类型(由于我们要扫描的代码是前端代码,选择other)
在本地目录中,执行下方生成的扫描命令,就可以扫描代码了
扫描完成以后,在SonarQube平台,就可以看到我们扫描信息了
恭喜你,到这里,我们的SonarQube扫描平台就配置好了,下面步骤是我们在vscode中使用SonarQube
使用VsCode连接SonarQube
在Vscode中使用SonarQube插件,我们需要先安装SonarLint插件
插件安装完以后,配置javaHome(java默认安装路径)
在VsCode中使用SonarQube连接命令
配置连接信息
保存连接信息(失败了没关系,我们已经把SonarQube规则拿下来了)
进入到js文件,鼠标悬浮黄色波浪线,我们可以看到错误信息了(在终端也可以看见输出)
结言
目前SonarQube是在本地搭建扫描本地项目,如果需要扫描Git项目,请参考如下链接