Add SwiftLint Plugin (#7)

* Add SwiftLint

* Fix warning

* Only use SwiftLint plugin on macOS

* Specify LambdaExtras as the default docs

Author: mgacy

.spi.yml

@@ -1,4 +1,4 @@
 version: 1
 builder:
   configs:
-    - documentation_targets: [LambdaExtrasCore, LambdaExtras, LambdaMocks]
+    - documentation_targets: [LambdaExtras, LambdaExtrasCore, LambdaMocks]

.swiftlint.yml

@@ -0,0 +1,58 @@
+excluded:
+  - .build
+
+opt_in_rules:
+  - empty_count
+  - explicit_init
+  - closure_spacing
+  - overridden_super_call
+  - redundant_nil_coalescing
+  - private_outlet
+  - nimble_operator
+  - attributes
+  - operator_usage_whitespace
+  - closure_end_indentation
+  - first_where
+  - prohibited_super_call
+  - fatal_error_message
+  - vertical_parameter_alignment_on_call
+  - let_var_whitespace
+  - unneeded_parentheses_in_closure_argument
+  - extension_access_modifier
+  - pattern_matching_keywords
+  - array_init
+  - literal_expression_end_indentation
+
+disabled_rules:
+  - void_return
+  - multiple_closures_with_trailing_closure
+  - vertical_parameter_alignment_on_call
+
+identifier_name:
+  excluded:
+    - id
+
+type_name:
+  excluded:
+    - ID
+
+function_body_length: 50
+
+line_length: 200
+
+file_length:
+    warning: 500
+    error: 1000
+
+nesting:
+  type_level:
+    warning: 2
+  function_level:
+    warning: 10
+
+large_tuple:
+  warning: 6
+  error: 10
+
+cyclomatic_complexity:
+  ignores_case_statements: true

Package.resolved

@@ -20,27 +20,6 @@ let package = Package(
         .package(url: "https://github.com/swift-server/swift-aws-lambda-runtime.git", branch: "main")
     ],
     targets: [
-        .target(
-            name: "LambdaExtrasCore",
-            dependencies: [
-                .product(name: "Logging", package: "swift-log"),
-                .product(name: "NIOCore", package: "swift-nio")
-            ]
-        ),
-        .target(
-            name: "LambdaExtras",
-            dependencies: [
-                "LambdaExtrasCore",
-                .product(name: "AWSLambdaRuntime",package: "swift-aws-lambda-runtime"),
-                .product(name: "AWSLambdaEvents", package: "swift-aws-lambda-events")
-            ]
-        ),
-        .target(
-            name: "LambdaMocks",
-            dependencies: [
-                "LambdaExtrasCore"
-            ]
-        ),
         .testTarget(
             name: "LambdaExtrasTests",
             dependencies: [
@@ -49,3 +28,36 @@ let package = Package(
         )
     ]
 )
+
+let genericTargets: [Target] = [
+    .target(
+        name: "LambdaExtrasCore",
+        dependencies: [
+            .product(name: "Logging", package: "swift-log"),
+            .product(name: "NIOCore", package: "swift-nio")
+        ]
+    ),
+    .target(
+        name: "LambdaExtras",
+        dependencies: [
+            "LambdaExtrasCore",
+            .product(name: "AWSLambdaRuntime",package: "swift-aws-lambda-runtime"),
+            .product(name: "AWSLambdaEvents", package: "swift-aws-lambda-events")
+        ]
+    ),
+    .target(
+        name: "LambdaMocks",
+        dependencies: [
+            "LambdaExtrasCore"
+        ]
+    )
+]
+
+#if os(macOS)
+package.dependencies.append(.package(url: "https://github.com/realm/SwiftLint.git", exact: "0.54.0"))
+for target in genericTargets {
+    target.plugins = [.plugin(name: "SwiftLintPlugin", package: "SwiftLint")]
+}
+#endif
+
+package.targets.append(contentsOf: genericTargets)

Package.swift

@@ -23,8 +23,6 @@ public protocol InitializationContext: Sendable {
     /// `ByteBufferAllocator` to allocate `ByteBuffer`.
     var allocator: ByteBufferAllocator { get }
 
-    // TODO: Is there any point to allowing a name to be passed?
-
     /// Register a closure to be performed on lambda shutdown.
     ///
     /// - Parameter handler: A closure to execute when the lambda shuts down.