yanom blog

様々な技術について書きます

C#のStyleCopAnalyzersを使ってみる

最近C#Windowsアプリケーションを開発しています。
Linterがほしいなと思っていたところ、 StyleCopAnalyzersというライブラリを見つけたので試してみました。
環境はVSCodeを使ってます。

やっていく

  • パッケージインストール
    • dotnet add project名.csproj package StyleCop.Analyzers
  • csproj書き換え
      <PropertyGroup>
        //中略
        <CodeAnalysisRuleSet>StyleCop.ruleset</CodeAnalysisRuleSet>
      </PropertyGroup>
  • StyleCop.rulesetファイル作成
    • この辺りを参考にファイルを作成してください。
    • 格納先はcsprojで記載したパスにおいてください。
    • なお、このファイルで検査する項目を指定できます。
  • 実行
    • 普通にプロジェクトをbuildすれば実行されます。
    • dotnet build

ちなみに、VSCodeではC#拡張機能を使ってbuild(Ctrl-F5)した場合、Linterの結果がVSCodeの画面に表示されて便利です。