Disable ROS0003 by default (fix #879)

dotnet · Jan 28, 2022 · 9c56292 · 9c56292
1 parent de37485
commit 9c56292
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 5 deletions.
diff --git a/src/Common/CommonDiagnosticRules.cs b/src/Common/CommonDiagnosticRules.cs
@@ -13,7 +13,7 @@ internal static class CommonDiagnosticRules
             id: CommonDiagnosticIdentifiers.AnalyzerIsObsolete,
             title: "Analyzer is obsolete",
             messageFormat: "Analyzer {0} is obsolete.{1}",
-            category: DiagnosticCategories.Roslynator,
+            category: "",
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: true,
             description: null,
@@ -24,7 +24,7 @@ internal static class CommonDiagnosticRules
             id: CommonDiagnosticIdentifiers.AnalyzerOptionIsObsolete,
             title: "Analyzer option is obsolete",
             messageFormat: "Analyzer option '{0}' is obsolete{1}",
-            category: DiagnosticCategories.Roslynator,
+            category: "",
             defaultSeverity: DiagnosticSeverity.Warning,
             isEnabledByDefault: false,
             description: null,
@@ -35,9 +35,9 @@ internal static class CommonDiagnosticRules
             id: CommonDiagnosticIdentifiers.RequiredConfigOptionNotSet,
             title: "Analyzer requires config option to be specified",
             messageFormat: "Analyzer {0} requires config option to be specified: {1}",
-            category: DiagnosticCategories.Roslynator,
-            defaultSeverity: DiagnosticSeverity.Warning,
-            isEnabledByDefault: true,
+            category: "",
+            defaultSeverity: DiagnosticSeverity.Info,
+            isEnabledByDefault: false,
             description: null,
             helpLinkUri: null,
             customTags: Array.Empty<string>());

diff --git a/src/Tools/CodeGenerator/Configuration.md b/src/Tools/CodeGenerator/Configuration.md
@@ -26,6 +26,11 @@ roslynator_compiler_diagnostic_fixes.enabled = true|false
 roslynator_compiler_diagnostic_fix.<COMPILER_DIAGNOSTIC_ID>.enabled = true|false
 ```
 
+## Required Options
+
+Some analyzers require option to be set. For this purpose there is special analyzer ROS0003 that reports a diagnostic
+if an analyzer is enabled but required option is not set. ROS0003 is disabled by default.
+
 ## Default Configuration
 
 If you want to configure Roslynator on a user-wide basis you have to use Roslynator config file.