🔀 Merge pull request #333 from MrKai77/Swiftlint

🎨 Swiftlint updates + Update README
MrKai77 · Apr 18, 2024 · 8eb3171 · 8eb3171
2 parents 80b00c3 + 6fa744b
commit 8eb3171
Show file tree

Hide file tree

Showing 45 changed files with 415 additions and 270 deletions.
diff --git a/.github/workflows/swiftlint.yml b/.github/workflows/swiftlint.yml
@@ -0,0 +1,22 @@
+name: SwiftLint
+
+on:
+  pull_request:
+    paths:
+      - '.github/workflows/swiftlint.yml'
+      - '.swiftlint.yml'
+      - '**/*.swift'
+
+jobs:
+  SwiftLint:
+    runs-on: ubuntu-latest
+    container:
+      image: ghcr.io/realm/swiftlint:latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: SwiftLint
+        run: |
+          swiftlint --reporter github-actions-logging
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -1,3 +1,15 @@
+opt_in_rules:
+  - modifier_order
+  - multiline_function_chains
+  - multiline_arguments_brackets
+  - superfluous_else
+  - switch_case_on_newline
+  - trailing_closure
+  - unneeded_parentheses_in_closure_argument
+  - unowned_variable_capture
+  - vertical_parameter_alignment_on_call
+  - vertical_whitespace_opening_braces
+
 excluded:
   - Loop/Extensions/CGKeyCode+Extensions.swift
 

diff --git a/Loop.xcodeproj/project.pbxproj b/Loop.xcodeproj/project.pbxproj
@@ -135,6 +135,7 @@
 		A84497CA2B395D8C003D4CF3 /* AnchorPicker.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AnchorPicker.swift; sourceTree = "<group>"; };
 		A84497CC2B3A52C7003D4CF3 /* PreviewWindowButton.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PreviewWindowButton.swift; sourceTree = "<group>"; };
 		A84497D12B3B88A6003D4CF3 /* Optional+Extensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "Optional+Extensions.swift"; sourceTree = "<group>"; };
+		A848130C2BD1A8D100B02E93 /* .github */ = {isa = PBXFileReference; lastKnownFileType = folder; path = .github; sourceTree = "<group>"; };
 		A848D8A62A8C2F3F00060834 /* LoopManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoopManager.swift; sourceTree = "<group>"; };
 		A8504D2C2A85832F00C2EFDA /* SoftwareUpdater.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SoftwareUpdater.swift; sourceTree = "<group>"; };
 		A859799A2B55FE94009FB067 /* UNNotification+Extensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "UNNotification+Extensions.swift"; sourceTree = "<group>"; };
@@ -403,6 +404,7 @@
 		A8E59C2C297F5E9A0064D4BA = {
 			isa = PBXGroup;
 			children = (
+				A848130C2BD1A8D100B02E93 /* .github */,
 				A8291D6D2A4513D200C5CB69 /* .swiftlint.yml */,
 				A8E6D1FC2A4155DC005751D4 /* .gitignore */,
 				A86AFD7529888B29008F4892 /* README.md */,

