如何在.net标准项目中获取Stylecop规则集槽小部件

时间:2018-10-10 14:24:52

标签: c# .net nuget .net-standard stylecop

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

我们现在拥有的是:

Custom.stylecop.props

<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)\Content\stylecop.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上有任何想法或示例吗,所以我们在其中可以找到示例,因为我们找不到任何示例。

2 个答案:

答案 0 :(得分:1)

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

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

参考

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

答案 1 :(得分:0)

我们通过以下方法解决了该问题:

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>