c# - 代码分析不适用于 nuget 包中的规则集(来自 .props)

Question

我正在尝试使用我们的 nuget 包中的自定义规则集文件。我已经添加到包 .props 文件的构建文件夹中:

<Project>
  <PropertyGroup>
    <CodeAnalysisRuleSet>
      $(MSBuildThisFileDirectory)..\My.Shared.ruleset
    </CodeAnalysisRuleSet>
    <RunCodeAnalysis>true</RunCodeAnalysis>
  </PropertyGroup>
</Project>

规则集文件在包根文件夹中，路径正确，它正在将 .props 文件导入到 csproj 文件中。

<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <Import Project="..\packages\My.Shared.Rulesets.1.0.0.7118\build\My.Shared.Rulesets.props" Condition="Exists('..\packages\My.Shared.Rulesets.1.0.0.7118\build\My.Shared.Rulesets.props')" />
  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
  ...

但是 Visual Studio 没有看到正确的规则集。当我从 References -> Analyzers 打开事件规则集时，它指向不同的文件:MinimumRecommendedRules.ruleset 并且它使用的是来自该文件的规则，而不是我的自定义规则。

• Visual Studio 社区 2017 版本 15.5.0
• 项目目标框架 4.6.1

Answer 1

Code Analysis is not working with ruleset from nuget package (from .props)

你应该在包文件夹的content文件夹中设置规则集文件，这样VS/MSBuild会把这个文件添加到你的项目中，然后VS\MSBuild可以改变默认的 MinimumRecommendedRules.ruleset 到您的 My.Shared.ruleset.ruleset 文件。

例如，您的 NuGet 源文件夹结构可能如下所示(“My.Shared.ruleset”是您的包 ID):

• 构建

  • My.Shared.ruleset.props

• 内容

  • My.Shared.ruleset.ruleset

My.Shared.ruleset.props 的内容如下所示:

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <PropertyGroup>
        <RunCodeAnalysis>true</RunCodeAnalysis>
        <CodeAnalysisRuleSet>My.Shared.Rulesets.ruleset</CodeAnalysisRuleSet>
    </PropertyGroup>
</Project>

创建nuget包的步骤:

• 打开 NuGet Package Explorer ，选择新建一个包，Edit->Edit元数据，将Id更改为My.Shared.Rulesets->保存。

• Content->Add->Content Folder->Add Existing file->选择你的My.Shared.Rulesets.ruleset

• 内容->添加->构建文件夹->添加现有文件->选择您的My.Shared.ruleset.props->保存。

然后将这个包添加到测试项目中:

然后您会发现事件规则集已更改为来自 nuget 包的规则集。

评论更新:

We were trying to avoid copying ruleset file to each project. Developers tend to change it and push to repository

如果您不想将规则集文件复制到每个项目，您只需更改.props 文件中的路径，但您应该确保路径是正确的.props 文件，例如。我在本地路径中设置了 .ruleset 文件:D:\ShareFolder\My.Shared.Rulesets.ruleset，然后从 nuget 包中移动 .ruleset 并更改.props 中 D:\ShareFolder\My.Shared.Rulesets.ruleset 的路径。

希望这对您有所帮助。