Add Swiftlint

Author: RISCfuture

.github/workflows/ci.yml

@@ -28,3 +28,9 @@ jobs:
         run: swift build -v
       - name: Test
         run: swift test -v
+  lint:
+    name: Run Swiftlint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: norio-nomura/[email protected]

.gitignore

@@ -1 +1,5 @@
 .swiftpm
+
+
+# SwiftLint Remote Config Cache
+.swiftlint/RemoteConfigCache

.swiftlint.yml

@@ -0,0 +1 @@
+parent_config: https://gist.githubusercontent.com/RISCfuture/c57d132e5e0160a768df1625e20ae3b8/raw/.swiftlint.yml

Package.resolved

@@ -15,7 +15,7 @@ let package = Package(
             name: "METARFormatting",
             targets: ["METARFormatting"]),
         .executable(name: "decode-metar", targets: ["DecodeMETAR"]),
-        .executable(name: "decode-taf", targets: ["DecodeTAF"]),
+        .executable(name: "decode-taf", targets: ["DecodeTAF"])
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
@@ -24,7 +24,7 @@ let package = Package(
         .package(url: "https://github.com/objecthub/swift-numberkit.git", from: "2.6.0"),
         .package(url: "https://github.com/apple/swift-docc-plugin.git", from: "1.4.3"),
         .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.5.0"),
-        .package(url: "https://github.com/Mr-Alirezaa/BuildableMacro.git", from: "0.5.0"),
+        .package(url: "https://github.com/Mr-Alirezaa/BuildableMacro.git", from: "0.5.0")
     ],
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.

Package.swift

@@ -1,7 +1,7 @@
-import Foundation
 import ArgumentParser
-import SwiftMETAR
+import Foundation
 import METARFormatting
+import SwiftMETAR
 
 @available(macOS 15.0, *)
 @main
