Add enable parameter to formatting rules

We do not want formatting rules to be run by default whenever scriptanalyzer is invoked. However, the engine doesn't provide a way to disable a given built-in rule without messing with the input parameters or input settings file. Hence we add this parameter to the formatting rules so that they are not run by default whenever scriptanalyer is invoked.

Author: Kapil Borle

Rules/ConfigurableScriptRule.cs

@@ -11,7 +11,7 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.Generic
     // This is still an experimental class and we do not want to expose it
     // as a public API as of yet. So we place it in builtinrules project
     // and keep it internal as it consumed only by a handful of rules.
-    internal abstract class ConfigurableScriptRule : IScriptRule
+    public abstract class ConfigurableScriptRule : IScriptRule
     {
         public bool IsRuleConfigured { get; protected set; } = false;
 

Rules/PlaceCloseBrace.cs

@@ -26,21 +26,34 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 #if !CORECLR
     [Export(typeof(IScriptRule))]
 #endif
-    public class PlaceCloseBrace : IScriptRule
+    public class PlaceCloseBrace : ConfigurableScriptRule
     {
+        [ConfigurableRuleProperty()]
+        public bool Enable {get; protected set;} = false;
+
         /// <summary>
         /// Analyzes the given ast to find the [violation]
         /// </summary>
         /// <param name="ast">AST to be analyzed. This should be non-null</param>
         /// <param name="fileName">Name of file that corresponds to the input AST.</param>
         /// <returns>A an enumerable type containing the violations</returns>
-        public IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
+        public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string fileName)
         {
             if (ast == null)
             {
                 throw new ArgumentNullException("ast");
             }
 
+            if (!IsRuleConfigured)
+            {
+                ConfigureRule();
+            }
+
+            if (!Enable)
+            {
+                return Enumerable.Empty<DiagnosticRecord>();
+            }
+
             // TODO Should have the following options
             // * no-empty-line-before
             // * align (if close brance and open brace on new lines align with open brace,
@@ -236,23 +249,23 @@ private string GetError()
         /// <summary>
         /// Retrieves the common name of this rule.
         /// </summary>
-        public string GetCommonName()
+        public override string GetCommonName()
         {
             return string.Format(CultureInfo.CurrentCulture, Strings.PlaceCloseBraceCommonName);
         }
 
         /// <summary>
         /// Retrieves the description of this rule.
         /// </summary>
-        public string GetDescription()
+        public override string GetDescription()
         {
             return string.Format(CultureInfo.CurrentCulture, Strings.PlaceCloseBraceDescription);
         }
 
         /// <summary>
         /// Retrieves the name of this rule.
         /// </summary>
-        public string GetName()
+        public override string GetName()
         {
             return string.Format(
                 CultureInfo.CurrentCulture,
@@ -264,7 +277,7 @@ public string GetName()
         /// <summary>
         /// Retrieves the severity of the rule: error, warning or information.
         /// </summary>
-        public RuleSeverity GetSeverity()
+        public override RuleSeverity GetSeverity()
         {
             return RuleSeverity.Information;
         }
@@ -281,17 +294,19 @@ public DiagnosticSeverity GetDiagnosticSeverity()
         /// <summary>
         /// Retrieves the name of the module/assembly the rule is from.
         /// </summary>
-        public string GetSourceName()
+        public override string GetSourceName()
         {
             return string.Format(CultureInfo.CurrentCulture, Strings.SourceName);
         }
 
         /// <summary>
         /// Retrieves the type of the rule, Builtin, Managed or Module.
         /// </summary>
-        public SourceType GetSourceType()
+        public override SourceType GetSourceType()
         {
             return SourceType.Builtin;
         }
+
+
     }
 }

Rules/PlaceOpenBrace.cs

@@ -29,13 +29,16 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 #if !CORECLR
     [Export(typeof(IScriptRule))]
 #endif
-    class PlaceOpenBrace : ConfigurableScriptRule
+    public class PlaceOpenBrace : ConfigurableScriptRule
     {
         private Func<Token[], string, IEnumerable<DiagnosticRecord>> findViolations;
 
         [ConfigurableRuleProperty()]
         public bool OnSameLine { get; protected set; } = true;
 
+        [ConfigurableRuleProperty()]
+        public bool Enable {get; protected set;} = false;
+
         /// <summary>
         /// Analyzes the given ast to find the [violation]
         /// </summary>
@@ -62,6 +65,11 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
                 }
             }
 
+            if (!Enable)
+            {
+                return Enumerable.Empty<DiagnosticRecord>();
+            }
+
             // TODO Should have the following options
             // * new-line-after
             // * no-empty-line-after

Rules/UseConsistentIndentation.cs

@@ -26,7 +26,7 @@ namespace Microsoft.Windows.PowerShell.ScriptAnalyzer.BuiltinRules
 #if !CORECLR
     [Export(typeof(IScriptRule))]
 #endif
-    class UseConsistentIndentation : ConfigurableScriptRule
+    public class UseConsistentIndentation : ConfigurableScriptRule
     {
         private enum IndentationKind { Space, Tab };
 
@@ -36,6 +36,9 @@ private enum IndentationKind { Space, Tab };
         [ConfigurableRuleProperty()]
         public int IndentationSize { get; protected set; } = 4;
 
+        [ConfigurableRuleProperty()]
+        public bool Enable {get; protected set;} = false;
+
         /// <summary>
         /// Analyzes the given ast to find the [violation]
         /// </summary>
@@ -54,6 +57,13 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
                 ConfigureRule();
             }
 
+            // we add this switch because there is no clean way
+            // to disable the rule by default
+            if (!Enable)
+            {
+                return Enumerable.Empty<DiagnosticRecord>();
+            }
+
             var tokens = Helper.Instance.Tokens;
             var diagnosticRecords = new List<DiagnosticRecord>();
             var indentationLevel = 0;