Add option to ignore close brace in a one line block

Author: Kapil Borle

Rules/PlaceCloseBrace.cs

@@ -37,7 +37,7 @@ public class PlaceCloseBrace : ConfigurableRule
         public bool NoEmptyLineBefore { get; protected set; }
 
         [ConfigurableRuleProperty(defaultValue: true)]
-        public bool IgnoreOneLineIf { get; protected set; }
+        public bool IgnoreOneLineBlock { get; protected set; }
 
         private HashSet<Token> tokensToIgnore;
 
@@ -61,22 +61,22 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
 
             // TODO Should have the following options
             // * no-empty-lines-before
-            // * align (if close brance and open brace on new lines align with open brace,
-            //   if close brace is on new line but open brace is not align with the first keyword on open brace line)
 
             var tokens = Helper.Instance.Tokens;
             var diagnosticRecords = new List<DiagnosticRecord>();
             var curlyStack = new Stack<Tuple<Token, int>> ();
 
             // TODO move part common with PlaceOpenBrace to one place
-            // TODO use a general switch to ignore blocks on one line
             var tokenOps = new TokenOperations(tokens, ast);
             tokensToIgnore = new HashSet<Token> (tokenOps.GetCloseBracesInCommandElements());
-            if (IgnoreOneLineIf)
+
+            // Ignore open braces that are part of a one line if-else statement
+            // E.g. $x = if ($true) { "blah" } else { "blah blah" }
+            if (IgnoreOneLineBlock)
             {
-                foreach (var closeBraceToken in tokenOps.GetCloseBraceInOneLineIfStatement())
+                foreach (var pair in tokenOps.GetBracePairsOnSameLine())
                 {
-                    tokensToIgnore.Add(closeBraceToken);
+                    tokensToIgnore.Add(pair.Item2);
                 }
             }
 

Tests/Rules/PlaceCloseBrace.tests.ps1

@@ -1,17 +1,17 @@
 Import-Module PSScriptAnalyzer
-$ruleName = "PSPlaceCloseBrace"
+$ruleConfiguration = @{
+    Enable = $true
+    NoEmptyLineBefore = $true
+    IgnoreOneLineBlock = $true
+}
+
 $settings = @{
     IncludeRules = @("PSPlaceCloseBrace")
     Rules = @{
-        PSPlaceCloseBrace = @{
-            Enable = $true
-            NoEmptyLineBefore = $true
-            IgnoreOneLineIf = $true
-        }
+        PSPlaceCloseBrace = $ruleConfiguration
     }
 }
 
-
 Describe "PlaceCloseBrace" {
     Context "When a close brace is not on a new line" {
         BeforeAll {
@@ -84,6 +84,7 @@ $hashtable = @{
             $def = @'
 Get-Process * | % { "blah" }
 '@
+            $ruleConfiguration.'IgnoreOneLineBlock' = $false
             $violations = Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings
         }
 
@@ -95,6 +96,7 @@ Get-Process * | % { "blah" }
             $def = @'
 $x = if ($true) { "blah" } else { "blah blah" }
 '@
+            $ruleConfiguration.'IgnoreOneLineBlock' = $true
             $violations = Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings
             $violations.Count | Should Be 0
         }