@@ -13,31 +13,31 @@ struct DecodeMETAR: AsyncParsableCommand {
             in which case it will download the latest METARs from AWC; or it can be used with
             a raw METAR string, in which case that string will be parsed.
             """)
-    
+
     @Argument(help: "The ICAO code of an airport, or a METAR string to decode")
-    var airportCodeOrMETAR: String? = nil
-    
-    @Option(name: [.customLong("metar-url"), .short], help: "The URL to load the METAR CSV from.", transform: { URL(string: $0)! })
+    var airportCodeOrMETAR: String?
+
+    @Option(name: [.customLong("metar-url"), .short], help: "The URL to load the METAR CSV from.", transform: { .init(string: $0)! })
     var METAR_URL = URL(string: "https://aviationweather.gov/data/cache/metars.cache.csv")!
-    
+
     @Flag(name: .long, inversion: .prefixedNo, help: "Include raw METAR text")
     var raw = false
-    
+
     @Flag(name: .shortAndLong, inversion: .prefixedNo, help: "Include remarks")
     var remarks = true
-    
+
     @Flag(name: .long, help: "Parse and decode all METARs (!)")
     var all = false
-    
+
     @Flag(name: .long, help: "Only show stations with parsing errors (intended to be used with `--all`")
     var errorsOnly = false
-    
+
     private var session: URLSession { .init(configuration: .ephemeral) }
-    
+
     func run() async throws {
         try await all ? parseAll() : parsePrompt()
     }
-    
+
     private func parseAll() async throws {
         let METARs = try await loadMETARs { raw, error in
             print(raw)
@@ -50,50 +50,50 @@ struct DecodeMETAR: AsyncParsableCommand {
             }
         }
     }
-    
+
     private func parsePrompt() async throws {
         let airportCodeOrMETAR = promptMETAR()
         let metar = try await airportCodeOrMETAR.count == 4 ? parse(code: airportCodeOrMETAR) : parse(raw: airportCodeOrMETAR)
         printMETAR(metar)
     }
-    
+
     private func promptMETAR() -> String {
         var airportCodeOrMETAR = self.airportCodeOrMETAR
-        
+
         while airportCodeOrMETAR == nil || airportCodeOrMETAR!.isEmpty {
             print("Enter airport code or METAR: ", terminator: "")
             airportCodeOrMETAR = readLine(strippingNewline: true)
         }
-        
+
         return airportCodeOrMETAR!
     }
-    
+
     private func parse(code: String) async throws -> METAR {
         guard let metar = try await getMETAR(airportCode: code) else {
             throw Errors.unknownAirportID(code)
         }
         return metar
     }
-    
+
     private func parse(raw: String) async throws -> METAR {
         try await METAR.from(string: raw)
     }
-    
-    private func loadMETARs(errorHandler: ((String, Swift.Error) throws -> Void)) async throws -> Dictionary<String, METAR> {
+
+    private func loadMETARs(errorHandler: ((String, Swift.Error) throws -> Void)) async throws -> [String: METAR] {
         print("Loading METARs…")
         print()
-        
+
         let (data, response) = try await session.bytes(from: METAR_URL)
         guard let response = response as? HTTPURLResponse else {
             throw Errors.badResponse(response)
         }
-        guard response.statusCode/100 == 2 else {
+        guard response.statusCode / 100 == 2 else {
             throw Errors.badStatus(response: response)
         }
-        
-        var METARs = Dictionary<String, METAR>()
+
+        var METARs = [String: METAR]()
         for try await line in data.lines {
-            guard let range  = line.rangeOfCharacter(from: CharacterSet(charactersIn: ",")) else { continue }
+            guard let range = line.rangeOfCharacter(from: CharacterSet(charactersIn: ",")) else { continue }
             let string = String(line[line.startIndex..<range.lowerBound])
             guard string.starts(with: "K") else { continue }
             do {
@@ -103,26 +103,26 @@ struct DecodeMETAR: AsyncParsableCommand {
                 try errorHandler(string, error)
             }
         }
-        
+
         return METARs
     }
-    
+
     private func getMETAR(airportCode: String) async throws -> METAR? {
-        let METARs = try await loadMETARs { raw, error in
+        let METARs = try await loadMETARs { raw, _ in
             if raw.starts(with: airportCode) {
                 throw Errors.badMETAR(raw: raw)
             }
         }
-        
+
         return METARs[airportCode]
     }
-    
+
     private func printMETAR(_ metar: METAR) {
         print("Airport: \(metar.stationID)")
         if raw, let text = metar.text {
             print(text)
         }
-        
+
         lprint("Issued: \(metar.date, format: .dateTime) (\(metar.issuance, format: .issuance))")
         lprint("Observer: \(metar.observer, format: .observer)")
         if let wind = metar.wind {
@@ -149,21 +149,21 @@ struct DecodeMETAR: AsyncParsableCommand {
         if let altimeter = metar.altimeter?.measurement {
             lprint("Altimeter: \(altimeter, format: .measurement(width: .abbreviated, usage: .asProvided))")
         }
-        
+
         if remarks {
             print()
             printRemarks(metar: metar)
         }
-        
+
         print()
     }
-    
+
     private func printRemarks(metar: METAR) {
         for remark in metar.remarks.sorted(using: RemarkComparator()) {
             print(RemarkEntry.FormatStyle.remark().format(remark))
         }
     }
-    
+
     private func lprint(_ str: LocalizedStringResource) {
         print(String(localized: str))
     }
@@ -185,7 +185,7 @@ extension Errors: LocalizedError {
             case let .badMETAR(raw): "Couldn’t parse METAR: \(raw)"
         }
     }
-    
+
     var failureReason: String? {
         switch self {
             case .badResponse, .badStatus: "The AWC API may have changed, or may not be functioning properly."

Sources/DecodeMETAR/DecodeMETAR.swift

@@ -1,16 +1,17 @@
+import BuildableMacro
 import Foundation
-import SwiftMETAR
 import METARFormatting
-import BuildableMacro
+import SwiftMETAR
 
 public extension RemarkEntry {
-    
+
     /// Formatter for `RemarkEntry`
-    @Buildable struct FormatStyle: Foundation.FormatStyle, Sendable {
-        
+    @Buildable
+    struct FormatStyle: Foundation.FormatStyle, Sendable {
+
         /// The format to use when printing times.
         public var dateFormat = Date.FormatStyle(date: .omitted, time: .shortened)
-        
+
         public func format(_ value: RemarkEntry) -> String {
             switch value.urgency {
                 case .unknown: String(localized: "(?) \(value.remark, format: .remark(dateFormat: dateFormat))", comment: "unknown remark")
@@ -22,10 +23,12 @@ public extension RemarkEntry {
     }
 }
 
+// swiftlint:disable missing_docs
 public extension FormatStyle where Self == RemarkEntry.FormatStyle {
+    static var remark: Self { .init() }
+
     static func remark(dateFormat: Date.FormatStyle? = nil) -> Self {
         dateFormat.map { .init(dateFormat: $0) } ?? .init()
     }
-    
-    static var remark: Self { .init() }
 }
+// swiftlint:enable missing_docs