- PR setting renamed to multiElementCollectionTrailingCommas and use literal rather than initializer

Author: mlavergn

Documentation/Configuration.md

@@ -82,7 +82,7 @@ top-level keys and values:
 *  `spacesAroundRangeFormationOperators` _(boolean)_: Determines whether whitespace should be forced
    before and after the range formation operators `...` and `..<`.
 
-*  `multilineCollectionTrailingCommas` _(boolean)_: Determines whether multi-line collections should have trailing commas.
+*  `multiElementCollectionTrailingCommas` _(boolean)_: Determines whether multi-element collection literals should have trailing commas.
     Defaults to `true`.
 
 > TODO: Add support for enabling/disabling specific syntax transformations in

Sources/SwiftFormat/API/Configuration+Default.swift

@@ -37,6 +37,6 @@ extension Configuration {
     self.indentSwitchCaseLabels = false
     self.spacesAroundRangeFormationOperators = false
     self.noAssignmentInExpressions = NoAssignmentInExpressionsConfiguration()
-    self.multilineCollectionTrailingCommas = true
+    self.multiElementCollectionTrailingCommas = true
   }
 }

Sources/SwiftFormat/API/Configuration.swift

@@ -42,7 +42,7 @@ public struct Configuration: Codable, Equatable {
     case rules
     case spacesAroundRangeFormationOperators
     case noAssignmentInExpressions
-    case multilineCollectionTrailingCommas
+    case multiElementCollectionTrailingCommas
   }
 
   /// A dictionary containing the default enabled/disabled states of rules, keyed by the rules'
@@ -163,8 +163,8 @@ public struct Configuration: Codable, Equatable {
   /// Contains exceptions for the `NoAssignmentInExpressions` rule.
   public var noAssignmentInExpressions: NoAssignmentInExpressionsConfiguration
 
-  /// Determines whether multi-line list initializers should have trailing commas.
-  public var multilineCollectionTrailingCommas: Bool
+  /// Determines whether multi-element collection literals should have trailing commas.
+  public var multiElementCollectionTrailingCommas: Bool
 
   /// Constructs a Configuration by loading it from a configuration file.
   public init(contentsOf url: URL) throws {
@@ -243,10 +243,10 @@ public struct Configuration: Codable, Equatable {
       try container.decodeIfPresent(
         NoAssignmentInExpressionsConfiguration.self, forKey: .noAssignmentInExpressions)
       ?? defaults.noAssignmentInExpressions
-    self.multilineCollectionTrailingCommas =
+    self.multiElementCollectionTrailingCommas =
       try container.decodeIfPresent(
-        Bool.self, forKey: .multilineCollectionTrailingCommas)
-    ?? defaults.multilineCollectionTrailingCommas
+        Bool.self, forKey: .multiElementCollectionTrailingCommas)
+    ?? defaults.multiElementCollectionTrailingCommas
 
     // If the `rules` key is not present at all, default it to the built-in set
     // so that the behavior is the same as if the configuration had been
@@ -279,7 +279,7 @@ public struct Configuration: Codable, Equatable {
     try container.encode(fileScopedDeclarationPrivacy, forKey: .fileScopedDeclarationPrivacy)
     try container.encode(indentSwitchCaseLabels, forKey: .indentSwitchCaseLabels)
     try container.encode(noAssignmentInExpressions, forKey: .noAssignmentInExpressions)
-    try container.encode(multilineCollectionTrailingCommas, forKey: .multilineCollectionTrailingCommas)
+    try container.encode(multiElementCollectionTrailingCommas, forKey: .multiElementCollectionTrailingCommas)
     try container.encode(rules, forKey: .rules)
   }
 

Sources/SwiftFormat/PrettyPrint/PrettyPrint.swift

@@ -557,7 +557,7 @@ public class PrettyPrinter {
       // We never want to add a trailing comma in an initializer so we disable trailing commas on
       // single element collections.
       let shouldHaveTrailingComma =
-        startLineNumber != openCloseBreakCompensatingLineNumber && !isSingleElement && configuration.multilineCollectionTrailingCommas
+        startLineNumber != openCloseBreakCompensatingLineNumber && !isSingleElement && configuration.multiElementCollectionTrailingCommas
       if shouldHaveTrailingComma && !hasTrailingComma {
         diagnose(.addTrailingComma, category: .trailingComma)
       } else if !shouldHaveTrailingComma && hasTrailingComma {

Sources/_SwiftFormatTestSupport/Configuration+Testing.swift

@@ -40,7 +40,7 @@ extension Configuration {
     config.indentSwitchCaseLabels = false
     config.spacesAroundRangeFormationOperators = false
     config.noAssignmentInExpressions = NoAssignmentInExpressionsConfiguration()
-    config.multilineCollectionTrailingCommas = true
+    config.multiElementCollectionTrailingCommas = true
     return config
   }
 }

Tests/SwiftFormatTests/PrettyPrint/CommaTests.swift

@@ -23,7 +23,7 @@ final class CommaTests: PrettyPrintTestCase {
       """
 
     var configuration = Configuration.forTesting
-    configuration.multilineCollectionTrailingCommas = true
+    configuration.multiElementCollectionTrailingCommas = true
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 20, configuration: configuration)
   }
 
@@ -49,7 +49,7 @@ final class CommaTests: PrettyPrintTestCase {
       """
 
     var configuration = Configuration.forTesting
-    configuration.multilineCollectionTrailingCommas = false
+    configuration.multiElementCollectionTrailingCommas = false
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 20, configuration: configuration)
   }
 
@@ -75,7 +75,7 @@ final class CommaTests: PrettyPrintTestCase {
       """
 
     var configuration = Configuration.forTesting
-    configuration.multilineCollectionTrailingCommas = true
+    configuration.multiElementCollectionTrailingCommas = true
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 20, configuration: configuration)
   }
 
@@ -101,7 +101,7 @@ final class CommaTests: PrettyPrintTestCase {
       """
 
     var configuration = Configuration.forTesting
-    configuration.multilineCollectionTrailingCommas = false
+    configuration.multiElementCollectionTrailingCommas = false
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 20, configuration: configuration)
   }
 
@@ -120,7 +120,7 @@ final class CommaTests: PrettyPrintTestCase {
       """
 
     var configuration = Configuration.forTesting
-    configuration.multilineCollectionTrailingCommas = true
+    configuration.multiElementCollectionTrailingCommas = true
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 40, configuration: configuration)
   }
 
@@ -139,7 +139,7 @@ final class CommaTests: PrettyPrintTestCase {
       """
 
     var configuration = Configuration.forTesting
-    configuration.multilineCollectionTrailingCommas = false
+    configuration.multiElementCollectionTrailingCommas = false
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 40, configuration: configuration)
   }
 
