StyleCop.Analyzers 集成到 GitLab

Question

我有一個 C# 項目（.NET Core 3.1），我使用了 nuget package StyleCop.Analyzers。 它會在構建期間分析我的代碼，並在發現我的代碼有任何問題時顯示各種警告。 現在我想知道是否可以將其檢查集成到 GitLab CI piplene 中？ 我想在 GitLab 中的每個構建之后運行這個分析。 我該怎么做？

Answer 1

“每次構建后運行此分析”

如果您通過在項目中引用 NuGet package 來使用來自StyleCop.Analyzers的代碼分析，則代碼分析將在編譯（構建）期間執行。 每次構建后都不需要進行分析，因為那時分析已經完成 - 與構建一起。 Any errors caused by deviations from the styling rules that you can see in Visual Studio error list or CLI will also be present in GitLab CI pipeline output, as in the end they all are compiled by the same .NET SDK.

要正確配置代碼分析，請將StyleCop.Analyzers package 引用添加到您的項目中：

  <ItemGroup>
    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
      <PrivateAssets>all</PrivateAssets>
      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    </PackageReference>
  </ItemGroup>

此外，您可以使用.ruleset文件進一步配置StyleCop.Analyzers行為，例如選擇退出一些煩人的樣式規則：

<RuleSet Name="Rules for ClassLibrary21" Description="" ToolsVersion="15.0">
    <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
        <Rule Id="SA0001" Action="None" />
    </Rules>
</RuleSet>

規則集文件必須在項目文件設置中明確指定：

  <PropertyGroup>
    <CodeAnalysisRuleSet>..\..\StyleCop.ruleset</CodeAnalysisRuleSet>
  </PropertyGroup>

在官方文檔中閱讀有關規則集的更多信息，或者查看我在 GitLab 上的庫中使用的規則集文件以供參考。