SonarLint IntelliJ 插件

SonarLint 是一个 IDE 扩展，通过在您编写代码时检测并帮助修复质量问题，支持您编写清洁代码。有关清洁代码的详细文档。 就像拼写检查器一样，SonarLint 会在代码提交前标记缺陷，以便及时修复。

有用链接

• 文档
  • 支持的编程语言完整列表以及每种语言相关的静态代码分析规则链接可在规则页面上找到。
• 社区
  • 报告问题、寻求帮助或提出新功能建议。

如何安装

您可以从 JetBrains 插件库安装 SonarLint，该库直接在 IDE 首选项中可用。

完整的最新详细信息可在系统要求和安装页面上找到。

问题和反馈？

对于 SonarLint 支持问题（"如何做？"、"我遇到这个错误，为什么？"等），请先阅读常见问题解答，了解如何获取日志，然后前往 SonarSource 论坛。在创建新主题之前，请检查您的问题是否已经得到解答，因为可能有人已经遇到过相同的问题。

请注意，这是一个社区论坛，需要遵守标准礼仪（你好、谢谢、我很感谢您的回复等）。如果您的帖子没有得到回答，请至少等待三天再进行提醒。我们没有专人值守，但团队和社区管理员知道您的问题很重要。:-)

贡献

如果您想看到新功能，请查看 PM for a Day 页面！在那里，我们提供一个论坛来讨论您的需求，并为您提供直接与产品经理和开发团队交流的机会。欢迎您加入正在进行的讨论或创建新的主题，如果您有新的想法要提出。

请注意，我们并不积极寻求功能贡献。事实是，对于 SonarSource 以外的人来说，要符合我们的路线图和期望是非常困难的。因此，我们通常只接受次要的外观改动和拼写错误修正。

考虑到这一点，如果您想提交代码贡献，请为这个仓库创建一个拉取请求。请解释您贡献更改的动机，描述您试图解决的问题，并告诉我们您试图做出的改进。SonarLint 团队将审查 PR 并在内部讨论它如何与路线图保持一致。

请确保您遵循我们的代码风格，并且所有测试都通过。

如何构建

./gradlew buildPlugin

注意，上述命令不会运行测试和检查。要同时运行这些，请执行：

./gradlew check buildPlugin

完整的任务列表，请参见：

./gradlew tasks

对于外部贡献者，项目应该保证可以从任何特定标签构建。在开发阶段，可能会使用一些公众无法访问的未发布依赖项，这可能会阻止您构建项目。

如何运行 UI 测试

./gradlew :its:runIdeForUiTests &

上述命令将启动一个带有 SonarLint 插件的 IDE 实例。等待 UI 机器人服务器启动，然后运行集成测试：

./gradlew :its:check

最后，关闭 IDE。

要针对特定版本的 IntelliJ 进行测试，可以使用 ijVersion 属性，例如：

./gradlew :its:runIdeForUiTests  -PijVersion=IC-2019.3 &

要针对特定 IDE 进行测试，可以使用 runIdeDirectory 属性，如下所示：

./gradlew :its:runIdeForUiTests -PrunIdeDirectory=<IDE_PATH> &

请注意，执行测试时 IDE 必须在前台运行。

由于一些集成测试利用了 SonarCloud，请确保设置了 SONARCLOUD_IT_PASSWORD 环境变量（您可以在我们的密码管理工具中找到该值）。

如何调试 UI 测试

如果您想调试测试端发生的情况，可以直接从 IDE 以调试模式启动测试。

如果您想调试 SonarLint 插件中发生的情况，可以在 IntelliJ 中打开项目，并以调试模式运行 its:runIdeForUiTests 任务（例如从右侧的 Gradle 面板）。

如何调试 SLOOP

如果您想调试 SLOOP：

• 打开您用于启动 IDE 的运行配置（runIde 或 its:runIdeForUiTests）
• 添加一个环境变量：SONARLINT_JVM_OPTS，值为 -agentlib:jdwp=transport=dt_socket,address=8080,server=y,suspend=n
• 运行任务
• 打开 SLCORE 项目并点击 运行 > 附加到进程
• 选择正在运行的 SLOOP 进程

如果您想在 SLOOP 启动时就插入调试器，可以修改上述命令，将 suspend=n 改为 suspend=y。 这将在启动 SLOOP 之前等待调试器附加到进程。

如何在 IntelliJ 中开发

将项目作为 Gradle 项目导入。

注意：每当您更改 Gradle 设置（例如在 build.gradle.kts 中）时， 不要忘记在 Gradle 工具栏中刷新所有 Gradle 项目。

要运行安装了插件的 IntelliJ 实例，请使用命令行执行 Gradle 任务 runIde， 或在 IntelliJ 中使用 Gradle 工具栏，在 Tasks/intellij 下。 实例文件存储在 build/idea-sandbox 下。

要针对特定 IDE 运行，可以使用 runIdeDirectory 属性，如下所示：

./gradlew :runIde -PrunIdeDirectory=<IDE_PATH>

请记住，clean 任务会清除 build/idea-sandbox 的内容， 因此您需要为该实例重复一些设置步骤，例如配置 JDK。

每当您更改依赖版本时，旧版本不会从沙盒中删除，JVM 可能不会加载您期望的版本。 由于 clean 任务可能不太方便，一个更简单的解决方法是删除沙盒中的 jar 文件，例如：

find build/idea-sandbox/ -name '*.jar' -delete

许可证

版权所有 2015-2024 SonarSource。

根据 GNU 较小通用公共许可证，版本 3.0 授权