asp.net-core – 在Asp.net Core中使用StyleCop

根据这篇 this article在Asp.net Core中使用Stylecop,

1)将以下内容添加到project.json文件的dependencies部分：

"Stylecop.Analyzers": {
  "version": "1.0.0","type": "build"
}

并构建项目.

2)创建stylecop.json并在其上添加配置,这是我的stylecop.json内容：

{
   "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StylecopAnalyzers/master/Stylecop.Analyzers/Stylecop.Analyzers/Settings/stylecop.schema.json","settings": {
     "documentationRules": {
       "documentInterfaces": true,"documentInternalMembers": false    
   }
  }
 }

3)project.json文件中的buildOptions节点下面的以下内容：

"additionalArguments": ["/additionalfile:path/to/stylecop.json" ]

但是我遇到了一些错误：问题是什么？

解决方法

简答

当Stylecop找不到您的stylecop.json时,会发生NullReferenceException错误.这是related GitHub issue.

要修复它(假设你的stylecop.json在你的项目的根目录中),改变它的路径：

"additionalArguments": [
  "/additionalfile:./stylecop.json"
]

完整的工作示例

目录结构

bin
obj
Program.cs
project.json
project.lock.json
stylecop.json
Stylecop.ruleset

Project.json

{
  "version": "1.0.0-*","buildOptions": {
    "debugType": "portable","emitEntryPoint": true,"warningsAsErrors": true,"Nowarn": [
      "1591"
    ],"xmlDoc": true,"additionalArguments": [
      "/ruleset:./Stylecop.ruleset","/additionalfile:./stylecop.json"   <----- This is probably the problem.
    ]
  },"dependencies": {
    "Stylecop.Analyzers": {
      "type": "build","version": "1.0.0"
    }
  },"frameworks": {
    "netcoreapp1.0": {
      "dependencies": {
        "Microsoft.NETCore.App": {
          "type": "platform","version": "1.0.1"
        }
      }
    }
  }
}

stylecop.json

{
  "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StylecopAnalyzers/master/Stylecop.Analyzers/Stylecop.Analyzers/Settings/stylecop.schema.json","settings": {
    "documentationRules": {
      "documentExposedElements": false,"documentInterfaces": false
    }
  }
}

Stylecop.ruleset

<?xml version="1.0" encoding="utf-8"?>
<RuleSet Name="New Rule Set" Description=" " Toolsversion="14.0">
  <Rules AnalyzerId="Stylecop.Analyzers" RuleNamespace="Stylecop.Analyzers">
    <Rule Id="SA0000" Action="Warning" />
    <Rule Id="SA1005" Action="Warning" />
    <Rule Id="SA1208" Action="Warning" />
    <Rule Id="SA1028" Action="Warning" />
    <Rule Id="SA1210" Action="Warning" />
  </Rules>
</RuleSet>

克隆并运行示例

git clone [email protected]:bigfont/StackOverflow.git
cd .\StackOverflow\AspNetCoreStylecop\
dotnet restore
dotnet build