代码分析无法使用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打开活动规则集时 - ＆gt;分析人员，它指向不同的文件： MinimumRecommendedRules.ruleset ，并且它使用此文件中的规则而非我的自定义文件。

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

Answer 1

  

代码分析不适用于nuget package（来自.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，选择新的包，编辑 - >编辑 元数据，将ID更改为My.Shared.Rulesets - ＆gt;保存。

• 内容 - ＆gt;添加 - >内容文件夹 - ＆gt;添加现有文件 - ＆gt;选择My.Shared.Rulesets.ruleset

• Content-＆gt; Add-＆gt; Build Folder-＆gt; Add existing file-＆gt;选择您的My.Shared.ruleset.props - ＆gt;保存。

然后将此包添加到测试项目中：

然后您会发现活动规则集已更改为nuget包中的规则集。

评论更新：

  

我们试图避免将规则集文件复制到每个项目。开发人员倾向于改变它并推送到存储库

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

希望这有帮助。