Configuration file

Author: wickwirew

Package.resolved

@@ -22,6 +22,7 @@ let package = Package(
         .package(url: "https://github.com/swiftlang/swift-syntax", from: "600.0.0-latest"),
         .package(url: "https://github.com/apple/swift-collections", from: "1.1.4"),
         .package(url: "https://github.com/apple/swift-argument-parser", from: "1.5.0"),
+        .package(url: "https://github.com/jpsim/Yams", from: "6.0.2"),
     ],
     targets: [
         .macro(
@@ -55,6 +56,7 @@ let package = Package(
             dependencies: [
                 "Compiler",
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
+                "Yams",
             ]
         ),
 

Package.swift

@@ -49,11 +49,8 @@ public actor Driver {
         reporters.append(reporter)
     }
 
-    public func compile(path: Path) async throws {
+    public func compile(migrationsPath: Path, queriesPath: Path) async throws {
         try await measure("Compilation") {
-            let migrationsPath = migrationsPath(at: path)
-            let queriesPath = queriesPath(at: path)
-            
             let migrationFiles = try fileSystem.files(atPath: migrationsPath)
             let queriesFiles = try fileSystem.files(atPath: queriesPath)
 
@@ -163,16 +160,6 @@ public actor Driver {
         }
     }
 
-    /// The migrations path relative to the base path
-    private func migrationsPath(at base: Path) -> Path {
-        "\(base)/Migrations"
-    }
-    
-    /// The queries path relative to the base path
-    private func queriesPath(at base: Path) -> Path {
-        "\(base)/Queries"
-    }
-    
     /// Sorts the migration files
     private func sortMigrations(
         fileNames: [String]

Sources/Compiler/Driver.swift

@@ -326,10 +326,10 @@ public struct GenerationOptions: Sendable {
     public var imports: [String]
 
     public init(
-        databaseName: String? = nil,
+        databaseName: String,
         imports: [String] = []
     ) {
-        self.databaseName = databaseName ?? "DB"
+        self.databaseName = databaseName
         self.imports = imports
     }
 }

Sources/Compiler/Gen/Language.swift

@@ -43,7 +43,7 @@ public struct SwiftLanguage: Language {
     }
 
     public func interpolatedQuestionMarks(for param: String) -> String {
-        return  "\\(\(param).sqlQuestionMarks)"
+        return "\\(\(param).sqlQuestionMarks)"
     }
 
     public func typeName(for type: GenerationType) -> String {

Sources/Compiler/Gen/SwiftLanguage.swift

@@ -9,24 +9,34 @@ import Foundation
 
 /// Small object to make interacting with the overall project structure easier.
 public struct Project {
-    public let url: URL
+    public let generatedOutputFile: URL
     public let migrationsDirectory: URL
     public let queriesDirectory: URL
     private let fileSystem: FileSystem
 
-    public init(url: URL) {
-        self = Project(url: url, fileSystem: FileManager.default)
+    public init(
+        generatedOutputFile: URL,
+        migrationsDirectory: URL,
+        queriesDirectory: URL
+    ) {
+        self = Project(
+            generatedOutputFile: generatedOutputFile,
+            migrationsDirectory: migrationsDirectory,
+            queriesDirectory: queriesDirectory,
+            fileSystem: FileManager.default
+        )
     }
 
-    init(url: URL, fileSystem: FileSystem) {
-        self.url = url
+    init(
+        generatedOutputFile: URL,
+        migrationsDirectory: URL,
+        queriesDirectory: URL,
+        fileSystem: FileSystem
+    ) {
+        self.generatedOutputFile = generatedOutputFile
+        self.migrationsDirectory = migrationsDirectory
+        self.queriesDirectory = queriesDirectory
         self.fileSystem = fileSystem
-        self.migrationsDirectory = url.appendingPathComponent("Migrations")
-        self.queriesDirectory = url.appendingPathComponent("Queries")
-    }
-    
-    public static func inWorkingDir() -> Project {
-        Project(url: URL(fileURLWithPath: FileManager.default.currentDirectoryPath))
     }
 
     public var doesMigrationsExist: Bool {

Sources/Compiler/Project.swift

@@ -0,0 +1,42 @@
+//
+//  Config.swift
+//  Otter
+//
+//  Created by Wes Wickwire on 8/5/25.
+//
+
+import Foundation
+import Yams
+import Compiler
+
+struct Config: Codable {
+    var queries: String
+    var migrations: String
+    var output: String?
+    var databaseName: String?
+    var additionalImports: [String]?
+    
+    func project(at path: String) -> Project {
+        let url = URL(fileURLWithPath: path)
+        
+        return Project(
+            generatedOutputFile: url.appendingPathComponent(output ?? "Queries.swift"),
+            migrationsDirectory: url.appendingPathComponent(migrations),
+            queriesDirectory: url.appendingPathComponent(queries)
+        )
+    }
+    
+    static func load(at path: String) throws -> Config {
+        let url = URL(fileURLWithPath: path)
+            .appendingPathComponent("otter.yaml")
+        
+        guard FileManager.default.fileExists(atPath: url.path) else {
+            throw OtterError.configDoesNotExist
+        }
+        
+        let data = try Data(contentsOf: url)
+        
+        let decoder = YAMLDecoder()
+        return try decoder.decode(Config.self, from: data)
+    }
+}

Sources/OtterCLI/Config.swift

@@ -13,36 +13,35 @@ import SwiftSyntax
 struct GenerateCommand: AsyncParsableCommand {
     static let configuration = CommandConfiguration(commandName: "generate")
 
-    @Option(name: .shortAndLong, help: "The root directory of the Otter sources")
+    @Option(name: .shortAndLong, help: "The directory containing the otter.yaml")
     var path: String = FileManager.default.currentDirectoryPath
 
-    @Option(name: .shortAndLong, help: "The output file path. Default is to stdout")
-    var output: String? = nil
-    
-    @Option(name: .shortAndLong, help: "The database name")
-    var databaseName: String = "DB"
-    
-    @Option(name: .shortAndLong, help: "Comma separated list of additional imports to add")
-    var additionalImports: String?
-    
     @Flag(help: "If set, any diagnostic message will not be colorized")
     var dontColorize = false
 
     @Flag(help: "If set, core parts of the compilation will be timed")
     var time = false
 
     mutating func run() async throws {
+        let config = try Config.load(at: path)
+        let project = config.project(at: path)
+        
         let options = GenerationOptions(
-            databaseName: databaseName,
-            imports: additionalImports?.split(separator: ",").map(\.description) ?? []
+            databaseName: config.databaseName ?? "DB",
+            imports: config.additionalImports ?? []
         )
 
-        try await generate(language: SwiftLanguage.self, options: options)
+        try await generate(
+            language: SwiftLanguage.self,
+            options: options,
+            project: project
+        )
     }
 
     private func generate<Lang: Language>(
         language: Lang.Type,
-        options: GenerationOptions
+        options: GenerationOptions,
+        project: Project
     ) async throws {
         let driver = Driver()
         await driver.logTimes(time)
@@ -51,12 +50,17 @@ struct GenerateCommand: AsyncParsableCommand {
             reporter: StdoutDiagnosticReporter(dontColorize: dontColorize)
         )
 
-        try await driver.compile(path: path)
+        try await driver.compile(
+            migrationsPath: project.migrationsDirectory.path,
+            queriesPath: project.queriesDirectory.path
+        )
 
         try await driver.generate(
             language: Lang.self,
-            to: output,
+            to: project.generatedOutputFile.path,
             options: options
         )
+        
+        print("Generated output to \(project.generatedOutputFile.path)")
     }
 }

Sources/OtterCLI/GenerateCommand.swift

@@ -13,8 +13,26 @@ struct InitCommand: ParsableCommand {
     static let configuration = CommandConfiguration(commandName: "init")
 
     func run() throws {
-        let project = Project.inWorkingDir()
-        try project.setup()
-        try project.addMigration()
+        let defaultConfig = """
+        # The type name of the generated struct for the database 
+        databaseName: DB
+        # Path to the directory containing the migrations
+        migrations: ProjectName/Migrations
+        # Path to the directory containing the queries
+        queries: ProjectName/Queries
+        # The path of the file to generate the Swift code into
+        output: ProjectName/Queries.swift
+        # Uncomment to add any custom imports that may be needed
+        # additionalImports:
+        #     - MyModule
+        """
+        
+        try defaultConfig.write(
+            toFile: FileManager.default.currentDirectoryPath.appending("/otter.yaml"),
+            atomically: true,
+            encoding: .utf8
+        )
+        
+        print("Created otter.yaml configration")
     }
 }

Sources/OtterCLI/InitCommand.swift

@@ -16,10 +16,14 @@ struct MigrateCommand: ParsableCommand {
     )
 
     struct Add: ParsableCommand {
+        @Option(name: .shortAndLong, help: "The directory containing the otter.yaml")
+        var path: String = FileManager.default.currentDirectoryPath
+        
         static let configuration = CommandConfiguration(commandName: "add")
 
         func run() throws {
-            let project = Project.inWorkingDir()
+            let config = try Config.load(at: path)
+            let project = config.project(at: path)
 
             guard project.doesMigrationsExist else {
                 throw OtterError.sourcesNotFound