Commit out stub DiagnosticDescriptors for not yet implemented analyze…

…rs which are marked as up-for-grabs for community. These stubs led to diagnostic ID entries in AnalyzerReleases files, and hence in the global analyzer config files generated for warning waves for these not implemented rules.
dotnet · Sep 4, 2020 · b8d56a0 · b8d56a0
1 parent 6a9cfce
commit b8d56a0
Show file tree

Hide file tree

Showing 18 changed files with 32 additions and 68 deletions.
diff --git a/src/NetAnalyzers/Core/AnalyzerReleases.Shipped.md b/src/NetAnalyzers/Core/AnalyzerReleases.Shipped.md
@@ -53,29 +53,23 @@ CA1068 | Design | Info | CancellationTokenParametersMustComeLastAnalyzer, [Docum
 CA1069 | Design | Info | EnumShouldNotHaveDuplicatedValues, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1069)
 CA1070 | Design | Info | DoNotDeclareEventFieldsAsVirtual, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1070)
 CA1200 | Documentation | Hidden | AvoidUsingCrefTagsWithAPrefixAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1200)
-CA1300 | Globalization | Disabled | SpecifyMessageBoxOptionsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1300)
-CA1301 | Globalization | Disabled | AvoidDuplicateAcceleratorsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1301)
 CA1303 | Globalization | Disabled | DoNotPassLiteralsAsLocalizedParameters, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1303)
 CA1304 | Globalization | Hidden | SpecifyCultureInfoAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1304)
 CA1305 | Globalization | Hidden | SpecifyIFormatProviderAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1305)
-CA1306 | Globalization | Disabled | SetLocaleForDataTypesAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1306)
 CA1307 | Globalization | Disabled | SpecifyStringComparisonAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1307)
 CA1308 | Globalization | Disabled | NormalizeStringsToUppercaseAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1308)
 CA1309 | Globalization | Hidden | UseOrdinalStringComparisonAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1309)
 CA1310 | Globalization | Hidden | SpecifyStringComparisonAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1310)
 CA1401 | Interoperability | Info | PInvokeDiagnosticAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1401)
-CA1414 | Interoperability | Disabled | MarkBooleanPInvokeArgumentsWithMarshalAsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1414)
 CA1416 | Interoperability | Warning | PlatformCompatabilityAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1416)
 CA1417 | Interoperability | Warning | DoNotUseOutAttributeStringPInvokeParametersAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1417)
-CA1500 | Maintainability | Disabled | VariableNamesShouldNotMatchFieldNamesAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1500)
 CA1501 | Maintainability | Disabled | CodeMetricsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1501)
 CA1502 | Maintainability | Disabled | CodeMetricsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1502)
 CA1505 | Maintainability | Disabled | CodeMetricsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1505)
 CA1506 | Maintainability | Disabled | CodeMetricsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1506)
 CA1507 | Maintainability | Info | UseNameofInPlaceOfStringAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1507)
 CA1508 | Maintainability | Disabled | AvoidDeadConditionalCode, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1508)
 CA1509 | Maintainability | Disabled | CodeMetricsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1509)
-CA1601 | Mobility | Disabled | DoNotUseTimersThatPreventPowerStateChangesAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1601)
 CA1700 | Naming | Disabled | DoNotNameEnumValuesReserved, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1700)
 CA1707 | Naming | Hidden | IdentifiersShouldNotContainUnderscoresAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1707)
 CA1708 | Naming | Hidden | IdentifiersShouldDifferByMoreThanCaseAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1708)
@@ -89,7 +83,6 @@ CA1720 | Naming | Hidden | IdentifiersShouldNotContainTypeNames, [Documentation]
 CA1721 | Naming | Disabled | PropertyNamesShouldNotMatchGetMethodsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1721)
 CA1724 | Naming | Disabled | TypeNamesShouldNotMatchNamespacesAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1724)
 CA1725 | Naming | Hidden | ParameterNamesShouldMatchBaseDeclarationAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1725)
-CA1726 | Naming | Disabled | UsePreferredTermsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1726)
 CA1801 | Usage | Disabled | ReviewUnusedParametersAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1801)
 CA1802 | Performance | Disabled | UseLiteralsWhereAppropriateAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1802)
 CA1805 | Performance | Info | DoNotInitializeUnnecessarilyAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1805)
@@ -121,7 +114,6 @@ CA1836 | Performance | Info | UseCountProperlyAnalyzer, [Documentation](https://
 CA1837 | Performance | Info | UseEnvironmentProcessId, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1837)
 CA1838 | Performance | Hidden | AvoidStringBuilderPInvokeParametersAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca1838)
 CA2000 | Reliability | Disabled | DisposeObjectsBeforeLosingScope, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2000)
