如何使用sonarQube进行代码质量报告?

发布时间 2023-08-02 11:16:04作者: Eric-Shen

一、安装sonarQube

下载这个免费的社区版的https://www.sonarsource.com/open-source-editions/sonarqube-community-edition/

 下载好之后,配置SonarQube的步骤如下:


1. 解压SonarQube安装包:首先,你需要解压你下载的SonarQube的zip包。

2. 启动SonarQube:解压完成后,进入解压后的目录,然后进入bin目录。根据你的操作系统,选择相应的脚本来启动SonarQube。例如,如果你使用的是Windows,你可以运行StartSonar.bat脚本。(如果运行一闪而过,这是由于我们没有配置jdk,需要下载安装jdk17,推荐下载msi而不是zip,不用自己配置环境变量了。)

官网说的也很纤细了:https://docs.sonarsource.com/sonarqube/latest/try-out-sonarqube/

3. 访问SonarQube:启动完成后,你可以通过浏览器访问http://localhost:9000来打开SonarQube的界面。默认的管理员用户名和密码都是admin。

 

4.创建项目,用于检测某个项目

如果我们使用svn的话,主要使用locally即可。

 

 

 

 

二、安装sonarScaner

选择平台好之后,下载sonarScnner。

sonarQube是一个显示的、可视化的web页面。

sonarScnner是用来检测项目质量的。

下载之后

1.配置环境变量

 

2.修改sonarscanner配置。

 配置SonarScanner:安装完成后,你需要配置SonarScanner。打开SonarScanner的安装目录,找到conf文件夹,然后编辑sonar-scanner.properties文件

#Configure here general information about the environment, such as SonarQube server connection details for example
#No information about specific project should appear here

#----- Default SonarQube server
#sonar.host.url=http://localhost:9000

#----- Default source code encoding
#sonar.sourceEncoding=UTF-8

# 使用的编程语言
sonar.language=js


# 排除某些文件或目录,可以使用通配符
sonar.exclusions=**/__tests__/**,**/node_modules/**,**/dist/**,

 

三、检测项目

安装完后,在要检测的项目下,跑这段代码即可。‘

sonar-scanner.bat -D"sonar.projectKey=resume" -D"sonar.sources=." -D"sonar.host.url=http://localhost:9000" -D"sonar.token=sqp_5ff59272aba0d6a3b7abe2f0904bfbd3a24620c8"