@@ -165,7 +165,7 @@ final class CommaTests: PrettyPrintTestCase {
       """
 
     var configuration = Configuration.forTesting
-    configuration.multilineCollectionTrailingCommas = true
+    configuration.multiElementCollectionTrailingCommas = true
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 20, configuration: configuration)
   }
 
@@ -191,7 +191,7 @@ final class CommaTests: PrettyPrintTestCase {
       """
 
     var configuration = Configuration.forTesting
-    configuration.multilineCollectionTrailingCommas = false
+    configuration.multiElementCollectionTrailingCommas = false
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 20, configuration: configuration)
   }
 
@@ -217,7 +217,7 @@ final class CommaTests: PrettyPrintTestCase {
       """
 
     var configuration = Configuration.forTesting
-    configuration.multilineCollectionTrailingCommas = true
+    configuration.multiElementCollectionTrailingCommas = true
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 20, configuration: configuration)
   }
 
@@ -243,7 +243,7 @@ final class CommaTests: PrettyPrintTestCase {
       """
 
     var configuration = Configuration.forTesting
-    configuration.multilineCollectionTrailingCommas = false
+    configuration.multiElementCollectionTrailingCommas = false
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 20, configuration: configuration)
   }
 
@@ -263,7 +263,7 @@ final class CommaTests: PrettyPrintTestCase {
       """
 
     var configuration = Configuration.forTesting
-    configuration.multilineCollectionTrailingCommas = true
+    configuration.multiElementCollectionTrailingCommas = true
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 40, configuration: configuration)
   }
 
@@ -283,7 +283,7 @@ final class CommaTests: PrettyPrintTestCase {
       """
 
     var configuration = Configuration.forTesting
-    configuration.multilineCollectionTrailingCommas = false
+    configuration.multiElementCollectionTrailingCommas = false
     assertPrettyPrintEqual(input: input, expected: expected, linelength: 40, configuration: configuration)
   }
 }