swift-format (#3)

* swift-format

* Update Makefile

* Update Makefile

* gh-workflow script

* fix linter

Author: Alexander-Ignition

.editorconfig

@@ -9,3 +9,7 @@ trim_trailing_whitespace = true
 
 [Makefile]
 indent_style = tab
+
+[*.yml]
+indent_style = space
+indent_size = 2

.github/workflows/test.yml

@@ -35,7 +35,7 @@ jobs:
             target: test-ios
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Build and test
         run: make ${{ matrix.target }}
         shell: bash
@@ -44,7 +44,15 @@ jobs:
     runs-on: macOS-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Build and test
         run: swift test
         shell: bash
+  Lint:
+    runs-on: macOS-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: swift-format lint
+        run: make lint 2>&1 | Scripts/gh-workflow.swift
+        shell: bash

.swift-format

@@ -0,0 +1,59 @@
+{
+    "version" : 1,
+    "indentation" : {
+        "spaces" : 4
+    },
+    "tabWidth" : 4,
+    "fileScopedDeclarationPrivacy" : {
+        "accessLevel" : "private"
+    },
+    "spacesAroundRangeFormationOperators" : false,
+    "indentConditionalCompilationBlocks" : false,
+    "indentSwitchCaseLabels" : false,
+    "lineBreakAroundMultilineExpressionChainComponents" : false,
+    "lineBreakBeforeControlFlowKeywords" : false,
+    "lineBreakBeforeEachArgument" : true,
+    "lineBreakBeforeEachGenericRequirement" : true,
+    "lineLength" : 120,
+    "maximumBlankLines" : 1,
+    "respectsExistingLineBreaks" : true,
+    "prioritizeKeepingFunctionOutputTogether" : true,
+    "rules" : {
+        "AllPublicDeclarationsHaveDocumentation" : false,
+        "AlwaysUseLiteralForEmptyCollectionInit" : false,
+        "AlwaysUseLowerCamelCase" : false,
+        "AmbiguousTrailingClosureOverload" : true,
+        "BeginDocumentationCommentWithOneLineSummary" : false,
+        "DoNotUseSemicolons" : true,
+        "DontRepeatTypeInStaticProperties" : true,
+        "FileScopedDeclarationPrivacy" : true,
+        "FullyIndirectEnum" : true,
+        "GroupNumericLiterals" : true,
+        "IdentifiersMustBeASCII" : true,
+        "NeverForceUnwrap" : true,
+        "NeverUseForceTry" : true,
+        "NeverUseImplicitlyUnwrappedOptionals" : false,
+        "NoAssignmentInExpressions" : true,
+        "NoCasesWithOnlyFallthrough" : true,
+        "NoEmptyTrailingClosureParentheses" : true,
+        "NoLabelsInCasePatterns" : true,
+        "NoLeadingUnderscores" : false,
+        "NoParensAroundConditions" : true,
+        "NoVoidReturnOnFunctionSignature" : true,
+        "OmitExplicitReturns" : true,
+        "OneCasePerLine" : true,
+        "OneVariableDeclarationPerLine" : true,
+        "OnlyOneTrailingClosureArgument" : true,
+        "OrderedImports" : true,
+        "ReturnVoidInsteadOfEmptyTuple" : true,
+        "UseEarlyExits" : false,
+        "UseExplicitNilCheckInConditions" : false,
+        "UseLetInEveryBoundCaseVariable" : false,
+        "UseShorthandTypeNames" : true,
+        "UseSingleLinePropertyGetter" : false,
+        "UseSynthesizedInitializer" : false,
+        "UseTripleSlashForDocumentationComments" : true,
+        "UseWhereClausesInForLoops" : false,
+        "ValidateDocumentationComments" : false
+    }
+}

Makefile

@@ -8,6 +8,14 @@ clean:
 	swift package clean
 	rm -rf $(OUTPUD_DIR)
 
+# MARK: - format
+
+lint:
+	xcrun swift-format lint --recursive --strict ./
+
+format:
+	xcrun swift-format --recursive --in-place  ./
+
 # MARK: - Tests
 
 test:

Package.swift

@@ -12,14 +12,17 @@ let package = Package(
     products: [
         .library(
             name: "SQLime",
-            targets: ["SQLime"]),
+            targets: ["SQLime"]
+        )
     ],
     targets: [
         .target(
             name: "SQLime",
-            dependencies: []),
+            dependencies: []
+        ),
         .testTarget(
             name: "SQLimeTests",
-            dependencies: ["SQLime"]),
+            dependencies: ["SQLime"]
+        ),
     ]
 )

