Swift format (#165)

* swift-format

* checkout v4

* Add dependabot

* Update validate.sh

* Fix generic parameter 'T' could not be inferred

Author: adam-fowler

.github/dependabot.yml

@@ -0,0 +1,24 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    ignore:
+      - dependency-name: "codecov/codecov-action"
+        update-types: ["version-update:semver-major"]
+    groups:
+      dependencies:
+        patterns:
+          - "*"
+  - package-ecosystem: "swift"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 5
+    allow:
+      - dependency-type: all
+    groups:
+      all-dependencies:
+        patterns:
+          - "*"

.github/workflows/ci.yml

@@ -31,10 +31,9 @@ jobs:
           -instr-profile=.build/debug/codecov/default.profdata > info.lcov
     - name: Upload to codecov.io
       uses: codecov/codecov-action@v4
-      env:
-        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       with:
-        file: info.lcov
+        files: info.lcov
+        token: ${{ secrets.CODECOV_TOKEN }}
 
   ios:
     runs-on: macOS-latest
@@ -94,7 +93,6 @@ jobs:
           -instr-profile .build/debug/codecov/default.profdata > info.lcov
     - name: Upload to codecov.io
       uses: codecov/codecov-action@v4
-      env:
-        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       with:
-        file: info.lcov
+        files: info.lcov
+        token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/validate.yml

@@ -2,18 +2,18 @@ name: Validity Check
 
 on:
   pull_request:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-validate
+  cancel-in-progress: true
 
 jobs:
   validate:
-    runs-on: macOS-latest
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
     steps:
     - name: Checkout
-      uses: actions/checkout@v1
+      uses: actions/checkout@v4
       with:
         fetch-depth: 1
-    - name: Install Dependencies
-      run: |
-        brew install mint
-        mint install nicklockwood/[email protected] --no-link
     - name: run script
       run: ./scripts/validate.sh

.swift-format

@@ -0,0 +1,63 @@
+{
+  "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" : 150,
+  "maximumBlankLines" : 1,
+  "respectsExistingLineBreaks" : true,
+  "prioritizeKeepingFunctionOutputTogether" : true,
+  "multiElementCollectionTrailingCommas" : 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" : false,
+    "NeverUseForceTry" : false,
+    "NeverUseImplicitlyUnwrappedOptionals" : false,
+    "NoAccessLevelOnExtensionDeclaration" : true,
+    "NoAssignmentInExpressions" : true,
+    "NoBlockComments" : true,
+    "NoCasesWithOnlyFallthrough" : true,
+    "NoEmptyTrailingClosureParentheses" : true,
+    "NoLabelsInCasePatterns" : true,
+    "NoLeadingUnderscores" : false,
+    "NoParensAroundConditions" : true,
+    "NoVoidReturnOnFunctionSignature" : true,
+    "OmitExplicitReturns" : true,
+    "OneCasePerLine" : true,
+    "OneVariableDeclarationPerLine" : true,
+    "OnlyOneTrailingClosureArgument" : true,
+    "OrderedImports" : true,
+    "ReplaceForEachWithForLoop" : true,
+    "ReturnVoidInsteadOfEmptyTuple" : true,
+    "UseEarlyExits" : false,
+    "UseExplicitNilCheckInConditions" : false,
+    "UseLetInEveryBoundCaseVariable" : false,
+    "UseShorthandTypeNames" : true,
+    "UseSingleLinePropertyGetter" : false,
+    "UseSynthesizedInitializer" : false,
+    "UseTripleSlashForDocumentationComments" : true,
+    "UseWhereClausesInForLoops" : false,
+    "ValidateDocumentationComments" : false
+  }
+}

.swiftformat

