Make rule optional, disabled by default

Author: liamjpeters

Rules/UseConsistentParameterSetName.cs

@@ -22,15 +22,15 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 #if !CORECLR
     [Export(typeof(IScriptRule))]
 #endif
-    public class UseConsistentParameterSetName : IScriptRule
+    public class UseConsistentParameterSetName : ConfigurableRule
     {
 
         private const string AllParameterSetsName = "__AllParameterSets";
 
         /// <summary>
         /// AnalyzeScript: Check for parameter set name issues.
         /// </summary>
-        public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
+        public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
         {
             if (ast == null)
             {
@@ -341,20 +341,6 @@ private static string GetNamedArgumentValue(AttributeAst attributeAst, string ar
         private static IScriptExtent GetParameterSetNameValueExtent(AttributeAst attributeAst)
         {
             return GetAttributeNamedArgumentValueExtent(attributeAst, "ParameterSetName", "Parameter");
-            // if (attributeAst == null || attributeAst.NamedArguments == null)
-            //     return null;
-
-            // if (!string.Equals(attributeAst.TypeName?.Name, "Parameter", StringComparison.OrdinalIgnoreCase))
-            //     return null;
-
-            // foreach (var namedArg in attributeAst.NamedArguments)
-            // {
-            //     if (string.Equals(namedArg.ArgumentName, "ParameterSetName", StringComparison.OrdinalIgnoreCase))
-            //     {
-            //         return namedArg.Argument?.Extent;
-            //     }
-            // }
-            // return null;
         }
 
         /// <summary>
@@ -421,7 +407,7 @@ public ParameterSetInfo(string parameterName, string parameterSetName, Attribute
         /// GetName: Retrieves the name of this rule.
         /// </summary>
         /// <returns>The name of this rule</returns>
-        public string GetName() => string.Format(
+        public override string GetName() => string.Format(
             CultureInfo.CurrentCulture,
             Strings.NameSpaceFormat,
             GetSourceName(),
@@ -432,7 +418,7 @@ public string GetName() => string.Format(
         /// GetCommonName: Retrieves the common name of this rule.
         /// </summary>
         /// <returns>The common name of this rule</returns>
-        public string GetCommonName() => string.Format(
+        public override string GetCommonName() => string.Format(
             CultureInfo.CurrentCulture,
             Strings.UseConsistentParameterSetNameCommonName
             );
@@ -441,26 +427,26 @@ public string GetCommonName() => string.Format(
         /// GetDescription: Retrieves the description of this rule.
         /// </summary>
         /// <returns>The description of this rule</returns>
-        public string GetDescription() => string.Format(
+        public override string GetDescription() => string.Format(
             CultureInfo.CurrentCulture,
             Strings.UseConsistentParameterSetNameDescription
             );
 
         /// <summary>
         /// Method: Retrieves the type of the rule: builtin, managed or module.
         /// </summary>
-        public SourceType GetSourceType() => SourceType.Builtin;
+        public override SourceType GetSourceType() => SourceType.Builtin;
 
         /// <summary>
         /// GetSeverity: Retrieves the severity of the rule: error, warning of information.
         /// </summary>
         /// <returns></returns>
-        public RuleSeverity GetSeverity() => RuleSeverity.Warning;
+        public override RuleSeverity GetSeverity() => RuleSeverity.Warning;
 
         /// <summary>
         /// Method: Retrieves the module/assembly name the rule is from.
         /// </summary>
-        public string GetSourceName() => string.Format(
+        public override string GetSourceName() => string.Format(
             CultureInfo.CurrentCulture, Strings.SourceName
             );
     }