Merge pull request swiftlang#221 from dabelknap/close-brace-whitespace

Demote CloseBraceWhitespace to a lint rule

Author: allevato

Diff for: Sources/SwiftFormat/PopulatePipeline.swift

@@ -31,12 +31,6 @@ func populate(_ pipeline: Pipeline) {
       MemberDeclBlockSyntax.self
   )
 
-  pipeline.addFormatter(
-    CloseBraceWhitespace.self,
-    for:
-      TokenSyntax.self
-  )
-
   pipeline.addFormatter(
     CollectionLiteralWhitespace.self,
     for:
@@ -280,6 +274,12 @@ func populate(_ pipeline: Pipeline) {
       SwitchStmtSyntax.self
   )
 
+  pipeline.addLinter(
+    CloseBraceWhitespace.self,
+    for:
+      TokenSyntax.self
+  )
+
   pipeline.addLinter(
     CommentWhitespace.self,
     for:

Diff for: Sources/SwiftFormatRules/CloseBraceWhitespace.swift

@@ -20,17 +20,14 @@ import SwiftSyntax
 /// Lint: If a close brace does not have a line break before it, except as covered by One Statement
 ///       Per Line, a lint error will be raised.
 ///
-/// Format: Line breaks will be inserted for all non-conforming close braces.
-///
 /// - SeeAlso: https://google.github.io/swift#braces
-public final class CloseBraceWhitespace: SyntaxFormatRule {
-  public override func visit(_ token: TokenSyntax) -> Syntax {
-    guard token.tokenKind == .rightBrace else { return token }
-    if isInAllowedSingleLineContainer(token) { return token }
-    if token.leadingTrivia.containsNewlines { return token }
+public final class CloseBraceWhitespace: SyntaxLintRule {
+  public override func visit(_ token: TokenSyntax) {
+    guard token.tokenKind == .rightBrace else { return }
+    if isInAllowedSingleLineContainer(token) { return }
+    if token.leadingTrivia.containsNewlines { return }
 
     diagnose(.lineBreakRequiredBeforeCloseBrace, on: token)
-    return token.withOneLeadingNewline()
   }
 }
 
@@ -57,4 +54,3 @@ extension Diagnostic.Message {
   static let lineBreakRequiredBeforeCloseBrace =
     Diagnostic.Message(.warning, "insert a newline before this '}'")
 }
-

Diff for: Tests/SwiftFormatRulesTests/CloseBraceWhitespaceTests.swift

@@ -6,32 +6,23 @@ import SwiftSyntax
 
 public class CloseBraceWhitespaceTests: DiagnosingTestCase {
   public func testInvalidCloseBraceWhitespace() {
-    XCTAssertFormatting(
-      CloseBraceWhitespace.self,
-      input: """
-             func a()
-             { print("hello")
-               print("goodbye")}
-             func b(){
-             }
-             func c() {}
-             """,
-      expected: """
-                func a()
-                { print("hello")
-                  print("goodbye")
-                }
-                func b(){
-                }
-                func c() {}
-                """)
+    let input =
+      """
+      func a()
+      { print("hello")
+        print("goodbye")}
+      func b(){
+      }
+      func c() {}
+      """
+
+    performLint(CloseBraceWhitespace.self, input: input)
+    XCTAssertDiagnosed(.lineBreakRequiredBeforeCloseBrace)
   }
 
 #if !os(macOS)
   static let allTests = [
     CloseBraceWhitespaceTests.testInvalidCloseBraceWhitespace,
   ]
 #endif
-
 }
-