Introduce .swift-format and enable linting requirement on PR requests (#162)

* Introduce .swift-format and enable linting requirement on PR requests

* Update spacesAroundRangeFormationOperators to false

Author: iCharlesHu

.github/workflows/pull_request.yml

@@ -28,14 +28,14 @@ jobs:
           # Test dependencies
           yum install -y procps
         fi
-      linux_build_command: 'swift test && swift test --disable-default-traits'
+      linux_build_command: 'swift-format lint -s -r --configuration ./.swift-format . && swift test && swift test --disable-default-traits'
       windows_swift_versions: '["6.1", "nightly-main"]'
       windows_build_command: |
         Invoke-Program swift test
         Invoke-Program swift test --disable-default-traits
       enable_macos_checks: true
       macos_xcode_versions: '["16.3"]'
-      macos_build_command: 'xcrun swift test && xcrun swift test --disable-default-traits'
+      macos_build_command: 'xcrun swift-format lint -s -r --configuration ./.swift-format . && xcrun swift test && xcrun swift test --disable-default-traits'
       enable_linux_static_sdk_build: true
       linux_static_sdk_versions: '["6.1", "nightly-6.2"]'
       linux_static_sdk_build_command: |

.swift-format

@@ -0,0 +1,74 @@
+{
+    "fileScopedDeclarationPrivacy": {
+        "accessLevel": "private"
+    },
+    "indentConditionalCompilationBlocks": false,
+    "indentSwitchCaseLabels": false,
+    "indentation": {
+        "spaces": 4
+    },
+    "lineBreakAroundMultilineExpressionChainComponents": false,
+    "lineBreakBeforeControlFlowKeywords": false,
+    "lineBreakBeforeEachArgument": false,
+    "lineBreakBeforeEachGenericRequirement": false,
+    "lineBreakBetweenDeclarationAttributes": false,
+    "lineLength": 9999,
+    "maximumBlankLines": 1,
+    "multiElementCollectionTrailingCommas": true,
+    "noAssignmentInExpressions": {
+        "allowedFunctions": [
+            "XCTAssertNoThrow"
+        ]
+    },
+    "prioritizeKeepingFunctionOutputTogether": false,
+    "respectsExistingLineBreaks": true,
+    "rules": {
+        "AllPublicDeclarationsHaveDocumentation": false,
+        "AlwaysUseLiteralForEmptyCollectionInit": false,
+        "AlwaysUseLowerCamelCase": false,
+        "AmbiguousTrailingClosureOverload": false,
+        "AvoidRetroactiveConformances": false,
+        "BeginDocumentationCommentWithOneLineSummary": false,
+        "DoNotUseSemicolons": false,
+        "DontRepeatTypeInStaticProperties": false,
+        "FileScopedDeclarationPrivacy": false,
+        "FullyIndirectEnum": false,
+        "GroupNumericLiterals": false,
+        "IdentifiersMustBeASCII": false,
+        "NeverForceUnwrap": false,
+        "NeverUseForceTry": false,
+        "NeverUseImplicitlyUnwrappedOptionals": false,
+        "NoAccessLevelOnExtensionDeclaration": false,
+        "NoAssignmentInExpressions": false,
+        "NoBlockComments": false,
+        "NoCasesWithOnlyFallthrough": false,
+        "NoEmptyLinesOpeningClosingBraces": false,
+        "NoEmptyTrailingClosureParentheses": false,
+        "NoLabelsInCasePatterns": false,
+        "NoLeadingUnderscores": false,
+        "NoParensAroundConditions": false,
+        "NoPlaygroundLiterals": false,
+        "NoVoidReturnOnFunctionSignature": false,
+        "OmitExplicitReturns": false,
+        "OneCasePerLine": false,
+        "OneVariableDeclarationPerLine": false,
+        "OnlyOneTrailingClosureArgument": false,
+        "OrderedImports": false,
+        "ReplaceForEachWithForLoop": false,
+        "ReturnVoidInsteadOfEmptyTuple": false,
+        "TypeNamesShouldBeCapitalized": false,
+        "UseEarlyExits": false,
+        "UseExplicitNilCheckInConditions": false,
+        "UseLetInEveryBoundCaseVariable": false,
+        "UseShorthandTypeNames": false,
+        "UseSingleLinePropertyGetter": false,
+        "UseSynthesizedInitializer": false,
+        "UseTripleSlashForDocumentationComments": false,
+        "UseWhereClausesInForLoops": false,
+        "ValidateDocumentationComments": false
+    },
+    "spacesAroundRangeFormationOperators": false,
+    "spacesBeforeEndOfLineComments": 1,
+    "tabWidth": 4,
+    "version": 1
+}

Package.swift

@@ -56,7 +56,7 @@ let package = Package(
                 .product(name: "SystemPackage", package: "swift-system"),
             ],
             path: "Sources/Subprocess",
-            exclude: [ "CMakeLists.txt" ],
+            exclude: ["CMakeLists.txt"],
             swiftSettings: [
                 .enableExperimentalFeature("StrictConcurrency"),
                 .enableExperimentalFeature("NonescapableTypes"),
@@ -73,7 +73,7 @@ let package = Package(
                 .product(name: "SystemPackage", package: "swift-system"),
             ],
             swiftSettings: [
-                .enableExperimentalFeature("Span"),
+                .enableExperimentalFeature("Span")
             ] + packageSwiftSettings
         ),
 
@@ -91,7 +91,7 @@ let package = Package(
         .target(
             name: "_SubprocessCShims",
             path: "Sources/_SubprocessCShims",
-            exclude: [ "CMakeLists.txt" ]
+            exclude: ["CMakeLists.txt"]
         ),
     ]
 )

