如何为 SonarQube 创建自己的 C# 自定义规则？

Question

我一直在做一些研究。我发现是相当不错的样本，但对于列表其他语言在这里。

我还看了sonar-dotnet。但它看起来与其他实现并不相似。

最后，老实说可能是我最后一次机会，我快速浏览了FxCop 自定义规则，但我不确定什么是正确的方法。

我想要做的只是一个基本的 c# 规则，可以像sonar 预定义的那样进行审查。

我的意思是，有不符合要求的准则和标准的解决方案。

Answer 1

您指向的sonar-custom-rules-examples都是用 Java 编写的，并且使用用 Java 编写的解析器用于各种目标语言。用于 C# 和 VB.NET的sonar-dotnet分析器是使用Microsoft 提供的Roslyn 框架用 C# 编写的。

如果您想为 C# 编写自己的自定义规则，那么编写 Roslyn 分析器绝对是最简单的方法（Roslyn 替换了 FxCop，现在已过时）。但是，有许多免费的第三方 Roslyn 分析器可用，因此可能有人已经编写了您想要的至少一些规则。查看NuGet以了解可用的内容。

接下来，您希望 Roslyn 分析器提出的问题出现在 SonarQube 中。如果您使用的是 SonarQube (v7.4+)、SonarScanner for MSBuild (v4.4+) 和 SonarC# 插件 (v7.6+) 的新版本，则第三方 Roslyn 分析器提出的问题将自动被导入为通用问题。有关更多信息，请参阅文档。

通用问题有几个明显的限制，就像无法选择在 SonarQube UI 中运行哪些规则一样。如果您想要更全面的体验（或者如果您使用的是旧版本的 SonarQube），您可以使用SonarQube Roslyn SDK生成一个自定义的 SonarQube 插件，该插件包装 Roslyn 分析器。使用 SDK 很简单：它是一个针对 Roslyn 分析器运行的 exe，它会为您生成一个 SonarQube 插件 jar。