diff --git a/Loop/About Window/AboutView.swift b/Loop/About Window/AboutView.swift
@@ -63,7 +63,6 @@ struct AboutView: View {
     var body: some View {
         VStack {
             VStack(spacing: 5) {
-
                 Image(nsImage: NSImage(named: IconManager.currentAppIcon.iconName)!)
                     .resizable()
                     .frame(width: 120, height: 120)

diff --git a/Loop/AppDelegate.swift b/Loop/AppDelegate.swift
@@ -10,7 +10,6 @@ import Defaults
 import UserNotifications
 
 class AppDelegate: NSObject, NSApplicationDelegate, UNUserNotificationCenterDelegate {
-
     private let loopManager = LoopManager()
     private let windowDragManager = WindowDragManager()
 
@@ -56,12 +55,13 @@ class AppDelegate: NSObject, NSApplicationDelegate, UNUserNotificationCenterDele
     func openSettings() {
         // Settings window is already open
         guard !NSApp.windows.contains(where: { $0.toolbar?.items != nil }) else {
-            NSApp.windows.first(where: { $0.toolbar?.items != nil })?.orderFrontRegardless()
+            NSApp.windows.first { $0.toolbar?.items != nil }?.orderFrontRegardless()
+
             return
         }
 
         let eventSource = CGEventSource(stateID: .hidSystemState)
-        let keyCommand = CGEvent(keyboardEventSource: eventSource, virtualKey: 0x2B, keyDown: true)
+        let keyCommand = CGEvent(keyboardEventSource: eventSource, virtualKey: CGKeyCode.kVK_ANSI_Comma, keyDown: true)
         guard let keyCommand else { return }
 
         keyCommand.flags = .maskCommand
@@ -105,7 +105,7 @@ class AppDelegate: NSObject, NSApplicationDelegate, UNUserNotificationCenterDele
     static func requestNotificationAuthorization() {
         UNUserNotificationCenter.current().requestAuthorization(
             options: [.alert]
-        ) { (accepted, error) in
+        ) { accepted, error in
             if !accepted {
                 print("User Notification access denied.")
             }

diff --git a/Loop/Extensions/CGGeometry+Extensions.swift b/Loop/Extensions/CGGeometry+Extensions.swift
@@ -58,15 +58,17 @@ extension CGRect {
             x: self.minX,
             y: screen.frame.maxY - self.maxY,
             width: self.width,
-            height: self.height)
+            height: self.height
+        )
     }
 
     func flipY(maxY: CGFloat) -> CGRect {
         return CGRect(
             x: self.minX,
             y: maxY - self.maxY,
             width: self.width,
-            height: self.height)
+            height: self.height
+        )
     }
 
     func padding(_ sides: Edge.Set, _ amount: CGFloat) -> CGRect {

diff --git a/Loop/Extensions/Color+Extensions.swift b/Loop/Extensions/Color+Extensions.swift
@@ -18,15 +18,13 @@ extension Color {
         case .normal:
             if Defaults[.useSystemAccentColor] {
                 return Color.accentColor
-            } else {
-                return Defaults[.customAccentColor]
             }
+            return Defaults[.customAccentColor]
         case .darker:
             if Defaults[.useSystemAccentColor] {
                 return Color(nsColor: NSColor.controlAccentColor.blended(withFraction: 0.5, of: .black)!)
-            } else {
-                return Defaults[.gradientColor]
             }
+            return Defaults[.gradientColor]
         }
     }
 }
diff --git a/Loop/Extensions/NSImage+Extensions.swift b/Loop/Extensions/NSImage+Extensions.swift
@@ -11,10 +11,12 @@ import AppKit
 extension NSImage {
     func resized(to newSize: NSSize) -> NSImage {
         return NSImage(size: newSize, flipped: false) { rect in
-            self.draw(in: rect,
-                      from: NSRect(origin: CGPoint.zero, size: self.size),
-                      operation: NSCompositingOperation.copy,
-                      fraction: 1.0)
+            self.draw(
+                in: rect,
+                from: NSRect(origin: CGPoint.zero, size: self.size),
+                operation: NSCompositingOperation.copy,
+                fraction: 1.0
+            )
             return true
         }
     }

diff --git a/Loop/Extensions/NSScreen+Extensions.swift b/Loop/Extensions/NSScreen+Extensions.swift
@@ -9,7 +9,6 @@ import SwiftUI
 import Defaults
 
 extension NSScreen {
-
     // Return the CGDirectDisplayID
     // Used in to help calculate the size a window needs to be resized to
     var displayID: CGDirectDisplayID? {

diff --git a/Loop/Managers/AppListManager.swift b/Loop/Managers/AppListManager.swift
@@ -9,7 +9,6 @@ import SwiftUI
 import Algorithms
 
 class AppListManager: ObservableObject {
-
     struct App: Identifiable {
         var id: String { bundleID }
         var bundleID: String
@@ -47,7 +46,7 @@ class AppListManager: ObservableObject {
 
     private func queryDidFinishGathering(notification: Notification) {
         if let items  = qry.results as? [NSMetadataItem] {
-            self.installedApps = items.compactMap({ item in
+            self.installedApps = items.compactMap { item in
                 guard
                     let bundleId = item.value(forAttribute: NSMetadataItemCFBundleIdentifierKey) as? String,
                     let displayName = item.value(forAttribute: NSMetadataItemDisplayNameKey) as? String,
@@ -63,7 +62,7 @@ class AppListManager: ObservableObject {
                     displayName: displayName,
                     installationFolder: installationFolder
                 )
-            })
+            }
         }
     }
 }
diff --git a/Loop/Managers/IconManager.swift b/Loop/Managers/IconManager.swift
@@ -10,7 +10,6 @@ import Defaults
 import UserNotifications
 
 class IconManager {
-
     struct Icon: Hashable {
         var name: String?
         var iconName: String
@@ -21,10 +20,10 @@ class IconManager {
         func getName() -> String {
             if let name = self.name {
                 return name
-            } else {
-                let prefix = "AppIcon-"
-                return iconName.replacingOccurrences(of: prefix, with: "")
             }
+
+            let prefix = "AppIcon-"
+            return iconName.replacingOccurrences(of: prefix, with: "")
         }
 
         static var gregLassaleFooter = String(
@@ -176,6 +175,8 @@ You've already looped 25 times! As a reward, here's new icon: \(.init(localized:
     }
 
     static var currentAppIcon: Icon {
-        return icons.first(where: { $0.iconName == Defaults[.currentIcon] }) ?? icons.first!
+        return icons.first {
+            $0.iconName == Defaults[.currentIcon]
+        } ?? icons.first!
     }
 }
diff --git a/Loop/Managers/KeybindMonitor.swift b/Loop/Managers/KeybindMonitor.swift
@@ -33,7 +33,6 @@ class KeybindMonitor {
         self.eventMonitor = CGEventMonitor(eventMask: [.keyDown, .keyUp]) { cgEvent in
              if cgEvent.type == .keyDown || cgEvent.type == .keyUp,
                 let event = NSEvent(cgEvent: cgEvent) {
-
                  if event.type == .keyUp {
                      KeybindMonitor.shared.pressedKeys.remove(event.keyCode.baseKey)
                  } else if event.type == .keyDown {
@@ -44,22 +43,21 @@ class KeybindMonitor {
                  if self.specialEvents.contains(event.keyCode.baseKey) {
                      if self.canPassthroughSpecialEvents {
                          return Unmanaged.passRetained(cgEvent)
-                     } else {
-                         return nil
                      }
+                     return nil
                  }
 
                  // If this is a valid event, don't passthrough
                  if self.performKeybind(event: event) {
                      return nil
-                 } else {
-                     // If this wasn't, check if it was a system keybind (ex. screenshot), and
-                     // in that case, passthrough and foce-close Loop
-                     if CGKeyCode.systemKeybinds.contains(self.pressedKeys) {
-                         Notification.Name.forceCloseLoop.post()
-                         print("Detected system keybind, closing!")
-                         return Unmanaged.passRetained(cgEvent)
-                     }
+                 }
+
+                 // If this wasn't, check if it was a system keybind (ex. screenshot), and
+                 // in that case, passthrough and foce-close Loop
+                 if CGKeyCode.systemKeybinds.contains(self.pressedKeys) {
+                     Notification.Name.forceCloseLoop.post()
+                     print("Detected system keybind, closing!")
+                     return Unmanaged.passRetained(cgEvent)
                  }
             }
 
@@ -70,7 +68,6 @@ class KeybindMonitor {
             if cgEvent.type == .flagsChanged,
                let event = NSEvent(cgEvent: cgEvent),
                !Defaults[.triggerKey].contains(where: { $0.baseModifier == event.keyCode.baseModifier }) {
-
                 self.checkForModifier(event, .kVK_Shift, .shift)
                 self.checkForModifier(event, .kVK_Command, .command)
                 self.checkForModifier(event, .kVK_Option, .option)
@@ -124,7 +121,6 @@ class KeybindMonitor {
 
         if let newAction = WindowAction.getAction(for: pressedKeys) {
             if !event.isARepeat || newAction.willManipulateCurrentWindowSize {
-
                 Notification.Name.updateBackendDirection.post(userInfo: ["action": newAction])
                 print("performKeybind: returning true due to valid event: \(newAction.direction)")
             }

diff --git a/Loop/Managers/LoopManager.swift b/Loop/Managers/LoopManager.swift
@@ -9,7 +9,6 @@ import SwiftUI
 import Defaults
 
 class LoopManager: ObservableObject {
-
     // Size Adjustment
     static var sidesToAdjust: Edge.Set?
     static var lastTargetFrame: CGRect = .zero
@@ -110,15 +109,24 @@ class LoopManager: ObservableObject {
         // If mouse over 50 points away, select half or quarter positions
         if distanceToMouse > pow(50 - Defaults[.radialMenuThickness], 2) {
             switch Int((angleToMouse.normalized().degrees + 22.5) / 45) {
-            case 0, 8: resizeDirection = .rightHalf
-            case 1:    resizeDirection = .bottomRightQuarter
-            case 2:    resizeDirection = .bottomHalf
-            case 3:    resizeDirection = .bottomLeftQuarter
-            case 4:    resizeDirection = .leftHalf
-            case 5:    resizeDirection = .topLeftQuarter
-            case 6:    resizeDirection = .topHalf
-            case 7:    resizeDirection = .topRightQuarter
-            default:   resizeDirection = .noAction
+            case 0, 8:
+                resizeDirection = .rightHalf
+            case 1:
+                resizeDirection = .bottomRightQuarter
+            case 2:
+                resizeDirection = .bottomHalf
+            case 3:
+                resizeDirection = .bottomLeftQuarter
+            case 4:
+                resizeDirection = .leftHalf
+            case 5:
+                resizeDirection = .topLeftQuarter
+            case 6:
+                resizeDirection = .topHalf
+            case 7:
+                resizeDirection = .topRightQuarter
+            default:
+                resizeDirection = .noAction
             }
         } else if distanceToMouse < pow(noActionDistance, 2) {
             resizeDirection = .noAction
@@ -159,9 +167,9 @@ class LoopManager: ObservableObject {
             var nextIndex = (cycle.firstIndex(of: self.currentAction) ?? -1) + 1
 
             if self.currentAction.direction != .custom {
-                nextIndex = (cycle.firstIndex(where: {
+                nextIndex = (cycle.firstIndex {
                     $0.direction == self.currentAction.direction
-                }) ?? -1) + 1
+                } ?? -1) + 1
             }
 
             if nextIndex >= cycle.count {
@@ -220,7 +228,6 @@ class LoopManager: ObservableObject {
         performHapticFeedback()
 
         if newAction != currentAction || newAction.willManipulateCurrentWindowSize {
-
             self.currentAction = newAction
 
             if Defaults[.hideUntilDirectionIsChosen] {
@@ -368,10 +375,8 @@ class LoopManager: ObservableObject {
             forceClose == false,
             self.currentAction.direction != .noAction,
             self.isLoopActive {
-
             if let screenToResizeOn = self.screenToResizeOn,
                Defaults[.previewVisibility] {
-
                 LoopManager.canAdjustSize = false
                 WindowEngine.resize(
                     self.targetWindow!,

diff --git a/Loop/Managers/ScreenManager.swift b/Loop/Managers/ScreenManager.swift
@@ -49,8 +49,12 @@ class ScreenManager {
 
     private static func getScreensInOrder() -> [NSScreen] {
         NSScreen.screens
-            .sorted(by: { $0.frame.origin.y < $1.frame.origin.y })
-            .sorted(by: { $0.frame.origin.x < $1.frame.origin.x })
+            .sorted {
+                $0.frame.origin.y < $1.frame.origin.y
+            }
+            .sorted {
+                $0.frame.origin.x < $1.frame.origin.x
+            }
     }
 
     private static func findScreen(with window: Window, _ screens: [NSScreen]) -> NSScreen? {

diff --git a/Loop/Managers/WindowDragManager.swift b/Loop/Managers/WindowDragManager.swift
@@ -9,7 +9,6 @@ import Cocoa
 import Defaults
 
 class WindowDragManager {
-
     private var draggingWindow: Window?
     private var initialWindowFrame: CGRect?
     private var direction: WindowDirection = .noAction

diff --git a/Loop/Preview Window/PreviewController.swift b/Loop/Preview Window/PreviewController.swift
@@ -9,7 +9,6 @@ import SwiftUI
 import Defaults
 
 class PreviewController {
-
     private var previewWindowController: NSWindowController?
     private var screen: NSScreen?
     private var window: Window?
@@ -91,9 +90,10 @@ class PreviewController {
         }
 
         let targetWindowFrame = action.getFrame(
-            window: self.window,
-            bounds: screen.safeScreenFrame
-        ).flipY(maxY: NSScreen.screens[0].frame.maxY)
+                window: self.window,
+                bounds: screen.safeScreenFrame
+            )
+            .flipY(maxY: NSScreen.screens[0].frame.maxY)
 
         let shouldBeTransparent = targetWindowFrame.size.area == 0
 

diff --git a/Loop/Preview Window/PreviewView.swift b/Loop/Preview Window/PreviewView.swift
@@ -9,7 +9,6 @@ import SwiftUI
 import Defaults
 
 struct PreviewView: View {
-
     let previewMode: Bool
     @State private var scale: CGFloat = 1