Update lint configuration

.swift-format

@@ -67,4 +67,4 @@
   "spacesAroundRangeFormationOperators" : false,
   "tabWidth" : 8,
   "version" : 1
-}
+}

Package.swift

@@ -31,6 +31,6 @@ let package = Package(
             name: "TelemetryDeckTests",
             dependencies: ["TelemetryDeck"],
             swiftSettings: [.enableExperimentalFeature("StrictConcurrency")]
-        )
+        ),
     ]
 )

README.md

@@ -142,3 +142,11 @@ This allows for compatibility with other logging solutions, such as [swift-log](
 Your PRs on TelemetryDeck's Swift SDK are very much welcome. Check out the [SwiftClientTester](https://github.com/TelemetryDeck/SwiftClientTester) project, which provides a harness you can use to work on the library and try out new things.
 
 When making a new release, run `./tag-release.sh MAJOR.MINOR.PATCH` to bump the version string in the SDK, create a new commit and tag that commit accordingly all in one step.
+
+The project includes a Makefile at the root with some useful commands:
+
+- `build`: Build the library
+- `lint`:  Applies all auto-correctable lint issues and reformats all source files
+- `test`:  Run unit tests
+
+Before finalising your PR, please run `make lint`.

Sources/TelemetryDeck/Signals/Signal+Helpers.swift

@@ -109,8 +109,7 @@ extension DefaultSignalPayload {
     static var isTestFlight: Bool {
         guard !isDebug, !isSimulator else { return false }
         guard let receiptURL = Bundle.main.appStoreReceiptURL else { return false }
-        return receiptURL.lastPathComponent == "sandboxReceipt" ||
-        receiptURL.path.contains("sandboxReceipt")
+        return receiptURL.lastPathComponent == "sandboxReceipt" || receiptURL.path.contains("sandboxReceipt")
     }
 
     /// Detects if the app is running in an App Store production environment.

Sources/TelemetryDeck/TelemetryClient.swift

@@ -419,19 +419,19 @@ public final class TelemetryManager: @unchecked Sendable {
 
     private var _configuration: TelemetryManagerConfiguration
     var configuration: TelemetryManagerConfiguration {
-        get { queue.sync(flags: .barrier) { return _configuration } }
+        get { queue.sync(flags: .barrier) { _configuration } }
         set { queue.sync(flags: .barrier) { _configuration = newValue } }
     }
 
     private var _lastTimeImmediateSyncRequested: Date = .distantPast
     var lastTimeImmediateSyncRequested: Date {
-        get { queue.sync(flags: .barrier) { return _lastTimeImmediateSyncRequested } }
+        get { queue.sync(flags: .barrier) { _lastTimeImmediateSyncRequested } }
         set { queue.sync(flags: .barrier) { _lastTimeImmediateSyncRequested = newValue } }
     }
 
     private var _lastDateAppEnteredBackground: Date = .distantPast
     private var lastDateAppEnteredBackground: Date {
-        get { queue.sync(flags: .barrier) { return _lastDateAppEnteredBackground } }
+        get { queue.sync(flags: .barrier) { _lastDateAppEnteredBackground } }
         set { queue.sync(flags: .barrier) { _lastDateAppEnteredBackground = newValue } }
     }
 

Tests/TelemetryDeckTests/ArrayExtensionTests.swift

@@ -1,6 +1,7 @@
-@testable import TelemetryDeck
 import Testing
 
+@testable import TelemetryDeck
+
 enum ArrayExtensionTests {
     enum CountISODatesOnOrAfter {
         @Test
@@ -32,7 +33,7 @@ enum ArrayExtensionTests {
                 "2025-01-01",  // Duplicate
                 "2025-02-01",
                 "2025-02-01",  // Duplicate
-                "2025-03-01"
+                "2025-03-01",
             ]
 
             #expect(datesWithDuplicates.countISODatesOnOrAfter(cutoffISODate: "2025-01-01") == 5)
@@ -58,7 +59,7 @@ enum ArrayExtensionTests {
                 "2024-02-28",  // End of February
                 "2024-02-29",  // Leap year day
                 "2024-03-01",  // Start of March
-                "2025-01-01"   // Far future
+                "2025-01-01",  // Far future
             ]
 
             // Test year boundaries

Tests/TelemetryDeckTests/CryptoHashingTests.swift

@@ -1,41 +1,43 @@
-@testable import TelemetryDeck
 import Testing
+
+@testable import TelemetryDeck
+
 #if canImport(CryptoKit)
-import CryptoKit
+    import CryptoKit
 #endif
 
 struct CryptoHashingTests {
     #if canImport(CryptoKit)
-    @Test
-    func cryptoKitAndCommonCryptoHaveSameDigestStringResults() {
-        let stringToHash = "how do i get cowboy paint off a dog ."
-        let dataToHash = stringToHash.data(using: .utf8)!
+        @Test
+        func cryptoKitAndCommonCryptoHaveSameDigestStringResults() {
+            let stringToHash = "how do i get cowboy paint off a dog ."
+            let dataToHash = stringToHash.data(using: .utf8)!
 
-        let expectedDigestString = "5b8fab7cf45fcece0e99a05950611b7b355917e4fb6daa73fd3d7590764fa53b"
+            let expectedDigestString = "5b8fab7cf45fcece0e99a05950611b7b355917e4fb6daa73fd3d7590764fa53b"
 
-        #expect(expectedDigestString == CryptoHashing.sha256(string: stringToHash, salt: ""))
-        #expect(expectedDigestString == CryptoHashing.commonCryptoSha256(strData: dataToHash))
+            #expect(expectedDigestString == CryptoHashing.sha256(string: stringToHash, salt: ""))
+            #expect(expectedDigestString == CryptoHashing.commonCryptoSha256(strData: dataToHash))
 
-        // even though we already test if we can import CryptoKit, somehow this still fails on iOS 12,
-        // so we're gating it to iOS 13 et al.
-        if #available(watchOS 7, iOS 13, macOS 10.14, tvOS 13, *) {
-            // calling directly to prove that CryptoKit produces same reult, as ``sha256(str:)`` can fall back,
-            #expect(expectedDigestString == SHA256.hash(data: dataToHash).compactMap { String(format: "%02x", $0) }.joined())
+            // even though we already test if we can import CryptoKit, somehow this still fails on iOS 12,
+            // so we're gating it to iOS 13 et al.
+            if #available(watchOS 7, iOS 13, macOS 10.14, tvOS 13, *) {
+                // calling directly to prove that CryptoKit produces same reult, as ``sha256(str:)`` can fall back,
+                #expect(expectedDigestString == SHA256.hash(data: dataToHash).compactMap { String(format: "%02x", $0) }.joined())
+            }
         }
-    }
 
-    @Test
-    func saltedResultsAreDifferentFromUnsaltedResults() {
-        let stringToHash = "how do i get cowboy paint off a dog ."
-        let salt = "q8wMvgVW3LzGCRQiLSLk"
-        let expectedDigestString = "d46208db801b09cf055fedd7ae0390e9797fc00d1bcdcb3589ea075ca157e0d6"
+        @Test
+        func saltedResultsAreDifferentFromUnsaltedResults() {
+            let stringToHash = "how do i get cowboy paint off a dog ."
+            let salt = "q8wMvgVW3LzGCRQiLSLk"
+            let expectedDigestString = "d46208db801b09cf055fedd7ae0390e9797fc00d1bcdcb3589ea075ca157e0d6"
 
-        let secondSalt = "x21MTSq3MRSmLjVFsYIe"
-        let expectedSecondDigestString = "acb027bb031c0f73de26c6b8d0441d9c98449d582a538014c44ca49b4c299aa8"
+            let secondSalt = "x21MTSq3MRSmLjVFsYIe"
+            let expectedSecondDigestString = "acb027bb031c0f73de26c6b8d0441d9c98449d582a538014c44ca49b4c299aa8"
 
-        #expect(expectedDigestString == CryptoHashing.sha256(string: stringToHash, salt: salt))
-        #expect(expectedSecondDigestString == CryptoHashing.sha256(string: stringToHash, salt: secondSalt))
-        #expect(CryptoHashing.sha256(string: stringToHash, salt: salt) != CryptoHashing.sha256(string: stringToHash, salt: secondSalt))
-    }
+            #expect(expectedDigestString == CryptoHashing.sha256(string: stringToHash, salt: salt))
+            #expect(expectedSecondDigestString == CryptoHashing.sha256(string: stringToHash, salt: secondSalt))
+            #expect(CryptoHashing.sha256(string: stringToHash, salt: salt) != CryptoHashing.sha256(string: stringToHash, salt: secondSalt))
+        }
     #endif
 }

Tests/TelemetryDeckTests/LogHandlerTests.swift

@@ -1,6 +1,7 @@
-@testable import TelemetryDeck
 import Testing
 
+@testable import TelemetryDeck
+
 actor LogHandlerTests {
     var counter: Int = 0
     var lastLevel: LogHandler.LogLevel?
@@ -17,7 +18,7 @@ actor LogHandlerTests {
                 await self.increment()
             }
         }
-        
+
         #expect(counter == 0)
 
         handler.log(.debug, message: "")
@@ -40,7 +41,7 @@ actor LogHandlerTests {
                 await self.setLastLevel(level)
             }
         }
-        
+
         handler.log(message: "")
         try await Task.sleep(nanoseconds: 10_000_000)  // 10 milliseconds
         #expect(lastLevel == .info)

Tests/TelemetryDeckTests/SignalCacheConcurrencyTests.swift

@@ -86,7 +86,6 @@ struct SignalCacheConcurrencyTests {
         }
     }
 
-
     /// Validates pop() correctly handles concurrent access without data races.
     /// Without barrier on pop(), concurrent calls can corrupt the array.
     /// Run multiple iterations to increase probability of catching race condition.

Tests/TelemetryDeckTests/SignalPayloadTests.swift

@@ -1,6 +1,7 @@
-@testable import TelemetryDeck
 import Testing
 
+@testable import TelemetryDeck
+
 struct DefaultSignalPayloadTests {
     @Test
     func isSimulatorOrTestFlight() {
@@ -68,7 +69,7 @@ struct DefaultSignalPayloadTests {
     @Test
     func operatingSystem() {
         let expectedResult: String
-        
+
         #if os(macOS)
             expectedResult = "macOS"
         #elseif os(iOS)
@@ -84,7 +85,7 @@ struct DefaultSignalPayloadTests {
         #else
             return "Unknown Operating System"
         #endif
-        
+
         #expect(expectedResult == DefaultSignalPayload.operatingSystem)
 
         print("operatingSystem", DefaultSignalPayload.operatingSystem)