SonarLint for Eclipse 技术文档

1. 安装指南

SonarLint for Eclipse 的安装可以通过以下两种方式进行：

在线安装

1. 打开 Eclipse。
2. 转到 Help 菜单，选择 Eclipse Marketplace...。
3. 搜索 SonarLint 并安装。

离线安装

1. 访问 SonarSource 官方网站提供的更新站点存档，下载所需版本的压缩包。
2. 解压压缩包，将其内容复制到 Eclipse 的 dropins 文件夹中。
3. 重启 Eclipse。

2. 项目的使用说明

SonarLint for Eclipse 帮助您在 IDE 中实现 Clean Code。以下是基本使用方法：

1. 安装完成后，SonarLint 将自动集成到 Eclipse 中。
2. 开始编写代码时，SonarLint 将实时分析代码，并在问题出现时提供反馈。
3. 您可以通过右键点击项目或文件，选择 SonarLint 菜单中的选项来配置和分析代码。

3. 项目API使用文档

目前，SonarLint for Eclipse 的 API 文档尚未公开。有关如何使用和集成 SonarLint 的详细信息，请参考官方文档和社区论坛。

4. 项目安装方式

开发环境搭建

1. 确保您的 Eclipse 安装了以下插件：

   • Eclipse RCP
   • Eclipse Plug-in development environment
   • m2e
   • RedDeer (用于运行集成测试)

2. 在命令行中运行 mvn verify 以获取父 pom 中引用的 artifacts。

3. 在 Eclipse 中，将项目根目录导入为 Maven 项目。

4. (可选) 在 Eclipse 中，将 its/ 文件夹导入为 Maven 项目。

5. 使用目标平台编辑器打开 target-platforms/dev.target，并在右上角点击 Set as Target Platform 或 Reload Target Platform。

运行和测试

• 要运行或调试插件，请打开 org.sonarline.eclipse.core 的 plugin.xml 文件，然后点击右上角的 Run 或 Debug 按钮。
• 要运行插件单元测试，请先通过 Run As... / JUnit Plug-in Test 运行一个测试类，然后编辑运行配置。
• 要运行集成测试，可以使用 ./scripts/run-its.sh 脚本。您可以使用 -Dtest=SimpleNameOfClass 参数运行特定测试。

添加依赖

应避免添加外部依赖。如果需要引入第三方库，应该将其打包或混入自己的插件中，以确保所有提供的 bundles 都经过签名，而不需要签名第三方组件。