Sources/Subprocess/API.swift

@@ -133,8 +133,7 @@ public func run<
         standardError: result.value.standardError
     )
 }
-#endif  // SubprocessSpan
-
+#endif // SubprocessSpan
 
 // MARK: - Custom Execution Body
 

Sources/Subprocess/AsyncBufferSequence.swift

@@ -192,10 +192,10 @@ extension AsyncBufferSequence {
                 }
 
                 // https://en.wikipedia.org/wiki/Newline#Unicode
-                let lineFeed            = Encoding.CodeUnit(0x0A)
+                let lineFeed = Encoding.CodeUnit(0x0A)
                 /// let verticalTab     = Encoding.CodeUnit(0x0B)
                 /// let formFeed        = Encoding.CodeUnit(0x0C)
-                let carriageReturn      = Encoding.CodeUnit(0x0D)
+                let carriageReturn = Encoding.CodeUnit(0x0D)
                 // carriageReturn + lineFeed
                 let newLine1: Encoding.CodeUnit
                 let newLine2: Encoding.CodeUnit
@@ -207,24 +207,24 @@ extension AsyncBufferSequence {
                 let paragraphSeparator3: Encoding.CodeUnit
                 switch Encoding.CodeUnit.self {
                 case is UInt8.Type:
-                    newLine1            = Encoding.CodeUnit(0xC2)
-                    newLine2            = Encoding.CodeUnit(0x85)
+                    newLine1 = Encoding.CodeUnit(0xC2)
+                    newLine2 = Encoding.CodeUnit(0x85)
 
-                    lineSeparator1      = Encoding.CodeUnit(0xE2)
-                    lineSeparator2      = Encoding.CodeUnit(0x80)
-                    lineSeparator3      = Encoding.CodeUnit(0xA8)
+                    lineSeparator1 = Encoding.CodeUnit(0xE2)
+                    lineSeparator2 = Encoding.CodeUnit(0x80)
+                    lineSeparator3 = Encoding.CodeUnit(0xA8)
 
                     paragraphSeparator1 = Encoding.CodeUnit(0xE2)
                     paragraphSeparator2 = Encoding.CodeUnit(0x80)
                     paragraphSeparator3 = Encoding.CodeUnit(0xA9)
                 case is UInt16.Type, is UInt32.Type:
                     // UTF16 and UTF32 use one byte for all
-                    newLine1            = Encoding.CodeUnit(0x0085)
-                    newLine2            = Encoding.CodeUnit(0x0085)
+                    newLine1 = Encoding.CodeUnit(0x0085)
+                    newLine2 = Encoding.CodeUnit(0x0085)
 
-                    lineSeparator1      = Encoding.CodeUnit(0x2028)
-                    lineSeparator2      = Encoding.CodeUnit(0x2028)
-                    lineSeparator3      = Encoding.CodeUnit(0x2028)
+                    lineSeparator1 = Encoding.CodeUnit(0x2028)
+                    lineSeparator2 = Encoding.CodeUnit(0x2028)
+                    lineSeparator3 = Encoding.CodeUnit(0x2028)
 
                     paragraphSeparator1 = Encoding.CodeUnit(0x2029)
                     paragraphSeparator2 = Encoding.CodeUnit(0x2029)
@@ -285,7 +285,7 @@ extension AsyncBufferSequence {
                             continue
                         }
                         return yield()
-                    case lineFeed ..< carriageReturn, newLine1, lineSeparator1, paragraphSeparator1:
+                    case lineFeed..<carriageReturn, newLine1, lineSeparator1, paragraphSeparator1:
                         return yield()
                     default:
                         continue
@@ -361,7 +361,7 @@ private let _pageSize: Int = Int(getpagesize())
 private let _pageSize: Int = Int(getpagesize())
 #elseif canImport(C)
 private let _pageSize: Int = Int(getpagesize())
-#endif  // canImport(Darwin)
+#endif // canImport(Darwin)
 
 @inline(__always)
 internal var readBufferSize: Int {

Sources/Subprocess/Buffer.swift

@@ -13,7 +13,6 @@
 @preconcurrency internal import Dispatch
 #endif
 
-
 extension AsyncBufferSequence {
     /// A immutable collection of bytes
     public struct Buffer: Sendable {
@@ -33,7 +32,7 @@ extension AsyncBufferSequence {
             if _fastPath(slices.count == 1) {
                 return [.init(data: slices[0], backingData: data)]
             }
-            return slices.map{ .init(data: $0, backingData: data) }
+            return slices.map { .init(data: $0, backingData: data) }
         }
         #else
         internal let data: [UInt8]
@@ -78,6 +77,7 @@ extension AsyncBufferSequence.Buffer {
     }
 
     #if SubprocessSpan
+    // swift-format-ignore
     // Access the storage backing this Buffer
     public var bytes: RawSpan {
         @lifetime(borrow self)
@@ -87,7 +87,7 @@ extension AsyncBufferSequence.Buffer {
             return _overrideLifetime(of: bytes, to: self)
         }
     }
-    #endif  // SubprocessSpan
+    #endif // SubprocessSpan
 }
 
 // MARK: - Hashable, Equatable

Sources/Subprocess/Configuration.swift

@@ -404,7 +404,7 @@ extension Environment: CustomStringConvertible, CustomDebugStringConvertible {
                 if environmentString.utf8.first == Character("=").utf8.first {
                     continue
                 }
-                #endif  // os(Windows)
+                #endif // os(Windows)
 
                 guard let delimiter = environmentString.firstIndex(of: "=") else {
                     continue
@@ -509,17 +509,17 @@ internal enum StringOrRawBytes: Sendable, Hashable {
     func createRawBytes() -> UnsafeMutablePointer<CChar> {
         switch self {
         case .string(let string):
-#if os(Windows)
+            #if os(Windows)
             return _strdup(string)
-#else
+            #else
             return strdup(string)
-#endif
+            #endif
         case .rawBytes(let rawBytes):
-#if os(Windows)
+            #if os(Windows)
             return _strdup(rawBytes)
-#else
+            #else
             return strdup(rawBytes)
-#endif
+            #endif
         }
     }
 
@@ -1026,11 +1026,10 @@ internal struct _OrderedSet<Element: Hashable & Sendable>: Hashable, Sendable {
     }
 }
 
-extension _OrderedSet : Sequence {
+extension _OrderedSet: Sequence {
     typealias Iterator = Array<Element>.Iterator
 
     internal func makeIterator() -> Iterator {
         return self.elements.makeIterator()
     }
 }
-

Sources/Subprocess/IO/AsyncIO+Dispatch.swift

@@ -27,7 +27,7 @@ final class AsyncIO: Sendable {
 
     internal init() {}
 
-    internal func shutdown() { /* noop on Darwin */ }
+    internal func shutdown() { /* noop on Darwin */  }
 
     internal func read(
         from diskIO: borrowing IOChannel,
@@ -104,7 +104,7 @@ final class AsyncIO: Sendable {
             }
         }
     }
-    #endif  // SubprocessSpan
+    #endif // SubprocessSpan
 
     internal func write(
         _ array: [UInt8],
@@ -167,7 +167,7 @@ final class AsyncIO: Sendable {
 }
 
 #if !canImport(Darwin)
-extension DispatchData: @retroactive @unchecked Sendable { }
+extension DispatchData: @retroactive @unchecked Sendable {}
 #endif
 
 #endif