Skip to content

Latest commit

 

History

History
27 lines (24 loc) · 1.69 KB

analyzers.md

File metadata and controls

27 lines (24 loc) · 1.69 KB
Raw

Adding new analyzers to the build

This repo relies on .NET Compiler Platform analyzers to help validate the correctness, performance, and maintainability of the code. Several existing analyzer packages are wired into the build, but it is easy to augment the utilized packages in order to experiment with additional analyzers.

To add an analyzer package to the build:

  1. Select a package you want to employ, for example https://www.nuget.org/packages/SonarAnalyzer.CSharp/. This analyzer package's name is SonarAnalyzer.CSharp and the latest version as of this edit is 7.15.0.8572.
  2. Add a PackageReference entry to https://github.com/dotnet/runtime/blob/main/eng/Analyzers.props, e.g.
<PackageReference Include="SonarAnalyzer.CSharp" Version="7.15.0.8572" />
  1. After that point, all builds will employ all rules in that analyzer package that are enabled by default. Rules can be disabled by adding entries to the https://github.com/dotnet/runtime/blob/main/src/libraries/CodeAnalysis.ruleset file, e.g.
  <Rules AnalyzerId="SonarAnalyzer.CSharp" RuleNamespace="SonarAnalyzer.CSharp">
    <Rule Id="S1006" Action="None" />
    <Rule Id="S1075" Action="None" />
    ...
  </Rules>

The build system in this repo defaults to treating all warnings as errors. It can be helpful when enabling a new rule to temporarily allow warnings to be warnings rather than errors, while you proceed to fix all of them across the repo. Instead of building from the root of the repo with:

build.cmd

(or ./build.sh on Unix), warnings-as-errors can be disabled with:

build.cmd -warnAsError 0