@@ -6,7 +6,7 @@ let package = Package(
     name: "mqtt-nio",
     platforms: [.macOS(.v10_14), .iOS(.v12), .tvOS(.v12), .watchOS(.v6)],
     products: [
-        .library(name: "MQTTNIO", targets: ["MQTTNIO"]),
+        .library(name: "MQTTNIO", targets: ["MQTTNIO"])
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-atomics.git", from: "1.0.0"),

Package.swift

@@ -11,13 +11,14 @@
 //
 //===----------------------------------------------------------------------===//
 
+import NIOCore
+
 #if canImport(FoundationEssentials)
 import Dispatch
 import FoundationEssentials
 #else
 import Foundation
 #endif
-import NIOCore
 
 @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
 extension MQTTClient {
@@ -31,7 +32,7 @@ extension MQTTClient {
     /// - Parameters:
     ///   - queue: Dispatch Queue to run shutdown on
     public func shutdown(queue: DispatchQueue = .global()) async throws {
-        return try await withUnsafeThrowingContinuation { cont in
+        try await withUnsafeThrowingContinuation { (cont: UnsafeContinuation<Void, Error>) in
             self.shutdown(queue: queue) { error in
                 if let error {
                     cont.resume(throwing: error)
@@ -59,7 +60,7 @@ extension MQTTClient {
         cleanSession: Bool = true,
         will: (topicName: String, payload: ByteBuffer, qos: MQTTQoS, retain: Bool)? = nil
     ) async throws -> Bool {
-        return try await self.connect(cleanSession: cleanSession, will: will).get()
+        try await self.connect(cleanSession: cleanSession, will: will).get()
     }
 
     /// Connect to MQTT server
@@ -80,10 +81,11 @@ extension MQTTClient {
         will: (topicName: String, payload: ByteBuffer, qos: MQTTQoS, retain: Bool)? = nil,
         connectConfiguration: ConnectConfiguration
     ) async throws -> Bool {
-        return try await self.connect(
+        try await self.connect(
             cleanSession: cleanSession,
-            will: will, connectConfiguration:
-            connectConfiguration
+            will: will,
+            connectConfiguration:
+                connectConfiguration
         ).get()
     }
 
@@ -101,23 +103,23 @@ extension MQTTClient {
     ///     - qos: Quality of Service for message.
     ///     - retain: Whether this is a retained message.
     public func publish(to topicName: String, payload: ByteBuffer, qos: MQTTQoS, retain: Bool = false) async throws {
-        return try await self.publish(to: topicName, payload: payload, qos: qos, retain: retain).get()
+        try await self.publish(to: topicName, payload: payload, qos: qos, retain: retain).get()
     }
 
     /// Subscribe to topic
     ///
     /// Completes when SUBACK is received
     /// - Parameter subscriptions: Subscription infos
     public func subscribe(to subscriptions: [MQTTSubscribeInfo]) async throws -> MQTTSuback {
-        return try await self.subscribe(to: subscriptions).get()
+        try await self.subscribe(to: subscriptions).get()
     }
 
     /// Unsubscribe from topic
     ///
     /// Completes when UNSUBACK is received
     /// - Parameter subscriptions: List of subscriptions to unsubscribe from
     public func unsubscribe(from subscriptions: [String]) async throws {
-        return try await self.unsubscribe(from: subscriptions).get()
+        try await self.unsubscribe(from: subscriptions).get()
     }
 
     /// Ping the server to test if it is still alive and to tell it you are alive.
@@ -128,12 +130,12 @@ extension MQTTClient {
     /// the connection is still live. If you initialize the client with the configuration `disablePingReq: true` then these
     /// are disabled and it is up to you to send the PINGREQ messages yourself
     public func ping() async throws {
-        return try await self.ping().get()
+        try await self.ping().get()
     }
 
     /// Disconnect from server
     public func disconnect() async throws {
-        return try await self.disconnect().get()
+        try await self.disconnect().get()
     }
 
     /// Create a publish listener AsyncSequence that yields a result whenever a PUBLISH message is received from the server
@@ -153,7 +155,7 @@ extension MQTTClient {
     /// }
     /// ```
     public func createPublishListener() -> MQTTPublishListener {
-        return .init(self)
+        .init(self)
     }
 }
 
@@ -187,6 +189,6 @@ public class MQTTPublishListener: AsyncSequence {
     }
 
     public __consuming func makeAsyncIterator() -> AsyncStream<Element>.AsyncIterator {
-        return self.stream.makeAsyncIterator()
+        self.stream.makeAsyncIterator()
     }
 }

Sources/MQTTNIO/AsyncAwaitSupport/MQTTClient+async.swift

@@ -11,12 +11,13 @@
 //
 //===----------------------------------------------------------------------===//
 
+import NIOCore
+
 #if canImport(FoundationEssentials)
 import FoundationEssentials
 #else
 import Foundation
 #endif
-import NIOCore
 
 @available(macOS 12.0, iOS 15.0, watchOS 8.0, tvOS 15.0, *)
 extension MQTTClient.V5 {
@@ -42,7 +43,7 @@ extension MQTTClient.V5 {
         will: (topicName: String, payload: ByteBuffer, qos: MQTTQoS, retain: Bool, properties: MQTTProperties)? = nil,
         authWorkflow: ((MQTTAuthV5, EventLoop) -> EventLoopFuture<MQTTAuthV5>)? = nil
     ) async throws -> MQTTConnackV5 {
-        return try await self.connect(cleanStart: cleanStart, properties: properties, will: will, authWorkflow: authWorkflow).get()
+        try await self.connect(cleanStart: cleanStart, properties: properties, will: will, authWorkflow: authWorkflow).get()
     }
 
     /// Connect to MQTT server
@@ -69,7 +70,7 @@ extension MQTTClient.V5 {
         authWorkflow: ((MQTTAuthV5, EventLoop) -> EventLoopFuture<MQTTAuthV5>)? = nil,
         connectConfiguration: MQTTClient.ConnectConfiguration
     ) async throws -> MQTTConnackV5 {
-        return try await self.connect(
+        try await self.connect(
             cleanStart: cleanStart,
             properties: properties,
             will: will,
@@ -95,7 +96,7 @@ extension MQTTClient.V5 {
         retain: Bool = false,
         properties: MQTTProperties = .init()
     ) async throws -> MQTTAckV5? {
-        return try await self.publish(to: topicName, payload: payload, qos: qos, retain: retain, properties: properties).get()
+        try await self.publish(to: topicName, payload: payload, qos: qos, retain: retain, properties: properties).get()
     }
 
     /// Subscribe to topic
@@ -108,7 +109,7 @@ extension MQTTClient.V5 {
         to subscriptions: [MQTTSubscribeInfoV5],
         properties: MQTTProperties = .init()
     ) async throws -> MQTTSubackV5 {
-        return try await self.subscribe(to: subscriptions, properties: properties).get()
+        try await self.subscribe(to: subscriptions, properties: properties).get()
     }
 
     /// Unsubscribe from topic
@@ -121,14 +122,14 @@ extension MQTTClient.V5 {
         from subscriptions: [String],
         properties: MQTTProperties = .init()
     ) async throws -> MQTTSubackV5 {
-        return try await self.unsubscribe(from: subscriptions, properties: properties).get()
+        try await self.unsubscribe(from: subscriptions, properties: properties).get()
     }
 
     /// Disconnect from server
     /// - Parameter properties: properties to attach to disconnect packet
     /// - Returns: Future waiting on disconnect message to be sent
     public func disconnect(properties: MQTTProperties = .init()) async throws {
-        return try await self.disconnect(properties: properties).get()
+        try await self.disconnect(properties: properties).get()
     }
 
     /// Re-authenticate with server
@@ -141,13 +142,13 @@ extension MQTTClient.V5 {
         properties: MQTTProperties,
         authWorkflow: ((MQTTAuthV5, EventLoop) -> EventLoopFuture<MQTTAuthV5>)? = nil
     ) async throws -> MQTTAuthV5 {
-        return try await self.auth(properties: properties, authWorkflow: authWorkflow).get()
+        try await self.auth(properties: properties, authWorkflow: authWorkflow).get()
     }
 
     /// Create a publish listener AsyncSequence that yields a value whenever a PUBLISH message is received from the server
     /// with the specified subscription id
     public func createPublishListener(subscriptionId: UInt) -> MQTTPublishIdListener {
-        return .init(self, subscriptionId: subscriptionId)
+        .init(self, subscriptionId: subscriptionId)
     }
 }
 
@@ -181,6 +182,6 @@ public class MQTTPublishIdListener: AsyncSequence {
     }
 
     public __consuming func makeAsyncIterator() -> AsyncStream<Element>.AsyncIterator {
-        return self.stream.makeAsyncIterator()
+        self.stream.makeAsyncIterator()
     }
 }