VSCode 配置 Sonar Lint

写在前面的话：

本文讲解如何在 VSCode 中关联并应用已配置好的 Sonar Lint 规则。因此，本文前提是 Sonar Server 已经被配置完备。
本文仅针对 VSCode 插件 SonarQube：

本文所指配置文件均是为了在 VSCode 中应用 Sonar Lint 规则而添加的 SonarQube 插件识别的配置文件。

---------------------------------------------------------------------------------------------------------

在安装了 SonarQube 之后，使用 Ctrl + P 打开 VSCode 命令搜索功能，输入 Sonar，搜索结果如下：

1. sonar lint 全局配置文件

（1）选择 Create global config with credentials to servers，出现下图提示。

（2）选择Open global.json，sonar lint 全局配置文件被打开，

{
    "servers": [
        {
            "id": "localhost",
            "url": "http://localhost:9000",
            "token": "YOUR_SONARQUBE_AUTH_TOKEN"
        },
        {
            "id": "my-company-server",
            "url": "http://my-company.com",
            "token": "YOUR_SONARQUBE_AUTH_TOKEN"
        }
    ]
}

（3）接下来只需要自定义上图对应字段（上图两个配置项只需定义一个即可），

id：与具体工程关联的唯一标识符，在具体工程配置文件中会用到
url：sonar server 所在的地址
token：能进入 sonar server 的用于验证用户身份的一串字符

2. sonar lint 工程配置文件
（1）选择 Create local sonarlinet config with project binding，出现下图提示。

（2）选择 Open sonarlint.json，sonar lint 工程配置文件被打开，

{
    "serverId": "my-company-server",
    "projectKey": "my-project"
}

（3）接下来自定义上图对应字段，

serverId：即配置全局文件时的 id
projectKey：sonar server 上的工程唯一标识

3. 其他命令

Analyze current file：重新分析当前文件
Analyze current project：重新分析当前工程所有文件
Update bindings to SonarQube server：更新来自 Sonar Server 的规则

VSCode 配置 Sonar Lint

猜你喜欢