Fix PSCloseBrace rule to not wrongly flag closing brace of one-line h…

…ashtable, which lead to incorrect formatting (#1309)

* Ignore Hashtables for PlaceCloseBrace rule

* suppress only single line hash tables

* Add test and make fix in proper place where RCurly of hashtable gets wrongly associated to the LCurly of the one line if statement

* cleanup code

* revert change to minimise diff

* final cleanup

* Apply suggestions from code review

Co-Authored-By: Robert Holt <rjmholt@gmail.com>

Engine/TokenOperations.cs

@@ -73,6 +73,7 @@ public IEnumerable<Token> GetCloseBracesInCommandElements()
  public IEnumerable<Tuple<Token, Token>> GetBracePairs()
  {
  var openBraceStack = new Stack<Token>();
+ IEnumerable<Ast> hashtableAsts = ast.FindAll(oneAst => oneAst is HashtableAst, searchNestedScriptBlocks: true);
  foreach (var token in tokens)
  {
  if (token.Kind == TokenKind.LCurly)
@@ -84,7 +85,16 @@ public IEnumerable<Tuple<Token, Token>> GetBracePairs()
  if (token.Kind == TokenKind.RCurly
  && openBraceStack.Count > 0)
  {
- yield return new Tuple<Token, Token>(openBraceStack.Pop(), token);
+ bool closeBraceBelongsToHashTable = hashtableAsts.Any(hashtableAst =>
+ {
+ return hashtableAst.Extent.EndLineNumber == token.Extent.EndLineNumber
+ && hashtableAst.Extent.EndColumnNumber == token.Extent.EndColumnNumber;
+ });
+
+ if (!closeBraceBelongsToHashTable)
+ {
+ yield return new Tuple<Token, Token>(openBraceStack.Pop(), token);
+ }
  }
  }
  }

Tests/Rules/PlaceCloseBrace.tests.ps1

@@ -78,6 +78,18 @@ $hashtable = @{a = 1; b = 2}
  }
  }
 
+ Context "When there is a one line hashtable inside a one line statement" {
+ BeforeAll {
+ $scriptDefinition = 'if ($true) { $test = @{ } }'
+ $ruleConfiguration.'IgnoreOneLineBlock' = $true
+ }
+
+ It "Should not find a violation" {
+ $violations = Invoke-ScriptAnalyzer -ScriptDefinition $scriptDefinition -Settings $settings
+ $violations.Count | Should -Be 0
+ }
+ }
+
  Context "When there is a multi-line hashtable" {
  BeforeAll {