Playgrounds/Example.playground/Contents.swift

@@ -2,7 +2,8 @@
  # 🍋 SQLime
  */
 import Foundation
-import SQLime // open Package.swift and select Playgrounds/Example
+import SQLime  // open Package.swift and select Playgrounds/Example
+
 /*:
  ## Open
 
@@ -17,12 +18,14 @@ let database = try Database.open(
 
  Create table for contacts with fileds `id` and `name`.
  */
-try database.execute("""
-CREATE TABLE contacts(
-    id INT PRIMARY KEY NOT NULL,
-    name CHAR(255)
-);
-""")
+try database.execute(
+    """
+    CREATE TABLE contacts(
+        id INT PRIMARY KEY NOT NULL,
+        name CHAR(255)
+    );
+    """
+)
 /*:
  ## Insert
 

Scripts/gh-workflow.swift

@@ -0,0 +1,16 @@
+#!/usr/bin/env swift
+
+// Workflow commands for GitHub Actions
+// https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions
+// Usage: xcrun swift-format lint --recursive --strict ./ 2>&1 | Scripts/gh-workflow.swift
+// Test: echo "Sources/SQLime/SQLParameter.swift:23:1: warning: [TrailingWhitespace] remove trailing whitespace" | Scripts/gh-workflow.swift
+
+let regex = #/(?<file>.+\.swift):(?<line>\d+):(?<column>\d+): (?<severity>.+): \[(?<title>.+)\] (?<message>.+)/#
+while let line = readLine() {
+    if let match = try? regex.firstMatch(in: line) {
+        let (_, file, line, column, severity, title, message) = match.output
+        print("::\(severity) file=\(file),line=\(line),col=\(column),title=\(title)::\(message)")
+    } else {
+        print(line)
+    }
+}

Sources/SQLime/CString.swift

@@ -1,4 +1,4 @@
-extension Optional<UnsafePointer<CChar>> {
+extension UnsafePointer<CChar>? {
     @inlinable
     var string: String? {
         self.map { String(cString: $0) }

Sources/SQLime/Database.swift

@@ -93,10 +93,10 @@ public final class Database {
 
     /// Compiling an SQL statement.
     public func prepare(_ sql: String, parameters: [SQLParameter?]) throws -> PreparedStatement {
-        var stmt: OpaquePointer?
+        var stmt: OpaquePointer!
         let code = sqlite3_prepare_v2(db, sql, -1, &stmt, nil)
         try check(code)
-        let statement = PreparedStatement(stmt: stmt!)
+        let statement = PreparedStatement(stmt: stmt)
         try statement.bind(parameters: parameters)
         return statement
     }

Sources/SQLime/StatementDecoder.swift

@@ -35,7 +35,7 @@ final class _StatementDecoder: Decoder {
         self.codingPath = codingPath
     }
 
-    func container<Key>(keyedBy type: Key.Type) throws -> KeyedDecodingContainer<Key> where Key : CodingKey {
+    func container<Key>(keyedBy type: Key.Type) throws -> KeyedDecodingContainer<Key> where Key: CodingKey {
         let container = KeyedContainer<Key>(context: context, codingPath: codingPath)
         return KeyedDecodingContainer(container)
     }
@@ -95,7 +95,7 @@ extension _StatementDecoder {
                 throw DecodingError.valueNotFound(type, codingPath: codingPath + [key])
             }
             guard let number = Float(exactly: value) else {
-                throw DecodingError.numberNotFit(type, value: value.description, codingPath: codingPath + [key])
+                throw DecodingError.numberNotFit(type, value: value.description, path: codingPath + [key])
             }
             return number
         }
@@ -140,7 +140,7 @@ extension _StatementDecoder {
             try integer(type, forKey: key)
         }
 
-        func decode<T>(_ type: T.Type, forKey key: Key) throws -> T where T : Decodable {
+        func decode<T>(_ type: T.Type, forKey key: Key) throws -> T where T: Decodable {
             // TODO: Data
             let decoder = _StatementDecoder(context: context, codingPath: codingPath + [key])
             return try type.init(from: decoder)
@@ -149,7 +149,7 @@ extension _StatementDecoder {
         func nestedContainer<NestedKey>(
             keyedBy type: NestedKey.Type,
             forKey key: Key
-        ) throws -> KeyedDecodingContainer<NestedKey> where NestedKey : CodingKey {
+        ) throws -> KeyedDecodingContainer<NestedKey> where NestedKey: CodingKey {
             fatalError()
         }
 
@@ -171,7 +171,7 @@ extension _StatementDecoder {
                 throw DecodingError.valueNotFound(type, codingPath: codingPath + [key])
             }
             guard let number = type.init(exactly: value) else {
-                throw DecodingError.numberNotFit(type, value: value.description, codingPath: codingPath + [key])
+                throw DecodingError.numberNotFit(type, value: value.description, path: codingPath + [key])
             }
             return number
         }
@@ -187,7 +187,7 @@ extension _StatementDecoder {
         func decodeNil() -> Bool {
             context.statement.null(for: key)
         }
-        
+
         func decode(_ type: Bool.Type) throws -> Bool {
             guard let value = context.statement.int64(for: key) else {
                 throw DecodingError.valueNotFound(type, codingPath: codingPath)
@@ -201,64 +201,64 @@ extension _StatementDecoder {
             }
             return value
         }
-        
+
         func decode(_ type: Double.Type) throws -> Double {
             guard let value = context.statement.double(for: key) else {
                 throw DecodingError.valueNotFound(type, codingPath: codingPath)
             }
             return value
         }
-        
+
         func decode(_ type: Float.Type) throws -> Float {
             guard let value = context.statement.double(for: key) else {
                 throw DecodingError.valueNotFound(type, codingPath: codingPath)
             }
             guard let number = Float(exactly: value) else {
-                throw DecodingError.numberNotFit(type, value: value.description, codingPath: codingPath)
+                throw DecodingError.numberNotFit(type, value: value.description, path: codingPath)
             }
             return number
         }
-        
+
         func decode(_ type: Int.Type) throws -> Int {
             try integer(type)
         }
-        
+
         func decode(_ type: Int8.Type) throws -> Int8 {
             try integer(type)
         }
-        
+
         func decode(_ type: Int16.Type) throws -> Int16 {
             try integer(type)
         }
-        
+
         func decode(_ type: Int32.Type) throws -> Int32 {
             try integer(type)
         }
-        
+
         func decode(_ type: Int64.Type) throws -> Int64 {
             try integer(type)
         }
-        
+
         func decode(_ type: UInt.Type) throws -> UInt {
             try integer(type)
         }
-        
+
         func decode(_ type: UInt8.Type) throws -> UInt8 {
             try integer(type)
         }
-        
+
         func decode(_ type: UInt16.Type) throws -> UInt16 {
             try integer(type)
         }
-        
+
         func decode(_ type: UInt32.Type) throws -> UInt32 {
             try integer(type)
         }
 
         func decode(_ type: UInt64.Type) throws -> UInt64 {
             try integer(type)
         }
-        
+
         func decode<T>(_ type: T.Type) throws -> T where T: Decodable {
             // TODO: Data
             let decoder = _StatementDecoder(context: context, codingPath: codingPath)
@@ -271,7 +271,7 @@ extension _StatementDecoder {
                 throw DecodingError.valueNotFound(type, codingPath: codingPath)
             }
             guard let number = type.init(exactly: value) else {
-                throw DecodingError.numberNotFit(type, value: value.description, codingPath: codingPath)
+                throw DecodingError.numberNotFit(type, value: value.description, path: codingPath)
             }
             return number
         }
@@ -284,8 +284,8 @@ extension DecodingError {
         return DecodingError.valueNotFound(type, context)
     }
 
-    fileprivate static func numberNotFit(_ type: Any.Type, value: String, codingPath: [any CodingKey]) -> DecodingError {
-        dataCorrupted(codingPath: codingPath, "Parsed JSON number <\(value)> does not fit in \(type).")
+    fileprivate static func numberNotFit(_ type: Any.Type, value: String, path: [any CodingKey]) -> DecodingError {
+        dataCorrupted(codingPath: path, "Parsed JSON number <\(value)> does not fit in \(type).")
     }
 
     fileprivate static func dataCorrupted(codingPath: [any CodingKey], _ message: String) -> DecodingError {