Merge pull request #180 from PureSwift/feature/swift-lint

Add Swift Lint and Formatting
PureSwift · Jan 13, 2025 · 3aeeb31 · 3aeeb31
2 parents 4a57214 + c121bb7
commit 3aeeb31
Show file tree

Hide file tree

Showing 483 changed files with 18,826 additions and 17,340 deletions.
diff --git a/.github/workflows/swiftlint.yml b/.github/workflows/swiftlint.yml
@@ -0,0 +1,31 @@
+name: Swift Lint
+on: [pull_request]
+jobs:
+    swift-format-lint:
+      name: swift-format lint
+      runs-on: ubuntu-latest
+      container: swift:6.0.3
+      steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Swift Version
+        run: swift --version
+      - name: Lint
+        run: swift format lint -r ./ --configuration .swift-format
+
+    swiftlint:
+      name: swiftlint 
+      runs-on: macos-latest
+      steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install Swift
+        uses: slashmo/[email protected]
+        with:
+          version: 6.0.3
+      - name: Swift Version
+        run: swift --version
+      - name: Install SwiftLint
+        run: brew install swiftlint
+      - name: Lint
+        run: swiftlint
diff --git a/.swift-format b/.swift-format
@@ -0,0 +1,70 @@
+{
+  "fileScopedDeclarationPrivacy" : {
+    "accessLevel" : "private"
+  },
+  "indentConditionalCompilationBlocks" : false,
+  "indentSwitchCaseLabels" : false,
+  "indentation" : {
+    "spaces" : 4
+  },
+  "lineBreakAroundMultilineExpressionChainComponents" : false,
+  "lineBreakBeforeControlFlowKeywords" : false,
+  "lineBreakBeforeEachArgument" : false,
+  "lineBreakBeforeEachGenericRequirement" : false,
+  "lineLength" : 1000,
+  "maximumBlankLines" : 1,
+  "multiElementCollectionTrailingCommas" : false,
+  "noAssignmentInExpressions" : {
+    "allowedFunctions" : [
+      "XCTAssertNoThrow"
+    ]
+  },
+  "prioritizeKeepingFunctionOutputTogether" : false,
+  "respectsExistingLineBreaks" : 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" : false,
+    "NoAssignmentInExpressions" : true,
+    "NoBlockComments" : false,
+    "NoCasesWithOnlyFallthrough" : true,
+    "NoEmptyTrailingClosureParentheses" : true,
+    "NoLabelsInCasePatterns" : true,
+    "NoLeadingUnderscores" : false,
+    "NoParensAroundConditions" : true,
+    "NoPlaygroundLiterals" : true,
+    "NoVoidReturnOnFunctionSignature" : true,
+    "OmitExplicitReturns" : false,
+    "OneCasePerLine" : true,
+    "OneVariableDeclarationPerLine" : true,
+    "OnlyOneTrailingClosureArgument" : true,
+    "OrderedImports" : false,
+    "ReplaceForEachWithForLoop" : false,
+    "ReturnVoidInsteadOfEmptyTuple" : false,
+    "TypeNamesShouldBeCapitalized" : true,
+    "UseEarlyExits" : false,
+    "UseExplicitNilCheckInConditions" : true,
+    "UseLetInEveryBoundCaseVariable" : false,
+    "UseShorthandTypeNames" : true,
+    "UseSingleLinePropertyGetter" : true,
+    "UseSynthesizedInitializer" : false,
+    "UseTripleSlashForDocumentationComments" : false,
+    "UseWhereClausesInForLoops" : false,
+    "ValidateDocumentationComments" : false
+  },
+  "spacesAroundRangeFormationOperators" : false,
+  "tabWidth" : 8,
+  "version" : 1
+}
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -0,0 +1,65 @@
+included:
+  - Plugins
+  - Source
+  - Tests
+  - Package.swift
+analyzer_rules:
+  - unused_declaration
+  - unused_import
+disabled_rules:
+  - comma
+  - void_return
+  - cyclomatic_complexity
+  - force_cast
+  - large_tuple
+  - comment_spacing
+  - private_over_fileprivate
+  - redundant_discardable_let
+  - statement_position
+  - file_length
+  - function_body_length
+  - identifier_name
+  - line_length
+  - number_separator
+  - sorted_imports
+  - trailing_whitespace
+  - vertical_whitespace
+  - vertical_whitespace_opening_braces
+  - vertical_parameter_alignment_on_call
+  - vertical_whitespace_closing_braces
+  - type_body_length
+  - anonymous_argument_in_multiline_closure
+  - async_without_await
+  - conditional_returns_on_newline
+  - contrasted_opening_brace
+  - convenience_type
+  - discouraged_optional_collection
+  - explicit_acl
+  - explicit_enum_raw_value
+  - explicit_top_level_acl
+  - explicit_type_interface
+  - file_types_order
+  - force_unwrapping
+  - function_default_parameter_at_end
+  - indentation_width
+  - missing_docs
+  - multiline_arguments
+  - multiline_arguments_brackets
+  - multiline_function_chains
+  - multiline_parameters_brackets
+  - no_extension_access_modifier
+  - no_grouping_extension
+  - no_magic_numbers
+  - one_declaration_per_file
+  - prefer_key_path # Re-enable once we are on Swift 6.
+  - prefer_nimble
+  - prefixed_toplevel_constant
+  - required_deinit
+  - sorted_enum_cases
+  - strict_fileprivate
+  - switch_case_on_newline
+  - todo
+  - trailing_closure
+  - type_contents_order
+  - vertical_whitespace_between_cases
+  - inclusive_language
diff --git a/Package.swift b/Package.swift
@@ -20,7 +20,7 @@ var package = Package(
         .macOS(.v10_15),
         .iOS(.v13),
         .watchOS(.v6),
-        .tvOS(.v13),
+        .tvOS(.v13)
     ],
     products: [
         .library(
@@ -74,7 +74,7 @@ var package = Package(
         .target(
             name: "BluetoothGATT",
             dependencies: [
-                "Bluetooth",
+                "Bluetooth"
             ]
         ),
         .target(
@@ -93,15 +93,15 @@ var package = Package(
                     condition: .when(platforms: [.macOS, .linux, .macCatalyst, .windows])
                 ),
                 .target(
-                    name: "BluetoothGAP", 
+                    name: "BluetoothGAP",
                     condition: .when(platforms: [.macOS, .linux, .macCatalyst, .windows])
                 ),
                 .target(
-                    name: "BluetoothGATT", 
+                    name: "BluetoothGATT",
                     condition: .when(platforms: [.macOS, .linux, .macCatalyst, .windows])
                 ),
                 .target(
-                    name: "BluetoothHCI", 
+                    name: "BluetoothHCI",
                     condition: .when(platforms: [.macOS, .linux, .macCatalyst, .windows])
                 )
             ]
@@ -127,7 +127,7 @@ if buildDocs {
 }
 
 if generateCode {
-    for (index, _) in package.targets.enumerated() {
+    for index in package.targets.indices {
         package.targets[index].swiftSettings = [
             .define("SWIFTPM_ENABLE_PLUGINS")
         ]
@@ -169,14 +169,14 @@ if enableMacros {
         .macro(
             name: "BluetoothMacros",
             dependencies: [
-              .product(
-                name: "SwiftSyntaxMacros",
-                package: "swift-syntax"
-              ),
-              .product(
-                name: "SwiftCompilerPlugin",
-                package: "swift-syntax"
-              )
+                .product(
+                    name: "SwiftSyntaxMacros",
+                    package: "swift-syntax"
+                ),
+                .product(
+                    name: "SwiftCompilerPlugin",
+                    package: "swift-syntax"
+                )
             ]
         )
     ]

diff --git a/Plugins/GenerateBluetoothDefinitions/BluetoothUUID.swift b/Plugins/GenerateBluetoothDefinitions/BluetoothUUID.swift
@@ -9,7 +9,7 @@ import Foundation
 import PackagePlugin
 
 extension GenerateBluetoothDefinitionsPlugin {
-    
+
     func bluetoothUUIDBuildCommands(
         type: String,
         fileName: String,
@@ -25,7 +25,8 @@ extension GenerateBluetoothDefinitionsPlugin {
         let outputURLs = [
             outputDirectory.appending(component: fileName + ".swift")
         ]
-        let arguments = ["uuid", type]
+        let arguments =
+            ["uuid", type]
             + outputURLs.map { $0.path() }
         let command = Command.buildCommand(
             displayName: "Generate Bluetooth \(type) UUID Definitions",

diff --git a/Plugins/GenerateBluetoothDefinitions/CompanyIdentifier.swift b/Plugins/GenerateBluetoothDefinitions/CompanyIdentifier.swift
@@ -9,7 +9,7 @@ import Foundation
 import PackagePlugin
 
 extension GenerateBluetoothDefinitionsPlugin {
-    
+
     func companyIdentifiersBuildCommands(
         for context: PluginContext,
         target: SwiftSourceModuleTarget,
@@ -34,7 +34,7 @@ extension GenerateBluetoothDefinitionsPlugin {
         assert(arguments.count == 2)
         commands.append(command)
     }
-    
+
     func companyIdentifierTestsBuildCommands(
         for context: PluginContext,
         target: SwiftSourceModuleTarget,

diff --git a/Plugins/GenerateBluetoothDefinitions/Plugin.swift b/Plugins/GenerateBluetoothDefinitions/Plugin.swift
@@ -1,6 +1,6 @@
 //
 //  Plugin.swift
-//  
+//
 //
 //  Created by Alsey Coleman Miller on 6/12/22.
 //
@@ -18,7 +18,7 @@ struct GenerateBluetoothDefinitionsPlugin: BuildToolPlugin {
         }
         var commands = [Command]()
         commands.reserveCapacity(10)
-        
+
         // Generate Bluetooth Company Identifier Definitions
         try companyIdentifiersBuildCommands(for: context, target: target, commands: &commands)
         // Generate Bluetooth Company Identifier Unit Tests
@@ -33,7 +33,7 @@ struct GenerateBluetoothDefinitionsPlugin: BuildToolPlugin {
             ("Characteristic", "CharacteristicUUID"),
             ("Descriptor", "DescriptorUUID"),
             ("Member", "MemberUUID"),
-            ("Declaration", "DeclarationUUID"),
+            ("Declaration", "DeclarationUUID")
         ]
         for (type, fileName) in uuidFiles {
             try bluetoothUUIDBuildCommands(
@@ -44,7 +44,7 @@ struct GenerateBluetoothDefinitionsPlugin: BuildToolPlugin {
                 commands: &commands
             )
         }
-        
+
         return commands
     }
 }
diff --git a/Plugins/GenerateBluetoothDefinitions/UnitIdentifier.swift b/Plugins/GenerateBluetoothDefinitions/UnitIdentifier.swift
@@ -9,7 +9,7 @@ import Foundation
 import PackagePlugin
 
 extension GenerateBluetoothDefinitionsPlugin {
-    
+
     func unitIdentifiersBuildCommands(
         for context: PluginContext,
         target: SwiftSourceModuleTarget,
@@ -31,7 +31,7 @@ extension GenerateBluetoothDefinitionsPlugin {
         )
         commands.append(command)
     }
-    
+
     func unitIdentifierTestsBuildCommands(
         for context: PluginContext,
         target: SwiftSourceModuleTarget,