ASP.NET Core MVC - StyleCop

ASP.NET Core MVC 2.1.6 Rider 2018.3 EAP 8

ASP.NET Core MVC 導入 StyleCop 還蠻簡單的，基本上只要安裝一個套件就好了

1、用 nuget 安裝 StyleCop.Analyzers，安裝後直接 Build 就可以在 Build 的視窗裡面看到 Warning 了

2、Rider 的程式碼分析功能有支援 StyleCop，會提醒你要怎麼修改才會 Fix 掉，以下圖來看，有問題的地方會用另外一種顏色來呈現，電燈泡也會有 Fix 的功能

3、如果想要出現 Error 而不是 Warning 的話，要在專案檔裡面加上 TreatWarningsAsErrors 的設定就可以了

<propertygroup>
	<treatwarningsaserrors>True</treatwarningsaserrors>
</propertygroup>

4、如果是要不檢查某個規格的話，可以新增一個 .ruleset 的檔案放在專案裡面 (多專案的話可以放在 solution)，然後在專案檔裡面使用 CodeAnalysisRuleSet 指定這個檔案就好了，加上之後就不會在檢查這些規則了

<PropertyGroup>
	<TreatWarningsAsErrors>True</TreatWarningsAsErrors>
	<CodeAnalysisRuleSet>..\..\stylecop.ruleset</CodeAnalysisRuleSet> // 路徑依照放的位置自行調整
</PropertyGroup>

5、.ruleset 的設定很簡單，基本上就是把 Id 給它，然後設定你要的 Action 就好了，不檢查的話就給 None，相關的設定可以參考官網 Use the code analysis rule set editor

Id 在 Build 視窗裡面每一條 Error [ ] 裡面