Update SwiftLint and SwiftFormat to latest versions and tidy up code formatting

iby · iby · commit d6f2eab116a9 · 2026-03-18T13:10:14.000Z
- Bring everything up to speed with Swift 5.9 and review all of the rules – some breaking ones have been fixed, some disabled ones aren't needed anymore.
- Add IntelliJ `swift - list + format` shared configuration.
- Add the swift-format configuration (the official one, not the good-old SwiftFormat) – the latest IntelliJ moving away from built-in formatting to this shitty alternative, but hopefully this will get reverted… 🤞
diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml
diff --git a/.idea/misc.xml b/.idea/misc.xml
diff --git a/.swift-format b/.swift-format
@@ -0,0 +1,11 @@
+{
+  "dotChainWrappingBehaviour": "preserve",
+  "indentation": { "spaces": 4 },
+  "indentSwitchCaseLabels": true,
+  "insertSpaces": true,
+  "lineLength": 1000,
+  "maximumBlankLines": 2,
+  "spacesBeforeEndOfLineComments": 1,
+  "tabWidth": 4,
+  "version": 1
+}
diff --git a/.swiftformat b/.swiftformat
@@ -0,0 +1,38 @@
+--swiftversion 5.9
+
+## Configure rules:
+--closure-void preserve
+--else-position same-line
+--extension-acl on-declarations
+--guard-else same-line
+--import-grouping testable-first
+--linebreaks lf
+--semicolons inline
+--trim-whitespace always
+
+### Disable unwanted rules:
+--disable andOperator
+--disable blankLinesAtStartOfScope
+--disable blankLinesBetweenScopes
+--disable consecutiveBlankLines
+--disable genericExtensions
+--disable hoistAwait
+--disable hoistPatternLet
+--disable hoistTry
+--disable indent
+--disable numberFormatting
+--disable opaqueGenericParameters
+--disable redundantFileprivate
+--disable redundantInternal
+--disable redundantSelf
+--disable redundantType
+--disable strongOutlets
+--disable todos
+--disable trailingClosures
+--disable unusedArguments
+--disable void
+--disable wrapArguments
+--disable wrapFunctionBodies
+--disable wrapLoopBodies
+--disable wrapMultilineStatementBraces
+--disable wrapPropertyBodies
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -8,35 +8,34 @@ analyzer_rules:
   - explicit_self
 
 opt_in_rules:
+  - explicit_acl
   - explicit_top_level_acl
   - modifier_order
+  - pattern_matching_keywords
   - prefer_self_type_over_type_of_self
 
 disabled_rules:
   - cyclomatic_complexity
-  - discarded_notification_center_observer
-  - duplicate_imports
   - file_length
   - force_cast
-  - force_try
   - function_body_length
-  - function_parameter_count
   - identifier_name
   - large_tuple
   - line_length
   - nesting
   - opening_brace
   - private_over_fileprivate
-  - redundant_discardable_let
+  - reduce_boolean
+  - todo
   - type_body_length
-  - type_name
-  - unused_closure_parameter
-  - unused_setter_value # https://github.com/realm/SwiftLint/issues/2585
-  - weak_delegate
+  - unneeded_override
 
 trailing_comma:
   mandatory_comma: true
 
+trailing_whitespace:
+  ignores_comments: false
+
 vertical_whitespace:
   max_empty_lines: 2
 
diff --git a/Mintfile b/Mintfile
@@ -0,0 +1,2 @@
+realm/SwiftLint@0.62.1
+nicklockwood/SwiftFormat@0.59.1
diff --git a/Observatory.xcodeproj/project.pbxproj b/Observatory.xcodeproj/project.pbxproj
@@ -72,6 +72,8 @@
 		17FD06581333B3906BE6258A /* Test.Shortcut.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Test.Shortcut.swift; sourceTree = "<group>"; };
 		17FD078E512F21A8ECE8F335 /* Test.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Test.swift; sourceTree = "<group>"; };
 		17FD0872935075E62744FA2B /* .gitignore */ = {isa = PBXFileReference; lastKnownFileType = text; path = .gitignore; sourceTree = "<group>"; };
