Fixing Linting Issues [skip ci]

Author: leogdion

.swift-format

@@ -6,11 +6,11 @@
     "spaces" : 2
   },
   "indentConditionalCompilationBlocks" : true,
-  "indentSwitchCaseLabels" : true,
-  "lineBreakAroundMultilineExpressionChainComponents" : true,
-  "lineBreakBeforeControlFlowKeywords" : true,
-  "lineBreakBeforeEachArgument" : true,
-  "lineBreakBeforeEachGenericRequirement" : true,
+  "indentSwitchCaseLabels" : false,
+  "lineBreakAroundMultilineExpressionChainComponents" : false,
+  "lineBreakBeforeControlFlowKeywords" : false,
+  "lineBreakBeforeEachArgument" : false,
+  "lineBreakBeforeEachGenericRequirement" : false,
   "lineLength" : 100,
   "maximumBlankLines" : 1,
   "multiElementCollectionTrailingCommas" : true,
@@ -26,7 +26,7 @@
     "AlwaysUseLiteralForEmptyCollectionInit" : false,
     "AlwaysUseLowerCamelCase" : true,
     "AmbiguousTrailingClosureOverload" : true,
-    "BeginDocumentationCommentWithOneLineSummary" : true,
+    "BeginDocumentationCommentWithOneLineSummary" : false,
     "DoNotUseSemicolons" : true,
     "DontRepeatTypeInStaticProperties" : true,
     "FileScopedDeclarationPrivacy" : false,
@@ -42,7 +42,7 @@
     "NoCasesWithOnlyFallthrough" : true,
     "NoEmptyTrailingClosureParentheses" : true,
     "NoLabelsInCasePatterns" : true,
-    "NoLeadingUnderscores" : false,
+    "NoLeadingUnderscores" : true,
     "NoParensAroundConditions" : true,
     "NoPlaygroundLiterals" : true,
     "NoVoidReturnOnFunctionSignature" : true,
@@ -67,4 +67,4 @@
   "spacesAroundRangeFormationOperators" : false,
   "tabWidth" : 2,
   "version" : 1
-}
+}

.swiftlint.yml

@@ -1,6 +1,5 @@
 opt_in_rules:
   - array_init
-  - attributes
   - closure_body_length
   - closure_end_indentation
   - closure_spacing
@@ -22,14 +21,15 @@ opt_in_rules:
   - explicit_acl
   - explicit_init
   - explicit_top_level_acl
-  - fallthrough
+  # - fallthrough
   - fatal_error_message
   - file_name
   - file_name_no_space
   - file_types_order
+  - first_where
   - flatmap_over_map_reduce
   - force_unwrapping
-  - function_default_parameter_at_end
+#  - function_default_parameter_at_end
   - ibinspectable_in_extension
   - identical_operands
   - implicit_return
@@ -41,8 +41,9 @@ opt_in_rules:
   - legacy_random
   - literal_expression_end_indentation
   - lower_acl_than_parent
-  #- missing_docs
+  - missing_docs
   - modifier_order
+  - multiline_arguments
   - multiline_arguments_brackets
   - multiline_function_chains
   - multiline_literal_brackets
@@ -56,7 +57,6 @@ opt_in_rules:
   - optional_enum_case_matching
   - overridden_super_call
   - override_in_extension
-  - pattern_matching_keywords
   - prefer_self_type_over_type_of_self
   - prefer_zero_over_explicit_init
   - private_action
@@ -74,48 +74,65 @@ opt_in_rules:
   - sorted_first_last
   - sorted_imports
   - static_operator
-  - strict_fileprivate
   - strong_iboutlet
   - toggle_bool
+#  - trailing_closure
   - type_contents_order
   - unavailable_function
   - unneeded_parentheses_in_closure_argument
   - unowned_variable_capture
+  - untyped_error_in_catch
   - vertical_parameter_alignment_on_call
-  - vertical_whitespace_between_cases
   - vertical_whitespace_closing_braces
   - vertical_whitespace_opening_braces
   - xct_specific_matcher
   - yoda_condition
-disabled_rules:
-  - trailing_comma
-  - strict_fileprivate
-  - function_default_parameter_at_end
-  - switch_case_alignment
+analyzer_rules:
+  - unused_import
+  - unused_declaration
 cyclomatic_complexity:
   - 6
-  - 8
-type_body_length:
-  - 125
-  - 200
+  - 12
 file_length:
-  - 250
-  - 300
+  warning: 225
+  error: 300
 function_body_length:
-  - 25
-  - 35
+  - 50
+  - 76
 function_parameter_count: 8
 line_length:
-  - 90
-  - 90
+  - 100
+  - 200
+closure_body_length:
+  - 50
+  - 60
 identifier_name:
   excluded:
     - id
-    - completeFileProtectionUntilFirstUserAuthentication
+    - no
 excluded:
   - DerivedData
   - .build
-  - .swiftpm
   - Mint
+  - Examples
 indentation_width:
   indentation_width: 2
+file_name:
+    severity: error
+fatal_error_message:
+    severity: error
+disabled_rules:
+    - nesting
+    - implicit_getter
+    - switch_case_alignment
+    - closure_parameter_position
+    - trailing_comma
+    - opening_brace
+    - optional_data_string_conversion
+    - pattern_matching_keywords
+custom_rules:
+  no_unchecked_sendable:
+    name: "No Unchecked Sendable"
+    regex: '@unchecked\s+Sendable'
+    message: "Use proper Sendable conformance instead of @unchecked Sendable to maintain strict concurrency safety"
+    severity: error

Mintfile

@@ -1,3 +1,3 @@
-swiftlang/swift-format@600.0.0
-realm/SwiftLint@0.58.0
-peripheryapp/periphery@2.20.0
+swiftlang/swift-format@602.0.0
+realm/SwiftLint@0.62.2
+peripheryapp/periphery@3.2.0

Sources/RadiantDocs/CodablePackageDocument.swift

@@ -83,7 +83,8 @@
           configuration.existingFile ?? FileWrapper(directoryWithFileWrappers: [:])
 
         if let oldConfigJSONWrapper = rootFileWrapper
