Xcode diagnostics

Author: wickwirew

Plugins/OtterPlugin/OtterPlugin.swift

@@ -41,7 +41,8 @@ struct OtterPlugin: BuildToolPlugin {
                 projectRoot.absoluteString,
                 "--override-output",
                 queries.absoluteString,
-                "--skip-directory-create"
+                "--skip-directory-create",
+                "--xcode-diagnostic-reporter"
             ],
             inputFiles: sourceFiles?
                 .filter { $0.url.pathExtension == "sql" }

Sources/Compiler/DiagnosticReporter.swift

@@ -5,20 +5,23 @@
 //  Created by Wes Wickwire on 5/3/25.
 //
 
+import Foundation
+
 public protocol DiagnosticReporter {
-    func report(diagnostic: Diagnostic, source: String, fileName: String)
+    func report(diagnostic: Diagnostic, source: String, filePath: String)
 }
 
 extension DiagnosticReporter {
-    func report(diagnostics: Diagnostics, source: String, fileName: String) {
+    func report(diagnostics: Diagnostics, source: String, filePath: String) {
         for diagnostic in diagnostics.sorted(by: { $0.location.lowerBound < $1.location.lowerBound }) {
-            report(diagnostic: diagnostic, source: source, fileName: fileName)
+            report(diagnostic: diagnostic, source: source, filePath: filePath)
         }
     }
 }
 
-public struct StdoutDiagnosticReporter: DiagnosticReporter {
+public final class StdoutDiagnosticReporter: DiagnosticReporter {
     private let dontColorize: Bool
+    private var stderr = FileHandle.standardError
 
     public init(dontColorize: Bool = false) {
         self.dontColorize = dontColorize
@@ -40,7 +43,8 @@ public struct StdoutDiagnosticReporter: DiagnosticReporter {
         dontColorize ? ("", "") : Self.bold
     }
 
-    public func report(diagnostic: Diagnostic, source: String, fileName: String) {
+    public func report(diagnostic: Diagnostic, source: String, filePath: String) {
+        let fileName = filePath.split(separator: "/").last ?? ""
         let range = diagnostic.location.range
         let start = startOfLine(index: range.lowerBound, source: source)
         // Note: This uses `lowerBound` as well to make sure we only get one line
@@ -59,7 +63,7 @@ public struct StdoutDiagnosticReporter: DiagnosticReporter {
         }
 
         print("""
-        \(fileName):\(line):\(column): \(bold.open)\(color.open)\(diagnostic.level)\(color.close)\(bold.close)
+        \(fileName):\(line):\(column): \(bold.open)\(color.open)\(diagnostic.level)\(color.close)\(bold.close):
         
         \(source)
         \(indent)\(color.open)\(underline)\(color.close) - \(bold.open)\(diagnostic.message)\(bold.close)
@@ -90,3 +94,22 @@ public struct StdoutDiagnosticReporter: DiagnosticReporter {
         return index
     }
 }
+
+public final class XcodeDiagnosticReporter: DiagnosticReporter {
+    private var stderr = FileHandle.standardError
+    
+    public init() {}
+    
+    public func report(diagnostic: Diagnostic, source: String, filePath: String) {
+        let line = diagnostic.location.line
+        let column = diagnostic.location.column
+        print("\(filePath):\(line):\(column): \(diagnostic.level): \(diagnostic.message)", to: &stderr)
+    }
+}
+
+extension FileHandle: TextOutputStream {
+    public func write(_ string: String) {
+        let data = Data(string.utf8)
+        self.write(data)
+    }
+}

Sources/Compiler/Driver.swift

@@ -91,7 +91,7 @@ public actor Driver {
             let hasDiagnostics = results.contains { $0.value.diagnostics.contains { $0.level == .error } }
 
             guard !hasDiagnostics else {
-                return // Just skip, diagnostics should have already been emitted.
+                exit(1) // Diagnostics should have already been emitted.
             }
 
             let lang = Lang(options: options)
@@ -140,7 +140,7 @@ public actor Driver {
             }
         }
 
-        report(diagnostics: diagnostics, source: fileContents, fileName: file)
+        report(diagnostics: diagnostics, source: fileContents, filePath: path)
 
         results[file] = Output(
             fileName: file,
@@ -157,9 +157,9 @@ public actor Driver {
         }
     }
 
-    private func report(diagnostics: Diagnostics, source: String, fileName: String) {
+    private func report(diagnostics: Diagnostics, source: String, filePath: String) {
         for reporter in reporters {
-            reporter.report(diagnostics: diagnostics, source: source, fileName: fileName)
+            reporter.report(diagnostics: diagnostics, source: source, filePath: filePath)
         }
     }
 
@@ -211,3 +211,4 @@ public actor Driver {
         return result
     }
 }
+struct Foot: Swift.Error {}

Sources/OtterCLI/GenerateCommand.swift

@@ -27,6 +27,9 @@ struct GenerateCommand: AsyncParsableCommand {
 
     @Flag(help: "If true, the directory the output exists in will not be created if it doesn't exist")
     var skipDirectoryCreate = false
+    
+    @Flag(help: "If true, it will emit diagnostics that Xcode can understand")
+    var xcodeDiagnosticReporter = false
 
     mutating func run() async throws {
         let config = try Config(at: path)
@@ -57,9 +60,11 @@ struct GenerateCommand: AsyncParsableCommand {
         let driver = Driver()
         await driver.logTimes(time)
 
-        await driver.add(
-            reporter: StdoutDiagnosticReporter(dontColorize: dontColorize)
-        )
+        if xcodeDiagnosticReporter {
+            await driver.add(reporter: XcodeDiagnosticReporter())
+        } else {
+            await driver.add(reporter: StdoutDiagnosticReporter(dontColorize: dontColorize))
+        }
 
         try await driver.compile(
             migrationsPath: project.migrationsDirectory.path,