+		17FD0873935075E62744FA2B /* .swift-format */ = {isa = PBXFileReference; lastKnownFileType = text; path = ".swift-format"; sourceTree = "<group>"; };
+		17FD0874935075E62744FA2B /* .swiftformat */ = {isa = PBXFileReference; lastKnownFileType = file.swiftformat; path = .swiftformat; sourceTree = "<group>"; };
 		17FD08D461EB26AE885B82AC /* Entrypoint.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Entrypoint.swift; sourceTree = "<group>"; };
 		17FD08E9489864D454E503B4 /* Test.Observer.Event.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Test.Observer.Event.swift; sourceTree = "<group>"; };
 		17FD0916F82FAC336830F9E0 /* Observer.Notification.Handler.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Observer.Notification.Handler.swift; sourceTree = "<group>"; };
@@ -88,6 +90,7 @@
 		17FD0F7C4A53D96FBDB8674E /* Observer.Hotkey.Handler.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Observer.Hotkey.Handler.swift; sourceTree = "<group>"; };
 		17FD0F994461E499BAC659EB /* Package.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Package.swift; sourceTree = "<group>"; };
 		17FD0FB54AAAEB24AB193225 /* Shortcut.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Shortcut.swift; sourceTree = "<group>"; };
+		17FD0FB64AAAEB24AB193225 /* Mintfile */ = {isa = PBXFileReference; lastKnownFileType = text; path = Mintfile; sourceTree = "<group>"; };
 		1968096E1E1189C984B6F696 /* Test.Keyboard.Modifier.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Test.Keyboard.Modifier.swift; sourceTree = "<group>"; };
 		691492DAECCDA8F37886F020 /* framework.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist; path = framework.plist; sourceTree = "<group>"; };
 		692C0EE3AC3E3172836E1B96 /* application.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = application.plist; sourceTree = "<group>"; };
@@ -338,7 +341,10 @@
 				E6D7642B1CDDBA100071CCB0 /* product */,
 				17FD0BB4EDB0784084E6A631 /* source */,
 				17FD0872935075E62744FA2B /* .gitignore */,
+				17FD0873935075E62744FA2B /* .swift-format */,
+				17FD0874935075E62744FA2B /* .swiftformat */,
 				17FD094B1DAE4CF98579274D /* .swiftlint.yml */,
+				17FD0FB64AAAEB24AB193225 /* Mintfile */,
 				17FD0F994461E499BAC659EB /* Package.swift */,
 				E690D12D267D1B0C002FD479 /* Package.resolved */,
 				E690D12E267D1B14002FD479 /* LICENSE.md */,