-CA2001 | Reliability | Disabled | AvoidCallingProblematicMethodsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2001)
 CA2002 | Reliability | Disabled | DoNotLockOnObjectsWithWeakIdentityAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2002)
 CA2007 | Reliability | Disabled | DoNotDirectlyAwaitATaskAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2007)
 CA2008 | Reliability | Disabled | DoNotCreateTasksWithoutPassingATaskSchedulerAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2008)
@@ -139,11 +131,9 @@ CA2119 | Security | Disabled | SealMethodsThatSatisfyPrivateInterfacesAnalyzer,
 CA2153 | Security | Disabled | DoNotCatchCorruptedStateExceptionsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2153)
 CA2200 | Usage | Warning | RethrowToPreserveStackDetailsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2200)
 CA2201 | Usage | Hidden | DoNotRaiseReservedExceptionTypesAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2201)
-CA2205 | Usage | Disabled | UseManagedEquivalentsOfWin32ApiAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2205)
 CA2207 | Usage | Disabled | InitializeStaticFieldsInlineAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2207)
 CA2208 | Usage | Info | InstantiateArgumentExceptionsCorrectlyAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2208)
 CA2211 | Usage | Info | NonConstantFieldsShouldNotBeVisibleAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2211)
-CA2212 | Usage | Disabled | DoNotMarkServicedComponentsWithWebMethodAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2212)
 CA2213 | Usage | Disabled | DisposableFieldsShouldBeDisposed, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2213)
 CA2214 | Usage | Disabled | DoNotCallOverridableMethodsInConstructorsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2214)
 CA2215 | Usage | Hidden | DisposeMethodsShouldCallBaseClassDispose, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2215)
@@ -155,14 +145,9 @@ CA2226 | Usage | Disabled | OperatorsShouldHaveSymmetricalOverloadsAnalyzer, [Do
 CA2227 | Usage | Disabled | CollectionPropertiesShouldBeReadOnlyAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2227)
 CA2229 | Usage | Hidden | SerializationRulesDiagnosticAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2229)
 CA2231 | Usage | Info | OverloadOperatorEqualsOnOverridingValueTypeEqualsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2231)
-CA2232 | Usage | Disabled | MarkWindowsFormsEntryPointsWithStaThreadAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2232)
 CA2234 | Usage | Disabled | PassSystemUriObjectsInsteadOfStringsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2234)
 CA2235 | Usage | Disabled | SerializationRulesDiagnosticAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2235)
-CA2236 | Usage | Disabled | CallBaseClassMethodsOnISerializableTypesAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2236)
 CA2237 | Usage | Disabled | SerializationRulesDiagnosticAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2237)
