SonarLint for Eclipse 技术文档

SonarLint for Eclipse 技术文档

安装指南

在线安装

1. 打开 Eclipse IDE。
2. 导航到 Help -> Eclipse Marketplace。
3. 在搜索框中输入 SonarLint。
4. 找到 SonarLint for Eclipse 并点击 Install。
5. 按照提示完成安装过程。

离线安装

1. 访问 SonarLint 更新站点归档。
2. 下载适合你 Eclipse 版本的更新站点归档。
3. 打开 Eclipse IDE。
4. 导航到 Help -> Install New Software。
5. 点击 Add，然后选择 Archive 并选择你下载的归档文件。
6. 按照提示完成安装过程。

项目的使用说明

启动 SonarLint

1. 安装完成后，重启 Eclipse IDE。
2. SonarLint 会自动集成到你的 Eclipse 工作区中。
3. 当你编写代码时，SonarLint 会实时检测并提示代码质量问题。

配置 SonarLint

1. 导航到 Window -> Preferences -> SonarLint。
2. 在这里，你可以配置 SonarLint 的各种设置，如连接到 SonarQube 服务器、设置规则集等。

项目API使用文档

核心API

SonarLint 的核心 API 主要用于集成到 Eclipse 的插件开发环境中。以下是一些常用的 API：

• org.sonarlint.eclipse.core.internal.SonarLintCorePlugin：核心插件类，提供了插件的初始化和配置功能。
• org.sonarlint.eclipse.core.internal.jobs.AnalyzeProjectJob：用于分析项目的作业类。

使用示例

import org.sonarlint.eclipse.core.internal.SonarLintCorePlugin;

public class MyPlugin {
    public void start() {
        SonarLintCorePlugin.getDefault().getSonarLintFacade().startAnalysis();
    }
}

项目安装方式

开发环境设置

1. 确保你已经安装了 Eclipse RCP、Eclipse Plug-in 开发环境、m2e 和 RedDeer。
2. 在命令行中运行 mvn verify 以获取父 pom 中引用的工件。
3. 在 Eclipse 中，将项目根目录作为 Maven 项目导入。
4. 可选：在 Eclipse 中，将 its/ 文件夹作为 Maven 项目导入。
5. 打开 target-platforms/dev.target 并使用目标平台编辑器设置为目标平台。

运行插件

1. 打开 org.sonarlint.eclipse.core 插件的 plugin.xml。
2. 使用右上角的 Run 或 Debug 按钮启动插件。

运行单元测试

1. 在 Eclipse 中，创建一个运行配置并通过 Run As... / JUnit Plug-in Test 运行测试类。
2. 编辑配置，取消选中 Run in UI thread，并在 Main 选项卡中选择 [No Application] - Headless Mode。

运行集成测试

1. 使用脚本 ./scripts/run-its.sh 运行集成测试。
2. 可以使用 -Dtest=SimpleNameOfClass 选项运行特定的测试类。

通过以上步骤，你可以顺利安装、配置和使用 SonarLint for Eclipse，并进行开发和测试。