Rename

Author: dduan

Documentation/Configuration.md

@@ -31,8 +31,8 @@ top-level keys and values:
     lines that are allowed to be present in a source file. Any number larger
     than this will be collapsed down to the maximum.
 
-*   `spacesBeforeLineComments` _(number)_: The number of spaces between the last
-    token on a non-empty line and a line comment starting with `//`.
+*   `spacesBeforeEndOfLineComments` _(number)_: The number of spaces between 
+    the last token on a non-empty line and a line comment starting with `//`.
 
 *   `respectsExistingLineBreaks` _(boolean)_: Indicates whether or not existing
     line breaks in the source code should be honored (if they are valid

Sources/SwiftFormat/API/Configuration+Default.swift

@@ -26,7 +26,7 @@ extension Configuration {
     self.lineLength = 100
     self.tabWidth = 8
     self.indentation = .spaces(2)
-    self.spacesBeforeLineComments = 2
+    self.spacesBeforeEndOfLineComments = 2
     self.respectsExistingLineBreaks = true
     self.lineBreakBeforeControlFlowKeywords = false
     self.lineBreakBeforeEachArgument = false

Sources/SwiftFormat/API/Configuration.swift

@@ -28,7 +28,7 @@ public struct Configuration: Codable, Equatable {
     case version
     case maximumBlankLines
     case lineLength
-    case spacesBeforeLineComments
+    case spacesBeforeEndOfLineComments
     case tabWidth
     case indentation
     case respectsExistingLineBreaks
@@ -68,7 +68,7 @@ public struct Configuration: Codable, Equatable {
   public var lineLength: Int
 
   // Number of spaces that preceeds line comments.
-  public var spacesBeforeLineComments: Int
+  public var spacesBeforeEndOfLineComments: Int
 
   /// The width of the horizontal tab in spaces.
   ///
@@ -229,9 +229,9 @@ public struct Configuration: Codable, Equatable {
     self.lineLength =
       try container.decodeIfPresent(Int.self, forKey: .lineLength)
       ?? defaults.lineLength
-    self.spacesBeforeLineComments =
-      try container.decodeIfPresent(Int.self, forKey: .spacesBeforeLineComments)
-      ?? defaults.spacesBeforeLineComments
+    self.spacesBeforeEndOfLineComments =
+      try container.decodeIfPresent(Int.self, forKey: .spacesBeforeEndOfLineComments)
+      ?? defaults.spacesBeforeEndOfLineComments
     self.tabWidth =
       try container.decodeIfPresent(Int.self, forKey: .tabWidth)
       ?? defaults.tabWidth
@@ -295,7 +295,7 @@ public struct Configuration: Codable, Equatable {
     try container.encode(version, forKey: .version)
     try container.encode(maximumBlankLines, forKey: .maximumBlankLines)
     try container.encode(lineLength, forKey: .lineLength)
-    try container.encode(spacesBeforeLineComments, forKey: .spacesBeforeLineComments)
+    try container.encode(spacesBeforeEndOfLineComments, forKey: .spacesBeforeEndOfLineComments)
     try container.encode(tabWidth, forKey: .tabWidth)
     try container.encode(indentation, forKey: .indentation)
     try container.encode(respectsExistingLineBreaks, forKey: .respectsExistingLineBreaks)

Sources/SwiftFormat/PrettyPrint/TokenStreamCreator.swift

@@ -3171,7 +3171,7 @@ fileprivate final class TokenStreamCreator: SyntaxVisitor {
       return (
         true,
         [
-          .space(size: config.spacesBeforeLineComments, flexible: true),
+          .space(size: config.spacesBeforeEndOfLineComments, flexible: true),
           .comment(Comment(kind: .line, text: text), wasEndOfLine: true),
           // There must be a break with a soft newline after the comment, but it's impossible to
           // know which kind of break must be used. Adding this newline is deferred until the

Tests/SwiftFormatTests/PrettyPrint/CommentTests.swift

@@ -317,7 +317,7 @@ final class CommentTests: PrettyPrintTestCase {
       """
 
     var config = Configuration.forTesting
-    config.spacesBeforeLineComments = 3
+    config.spacesBeforeEndOfLineComments = 3
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 45, configuration: config)
   }
 
@@ -468,7 +468,7 @@ final class CommentTests: PrettyPrintTestCase {
 
       """
     var config = Configuration.forTesting
-    config.spacesBeforeLineComments = 1
+    config.spacesBeforeEndOfLineComments = 1
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 80, configuration: config)
   }