-CA2238 | Usage | Disabled | ImplementSerializationMethodsCorrectlyAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2238)
-CA2239 | Usage | Disabled | ProvideDeserializationMethodsForOptionalFieldsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2239)
-CA2240 | Usage | Disabled | ImplementISerializableCorrectlyAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2240)
 CA2241 | Usage | Info | ProvideCorrectArgumentsToFormattingMethodsAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2241)
 CA2242 | Usage | Info | TestForNaNCorrectlyAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2242)
 CA2243 | Usage | Disabled | AttributeStringLiteralsShouldParseCorrectlyAnalyzer, [Documentation](https://docs.microsoft.com/visualstudio/code-quality/ca2243)

diff --git a/...etAnalyzers/Core/Microsoft.CodeQuality.Analyzers/ApiDesignGuidelines/UsePreferredTerms.cs b/...etAnalyzers/Core/Microsoft.CodeQuality.Analyzers/ApiDesignGuidelines/UsePreferredTerms.cs
@@ -3,7 +3,6 @@
 using System.Collections.Immutable;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Diagnostics;
-using Analyzer.Utilities;
 
 namespace Microsoft.CodeQuality.Analyzers.ApiDesignGuidelines
 {
@@ -14,7 +13,7 @@ public abstract class UsePreferredTermsAnalyzer : DiagnosticAnalyzer
     {
         internal const string RuleId = "CA1726";
 
-        private static readonly LocalizableString s_localizableTitle = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.UsePreferredTermsTitle), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
+        /*private static readonly LocalizableString s_localizableTitle = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.UsePreferredTermsTitle), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
 
         private static readonly LocalizableString s_localizableMessageAssembly = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.UsePreferredTermsMessageAssembly), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
         private static readonly LocalizableString s_localizableMessageNamespace = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.UsePreferredTermsMessageNamespace), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
@@ -177,7 +176,7 @@ public abstract class UsePreferredTermsAnalyzer : DiagnosticAnalyzer
                                                                              description: s_localizableDescription,
                                                                              isPortedFxCopRule: true,
                                                                              isDataflowRule: false,
-                                                                             isEnabledByDefaultInFxCopAnalyzers: false);
+                                                                             isEnabledByDefaultInFxCopAnalyzers: false);*/
 
         public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray<DiagnosticDescriptor>.Empty;
         //ImmutableArray.Create(AssemblyRule, NamespaceRule, MemberParameterRule, DelegateParameterRule, TypeTypeParameterRule, MethodTypeParameterRule, TypeRule, MemberRule, AssemblyNoAlternateRule, NamespaceNoAlternateRule, MemberParameterNoAlternateRule, DelegateParameterNoAlternateRule, TypeTypeParameterNoAlternateRule, MethodTypeParameterNoAlternateRule, TypeNoAlternateRule, MemberNoAlternateRule);

diff --git a/...nalyzers/Core/Microsoft.CodeQuality.Analyzers/ApiReview/AvoidCallingProblematicMethods.cs b/...nalyzers/Core/Microsoft.CodeQuality.Analyzers/ApiReview/AvoidCallingProblematicMethods.cs
@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft.  All Rights Reserved.  Licensed under the Apache License, Version 2.0.  See License.txt in the project root for license information.
 
 using System.Collections.Immutable;
-using Analyzer.Utilities;
 using Microsoft.CodeAnalysis.Diagnostics;
 using Microsoft.CodeAnalysis;
 
@@ -14,7 +13,7 @@ public abstract class AvoidCallingProblematicMethodsAnalyzer : DiagnosticAnalyze
     {
         internal const string RuleId = "CA2001";
 
-        private static readonly LocalizableString s_localizableTitle = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidCallingProblematicMethodsTitle), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
+        /*private static readonly LocalizableString s_localizableTitle = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidCallingProblematicMethodsTitle), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
 
         private static readonly LocalizableString s_localizableMessageSystemGCCollect = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidCallingProblematicMethodsMessageSystemGCCollect), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
         private static readonly LocalizableString s_localizableMessageSystemThreadingThreadResume = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.AvoidCallingProblematicMethodsMessageSystemThreadingThreadResume), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
@@ -117,7 +116,7 @@ public abstract class AvoidCallingProblematicMethodsAnalyzer : DiagnosticAnalyze
                                                                              description: s_localizableDescription,
                                                                              isPortedFxCopRule: true,
                                                                              isDataflowRule: false,
-                                                                             isEnabledByDefaultInFxCopAnalyzers: false);
+                                                                             isEnabledByDefaultInFxCopAnalyzers: false);*/
 
         public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray<DiagnosticDescriptor>.Empty;
         // ImmutableArray.Create(SystemGCCollectRule, SystemThreadingThreadResumeRule, SystemThreadingThreadSuspendRule, SystemTypeInvokeMemberRule, CoInitializeSecurityRule, CoSetProxyBlanketRule, SystemRuntimeInteropServicesSafeHandleDangerousGetHandleRule, SystemReflectionAssemblyLoadFromRule, SystemReflectionAssemblyLoadFileRule, SystemReflectionAssemblyLoadWithPartialNameRule);

diff --git a/.../Microsoft.CodeQuality.Analyzers/Maintainability/VariableNamesShouldNotMatchFieldNames.cs b/.../Microsoft.CodeQuality.Analyzers/Maintainability/VariableNamesShouldNotMatchFieldNames.cs
@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft.  All Rights Reserved.  Licensed under the Apache License, Version 2.0.  See License.txt in the project root for license information.
 
 using System.Collections.Immutable;
-using Analyzer.Utilities;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.Diagnostics;
 
@@ -14,7 +13,7 @@ public abstract class VariableNamesShouldNotMatchFieldNamesAnalyzer : Diagnostic
     {
         internal const string RuleId = "CA1500";
 
-        private static readonly LocalizableString s_localizableTitle = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.VariableNamesShouldNotMatchFieldNamesTitle), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
+        /*private static readonly LocalizableString s_localizableTitle = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.VariableNamesShouldNotMatchFieldNamesTitle), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
 
         private static readonly LocalizableString s_localizableMessageLocal = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.VariableNamesShouldNotMatchFieldNamesMessageLocal), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
         private static readonly LocalizableString s_localizableMessageParameter = new LocalizableResourceString(nameof(MicrosoftCodeQualityAnalyzersResources.VariableNamesShouldNotMatchFieldNamesMessageParameter), MicrosoftCodeQualityAnalyzersResources.ResourceManager, typeof(MicrosoftCodeQualityAnalyzersResources));
@@ -37,7 +36,7 @@ public abstract class VariableNamesShouldNotMatchFieldNamesAnalyzer : Diagnostic
                                                                              description: s_localizableDescription,
                                                                              isPortedFxCopRule: true,
                                                                              isDataflowRule: false,
-                                                                             isEnabledByDefaultInFxCopAnalyzers: false);
+                                                                             isEnabledByDefaultInFxCopAnalyzers: false);*/
 
         public override ImmutableArray<DiagnosticDescriptor> SupportedDiagnostics => ImmutableArray<DiagnosticDescriptor>.Empty;
         //ImmutableArray.Create(LocalRule, ParameterRule);