前端项目接入sonar进行代码质量检查

1,558 阅读2分钟

环境准备

   当前从官网下载的sonar 安装包需要 jdk-11的环境。

   以windows系统为例,仅涉及前端项目接入,不涉及后端项目、数据库等

1. 下载 Java-11  点击跳转至下载地址 (www.oracle.com/java/techno…

2.配置 jdk 环境变量

sonar-SonarQube 安装

点击跳转至下载地址www.sonarqube.org/downloads/)

1. 下载压缩包

2.解压缩到目标路径,如   E:\sonar

3.双击启动 sonar 服务

4.打开 http://localhost:9000 ,登录默认账号 admin/admin ,根据提示设置新密码。

5. 汉化。在应用市场下载汉化包。重启服务后生效。

sonar-scanner扫描器安装

1.点击跳转至下载地址,根据系统选择对应安装包进行下载(docs.sonarqube.org/latest/anal…

2.配置扫描器的环境变量。新建SONAR_SCANNER_HOME,值为sonar-scanner放置路径

   a . sonar-scanner放置路径

b. SONAR_SCANNER_HOME环境变量配置

c. 将SONAR_SCANNER_HOME添加至path:%SONAR_SCANNER_HOME%\bin

2.验证 sonar-scanner是否安装成功:打开cmd,输入:sonar-scanner -version,如下图所示,代表环境变量配置正确。否则请检查环境变量是否正确配置。

sonar-scanner配置文件修改

1.进入E:\sonar\sonar-scanner-4.6.2.2472-windows\conf,找到sonar-scanner.properties文件。

2. 修改编码信息(数据库信息目前用不到,忽略)

sonar使用

1. 将项目拉到本地,在根目录增加文件sonar-project.properties。

2. 修改sonar-project.properties的配置项,配置项 如下图

    < 配置项说明  >

  • sonarprojectKey=在sonarQube上的实例键名(必须是唯一的)

  • sonar.projectName=在sonarQube上的项目名称

  • sonar.sources=js源代码目录指定,可以知道扫描目录,填写sonar-project.properties文件所在目录的相对路径

  • sonarsourceEncoding=UTF-8(编码格式指定)

  • sonar.language=js(指明只扫描js语言)

3. 获取sonarprojectKey 

 a.  新增项目(以本地项目为例)

b.得到令牌 并拷贝至sonar-project.properties文件对应位置

3. 获得扫描命令并拷贝

4. cmd 进入sonar-project.properties所在目录,输入步骤3中拷贝的命令,执行扫描。

5. 查看扫描结果

    其他 

     1. 可以用管理员账号登入配置语言的检查规则,并将其设置为默认。

     2. sonar具备强大的功能,具体请查阅官网文档