Add option to ignore open brace in a one line block

Author: Kapil Borle

Rules/PlaceOpenBrace.cs

@@ -46,7 +46,7 @@ public class PlaceOpenBrace : ConfigurableRule
         public bool NewLineAfter { get; protected set; }
 
         [ConfigurableRuleProperty(defaultValue: true)]
-        public bool IgnoreOneLineIf { get; protected set; }
+        public bool IgnoreOneLineBlock { get; protected set; }
 
         private List<Func<Token[], Ast, string, IEnumerable<DiagnosticRecord>>> violationFinders
             = new List<Func<Token[], Ast, string, IEnumerable<DiagnosticRecord>>>();
@@ -99,18 +99,20 @@ public override IEnumerable<DiagnosticRecord> AnalyzeScript(Ast ast, string file
             var tokens = Helper.Instance.Tokens;
 
             // Ignore open braces that are part of arguments to a command
-            // * E.g. get-process | % { "blah }f
+            // * E.g. get-process | % { "blah }
             // In the above case even if OnSameLine == false, we should not
             // flag the open brace as it would move the brace to the next line
             // and will invalidate the command
             var tokenOps = new TokenOperations(tokens, ast);
             tokensToIgnore = new HashSet<Token>(tokenOps.GetOpenBracesInCommandElements());
 
-            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 openBraceToken in tokenOps.GetOpenBraceInOneLineIfStatement())
+                foreach (var pair in tokenOps.GetBracePairsOnSameLine())
                 {
-                    tokensToIgnore.Add(openBraceToken);
+                    tokensToIgnore.Add(pair.Item1);
                 }
             }
 

Tests/Rules/PlaceOpenBrace.tests.ps1

@@ -15,7 +15,7 @@ $settings = @{
 
 Describe "PlaceOpenBrace" {
     Context "When an open brace must be on the same line" {
-        BeforeAll{
+        BeforeAll {
             $def = @'
 function foo ($param1)
 {
@@ -36,14 +36,15 @@ function foo ($param1)
     }
 
     Context "When an open brace must be on a new line" {
-        BeforeAll{
+        BeforeAll {
             $def = @'
 function foo ($param1) {
 
 }
 '@
             $ruleConfiguration.'OnSameLine' = $false
-	        $ruleConfiguration.'NewLineAfter' = $true
+            $ruleConfiguration.'NewLineAfter' = $true
+            $ruleConfiguration.'IgnoreOneLineBlock' = $false
             $violations = Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings
             $defShouldIgnore = @'
 Get-Process | % { "blah" }
@@ -67,19 +68,20 @@ Get-Process | % { "blah" }
             $def = @'
 $x = if ($true) { "blah" } else { "blah blah" }
 '@
-            $ruleConfiguration.'IgnoreOneLineIf' = $true
+            $ruleConfiguration.'IgnoreOneLineBlock' = $true
             $violations = Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings
             $violations.Count | Should Be 0
         }
     }
 
     Context "When a new line should follow an open brace" {
-        BeforeAll{
+        BeforeAll {
             $def = @'
 function foo { }
 '@
             $ruleConfiguration.'OnSameLine' = $true
             $ruleConfiguration.'NewLineAfter' = $true
+            $ruleConfiguration.'IgnoreOneLineBlock' = $false
             $violations = Invoke-ScriptAnalyzer -ScriptDefinition $def -Settings $settings
         }