如何在 .net 标准项目中通过 nuget 获取样式警察规则集



我们正在尝试为所有项目提供一个带有stylecop规则集的nuget包。 我们获取项目中的文件,但规则集未应用于我们的项目。它仍然使用 minimimumrecomended.ruleset。

我们现在拥有的是:

自定义.风格.道具

<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
<RunCodeAnalysis>true</RunCodeAnalysis>
<CodeAnalysisRuleSet>Custom.StyleCop.ruleset</CodeAnalysisRuleSet>
</PropertyGroup>
</Project>

custom.stylecop.targets

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<ItemGroup>
<AdditionalFiles Include="$(MSBuildThisFileDirectory)Contentstylecop.json">
<Link>stylecop.json</Link>
</AdditionalFiles>
</ItemGroup>
</Project>

Custom.stylecop.nuspec

<contentFiles>
<files include="Content/stylecop.json" buildAction="EmbeddedResource" />
</contentFiles>
....
<files>
<file src="build**" target="build" />
<file src="Content/stylecop.json" target="contentFiles" />
</files>

有没有人在 github 上有任何想法或示例,我们可以在其中找到一个例子,因为我们找不到任何示例。

我们通过以下方式解决了这个问题:

CodeAnalysis.props

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<PropertyGroup>
<CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)..CodeAnalysis.ruleset</CodeAnalysisRuleSet>
</PropertyGroup>
<ItemGroup>
<AdditionalFiles Include="$(MSBuildThisFileDirectory)..stylecop.json" />
</ItemGroup>
</Project>

CodeAnalysis.nuspec

<?xml version="1.0" encoding="utf-8"?>
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
<metadata>
<id>CodeAnalysis</id>
<version>1.0.0</version>
<description>Roslyn analyzers, rule sets and additional configuration to be used for Code Analysis</description>
<authors></authors>
<owners></owners>
<dependencies>
<dependency id="Stylecop.Analyzers" version="1.0.2" />
</dependencies>
</metadata>
<files>
<file src="stylecop.json" />
<file src="CodeAnalysis.ruleset" />
<file src="CodeAnalysis.props" target="build" />
</files>
</package>

在我们的 Xamarin.Forms 项目中,修复是编辑 .NET Standard.csproj文件的手动过程。如果有更好的方法,请告诉我!

  1. 首先,在文本编辑器中打开 .NET 标准项目 (_Notepad++(
  2. 然后将<CodeAnalysisRuleSet> ... </CodeAnalysisRuleSet>添加到<PropertyGroup>内。
<PropertyGroup>
<CodeAnalysisRuleSet>..stylecop.ruleset</CodeAnalysisRuleSet>
</PropertyGroup>
  1. (可选(如果要访问项目中的这些文件,可以使用<AdditionalFiles ... />创建项组。
<ItemGroup>
<AdditionalFiles Include="..stylecop.json" />
<AdditionalFiles Include="..stylecop.ruleset" />
</ItemGroup>

参考

https://github.com/dotnet/roslyn/blob/master/docs/compilers/Rule%20Set%20Format.md

最新更新