SonarQube 插件 - 包含“问题”功能

Question

说明：

我开发了一个插件，它可以在项目中扫描具有特定名称的 xml 文件，并执行一些解析逻辑，以确定对项目代码的某些子集所做的更改的向后兼容性。现在，我在 sonarqube 仪表板上有一个小部件，它显示有关在检查这些 xml 文件后检测到的非向后兼容问题的数量的信息。

问题：

我想启用插件中的功能，以将具有非向后兼容标志的 xml 文件添加到“问题”选项卡，并设置严重的严重性。然后，团队中的开发人员可以希望将这些问题添加到整体问题计数中，而不是单独检查仪表板小部件。在扩展参考插件之后，我有一个 Metrics、Sensor、Plugin 和 RubyWidget 类，以及我自己的类，这些类添加了查找文件和执行解析逻辑的功能。

我是否可以扩展一个类来将此新问题添加到问题计数中并授予用户检查 xml 文件以查看问题本身描述的能力？

如何整合此功能？ 谢谢。

Answer 1

您需要提供org.sonar.api.server.rule.RulesDefinition 的实现并将其类添加到插件类的getExtensions() 方法中。 然后，您可以通过传感器在项目文件上为您定义的规则创建“问题”。

例如，您可以查看 SonarQube 示例插件 defines a rule 和 creates issues for that rule 的方式。