From 1b22d373f2cdb08ad05ac79019fab52dc795f6fe Mon Sep 17 00:00:00 2001 From: Youssef Victor Date: Fri, 27 Jan 2023 17:53:39 +0200 Subject: [PATCH] Update analyzers.md (#79768) * Update analyzers.md * Apply suggestions from code review * Update analyzers.md * Apply suggestions from code review Co-authored-by: Stephen Toub * Apply suggestions from code review --------- Co-authored-by: Stephen Toub --- docs/project/analyzers.md | 23 ++++++++--------------- 1 file changed, 8 insertions(+), 15 deletions(-) diff --git a/docs/project/analyzers.md b/docs/project/analyzers.md index d423a61..61318e8 100644 --- a/docs/project/analyzers.md +++ b/docs/project/analyzers.md @@ -1,23 +1,16 @@ ## Adding new analyzers to the build -This repo relies on [.NET Compiler Platform analyzers](https://docs.microsoft.com/en-us/visualstudio/code-quality/roslyn-analyzers-overview?view=vs-2019) 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. +This repo relies on [.NET Compiler Platform analyzers](https://learn.microsoft.com/visualstudio/code-quality/roslyn-analyzers-overview) 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. -```XML - -``` -3. 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. -```XML - - - - ... - -``` +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 `8.50.0.58025`. +2. Add a `PackageReference` entry to , e.g. + ```XML + + ``` +3. After that point, all builds will employ all rules in that analyzer package that are enabled by default. You can change the severity for rules by adding entries to the globalconfig files [CodeAnalysis.src.globalconfig](https://github.com/dotnet/runtime/blob/main/eng/CodeAnalysis.src.globalconfig) or [CodeAnalysis.test.globalconfig](https://github.com/dotnet/runtime/blob/main/eng/CodeAnalysis.test.globalconfig). -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: +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 ``` -- 2.7.4