Improve swift style + swiftlint (#1092)

Task/Issue URL: https://app.asana.com/0/0/1201986385932308/f Description: Implement style guide changes Update swift lint Fork style from RW repo with some added changes
duckduckgo · Apr 4, 2022 · 3f6fb5e · 3f6fb5e
1 parent 207ea9d
commit 3f6fb5e
Show file tree

Hide file tree

Showing 74 changed files with 1,241 additions and 116 deletions.
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -1,21 +1,56 @@
 
 disabled_rules:
-  - trailing_whitespace
+  - discarded_notification_center_observer
+  - notification_center_detachment
+  - orphaned_doc_comment
+  - todo
+  - unused_capture_list
+
+opt_in_rules:
+  - closure_end_indentation
+  - closure_spacing
+  - colon
+  - overridden_super_call
+  - unused_import
+  - fatal_error_message
+
+force_cast: warning
+force_try: warning
+legacy_hashing: error
 
-# Rule Config
-line_length:
-  warning: 150
-  ignores_comments: true
 identifier_name:
   min_length: 1
   max_length:
     warning: 40
     error: 60
+  excluded:
+    - i
+    - id
+    - x
+    - y
+    - z
+
+line_length:
+  warning: 150
+  ignores_urls: true
+  ignores_function_declarations: true
+  ignores_comments: true
+
+vertical_whitespace:
+  max_empty_lines: 2
+
+trailing_whitespace:
+  ignores_empty_lines: true
+  ignores_comments: true
+
+private_over_fileprivate:
+  validate_extensions: true
+
 type_name:
-  min_length: 3
-  max_length:
-    warning: 80
-    error: 100
+ min_length: 3
+ max_length:
+   warning: 80
+   error: 100
 
 # General Config
 excluded:

diff --git a/AtbUITests/AtbIntegrationTests.swift b/AtbUITests/AtbIntegrationTests.swift
@@ -137,7 +137,7 @@ class AtbIntegrationTests: XCTestCase {
 
 }
 
-fileprivate extension HttpRequest {
+private extension HttpRequest {
 
     func queryParam(_ named: String) -> String? {
         return queryParams.first(where: { $0.0 == named })?.1

diff --git a/Core/APIRequest.swift b/Core/APIRequest.swift
@@ -88,7 +88,7 @@ public class APIRequest {
 
             if let error = error {
                 completion(nil, error)
-            } else if let error = httpResponse?.validateStatusCode(statusCode: 200..<300) { 
+            } else if let error = httpResponse?.validateStatusCode(statusCode: 200..<300) {
                 completion(nil, error)
             } else {
                 var etag = httpResponse?.headerValue(for: APIHeaders.Name.etag)

diff --git a/Core/BookmarkObjects.swift b/Core/BookmarkObjects.swift
@@ -34,7 +34,7 @@ private struct Constants {
 public protocol Bookmark: BookmarkItem {
     var url: URL? { get set }
 
-    var displayTitle: String? { get }    
+    var displayTitle: String? { get }
 }
 
 public extension Bookmark {

diff --git a/Core/BookmarksCoreDataStorage.swift b/Core/BookmarksCoreDataStorage.swift
@@ -132,7 +132,7 @@ public class BookmarksCoreDataStorage {
             context.perform {
                 handler(context)
                 self.storeLoadedCondition.resolve()
-            }            
+            }
         }
     }
 }
@@ -422,7 +422,7 @@ extension BookmarksCoreDataStorage {
         loadStore()
     }
 
-    public func favoritesUncachedForWidget(completion: @escaping ([BookmarkManagedObject]) -> Void) {        
+    public func favoritesUncachedForWidget(completion: @escaping ([BookmarkManagedObject]) -> Void) {
         Task {
             guard await hasTopLevelFolder() else {
                 completion([])

diff --git a/Core/Database.swift b/Core/Database.swift
@@ -122,5 +122,5 @@ private class DDGPersistentContainer: NSPersistentContainer {
     override public class func defaultDirectoryURL() -> URL {
 
         return FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: Database.Constants.databaseGroupID)!
-    } 
+    }
 }
diff --git a/Core/PartiallyRoundedRectangleView.swift b/Core/PartiallyRoundedRectangleView.swift
@@ -47,9 +47,9 @@ public class PartiallyRoundedRectangleView: UIView {
     override public func layoutSubviews() {
         super.layoutSubviews()
         var corners = UIRectCorner()
-        if topLeftCorner { corners.insert(.topLeft)     }
-        if topRightCorner { corners.insert(.topRight)    }
-        if bottomLeftCorner { corners.insert(.bottomLeft)  }
+        if topLeftCorner { corners.insert(.topLeft) }
+        if topRightCorner { corners.insert(.topRight) }
+        if bottomLeftCorner { corners.insert(.bottomLeft) }
         if bottomRightCorner { corners.insert(.bottomRight) }
         round(corners: corners, radius: cornerRadius)
     }

diff --git a/Core/PrivacyPractices.swift b/Core/PrivacyPractices.swift
@@ -72,7 +72,7 @@ public class PrivacyPractices {
 
     func findPractice(forHost host: String) -> Practice {
         guard let domain = tld.domain(host) else { return Constants.unknown }
-        guard let term = termsOfServiceStore.terms[domain] else { return Constants.unknown}
+        guard let term = termsOfServiceStore.terms[domain] else { return Constants.unknown }
         let entityScore = entityScores[entityMapping.findEntity(forHost: domain)?.displayName ?? ""]
         return Practice(score: entityScore ?? term.derivedScore,
                         summary: term.summary,

diff --git a/Core/WebCacheManager.swift b/Core/WebCacheManager.swift
@@ -113,7 +113,7 @@ public class WebCacheManager {
         cookieStore.getAllCookies { cookies in
             let group = DispatchGroup()
             cookies.forEach { cookie in
-                if domains.contains(where: { self.isCookie(cookie, matchingDomain: $0)}) {
+                if domains.contains(where: { self.isCookie(cookie, matchingDomain: $0) }) {
                     group.enter()
                     cookieStore.delete(cookie) {
                         group.leave()

diff --git a/DuckDuckGo/ActionSheetDaxDialogViewController.swift b/DuckDuckGo/ActionSheetDaxDialogViewController.swift
@@ -74,7 +74,7 @@ class ActionSheetDaxDialogViewController: UIViewController {
     override func viewWillAppear(_ animated: Bool) {
         super.viewWillAppear(animated)
 
-        containerHeight.constant = daxDialogViewController?.calculateHeight() ?? 0        
+        containerHeight.constant = daxDialogViewController?.calculateHeight() ?? 0
     }
 
     override func viewDidAppear(_ animated: Bool) {

diff --git a/DuckDuckGo/AddOrEditBookmarkViewController.swift b/DuckDuckGo/AddOrEditBookmarkViewController.swift
@@ -105,7 +105,7 @@ class AddOrEditBookmarkViewController: UIViewController {
     }
 }
 
-extension AddOrEditBookmarkViewController: BookmarkOrFavoriteDetailsDataSourceDelegate {    
+extension AddOrEditBookmarkViewController: BookmarkOrFavoriteDetailsDataSourceDelegate {
 
     func bookmarkOrFavoriteDetailsDataSource(_ dataSource: BookmarkOrFavoriteDetailsDataSource,
                                              textFieldDidChangeWithTitleText titleText: String?,

diff --git a/DuckDuckGo/AppRatingPrompt.swift b/DuckDuckGo/AppRatingPrompt.swift
@@ -42,7 +42,7 @@ class AppRatingPrompt {
     func registerUsage(onDate date: Date = Date()) {
         if !date.isSameDay(storage.lastAccess) {
             storage.uniqueAccessDays += 1
-        }        
+        }
         storage.lastAccess = date
     }
 
@@ -65,7 +65,7 @@ class AppRatingPromptCoreDataStorage: AppRatingPromptStorage {
 
         set {
             entity().lastAccess = newValue
-            try? context.save() 
+            try? context.save()
         }
     }
 

diff --git a/DuckDuckGo/AutocompleteViewController.swift b/DuckDuckGo/AutocompleteViewController.swift
@@ -153,7 +153,7 @@ class AutocompleteViewController: UIViewController {
             strongSelf.bookmarksSearch.search(query: query) { matches in
                 let notQueryMatches = matches.filter { $0.url?.absoluteString != query }
                 let filteredMatches = notQueryMatches.filter { $0.displayTitle != nil }.prefix(Constants.maxLocalItems)
-                let localSuggestions = filteredMatches.map { Suggestion(source: .local, suggestion: $0.displayTitle!, url: $0.url)}
+                let localSuggestions = filteredMatches.map { Suggestion(source: .local, suggestion: $0.displayTitle!, url: $0.url) }
 
                 guard let suggestions = suggestions, error == nil else {
                     os_log("%s", log: generalLog, type: .debug, error?.localizedDescription ?? "Failed to retrieve suggestions")

diff --git a/DuckDuckGo/BookmarksDataSource.swift b/DuckDuckGo/BookmarksDataSource.swift
@@ -139,8 +139,7 @@ class DefaultBookmarksDataSource: BookmarksDataSource, MainBookmarksViewDataSour
             bookmarksManager.convertFavoriteToBookmark(item.objectID, newIndex: destinationIndexPath.row)
         } else if sourceIndexPath.section == 1 && destinationIndexPath.section == 0 {
             guard let bookmark = item as? Bookmark else {
-                // Folders aren't allowed in favourites. We shouldn't be able to get here
-                fatalError()
+                fatalError("Folders aren't allowed in favorites. We shouldn't be able to get here")
             }
             bookmarksManager.convertBookmarkToFavorite(bookmark.objectID, newIndex: destinationIndexPath.row)
         }

diff --git a/DuckDuckGo/BrowserChromeManager.swift b/DuckDuckGo/BrowserChromeManager.swift
@@ -333,7 +333,7 @@ private class BarsAnimator {
     }
 }
 
-fileprivate extension UIScrollView {
+private extension UIScrollView {
 
     /// Calculate Y-axis content offset corresponding to very bottom of the scroll area
     var contentOffsetYAtBottom: CGFloat {

diff --git a/DuckDuckGo/BrowsingMenu/BrowsingMenuViewController.swift b/DuckDuckGo/BrowsingMenu/BrowsingMenuViewController.swift
@@ -307,14 +307,14 @@ extension BrowsingMenuViewController: UITableViewDataSource {
         switch menuEntries[indexPath.row] {
         case .regular(let name, let accessibilityLabel, let image, let showNotificationDot, _):
             guard let cell = tableView.dequeueReusableCell(withIdentifier: "BrowsingMenuEntryViewCell", for: indexPath) as? BrowsingMenuEntryViewCell else {
-                fatalError()
+                fatalError("Cell should be dequeued")
             }
 
             cell.configure(image: image, label: name, accessibilityLabel: accessibilityLabel, theme: theme, showNotificationDot: showNotificationDot)
             return cell
         case .separator:
             guard let cell = tableView.dequeueReusableCell(withIdentifier: "BrowsingMenuSeparatorViewCell", for: indexPath) as? BrowsingMenuSeparatorViewCell else {
-                fatalError()
+                fatalError("Cell should be dequeued")
             }
 
             cell.separator.backgroundColor = theme.browsingMenuSeparatorColor

diff --git a/DuckDuckGo/DirectoryMonitor.swift b/DuckDuckGo/DirectoryMonitor.swift
@@ -67,7 +67,7 @@ class DirectoryMonitor {
     }
 
     func start() throws {
-        guard case .stopped = state else { fatalError() }
+        guard case .stopped = state else { fatalError("Should only start stopped state") }
 
         directoryContents = DirectoryMonitor.contents(of: directory)
 
@@ -110,7 +110,7 @@ class DirectoryMonitor {
     }
 
     private func debounceTimerDidFire() {
-        guard case .debounce(let source, let timer) = state else { fatalError() }
+        guard case .debounce(let source, let timer) = state else { fatalError("state should be .debounce") }
 
         timer.invalidate()
         state = .started(source: source)
@@ -142,7 +142,7 @@ class DirectoryMonitor {
     }
 }
 
-fileprivate extension DirectoryMonitor.State {
+private extension DirectoryMonitor.State {
     var isRunning: Bool {
         switch self {
         case .stopped:  return false

diff --git a/DuckDuckGo/DownloadListRepresentable.swift b/DuckDuckGo/DownloadListRepresentable.swift
@@ -40,12 +40,12 @@ struct AnyDownloadListRepresentable: DownloadListRepresentable, Comparable {
       self.wrappedRepresentable = representable
     }
 
-    public var id: String { filename}
+    public var id: String { filename }
     var filename: String { wrappedRepresentable.filename }
     var creationDate: Date { wrappedRepresentable.creationDate }
     var fileSize: Int { wrappedRepresentable.fileSize }
     var type: DownloadListRepresentableType { wrappedRepresentable.type }
-    var filePath: String { wrappedRepresentable.filePath}
+    var filePath: String { wrappedRepresentable.filePath }
 
     static func < (lhs: AnyDownloadListRepresentable, rhs: AnyDownloadListRepresentable) -> Bool {
         lhs.creationDate < rhs.creationDate

diff --git a/DuckDuckGo/DownloadsListSectioningHelper.swift b/DuckDuckGo/DownloadsListSectioningHelper.swift
@@ -95,10 +95,10 @@ class DownloadsListSectioningHelper {
 
         switch downloadRepresentable.type {
         case .ongoing:
-            guard let download = downloadRepresentable.wrappedRepresentable as? Download else { fatalError() }
+            guard let download = downloadRepresentable.wrappedRepresentable as? Download else { fatalError("Ongoing download should be Download") }
             row = OngoingDownloadRowViewModel(download: download)
         case .complete:
-            guard let url = downloadRepresentable.wrappedRepresentable as? URL else { fatalError() }
+            guard let url = downloadRepresentable.wrappedRepresentable as? URL else { fatalError("Complete download should be URL") }
             row = CompleteDownloadRowViewModel(fileURL: url)
         }
 

diff --git a/DuckDuckGo/FavoritesOverlay.swift b/DuckDuckGo/FavoritesOverlay.swift
@@ -86,7 +86,7 @@ class FavoritesOverlay: UIViewController {
     }
 
     @objc private func keyboardDidShow(notification: NSNotification) {
-        guard !AppWidthObserver.shared.isLargeWidth else { return }        
+        guard !AppWidthObserver.shared.isLargeWidth else { return }
         guard let keyboardFrame = notification.userInfo?[UIResponder.keyboardFrameEndUserInfoKey] as? CGRect else { return }
         let keyboardSize = keyboardFrame.size
         let contentInsets = UIEdgeInsets(top: 0.0, left: 0.0, bottom: keyboardSize.height + Constants.margin * 2, right: 0.0)

diff --git a/DuckDuckGo/FileSizeDebugViewController.swift b/DuckDuckGo/FileSizeDebugViewController.swift
@@ -27,7 +27,7 @@ struct FileItem {
     let isDirectory: Bool
     let size: Int?
 
-    var isEmpty: Bool { (size ?? 0) == 0}
+    var isEmpty: Bool { (size ?? 0) == 0 }
 }
 
 class FileSizeDebugViewController: UITableViewController {
@@ -160,7 +160,7 @@ class FileSizeDebugViewController: UITableViewController {
     }
 }
 
-fileprivate extension URL {
+private extension URL {
 
     var isDirectory: Bool {
         let urlForDirectory = (try? resourceValues(forKeys: [.isDirectoryKey]).isDirectory) ?? false

diff --git a/DuckDuckGo/FindInPageUserScript.swift b/DuckDuckGo/FindInPageUserScript.swift
@@ -40,5 +40,5 @@ public class FindInPageUserScript: NSObject, UserScript {
         let currentResult = dict["currentResult"] as? Int
         let totalResults = dict["totalResults"] as? Int
         findInPage?.update(currentResult: currentResult, totalResults: totalResults)
-    } 
+    }
 }
diff --git a/DuckDuckGo/FindInPageView.swift b/DuckDuckGo/FindInPageView.swift
@@ -40,6 +40,8 @@ class FindInPageView: UIView {
     weak var findInPage: FindInPage?
 
     override func awakeFromNib() {
+        super.awakeFromNib()
+
         layer.shadowRadius = 1
         layer.shadowOffset = CGSize(width: 0, height: -1.0 / UIScreen.main.scale)
         layer.shadowColor = UIColor.black.cgColor

diff --git a/DuckDuckGo/FullscreenDaxDialogViewController.swift b/DuckDuckGo/FullscreenDaxDialogViewController.swift
@@ -160,7 +160,7 @@ extension TabViewController: FullscreenDaxDialogDelegate {
     }
 }
 
-fileprivate extension DefaultDaxDialogsSettings {
+private extension DefaultDaxDialogsSettings {
 
     var browsingDialogsSeenCount: String {
         let count = [ browsingMajorTrackingSiteShown,

diff --git a/DuckDuckGo/LaunchTabNotification.swift b/DuckDuckGo/LaunchTabNotification.swift
@@ -56,7 +56,7 @@ class LaunchTabNotification {
 
 }
 
-fileprivate extension NSNotification.Name {
+private extension NSNotification.Name {
 
     static let launchTab: NSNotification.Name = Notification.Name(rawValue: "com.duckduckgo.notification.launchTab")
 

diff --git a/DuckDuckGo/NativeDisplayableCertificateBuilderDriver.swift b/DuckDuckGo/NativeDisplayableCertificateBuilderDriver.swift
@@ -45,7 +45,7 @@ class NativeDisplayableCertificateBuilderDriver: DisplayableCertificateBuilderDr
 
 }
 
-fileprivate extension SecCertificate {
+private extension SecCertificate {
 
     func toDisplayable() -> DisplayableCertificate {
         let displayable = DisplayableCertificate()
@@ -85,7 +85,7 @@ fileprivate extension SecCertificate {
 
 }
 
-fileprivate extension SecKey {
+private extension SecKey {
 
     func toDisplayable() -> DisplayableKey {
         var key = DisplayableKey()

diff --git a/DuckDuckGo/OnboardingViewController.swift b/DuckDuckGo/OnboardingViewController.swift
@@ -199,7 +199,7 @@ class OnboardingViewController: UIViewController, Onboarding {
     }
 
     override var shouldAutorotate: Bool {
-        return true 
+        return true
     }
 
 }

diff --git a/DuckDuckGo/OngoingDownloadRow.swift b/DuckDuckGo/OngoingDownloadRow.swift
@@ -20,7 +20,7 @@
 import SwiftUI
 import Combine
 
-struct OngoingDownloadRow: View {    
+struct OngoingDownloadRow: View {
     @ObservedObject var rowModel: OngoingDownloadRowViewModel
 
     var cancelButtonAction: () -> Void
-Original file line number
+Diff line change
@@ Expand Up @@
         override public class func defaultDirectoryURL() -> URL {
             return FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: Database.Constants.databaseGroupID)!
-        }
+        }
     }