Update minimum supported Swift version to Swift 5.7

.github/workflows/build.yml

@@ -42,8 +42,8 @@ jobs:
       fail-fast: false
       matrix:
         swiftver:
-          - swift:5.2
-          - swift:5.6
+          - swift:5.7
+          - swift:5.10
         swiftos:
           - focal
     runs-on: ubuntu-latest

.swiftformat

@@ -29,7 +29,7 @@
 --self remove
 --semicolons inline
 --stripunusedargs always
---swiftversion 5.1
+--swiftversion 5.7
 --trimwhitespace always
 --wraparguments preserve
 --wrapcollections preserve

EditorExtension/Application/Source/AppDelegate.swift

@@ -31,7 +31,7 @@
 
 import Cocoa
 
-@NSApplicationMain
+@main
 class AppDelegate: NSObject, NSApplicationDelegate {
     var window: NSWindow? {
         NSApp.mainWindow
@@ -87,7 +87,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     }
 
     @IBAction func openConfiguration(_: NSMenuItem) {
-        guard let window = window else {
+        guard let window else {
             return
         }
 
@@ -108,7 +108,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     }
 
     @IBAction func saveConfiguration(_: NSMenuItem) {
-        guard let window = window else {
+        guard let window else {
             return
         }
 
@@ -137,7 +137,7 @@ class AppDelegate: NSObject, NSApplicationDelegate {
     }
 
     private func showError(_ error: Error) {
-        guard let window = window else {
+        guard let window else {
             return
         }
 

EditorExtension/Extension/FormatFileCommand.swift

@@ -57,7 +57,7 @@ class FormatFileCommand: NSObject, XCSourceEditorCommand {
 
         let output: [Token]
         do {
-            output = try format(input, rules: rules, options: formatOptions)
+            output = try format(input, rules: rules, options: formatOptions).tokens
         } catch {
             return completionHandler(error)
         }

EditorExtension/Extension/FormatSelectionCommand.swift

@@ -67,7 +67,7 @@ class FormatSelectionCommand: NSObject, XCSourceEditorCommand {
             let start = tokenIndex(for: startOffset, in: output, tabWidth: formatOptions.tabWidth)
             let end = tokenIndex(for: endOffset, in: output, tabWidth: formatOptions.tabWidth)
             do {
-                output = try format(output, rules: rules, options: formatOptions, range: start ..< end)
+                output = try format(output, rules: rules, options: formatOptions, range: start ..< end).tokens
             } catch {
                 return completionHandler(error)
             }

EditorExtension/Shared/RulesStore.swift

@@ -60,7 +60,7 @@ extension Rule: Comparable {
     /// Space-separated, lowercased text terms that this rule might by found by.
     var searchableText: String {
         var items = [name]
-        if let formatRule = formatRule {
+        if let formatRule {
             items.append(formatRule.help.keywords.joined(separator: " "))
             items.append(formatRule.options.joined(separator: " "))
             items.append(formatRule.sharedOptions.joined(separator: " "))

Package.swift

@@ -1,15 +1,36 @@
-// swift-tools-version:4.2
+// swift-tools-version:5.6
 import PackageDescription
 
 let package = Package(
     name: "SwiftFormat",
     products: [
         .executable(name: "swiftformat", targets: ["CommandLineTool"]),
         .library(name: "SwiftFormat", targets: ["SwiftFormat"]),
+        .plugin(name: "SwiftFormatPlugin", targets: ["SwiftFormatPlugin"]),
     ],
     targets: [
-        .target(name: "CommandLineTool", dependencies: ["SwiftFormat"], path: "CommandLineTool"),
-        .target(name: "SwiftFormat", path: "Sources"),
-        .testTarget(name: "SwiftFormatTests", dependencies: ["SwiftFormat"], path: "Tests"),
+        .executableTarget(
+            name: "CommandLineTool", dependencies: ["SwiftFormat"], path: "CommandLineTool",
+            exclude: ["swiftformat"]
+        ),
+        .target(name: "SwiftFormat", path: "Sources", exclude: ["Info.plist"]),
+        .testTarget(
+            name: "SwiftFormatTests",
+            dependencies: ["SwiftFormat"],
+            path: "Tests",
+            exclude: ["Info.plist", "GlobTest[5].txt"]
+        ),
+        .plugin(
+            name: "SwiftFormatPlugin",
+            capability: .command(
+                intent: .custom(
+                    verb: "swiftformat", description: "Formats Swift source files using SwiftFormat"
+                ),
+                permissions: [
+                    .writeToPackageDirectory(reason: "This command reformats source files"),
+                ]
+            ),
+            dependencies: [.target(name: "CommandLineTool")]
+        ),
     ]
 )

PerformanceTests/PerformanceTests.swift

@@ -96,8 +96,8 @@ class PerformanceTests: XCTestCase {
         let tokens = files.map { tokenize($0) }
         let options = FormatOptions(
             linebreak: "\r\n",
-            spaceAroundRangeOperators: false,
-            spaceAroundOperatorDeclarations: false,
+            spaceAroundRangeOperators: .remove,
+            spaceAroundOperatorDeclarations: .remove,
             useVoid: false,
             indentCase: true,
             trailingCommas: false,
@@ -137,7 +137,7 @@ class PerformanceTests: XCTestCase {
         let files = PerformanceTests.files
         let tokens = files.map { tokenize($0) }
         measure {
-            _ = tokens.map { try! format($0, rules: [FormatRules.indent]) }
+            _ = tokens.map { try! format($0, rules: [.indent]) }
         }
     }
 
@@ -146,15 +146,15 @@ class PerformanceTests: XCTestCase {
         let tokens = files.map { tokenize($0) }
         let options = FormatOptions(indent: "\t", allmanBraces: true)
         measure {
-            _ = tokens.map { try! format($0, rules: [FormatRules.indent], options: options) }
+            _ = tokens.map { try! format($0, rules: [.indent], options: options) }
         }
     }
 
     func testRedundantSelf() {
         let files = PerformanceTests.files
         let tokens = files.map { tokenize($0) }
         measure {
-            _ = tokens.map { try! format($0, rules: [FormatRules.redundantSelf]) }
+            _ = tokens.map { try! format($0, rules: [.redundantSelf]) }
         }
     }
 
@@ -163,15 +163,15 @@ class PerformanceTests: XCTestCase {
         let tokens = files.map { tokenize($0) }
         let options = FormatOptions(explicitSelf: .insert)
         measure {
-            _ = tokens.map { try! format($0, rules: [FormatRules.redundantSelf], options: options) }
+            _ = tokens.map { try! format($0, rules: [.redundantSelf], options: options) }
         }
     }
 
     func testNumberFormatting() {
         let files = PerformanceTests.files
         let tokens = files.map { tokenize($0) }
         measure {
-            _ = tokens.map { try! format($0, rules: [FormatRules.numberFormatting]) }
+            _ = tokens.map { try! format($0, rules: [.numberFormatting]) }
         }
     }
 
@@ -187,7 +187,7 @@ class PerformanceTests: XCTestCase {
             hexGrouping: .group(1, 1)
         )
         measure {
-            _ = tokens.map { try! format($0, rules: [FormatRules.numberFormatting], options: options) }
+            _ = tokens.map { try! format($0, rules: [.numberFormatting], options: options) }
         }
     }
 }

README.md

@@ -915,6 +915,13 @@ Q. I don't want to be surprised by new rules added when I upgrade SwiftFormat. H
 
 > A. Yes, the SwiftFormat framework can be included in an app or test target, and used for many kinds of parsing and processing of Swift source code besides formatting. The SwiftFormat framework is available as a [CocoaPod](https://cocoapods.org/pods/SwiftFormat) for easy integration.
 
+*Q. How to create own rule?*
+
+> A. 1) Open `SwiftFormat.xcodeproj`; 2) Add a rule in `Sources/Rules/..`; 3) Add a test in `Tests/Rules/..`; 4) Add an example in `Sources/Examples.swift`; 5) Run all tests.
+
+*Q. How do I run and debug the command line tool in Xcode while developing a new rule?*
+
+> A. You can run the `swiftformat` command line tool via the `Swift Format (Command Line Tool)` scheme, and you can pass in arguments like `/path/to/my/code --config /path/to/my/config` as the `Arguments Passed On Launch` in Xcode's scheme editor. More instructions are available [here](https://github.com/nicklockwood/SwiftFormat/pull/1804#issuecomment-2263079432).
 
 Known issues
 ---------------
@@ -951,7 +958,13 @@ Known issues
 
 * If you have a generic typealias that defines a closure (e.g. `typealias ResultCompletion<T> = (Result<T, Error>) -> Void`) and use this closure as an argument in a generic function (e.g. `func handle<T: Decodable>(_ completion: ResultCompletion<T>)`), the `opaqueGenericParameters` rule may update the function definition to use `some` syntax (e.g. `func handle(_ completion: ResultCompletion<some Decodable>)`). `some` syntax is not permitted in closure parameters, so this will no longer compile. Workarounds include spelling out the closure explicitly in the generic function (instead of using a `typealias`) or disabling the `opaqueGenericParameters` rule (e.g. with `// swiftformat:disable:next opaqueGenericParameters`).
 
-* If compiling for macOS with Xcode 14.0 and configuring SwiftFormat with `--swift-version 5.7`, the `genericExtensions` rule may cause a build failure by updating extensions of the format `extension Collection where Element == Foo` to `extension Collection<Foo>`. This fails to compile for macOS in Xcode 14.0, because the macOS SDK in that version of Xcode [does not include](https://forums.swift.org/t/xcode-14-rc-cannot-specialize-protocol-type/60171) the Swift 5.7 standard library. Workarounds include using `--swift-version 5.6` instead, updating to Xcode 14.1+, or disabling the `genericExtensions` rule (e.g. with `// swiftformat:next:disable genericExtensions`).
+* If compiling for macOS with Xcode 14.0 and configuring SwiftFormat with `--swift-version 5.7`, the `genericExtensions` rule may cause a build failure by updating extensions of the format `extension Collection where Element == Foo` to `extension Collection<Foo>`. This fails to compile for macOS in Xcode 14.0, because the macOS SDK in that version of Xcode [does not include](https://forums.swift.org/t/xcode-14-rc-cannot-specialize-protocol-type/60171) the Swift 5.7 standard library. Workarounds include using `--swift-version 5.6` instead, updating to Xcode 14.1+, or disabling the `genericExtensions` rule (e.g. with `// swiftformat:disable:next genericExtensions`).
+
+* The `propertyType` rule can cause a build failure in cases where there are multiple static overloads with the same name but different return types. As a workaround you can rename the overloads to no longer conflict, or exclude the property name with `--preservesymbols propertyName,otherPropertyName,etc`.
+
+* The `propertyType` rule can cause a build failure in cases where the property's type is a protocol / existential like `let shapeStyle: ShapeStyle = .myShapeStyle`, and the value used on the right-hand side is defined in an extension like `extension ShapeStyle where Self == MyShapeStyle { static var myShapeStyle: MyShapeStyle { ... } }`. As a workaround you can use the existential `any` syntax (`let shapeStyle: any ShapeStyle = .myShapeStyle`), which the rule will preserve as-is, or exclude the type name and/or property name with `--preservesymbols ShapeStyle,myShapeStyle,etc`.
+
+* The `propertyType` rule can cause a build failure in cases like `let foo = Foo.bar` where the value is a static member that doesn't return the same time. For example, `let foo: Foo = .bar` would be invalid if the `bar` property was defined as `static var bar: Bar`. As a workaround you can write the name of the type explicitly, like `let foo: Bar = Foo.bar`, or exclude the type name and/or property name with `--preservesymbols Bar,bar,etc`.
 
 
 Tip Jar