chore: remove mark comments

algolia · Fluf22 · Feb 15, 2024 · Feb 15, 2024 · Feb 15, 2024 · Feb 15, 2024
commit 2777e2ecf5461f454ba1af4060cdcd5646db84fc
@@ -83,7 +83,6 @@
 --enable leadingDelimiters
 --enable linebreakAtEndOfFile
 --enable linebreaks
---enable markTypes
 --enable modifierOrder
 --enable noExplicitOwnership
 --enable numberFormatting
@@ -143,6 +142,7 @@
 --disable applicationMain
 --disable blankLinesBetweenImports
 --disable fileHeader
+--disable markTypes
 --disable organizeDeclarations
 --disable preferForLoop
 --disable redundantBackticks

@@ -7,17 +7,13 @@
 
 import Foundation
 
-// MARK: - CallType
-
 /// Indicate whether the HTTP call performed is of type [read] (GET) or [write] (POST, PUT ..).
 /// Used to determine which timeout duration to use.
 public enum CallType {
     case read
     case write
 }
 
-// MARK: CustomStringConvertible
-
 extension CallType: CustomStringConvertible {
     public var description: String {
         switch self {

@@ -7,17 +7,11 @@
 
 import Foundation
 
-// MARK: - DecodingErrorPrettyPrinter
-
 struct DecodingErrorPrettyPrinter: CustomStringConvertible, CustomDebugStringConvertible {
-    // MARK: Lifecycle
-
     init(decodingError: DecodingError) {
         self.decodingError = decodingError
     }
 
-    // MARK: Internal
-
     let decodingError: DecodingError
 
     var description: String {
@@ -28,8 +22,6 @@ struct DecodingErrorPrettyPrinter: CustomStringConvertible, CustomDebugStringCon
         self.description
     }
 
-    // MARK: Private
-
     private let prefix = "Decoding error"
 
     private func codingKeyDescription(_ key: CodingKey) -> String {

@@ -7,29 +7,17 @@
 
 import Foundation
 
-// MARK: - GenericError
-
 public struct GenericError: Error, CustomStringConvertible {
-    // MARK: Lifecycle
-
     public init(description: String) {
         self.description = description
     }
 
-    // MARK: Public
-
     public var description: String
 }
 
-// MARK: - ErrorMessage
-
 public struct ErrorMessage: Codable, CustomStringConvertible {
-    // MARK: Public
-
     public let description: String
 
-    // MARK: Internal
-
     enum CodingKeys: String, CodingKey {
         case description = "message"
     }

@@ -10,15 +10,9 @@ import Logging
 
 typealias SwiftLog = Logging.Logger
 
-// MARK: - Logger
-
 public struct Logger {
-    // MARK: Lifecycle
-
     private init() {}
 
-    // MARK: Public
-
     public static var loggingService: Loggable = {
         var swiftLog = SwiftLog(label: "com.algolia.searchClientSwift")
         print(
@@ -38,8 +32,6 @@ public struct Logger {
         }
     }
 
-    // MARK: Internal
-
     static func trace(_ message: String) {
         self.loggingService.log(level: .trace, message: message)
     }
@@ -69,8 +61,6 @@ public struct Logger {
     }
 }
 
-// MARK: - LogLevel
-
 public enum LogLevel {
     case trace
     case debug
@@ -119,16 +109,12 @@ extension LogLevel {
     }
 }
 
-// MARK: - Loggable
-
 public protocol Loggable {
     var minSeverityLevel: LogLevel { get set }
 
     func log(level: LogLevel, message: String)
 }
 
-// MARK: - SwiftLog + Loggable
-
 extension SwiftLog: Loggable {
     public var minSeverityLevel: LogLevel {
         get {

@@ -8,14 +8,10 @@
 import Foundation
 
 public struct Region: StringOption, ProvidingCustomOption {
-    // MARK: Lifecycle
-
     public init(rawValue: String) {
         self.rawValue = rawValue
     }
 
-    // MARK: Public
-
     public static var us: Self { .init(rawValue: #function) }
 
     /// European (Germany) region for Insights and Analytics APIs

@@ -8,8 +8,6 @@
 import Foundation
 
 public class RequestOptions {
-    // MARK: Lifecycle
-
     public init(
         headers: [String: String]? = nil,
         queryParameters: [String: Any?]? = nil,
@@ -24,8 +22,6 @@ public class RequestOptions {
         self.body = body
     }
 
-    // MARK: Public
-
     public static func +(lhs: RequestOptions, rhs: RequestOptions?) -> RequestOptions {
         guard let rhs else {
             return lhs
@@ -86,8 +82,6 @@ public class RequestOptions {
         return self
     }
 
-    // MARK: Internal
-
     private(set) var headers: [String: String]?
     private(set) var queryParameters: [String: Any?]?
     private(set) var readTimeout: TimeInterval?

@@ -7,8 +7,6 @@
 
 import Foundation
 
-// MARK: - StringOption
-
 public protocol StringOption: Codable, Equatable, RawRepresentable where RawValue == String {}
 
 public extension StringOption {
@@ -17,8 +15,6 @@ public extension StringOption {
     }
 }
 
-// MARK: - ProvidingCustomOption
-
 public protocol ProvidingCustomOption {
     static func custom(_ value: String) -> Self
 }

@@ -7,8 +7,6 @@
 import Foundation
 
 open class CodableHelper {
-    // MARK: Open
-
     open class func decode<T>(_ type: T.Type, from data: Data) -> Swift.Result<T, Error>
     where T: Decodable {
         Swift.Result { try self.jsonDecoder.decode(type, from: data) }
@@ -18,8 +16,6 @@ open class CodableHelper {
         Swift.Result { try self.jsonEncoder.encode(value) }
     }
 
-    // MARK: Public
-
     public static var dateFormatter: DateFormatter {
         get { customDateFormatter ?? defaultDateFormatter }
         set { customDateFormatter = newValue }
@@ -35,8 +31,6 @@ open class CodableHelper {
         set { customJSONEncoder = newValue }
     }
 
-    // MARK: Private
-
     private static var customDateFormatter: DateFormatter?
     private static var defaultDateFormatter: DateFormatter = OpenISO8601DateFormatter()
 

@@ -12,62 +12,42 @@ import Foundation
     import AnyCodable
 #endif
 
-// MARK: - Bool + JSONEncodable
-
 extension Bool: JSONEncodable {
     public func encodeToJSON() -> Any { self }
 }
 
-// MARK: - Float + JSONEncodable
-
 extension Float: JSONEncodable {
     public func encodeToJSON() -> Any { self }
 }
 
-// MARK: - Int + JSONEncodable
-
 extension Int: JSONEncodable {
     public func encodeToJSON() -> Any { self }
 }
 
-// MARK: - Int32 + JSONEncodable
-
 extension Int32: JSONEncodable {
     public func encodeToJSON() -> Any { self }
 }
 
-// MARK: - Int64 + JSONEncodable
-
 extension Int64: JSONEncodable {
     public func encodeToJSON() -> Any { self }
 }
 
-// MARK: - Double + JSONEncodable
-
 extension Double: JSONEncodable {
     public func encodeToJSON() -> Any { self }
 }
 
-// MARK: - Decimal + JSONEncodable
-
 extension Decimal: JSONEncodable {
     public func encodeToJSON() -> Any { self }
 }
 
-// MARK: - String + JSONEncodable
-
 extension String: JSONEncodable {
     public func encodeToJSON() -> Any { self }
 }
 
-// MARK: - URL + JSONEncodable
-
 extension URL: JSONEncodable {
     public func encodeToJSON() -> Any { self }
 }
 
-// MARK: - UUID + JSONEncodable
-
 extension UUID: JSONEncodable {
     public func encodeToJSON() -> Any { self }
 }
@@ -84,24 +64,18 @@ private func encodeIfPossible(_ object: some Any) -> Any {
     }
 }
 
-// MARK: - Array + JSONEncodable
-
 extension Array: JSONEncodable {
     public func encodeToJSON() -> Any {
         map(encodeIfPossible)
     }
 }
 
-// MARK: - Set + JSONEncodable
-
 extension Set: JSONEncodable {
     public func encodeToJSON() -> Any {
         Array(self).encodeToJSON()
     }
 }
 
-// MARK: - Dictionary + JSONEncodable
-
 extension Dictionary: JSONEncodable where Key == String {
     public func encodeToJSON() -> Any {
         var dictionary = [String: Any]()
@@ -112,8 +86,6 @@ extension Dictionary: JSONEncodable where Key == String {
     }
 }
 
-// MARK: - Data + JSONEncodable
-
 extension Data: JSONEncodable {
     public func encodeToJSON() -> Any {
         guard let selfString = String(data: self, encoding: .utf8) else {
@@ -130,8 +102,6 @@ extension Data: JSONEncodable {
     }
 }
 
-// MARK: - Date + JSONEncodable
-
 extension Date: JSONEncodable {
     public func encodeToJSON() -> Any {
         CodableHelper.dateFormatter.string(from: self)
@@ -153,8 +123,6 @@ public extension JSONEncodable where Self: Encodable {
     }
 }
 
-// MARK: - String + CodingKey
-
 extension String: CodingKey {
     public var stringValue: String {
         self
@@ -284,8 +252,6 @@ extension HTTPURLResponse {
     }
 }
 
-// MARK: - URLRequest.FormatError
-
 public extension URLRequest {
     enum FormatError: LocalizedError {
         case missingURL
@@ -294,8 +260,6 @@ public extension URLRequest {
         case invalidPath(String)
         case invalidQueryItems
 
-        // MARK: Public
-
         public var errorDescription: String? {
             let contactUs = "Please contact [email protected] if this problem occurs."
             switch self {