-          .fileWrappers?[T.configurationFileWrapperKey] {
+          .fileWrappers?[T.configurationFileWrapperKey]
+        {
           rootFileWrapper.removeFileWrapper(oldConfigJSONWrapper)
         }
 

Sources/RadiantDocs/Primitives/FileType.swift

@@ -51,7 +51,7 @@ public struct FileType: Hashable, ExpressibleByStringLiteral, Sendable {
   /// - Parameters:
   ///   - utIdentifier: The Uniform Type Identifier (UTI) for the file type.
   ///   - isOwned: A boolean indicating whether the file type is owned.
-  /// - fileExtension: The optional file extension associated with the file type.
+  ///   - fileExtension: The optional file extension associated with the file type.
   public init(utIdentifier: String, isOwned: Bool, fileExtension: String? = nil) {
     self.utIdentifier = utIdentifier
     self.isOwned = isOwned

Sources/RadiantDocs/Primitives/InitializablePackage.swift

@@ -49,8 +49,8 @@ extension InitializablePackage {
   /// - Parameters:
   ///   - fileURL: The URL at which to create the package.
   ///   - encoder: The JSON encoder to use for encoding the package.
-  /// - options: The options to use when creating the package. Defaults to
-  /// `.none`.
+  ///   - options: The options to use when creating the package. Defaults to
+  ///     `.none`.
   ///
   /// - Returns: The newly created instance of the package.
   ///

Sources/RadiantDocs/Primitives/InitializablePackageOptions.swift

@@ -29,6 +29,7 @@
 
 public import Foundation
 
+/// Options for controlling how package files are written and protected.
 public struct InitializablePackageOptions: OptionSet, Sendable {
   /// An option to write data to an auxiliary file first and
   /// then replace the original file
@@ -46,10 +47,12 @@ public struct InitializablePackageOptions: OptionSet, Sendable {
   /// or the file is already open.
   public static let completeFileProtectionUnlessOpen =
     InitializablePackageOptions(rawValue: 1 << 4)
+  // swiftlint:disable identifier_name
   /// An option to allow the file to be accessible after a user first unlocks the
   /// device.
   public static let completeFileProtectionUntilFirstUserAuthentication =
     InitializablePackageOptions(rawValue: 1 << 5)
+  // swiftlint:enable identifier_name
   /// An option the system uses when determining the file protection options that
   /// the system assigns to the data.
   public static let fileProtectionMask = InitializablePackageOptions(rawValue: 0x0F << 2)
@@ -58,21 +61,24 @@ public struct InitializablePackageOptions: OptionSet, Sendable {
   public static let withIntermediateDirectories =
     InitializablePackageOptions(rawValue: 1 << 6)
   // Common combinations
+  /// No options enabled.
   public static let none: InitializablePackageOptions = []
+  /// The raw integer value representing the option set.
   public let rawValue: Int
   /// Returns true if the withIntermediateDirectories option is enabled
   public var withIntermediateDirectoriesIsEnabled: Bool {
     contains(.withIntermediateDirectories)
   }
+  /// Creates an option set with the specified raw value.
+  ///
+  /// - Parameter rawValue: The raw integer value for the option set.
   public init(rawValue: Int) { self.rawValue = rawValue }
 }
 
 extension Data.WritingOptions {
   /// Initialize Data.WritingOptions from InitializablePackageOptions
   /// - Parameter options: The `InitializablePackageOptions`
-  /// to convert to `Data.WritingOptions`
-  /// - Returns: The `Data.WritingOptions` equivalent
-  /// of the provided `InitializablePackageOptions`
+  ///   to convert to `Data.WritingOptions`
   public init(options: InitializablePackageOptions) {
     var dataOptions: Data.WritingOptions = []
     if options.contains(.atomic) { dataOptions.insert(.atomic) }

Sources/RadiantDocs/UTType.swift

@@ -57,7 +57,8 @@
       if fileType.isOwned { types.append(.init(exportedAs: fileType.utIdentifier)) }
 
       if let fileExtensionType =
-        fileType.fileExtension.flatMap({ UTType(filenameExtension: $0) }) {
+        fileType.fileExtension.flatMap({ UTType(filenameExtension: $0) })
+      {
         types.append(fileExtensionType)
       }
 

Sources/RadiantKit/AppKit/NSWindowAdaptorModifier.swift

@@ -52,7 +52,8 @@ import Foundation
 
       /// Creates the `NSView` that will be used to access the underlying
       /// `NSWindow`.
-      /// - Parameter context: The context provided by the SwiftUI framework.
+      /// - Parameter _:  The context provided by the SwiftUI framework.
+      ///   -
       /// - Returns: An `NSView` instance.
       fileprivate func makeNSView(context _: Self.Context) -> NSView {
         let view = NSView()
@@ -65,8 +66,8 @@ import Foundation
 
       /// Updates the `NSView` if necessary.
       /// - Parameters:
-      ///   - nsView: The `NSView` to be updated.
-      ///   - context: The context provided by the SwiftUI framework.
+      ///   - _: The `NSView` to be updated.
+      ///   - _: The context provided by the SwiftUI framework.
       fileprivate func updateNSView(_: NSView, context _: Context) {}
     }
 
@@ -110,8 +111,8 @@ import Foundation
   #else
     extension View {
       /// Adds a no-op `nsWindowAdaptor` modifier to the `View`.
-      /// - Parameter callback: A closure that will be called with `Any?`, but
-      /// does nothing.
+      /// - Parameter _:  A closure that will be called with `Any?`, but
+      ///     does nothing.
       /// - Returns: The original `View`.
       public func nsWindowAdaptor(_: @escaping (Any?) -> Void) -> some View { self }
     }

Sources/RadiantKit/Color.swift

@@ -33,8 +33,6 @@
   /// An extension to the `Color` type that adds an initializer to create a
   /// `Color` instance from a hexadecimal string.
   extension Color {
-    // swiftlint:disable function_body_length
-
     /// Initializes a `Color` instance from a hexadecimal string.
     ///
     /// - Parameter hex: A hexadecimal string representation of the color, in the
@@ -49,19 +47,19 @@
       let blue: UInt64
 
       switch hex.count {
-        case 3:  // RGB (12-bit)
-          (alpha, red, green, blue) = (
-            255, (int >> 8) * 17, (int >> 4 & 0xF) * 17, (int & 0xF) * 17
-          )
-        case 6:  // RGB (24-bit)
-          (alpha, red, green, blue) =
-            (255, int >> 16, int >> 8 & 0xFF, int & 0xFF)
-        case 8:  // ARGB (32-bit)
-          (alpha, red, green, blue) =
-            (int >> 24, int >> 16 & 0xFF, int >> 8 & 0xFF, int & 0xFF)
+      case 3:  // RGB (12-bit)
+        (alpha, red, green, blue) = (
+          255, (int >> 8) * 17, (int >> 4 & 0xF) * 17, (int & 0xF) * 17
+        )
+      case 6:  // RGB (24-bit)
+        (alpha, red, green, blue) =
+          (255, int >> 16, int >> 8 & 0xFF, int & 0xFF)
+      case 8:  // ARGB (32-bit)
+        (alpha, red, green, blue) =
+          (int >> 24, int >> 16 & 0xFF, int >> 8 & 0xFF, int & 0xFF)
 
-        default:
-          (alpha, red, green, blue) = (255, 0, 0, 0)
+      default:
+        (alpha, red, green, blue) = (255, 0, 0, 0)
       }
 
       self.init(
@@ -72,6 +70,5 @@
         opacity: Double(alpha) / 255
       )
     }
-    // swiftlint:enable function_body_length
   }
 #endif