ContextQMD
Back to Roslyn

README

src/RoslynAnalyzers/Tools/GenerateDocumentationAndConfigFiles/README.md

11.0.1002.2 KB
Original Source

CodeAnalysisTreatWarningsAsErrors - Treat code analysis warnings as errors

If you use the /warnaserror flag when you build your projects, all code analysis warnings are also treated as errors. If you do not want code quality warnings (CAxxxx) to be treated as errors in presence of /warnaserror, you can set the CodeAnalysisTreatWarningsAsErrors MSBuild property to false in your project file. Similarly, if want only code analysis warnings to be treated as errors, you can set CodeAnalysisTreatWarningsAsErrors MSBuild property to true in your project file.

Semantics for CodeAnalysisTreatWarningsAsErrors

We have following important MSBuild properties that determine whether or not CAxxxx rules are bulk escalated (or not escalated) from warnings to errors:

  • CodeAnalysisTreatWarningsAsErrors
  • TreatWarningsAsErrors
  • WarningsAsErrors
  • WarningsNotAsErrors

Following are the precedence rules as per the values of these properties:

  1. For non-CAxxxx rules

    1. CodeAnalysisTreatWarningsAsErrors has no relevance and is ignored.
    2. TreatWarningsAsErrors, if not set, defaults to false. If true, this property translates to /warnaserror command line switch.
    3. Compiler bumps all warnings to errors iff TreatWarningsAsErrors is true. Users can prevent escalation or force escalation of individual warnings to errors by appending the IDs to WarningsNotAsErrors or WarningsAsErrors, which just translate to /warnaserror[+|-]:<%rule ids%> on the command line.

  2. For CAxxxx rules:

    1. If CodeAnalysisTreatWarningsAsErrors is set to true, enabled CA warnings are bulk escalated to errors by choosing the appropriate globalconfig file with the error severity settings.
    2. If CodeAnalysisTreatWarningsAsErrors is set to false and TreatWarningsAsErrors is set to true, we append all CA rule IDs to WarningsNotAsErrors to ensure they are not escalated to errors. Users can still bump individual rule IDs to errors by editorconfig/ruleset entry, etc.
    3. Otherwise, if TreatWarningsAsErrors is set to true, this property translates to /warnaserror command line switch and the compiler bumps all warnings, including enabled CA warnings, to errors.