Swiftlint refactoring (#2952)

Task/Issue URL: https://app.asana.com/0/1205842942115003/1207743897886423/f What kind of version bump will this require?: No version bump Swiftlint rules disabled: - line_length - function_parameter_count - function_body_length - file_length - type_body_length removed cyclomatic_complexity disabled only for switch cases and superfluous disable removed
duckduckgo · Jul 10, 2024 · 98aaee0 · 98aaee0
1 parent f2d4143
commit 98aaee0
Show file tree

Hide file tree

Showing 69 changed files with 89 additions and 191 deletions.
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -9,10 +9,15 @@ disabled_rules:
   - line_length
   - type_name
   - implicit_getter
-  - function_parameter_count
   - trailing_comma
   - nesting
   - opening_brace
+  - function_parameter_count
+  - function_body_length
+  - file_length
+  - type_body_length
+  - non_optional_string_data_conversion
+  - static_over_final_class
 
 opt_in_rules:
   - file_header
@@ -37,15 +42,11 @@ custom_rules:
     severity: error
 
 # Rule Config
+cyclomatic_complexity:
+  ignores_case_statements: true
 identifier_name:
   min_length: 1
   max_length: 1000
-file_length:
-  warning: 1200
-  error: 1200
-type_body_length:
-  warning: 500
-  error: 500
 large_tuple:
   warning: 4
   error: 5

diff --git a/DuckDuckGo.xcodeproj/xcshareddata/xcschemes/sandbox-test-tool.xcscheme b/DuckDuckGo.xcodeproj/xcshareddata/xcschemes/sandbox-test-tool.xcscheme
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
    LastUpgradeVersion = "1530"
-   version = "1.8">
+   version = "1.7">
    <BuildAction
       parallelizeBuildables = "YES"
       buildImplicitDependencies = "YES"

diff --git a/DuckDuckGo/Application/AppDelegate.swift b/DuckDuckGo/Application/AppDelegate.swift
@@ -40,8 +40,6 @@ import NetworkProtectionIPC
 import DataBrokerProtection
 import RemoteMessaging
 
-// @MainActor
-// swiftlint:disable:next type_body_length
 final class AppDelegate: NSObject, NSApplicationDelegate {
 
 #if DEBUG
@@ -149,7 +147,6 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
         return firstLaunchDate >= Date.weekAgo
     }
 
-    // swiftlint:disable:next function_body_length
     override init() {
         do {
             let encryptionKey = NSApplication.runType.requiresEnvironment ? try keyStore.readKey() : nil
@@ -278,7 +275,6 @@ final class AppDelegate: NSObject, NSApplicationDelegate {
                                                                                               vpnUninstaller: vpnUninstaller)
     }
 
-    // swiftlint:disable:next function_body_length
     func applicationDidFinishLaunching(_ notification: Notification) {
         guard NSApp.runType.requiresEnvironment else { return }
         defer {

diff --git a/DuckDuckGo/Bookmarks/Legacy/LegacyBookmarksStoreMigration.swift b/DuckDuckGo/Bookmarks/Legacy/LegacyBookmarksStoreMigration.swift
@@ -44,8 +44,7 @@ public class LegacyBookmarksStoreMigration {
         return results
     }
 
-    // swiftlint:disable cyclomatic_complexity
-    // swiftlint:disable function_body_length
+    // swiftlint:disable:next cyclomatic_complexity
     public static func setupAndMigrate(from source: NSManagedObjectContext,
                                        to destination: NSManagedObjectContext) {
 
@@ -173,8 +172,6 @@ public class LegacyBookmarksStoreMigration {
             }
         }
     }
-    // swiftlint:enable cyclomatic_complexity
-    // swiftlint:enable function_body_length
 
     private static func cleanupOldData(in context: NSManagedObjectContext) {
         let allObjects = (try? context.fetch(BookmarkManagedObject.fetchRequest())) ?? []

diff --git a/DuckDuckGo/Bookmarks/Services/LocalBookmarkStore.swift b/DuckDuckGo/Bookmarks/Services/LocalBookmarkStore.swift
@@ -26,7 +26,6 @@ import Cocoa
 import Persistence
 import PixelKit
 
-// swiftlint:disable:next type_body_length
 final class LocalBookmarkStore: BookmarkStore {
 
     convenience init(bookmarkDatabase: BookmarkDatabase) {
@@ -685,7 +684,6 @@ final class LocalBookmarkStore: BookmarkStore {
         }
     }
 
-    // swiftlint:disable:next function_body_length
     func moveFavorites(with objectUUIDs: [String], toIndex index: Int?, completion: @escaping (Error?) -> Void) {
 
         applyChangesAndSave(changes: { [weak self] context in

diff --git a/DuckDuckGo/Bookmarks/View/BookmarkListViewController.swift b/DuckDuckGo/Bookmarks/View/BookmarkListViewController.swift
@@ -100,7 +100,7 @@ final class BookmarkListViewController: NSViewController {
         fatalError("\(type(of: self)): Bad initializer")
     }
 
-    override func loadView() { // swiftlint:disable:this function_body_length
+    override func loadView() {
         view = ColorView(frame: .zero, backgroundColor: .popoverBackground)
 
         view.addSubview(titleTextField)

diff --git a/DuckDuckGo/Bookmarks/View/BookmarkManagementDetailViewController.swift b/DuckDuckGo/Bookmarks/View/BookmarkManagementDetailViewController.swift
@@ -72,7 +72,6 @@ final class BookmarkManagementDetailViewController: NSViewController, NSMenuItem
         fatalError("\(type(of: self)): Bad initializer")
     }
 
-    // swiftlint:disable:next function_body_length
     override func loadView() {
         view = ColorView(frame: .zero, backgroundColor: .bookmarkPageBackground)
         view.translatesAutoresizingMaskIntoConstraints = false

diff --git a/DuckDuckGo/Common/Surveys/SurveyRemoteMessaging.swift b/DuckDuckGo/Common/Surveys/SurveyRemoteMessaging.swift
@@ -113,7 +113,7 @@ final class DefaultSurveyRemoteMessaging: SurveyRemoteMessaging {
         }
     }
 
-    // swiftlint:disable cyclomatic_complexity function_body_length
+    // swiftlint:disable cyclomatic_complexity
 
     /// Processes the messages received from S3 and returns those which the user is eligible for. This is done by checking each of the attributes against the user's local state.
     /// Because the result of the message fetch is cached, it means that they won't be immediately updated if the user suddenly qualifies, but the refresh interval for remote messages is only 1 hour so it
@@ -239,7 +239,7 @@ final class DefaultSurveyRemoteMessaging: SurveyRemoteMessaging {
         }
     }
 
-    // swiftlint:enable cyclomatic_complexity function_body_length
+    // swiftlint:enable cyclomatic_complexity
 
     func presentableRemoteMessages() -> [SurveyRemoteMessage] {
         let dismissedMessageIDs = messageStorage.dismissedMessageIDs()

diff --git a/DuckDuckGo/Common/Surveys/SurveyURLBuilder.swift b/DuckDuckGo/Common/Surveys/SurveyURLBuilder.swift
@@ -71,7 +71,7 @@ final class SurveyURLBuilder {
         self.daysSincePIRLastActive = daysSincePIRLastActive
     }
 
-    // swiftlint:disable:next cyclomatic_complexity function_body_length
+    // swiftlint:disable:next cyclomatic_complexity
     func buildSurveyURL(from originalURLString: String) -> URL? {
         guard var components = URLComponents(string: originalURLString) else {
             assertionFailure("Could not build components from survey URL")

diff --git a/DuckDuckGo/DBP/DataBrokerProtectionDebugMenu.swift b/DuckDuckGo/DBP/DataBrokerProtectionDebugMenu.swift
@@ -52,7 +52,6 @@ final class DataBrokerProtectionDebugMenu: NSMenu {
     private let webUISettings = DataBrokerProtectionWebUIURLSettings(.dbp)
     private let settings = DataBrokerProtectionSettings(defaults: .dbp)
 
-    // swiftlint:disable:next function_body_length
     init() {
         super.init(title: "Personal Information Removal")
 

diff --git a/DuckDuckGo/DBP/DataBrokerProtectionPixelsHandler.swift b/DuckDuckGo/DBP/DataBrokerProtectionPixelsHandler.swift
@@ -23,7 +23,6 @@ import Common
 
 public class DataBrokerProtectionPixelsHandler: EventMapping<DataBrokerProtectionPixels> {
 
-    // swiftlint:disable:next function_body_length
     public init() {
         super.init { event, _, _, _ in
             switch event {

diff --git a/DuckDuckGo/DataImport/Logins/CSV/CSVParser.swift b/DuckDuckGo/DataImport/Logins/CSV/CSVParser.swift
@@ -67,7 +67,6 @@ struct CSVParser {
             hasPrecedingQuote = false
         }
 
-        // swiftlint:disable:next cyclomatic_complexity
         mutating func accept(_ character: Character) throws {
             switch (state, character.kind(delimiter: delimiter), precedingQuote: hasPrecedingQuote) {
             case (_, .unsupported, _):

diff --git a/DuckDuckGo/DataImport/Model/DataImportViewModel.swift b/DuckDuckGo/DataImport/Model/DataImportViewModel.swift
@@ -223,7 +223,7 @@ struct DataImportViewModel {
 
     /// Called with data import task result to update the state by merging the summary with an existing summary
     @MainActor
-    private mutating func mergeImportSummary(with summary: DataImportSummary) { // swiftlint:disable:this cyclomatic_complexity
+    private mutating func mergeImportSummary(with summary: DataImportSummary) {
         self.importTask = nil
 
         log("merging summary \(summary)")

diff --git a/DuckDuckGo/DataImport/Model/InstructionsFormatParser.swift b/DuckDuckGo/DataImport/Model/InstructionsFormatParser.swift
@@ -142,7 +142,6 @@ struct InstructionsFormatParser {
             currentEscapeSequence = ""
         }
 
-        // swiftlint:disable:next cyclomatic_complexity function_body_length
         mutating func accept(_ character: Character?) throws {
             switch (currentEscapeSequence, character) {
                 // beggining of %-escaped seq

diff --git a/DuckDuckGo/DataImport/ThirdPartyBrowser.swift b/DuckDuckGo/DataImport/ThirdPartyBrowser.swift
@@ -49,7 +49,6 @@ enum ThirdPartyBrowser: CaseIterable {
     case onePassword7
     case onePassword8
 
-    // swiftlint:disable:next cyclomatic_complexity
     static func browser(for source: DataImport.Source) -> ThirdPartyBrowser? {
         switch source {
         case .brave: return .brave
@@ -254,7 +253,6 @@ enum ThirdPartyBrowser: CaseIterable {
     }
 
     // Returns the URL to the profiles for a given browser. This directory will contain a list of directories, each representing a profile.
-    // swiftlint:disable:next cyclomatic_complexity
     func profilesDirectories(applicationSupportURL: URL? = nil) -> [URL] {
         let applicationSupportURL = applicationSupportURL ?? URL.nonSandboxApplicationSupportDirectoryURL
         return switch self {

diff --git a/DuckDuckGo/DataImport/View/DataImportView.swift b/DuckDuckGo/DataImport/View/DataImportView.swift
@@ -102,7 +102,6 @@ struct DataImportView: ModalView {
         }
     }
 
-    // swiftlint:disable:next cyclomatic_complexity
     private func viewBody() -> some View {
         VStack(alignment: .leading, spacing: 0) {
             // body
@@ -452,7 +451,6 @@ extension DataImportViewModel {
             self.dataType = dataType
         }
 
-        // swiftlint:disable:next function_body_length
         func importData(types: Set<DataImport.DataType>) -> DataImportTask {
             .detachedWithProgress(.initial) { progressUpdate in
                 func makeProgress(_ op: (Double) throws -> Void) async throws {

diff --git a/DuckDuckGo/DataImport/View/FileImportView.swift b/DuckDuckGo/DataImport/View/FileImportView.swift
@@ -20,7 +20,6 @@ import Common
 import SwiftUI
 import UniformTypeIdentifiers
 
-// swiftlint:disable function_body_length cyclomatic_complexity
 @InstructionsView.InstructionsBuilder
 func fileImportInstructionsBuilder(source: DataImport.Source, dataType: DataImport.DataType, button: @escaping (String) -> AnyView) -> [InstructionsView.InstructionsItem] {
 
@@ -452,7 +451,6 @@ func fileImportInstructionsBuilder(source: DataImport.Source, dataType: DataImpo
         assertionFailure("Invalid source/dataType")
     }
 }
-// swiftlint:enable function_body_length cyclomatic_complexity
 
 struct FileImportView: View {
 
@@ -592,7 +590,6 @@ struct InstructionsView: View {
     // View Model
     private let instructions: [[InstructionsViewItem]]
 
-    // swiftlint:disable:next function_body_length cyclomatic_complexity
     init(@InstructionsBuilder builder: () -> [InstructionsItem]) {
         var args = builder()
 

diff --git a/DuckDuckGo/Email/EmailManagerRequestDelegate.swift b/DuckDuckGo/Email/EmailManagerRequestDelegate.swift
@@ -26,7 +26,6 @@ extension EmailManagerRequestDelegate {
         set {}
     }
 
-    // swiftlint:disable function_parameter_count
     func emailManager(_ emailManager: EmailManager, requested url: URL, method: String, headers: [String: String], parameters: [String: String]?, httpBody: Data?, timeoutInterval: TimeInterval) async throws -> Data {
         let finalURL = url.appendingParameters(parameters ?? [:])
         var request = URLRequest(url: finalURL, timeoutInterval: timeoutInterval)
@@ -45,7 +44,6 @@ extension EmailManagerRequestDelegate {
 
         return data
     }
-    // swiftlint:enable function_parameter_count
 
     public func emailManagerKeychainAccessFailed(_ emailManager: EmailManager, accessType: EmailKeychainAccessType, error: EmailKeychainAccessError) {
         var parameters = [

diff --git a/DuckDuckGo/FileDownload/View/DownloadsCellView.swift b/DuckDuckGo/FileDownload/View/DownloadsCellView.swift
@@ -108,7 +108,6 @@ final class DownloadsCellView: NSTableCellView {
         fatalError("\(Self.self): Bad initializer")
     }
 
-    // swiftlint:disable:next function_body_length
     private func setupUI() {
         self.imageView = fileIconView
         self.wantsLayer = true

diff --git a/DuckDuckGo/FileDownload/View/DownloadsViewController.swift b/DuckDuckGo/FileDownload/View/DownloadsViewController.swift
@@ -52,7 +52,7 @@ final class DownloadsViewController: NSViewController {
         super.init(coder: coder)
     }
 
-    override func loadView() { // swiftlint:disable:this function_body_length
+    override func loadView() {
         view = NSView()
 
         view.addSubview(titleLabel)
@@ -373,7 +373,6 @@ final class DownloadsViewController: NSViewController {
 
 extension DownloadsViewController: NSMenuDelegate {
 
-    // swiftlint:disable cyclomatic_complexity
     func menuNeedsUpdate(_ menu: NSMenu) {
         guard let index = index(for: menu),
               let item = viewModel.items[safe: index]
@@ -412,8 +411,6 @@ extension DownloadsViewController: NSMenuDelegate {
             }
         }
     }
-    // swiftlint:enable cyclomatic_complexity
-
 }
 
 extension DownloadsViewController: NSTableViewDataSource, NSTableViewDelegate {

diff --git a/DuckDuckGo/History/Services/EncryptedHistoryStore.swift b/DuckDuckGo/History/Services/EncryptedHistoryStore.swift
@@ -156,7 +156,6 @@ final class EncryptedHistoryStore: HistoryStoring {
         }
     }
 
-    // swiftlint:disable:next function_body_length
     func save(entry: HistoryEntry) -> Future<[(id: Visit.ID, date: Date)], Error> {
         return Future { [weak self] promise in
             self?.context.perform { [weak self] in

diff --git a/DuckDuckGo/HomePage/Model/HomePageRecentlyVisitedModel.swift b/DuckDuckGo/HomePage/Model/HomePageRecentlyVisitedModel.swift
@@ -284,7 +284,6 @@ final class RecentlyVisitedSiteModel: ObservableObject {
         return Self.feedImage(for: trackerNetwork)
     }
 
-    // swiftlint:disable:next cyclomatic_complexity
     static func feedImage(for trackerNetwork: TrackerNetwork) -> NSImage? {
         switch trackerNetwork {
         case .adform:            .feedAdform

diff --git a/DuckDuckGo/Menus/MainMenu.swift b/DuckDuckGo/Menus/MainMenu.swift
@@ -28,8 +28,8 @@ import NetworkProtection
 import Subscription
 import SubscriptionUI
 
-// swiftlint:disable:next type_body_length
-@MainActor final class MainMenu: NSMenu {
+@MainActor
+final class MainMenu: NSMenu {
 
     enum Constants {
         static let maxTitleLength = 55
@@ -553,7 +553,6 @@ import SubscriptionUI
 
     let internalUserItem = NSMenuItem(title: "Set Internal User State", action: #selector(MainViewController.internalUserState))
 
-    // swiftlint:disable:next function_body_length
     private func setupDebugMenu() -> NSMenu {
         let debugMenu = NSMenu(title: "Debug") {
             NSMenuItem(title: "Open Vanilla Browser", action: #selector(MainViewController.openVanillaBrowser)).withAccessibilityIdentifier("MainMenu.openVanillaBrowser")

diff --git a/DuckDuckGo/Menus/MainMenuActions.swift b/DuckDuckGo/Menus/MainMenuActions.swift
@@ -963,8 +963,6 @@ extension MainViewController {
 
 extension MainViewController: NSMenuItemValidation {
 
-    // swiftlint:disable cyclomatic_complexity
-    // swiftlint:disable function_body_length
     func validateMenuItem(_ menuItem: NSMenuItem) -> Bool {
         guard fireViewController.fireViewModel.fire.burningData == nil else {
             return true
@@ -1068,9 +1066,6 @@ extension MainViewController: NSMenuItemValidation {
             return true
         }
     }
-
-    // swiftlint:enable function_body_length
-    // swiftlint:enable cyclomatic_complexity
 }
 
 extension AppDelegate: NSMenuItemValidation {

diff --git a/DuckDuckGo/NavigationBar/View/AddressBarButtonsViewController.swift b/DuckDuckGo/NavigationBar/View/AddressBarButtonsViewController.swift
@@ -29,7 +29,6 @@ protocol AddressBarButtonsViewControllerDelegate: AnyObject {
 
 }
 
-// swiftlint:disable:next type_body_length
 final class AddressBarButtonsViewController: NSViewController {
 
     weak var delegate: AddressBarButtonsViewControllerDelegate?

diff --git a/DuckDuckGo/NavigationBar/View/AddressBarTextField.swift b/DuckDuckGo/NavigationBar/View/AddressBarTextField.swift
@@ -25,7 +25,6 @@ import PixelKit
 import Suggestions
 import Subscription
 
-// swiftlint:disable:next type_body_length
 final class AddressBarTextField: NSTextField {
 
     var tabCollectionViewModel: TabCollectionViewModel! {

diff --git a/DuckDuckGo/NavigationBar/View/NavigationBarViewController.swift b/DuckDuckGo/NavigationBar/View/NavigationBarViewController.swift
@@ -28,7 +28,6 @@ import NetworkProtectionUI
 import Subscription
 import SubscriptionUI
 
-// swiftlint:disable:next type_body_length
 final class NavigationBarViewController: NSViewController {
 
     enum Constants {

diff --git a/DuckDuckGo/NavigationBar/ViewModel/PrivacyIconViewModel.swift b/DuckDuckGo/NavigationBar/ViewModel/PrivacyIconViewModel.swift
@@ -126,7 +126,6 @@ struct PrivacyIconViewModel {
         }()?.cgImage(forProposedRect: nil, context: .current, hints: nil)
     }
 
-    // swiftlint:disable cyclomatic_complexity
     private static func aquaLogo(for trackerNetwork: TrackerNetwork) -> NSImage? {
         switch trackerNetwork {
         case .adform:            .adform
@@ -216,8 +215,6 @@ struct PrivacyIconViewModel {
         case .xaxis:             .xaxisDark
         }
     }
-    // swiftlint:enable cyclomatic_complexity
-
 }
 
 extension Character {

diff --git a/DuckDuckGo/NetworkProtection/AppTargets/BothAppTargets/NetworkProtectionDebugMenu.swift b/DuckDuckGo/NetworkProtection/AppTargets/BothAppTargets/NetworkProtectionDebugMenu.swift
@@ -53,7 +53,6 @@ final class NetworkProtectionDebugMenu: NSMenu {
 
     private let excludeLocalNetworksMenuItem = NSMenuItem(title: "excludeLocalNetworks", action: #selector(NetworkProtectionDebugMenu.toggleShouldExcludeLocalRoutes))
 
-    // swiftlint:disable:next function_body_length
     init() {
         preferredServerMenu = NSMenu { [preferredServerAutomaticItem] in
             preferredServerAutomaticItem
-Original file line number
+Diff line change
@@ Expand Up / @@ -29,7 +29,6 @@ protocol AddressBarButtonsViewControllerDelegate: AnyObject { @@
     }
-    // swiftlint:disable:next type_body_length
     final class AddressBarButtonsViewController: NSViewController {
         weak var delegate: AddressBarButtonsViewControllerDelegate?
@@ Expand Down @@