代码分析不适用于nuget包中的规则集（来自.props）

Question

我正在尝试从nuget包中使用自定义规则集文件。我已经将.props文件添加到build文件夹中：

<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没有看到正确的规则集。当我从“引用”->“分析器”中打开活动规则集时，它指向另一个文件：MinimumRecommendedRules.ruleset，它使用的是该文件中的规则，而不是我的自定义规则。

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

Answer 1

代码分析不适用于nuget包中的规则集（来自.props）

您应该content在package文件夹的文件夹中设置Rule set文件，以便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软件包资源管理器，选择一个新的软件包，编辑->编辑元数据，将ID更改为My.Shared.Rulesets->保存。

• 内容->添加->内容文件夹->添加现有文件->选择您的 My.Shared.Rulesets.ruleset

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

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

然后您会发现活动规则集已从nuget包更改为一个规则集。

更新评论：

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

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

希望这可以帮助。