diff --git a/Package.swift b/Package.swift
@@ -1,10 +1,10 @@
-// swift-tools-version: 5.7
+// swift-tools-version: 5.9
 import PackageDescription
 
 let package = Package(
     name: "Observatory",
     platforms: [
-        .macOS(.v10_13)
+        .macOS(.v10_15)
     ],
     products: [
         .library(name: "Observatory", targets: ["Observatory"]),
@@ -17,14 +17,13 @@ let package = Package(
         .target(
             name: "Observatory",
             path: "source/Observatory",
-            exclude: ["Test", "Testing"]
+            exclude: ["Test", "Testing"],
         ),
         .testTarget(
             name: "Observatory-Test",
             dependencies: ["Observatory", "Quick", "Nimble"],
             path: "source/Observatory",
-            exclude: ["Keyboard", "Observer", "Shortcut"]
-            // sources: ["Test", "Testing"] // Since tools 5.3 this alone doesn't work and produces a warning… no need for it really…
+            exclude: ["Keyboard", "Observer", "Shortcut"],
         ),
     ],
     swiftLanguageVersions: [.v5]
diff --git a/source/Demo/Entrypoint.swift b/source/Demo/Entrypoint.swift
@@ -1,8 +1,7 @@
 import AppKit
 import Observatory
 
-@NSApplicationMain public class AppDelegate: NSObject, NSApplicationDelegate {
-}
+@main public class AppDelegate: NSObject, NSApplicationDelegate {}
 
 open class ViewController: NSViewController {
     @IBOutlet private weak var buttonFoo: ShortcutRecorderButton!
@@ -26,7 +25,7 @@ open class ViewController: NSViewController {
     }
 
     override open func viewDidAppear() {
-        /// Reset first responder, do it asynchronously, because the window will modify it once presented.
+        // Reset first responder, do it asynchronously, because the window will modify it once presented.
         DispatchQueue.main.async(execute: { self.view.window?.makeFirstResponder(nil) })
     }
 
diff --git a/source/Observatory/Keyboard/Keyboard.Key.swift b/source/Observatory/Keyboard/Keyboard.Key.swift
@@ -260,7 +260,7 @@ extension KeyboardKey.Layout {
 
     /// Cache layout data by input source – this minimizes calls to Carbon's TIS, which are super-unstable and thread-unsafe…
     fileprivate static var cache: [Self: Data] = [:]
-    private static func invalidateCaches() { Self.lock.withLock({ Self.cache = [:] }) }
+    private static func invalidateCaches() { self.lock.withLock({ Self.cache = [:] }) }
 
     /// Input source change observers.
     private static var observers: [NSObjectProtocol] = []
diff --git a/source/Observatory/Keyboard/Keyboard.Modifier.swift b/source/Observatory/Keyboard/Keyboard.Modifier.swift
@@ -46,7 +46,7 @@ public struct KeyboardModifier: RawRepresentable, OptionSet {
 
     /// The name of the modifier.
     public var name: String? {
-        let name = self.keys.compactMap({ $0.name }).joined(separator: "")
+        let name = self.keys.compactMap(\.name).joined(separator: "")
         return name == "" ? nil : name
     }
 
diff --git a/source/Observatory/Observer/Event/Observer.Event.Handler.swift b/source/Observatory/Observer/Event/Observer.Event.Handler.swift
@@ -2,8 +2,7 @@ import AppKit.NSEvent
 import Foundation
 
 extension EventObserver {
-    public struct Handler {
-    }
+    public struct Handler {}
 }
 
 extension EventObserver.Handler {
@@ -92,7 +91,7 @@ extension EventObserver.Handler.AppKit.Definition {
             NSEvent.addLocalMonitorForEvents(matching: mask, handler: { [weak self] in self?.receive(local: $0, handler: handler) })
         }
         internal func unobserve(_ monitor: Any) { NSEvent.removeMonitor(monitor) }
-        internal func receive(global event: NSEvent, handler: @escaping (NSEvent) -> Void){ handler(event) }
+        internal func receive(global event: NSEvent, handler: @escaping (NSEvent) -> Void) { handler(event) }
         internal func receive(local event: NSEvent, handler: @escaping (NSEvent) -> NSEvent?) -> NSEvent? { handler(event) }
     }
 }
@@ -170,7 +169,7 @@ extension EventObserver.Handler {
                 let userInfo: UnsafeMutablePointer<Signature> = UnsafeMutablePointer.allocate(capacity: 1)
                 userInfo.initialize(to: { mask & CGEventMask(1 << $0.type.rawValue) > 0 ? handler($0) : $0 })
 
-                let callback: CGEventTapCallBack = { (proxy: CGEventTapProxy, type: CGEventType, event: CGEvent, handler: UnsafeMutableRawPointer?) -> Unmanaged<CGEvent>? in
+                let callback: CGEventTapCallBack = { _, _, event, handler in
                     UnsafeMutablePointer<Signature>(OpaquePointer(handler!)).pointee(event).map({ Unmanaged.passUnretained($0) })
                 }
 
diff --git a/source/Observatory/Observer/Event/Observer.Event.swift b/source/Observatory/Observer/Event/Observer.Event.swift
@@ -1,6 +1,6 @@
 import AppKit.NSEvent
-import Foundation
 import CoreGraphics
+import Foundation
 
 /// Event observer provides a flexible interface for registering and managing multiple event handlers in, both, global
 /// and local contexts.
@@ -150,7 +150,7 @@ open class EventObserver: AbstractObserver {
     /// Note, for this to work the process must have Accessibility Control permission enabled
     /// in Security & Privacy system preferences.
     fileprivate func add(definition: Handler.Carbon.Definition?) -> Self {
-        if let definition: Handler.Carbon.Definition = definition { return self.add(definition: definition) } else { return self }
+        if let definition: Handler.Carbon.Definition = definition { self.add(definition: definition) } else { self }
     }
 
     /// Register CoreGraphics handler with manual event forwarding. Note, for this to work the process must have
diff --git a/source/Observatory/Observer/Hotkey/Observer.Hotkey.Handler.swift b/source/Observatory/Observer/Hotkey/Observer.Hotkey.Handler.swift
@@ -1,5 +1,5 @@
-import Foundation
 import Carbon
+import Foundation
 
 extension HotkeyObserver {
     public struct Handler {
diff --git a/source/Observatory/Observer/Hotkey/Observer.Hotkey.swift b/source/Observatory/Observer/Hotkey/Observer.Hotkey.swift
@@ -1,5 +1,5 @@
-import Foundation
 import Carbon
+import Foundation
 
 /// Useful resources on how to implement shortcuts and work with carbon events.
 ///
diff --git a/source/Observatory/Observer/Notification/Observer.Notification.Handler.swift b/source/Observatory/Observer/Notification/Observer.Notification.Handler.swift
@@ -9,7 +9,7 @@ extension NotificationObserver {
                 self.deactivate()
             }
 
-            init(name: Notification.Name, observee: AnyObject?, queue: OperationQueue?, handler: @escaping Signature) {
+            internal init(name: Notification.Name, observee: AnyObject?, queue: OperationQueue?, handler: @escaping Signature) {
                 self.name = name
                 self.observee = observee
                 self.queue = queue
diff --git a/source/Observatory/Shortcut/Shortcut.Center.swift b/source/Observatory/Shortcut/Shortcut.Center.swift
@@ -14,7 +14,7 @@ open class ShortcutCenter {
     open var recorder: ShortcutRecorder? {
         didSet {
             if self.recorder === oldValue { return }
-            /// Disables registered hotkey observers if there's an active hotkey recorder and enables them if there's not.
+            // Disables registered hotkey observers if there's an active hotkey recorder and enables them if there's not.
             let isIgnored: Bool = self.recorder != nil
             self.observer.isActive = !isIgnored
         }
@@ -24,7 +24,7 @@ open class ShortcutCenter {
     private var registrations: [Registration] = []
 
     /// All shortcuts registered in the center.
-    open var shortcuts: [Shortcut] { self.registrations.lazy.map({ $0.shortcut }) }
+    open var shortcuts: [Shortcut] { self.registrations.lazy.map(\.shortcut) }
 
     /// Registers the shortcut-hotkey pair.
     private func add(_ shortcut: Shortcut, _ hotkey: KeyboardHotkey) {
diff --git a/source/Observatory/Shortcut/Shortcut.Recorder.Button.swift b/source/Observatory/Shortcut/Shortcut.Recorder.Button.swift
@@ -1,6 +1,6 @@
 import AppKit
-import Foundation
 import Carbon
+import Foundation
 
 /// NSButton-based control for recording shortcut hotkeys. Unlike regular button, it will send actions
 /// when the associated hotkey gets modified as the result of the user input.
@@ -56,16 +56,16 @@ open class ShortcutRecorderButton: NSButton, ShortcutRecorder {
     /// Temporarily stores the reference to original first responder during hotkey recording.
     private weak var originalFirstResponder: NSResponder?
 
-    // Makes self as the the first responder and stores the original first responder reference for later restoration.
+    /// Makes self as the the first responder and stores the original first responder reference for later restoration.
     private func makeFirstResponder() {
-        // Check if another instance of `Self` is already the first responder and use it's value instead. 
+        // Check if another instance of `Self` is already the first responder and use it's value instead.
         var currentFirstResponder: NSResponder? = self.window?.firstResponder
         if let recorder = currentFirstResponder as? Self, recorder.isRecording { currentFirstResponder = recorder.originalFirstResponder }
         if self.originalFirstResponder == nil { self.originalFirstResponder = currentFirstResponder }
         if currentFirstResponder !== self { self.window?.makeFirstResponder(self) }
     }
 
-    // Restores the original first responder if self is the current first responder and clears the original first responder reference.
+    /// Restores the original first responder if self is the current first responder and clears the original first responder reference.
     private func restoreFirstResponder() {
         let currentFirstResponder: NSResponder? = self.window?.firstResponder
         if currentFirstResponder === self && currentFirstResponder !== self.originalFirstResponder { self.window?.makeFirstResponder(self.originalFirstResponder) }
@@ -101,7 +101,7 @@ open class ShortcutRecorderButton: NSButton, ShortcutRecorder {
         String(describing: modifier)
     }
 
-    /// Returns the receiver's title for the keyboard key. 
+    /// Returns the receiver's title for the keyboard key.
     open func title(forKey key: KeyboardKey) -> String {
         String(describing: key)
     }
@@ -135,7 +135,7 @@ open class ShortcutRecorderButton: NSButton, ShortcutRecorder {
             self.shortcut?.hotkey = nil
             self.isRecording = false
             NotificationCenter.default.post(name: Self.hotkeyDidRecordNotification, object: self)
-            let _ = self.sendAction(self.action, to: self.target)
+            _ = self.sendAction(self.action, to: self.target)
             return true
         }
 
@@ -163,7 +163,7 @@ open class ShortcutRecorderButton: NSButton, ShortcutRecorder {
                 self.shortcut?.hotkey = hotkey
                 self.isRecording = false
                 NotificationCenter.default.post(name: Self.hotkeyDidRecordNotification, object: self)
-                let _ = self.sendAction(self.action, to: self.target)
+                _ = self.sendAction(self.action, to: self.target)
             }
         } else {
             NSSound.beep()
@@ -216,7 +216,7 @@ extension KeyboardModifier {
     /// Creates new keyboard modifier from the key equivalent string and modifier flags. If the key equivalent is an uppercase string
     /// the shift modifier flag will be included into the modifier flags.
     fileprivate init(_ keyEquivalent: String, _ flags: NSEvent.ModifierFlags) {
-        let isUppercase = keyEquivalent.allSatisfy({ $0.isUppercase })
+        let isUppercase = keyEquivalent.allSatisfy(\.isUppercase)
         self.init(isUppercase ? flags.union(.shift) : flags)
     }
 }
diff --git a/source/Observatory/Shortcut/Shortcut.swift b/source/Observatory/Shortcut/Shortcut.swift
diff --git a/source/Observatory/Test/Observer/Test.Observer.Event.swift b/source/Observatory/Test/Observer/Test.Observer.Event.swift

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+realm/SwiftLint@0.62.1`
	`2`	`+nicklockwood/SwiftFormat@0.59.1`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,7 @@`
`1`	`1`	`import AppKit`
`2`	`2`	`import Observatory`
`3`	`3`
`4`		`-@NSApplicationMain public class AppDelegate: NSObject, NSApplicationDelegate {`
`5`		`-}`
	`4`	`+@main public class AppDelegate: NSObject, NSApplicationDelegate {}`
`6`	`5`
`7`	`6`	`open class ViewController: NSViewController {`
`8`	`7`	`@IBOutlet private weak var buttonFoo: ShortcutRecorderButton!`
`@@ -26,7 +25,7 @@ open class ViewController: NSViewController {`
`26`	`25`	`}`
`27`	`26`
`28`	`27`	`override open func viewDidAppear() {`
`29`		`- /// Reset first responder, do it asynchronously, because the window will modify it once presented.`
	`28`	`+ // Reset first responder, do it asynchronously, because the window will modify it once presented.`
`30`	`29`	`DispatchQueue.main.async(execute: { self.view.window?.makeFirstResponder(nil) })`
`31`	`30`	`}`
`32`	`31`