Merge pull request swiftlang#223 from dabelknap/one-space-after-keywords

Demote OneSpaceAfterKeywords to lint rule

Author: allevato

Diff for: Sources/SwiftFormat/PopulatePipeline.swift

@@ -120,12 +120,6 @@ func populate(_ pipeline: Pipeline) {
       EnumDeclSyntax.self
   )
 
-  pipeline.addFormatter(
-    OneSpaceAfterKeywords.self,
-    for:
-      TokenSyntax.self
-  )
-
   pipeline.addFormatter(
     OneSpaceInsideBraces.self,
     for:
@@ -341,6 +335,12 @@ func populate(_ pipeline: Pipeline) {
       TypealiasDeclSyntax.self
   )
 
+  pipeline.addLinter(
+    OneSpaceAfterKeywords.self,
+    for:
+      TokenSyntax.self
+  )
+
   pipeline.addLinter(
     OnlyOneTrailingClosureArgument.self,
     for:

Diff for: Sources/SwiftFormatRules/OneSpaceAfterKeywords.swift

@@ -19,12 +19,10 @@ import SwiftSyntax
 /// Lint: If a keyword appears before a token on the same line without a space between them, a lint
 ///       error is raised.
 ///
-/// Format: A single space will be inserted between keywords and other same-line tokens.
-///
 /// - SeeAlso: https://google.github.io/swift#horizontal-whitespace
-public final class OneSpaceAfterKeywords: SyntaxFormatRule {
-  public override func visit(_ token: TokenSyntax) -> Syntax {
-    guard let nextToken = token.nextToken else { return token }
+public final class OneSpaceAfterKeywords: SyntaxLintRule {
+  public override func visit(_ token: TokenSyntax) {
+    guard let nextToken = token.nextToken else { return }
 
     // Keywords own their trailing spaces, so ensure it only has 1, if there's
     // another token on the same line.
@@ -33,11 +31,10 @@ public final class OneSpaceAfterKeywords: SyntaxFormatRule {
        !nextToken.leadingTrivia.containsNewlines {
       let numSpaces = token.trailingTrivia.numberOfSpaces
       if numSpaces > 1 {
-        diagnose(.removeSpacesAfterKeyword(numSpaces - 1, token.description), on: token)
-        return token.withOneTrailingSpace()
+        diagnose(
+          .removeSpacesAfterKeyword(numSpaces - 1, token.withoutTrivia().description), on: token)
       }
     }
-    return token
   }
 }
 

Diff for: Tests/SwiftFormatRulesTests/OneSpaceAfterKeywordsTests.swift

@@ -5,30 +5,39 @@ import XCTest
 
 public class OneSpaceAfterKeywordsTests: DiagnosingTestCase {
   public func testInvalidOneSpaceAfterKeywordsTests() {
-    XCTAssertFormatting(
-      OneSpaceAfterKeywords.self,
-      input: """
-             let   v1 = "Test"
-             var             values: Values
-             func isIdentifier(_       tokKind: TokenKind) -> Bool {
-               guard     let     first = v1.first else { return false }
-               if case .identifier(_) = tokKind {
-                 return               true
-               }
-               return  false
-             }
-             """,
-      expected: """
-                let v1 = "Test"
-                var values: Values
-                func isIdentifier(_ tokKind: TokenKind) -> Bool {
-                  guard let first = v1.first else { return false }
-                  if case .identifier(_) = tokKind {
-                    return true
-                  }
-                  return false
-                }
-                """)
+    let input =
+      """
+      let   v1 = "Test"
+      var             values: Values
+      func isIdentifier(_       tokKind: TokenKind) -> Bool {
+        guard     let     first = v1.first else { return false }
+        if case .identifier(_) = tokKind {
+          return               true
+        }
+        return  false
+      }
+      """
+
+    performLint(OneSpaceAfterKeywords.self, input: input)
+
+    // let   v1 = "Test"
+    XCTAssertDiagnosed(.removeSpacesAfterKeyword(2, "let"))
+
+    // var             values: Values
+    XCTAssertDiagnosed(.removeSpacesAfterKeyword(12, "var"))
+
+    // func isIdentifier(_       tokKind: TokenKind) -> Bool {
+    XCTAssertDiagnosed(.removeSpacesAfterKeyword(6, "_"))
+
+    // guard     let     first = v1.first else { return false }
+    XCTAssertDiagnosed(.removeSpacesAfterKeyword(4, "guard"))
+    XCTAssertDiagnosed(.removeSpacesAfterKeyword(4, "let"))
+
+    // return               true
+    XCTAssertDiagnosed(.removeSpacesAfterKeyword(14, "return"))
+
+    // return  false
+    XCTAssertDiagnosed(.removeSpacesAfterKeyword(1, "return"))
   }
 
   #if !os(macOS)