move the configure command into its own file/subcommand

Author: ktoso

.swift-version

@@ -0,0 +1 @@
+6.1.2

Sources/SwiftJavaTool/CommonOptions.swift

@@ -25,14 +25,16 @@ import SwiftSyntaxBuilder
 import JavaKitConfigurationShared
 import JavaKitShared
 
+protocol HasCommonOptions {
+  var commonOptions: SwiftJava.CommonOptions { get set }
+}
+
+protocol HasCommonJVMOptions {
+  var commonJVMOptions: SwiftJava.CommonJVMOptions { get set }
+}
+
 extension SwiftJava {
   struct CommonOptions: ParsableArguments {
-    @Option(
-      name: [.customLong("cp"), .customLong("classpath")],
-      help: "Class search path of directories and zip/jar files from which Java classes can be loaded."
-    )
-    var classpath: [String] = []
-
     // TODO: clarify this vs outputSwift (history: outputSwift is jextract, and this was java2swift)
     @Option(name: .shortAndLong, help: "The directory in which to output the generated Swift files or the SwiftJava configuration file.")
     var outputDirectory: String? = nil
@@ -43,7 +45,14 @@ extension SwiftJava {
     @Option(name: .shortAndLong, help: "Configure the level of logs that should be printed")
     var logLevel: Logger.Level = .info
   }
+
   struct CommonJVMOptions: ParsableArguments {
+    @Option(
+      name: [.customLong("cp"), .customLong("classpath")],
+      help: "Class search path of directories and zip/jar files from which Java classes can be loaded."
+    )
+    var classpath: [String] = []
+
     @Option(name: .shortAndLong, help: "While scanning a classpath, inspect only types included in this package")
     var filterJavaPackage: String? = nil
   }
@@ -60,6 +69,46 @@ protocol SwiftJavaBaseAsyncParsableCommand: AsyncParsableCommand {
 
 }
 
+extension SwiftJavaBaseAsyncParsableCommand {
+  mutating func writeContents(
+    _ contents: String,
+    to filename: String, description: String) throws {
+    try writeContents(
+      contents,
+      outputDirectoryOverride: self.actualOutputDirectory,
+      to: filename,
+      description: description)
+  }
+
+  mutating func writeContents(
+    _ contents: String,
+    outputDirectoryOverride: Foundation.URL?,
+    to filename: String,
+    description: String) throws {
+    guard let outputDir = (outputDirectoryOverride ?? actualOutputDirectory) else {
+      print("// \(filename) - \(description)")
+      print(contents)
+      return
+    }
+
+    // If we haven't tried to create the output directory yet, do so now before
+    // we write any files to it.
+    // if !createdOutputDirectory {
+    try FileManager.default.createDirectory(
+      at: outputDir,
+      withIntermediateDirectories: true
+    )
+    // createdOutputDirectory = true
+    //}
+
+    // Write the file:
+    let file = outputDir.appendingPathComponent(filename)
+    print("[debug][swift-java] Writing \(description) to '\(file.path)'... ", terminator: "")
+    try contents.write(to: file, atomically: true, encoding: .utf8)
+    print("done.".green)
+  }
+}
+
 extension SwiftJavaBaseAsyncParsableCommand {
   public mutating func run() async {
     print("[info][swift-java] Run: \(CommandLine.arguments.joined(separator: " "))")
@@ -168,33 +217,36 @@ extension SwiftJavaBaseAsyncParsableCommand {
 }
 
 extension SwiftJava {
-  struct ConfigureCommand: SwiftJavaBaseAsyncParsableCommand {
+  struct ConfigureCommand: SwiftJavaBaseAsyncParsableCommand, HasCommonOptions, HasCommonJVMOptions {
     static let configuration = CommandConfiguration(
       commandName: "configure",
       abstract: "Configure and emit a swift-java.config file based on an input dependency or jar file")
 
     // TODO: This should be a "make wrappers" option that just detects when we give it a jar
     @Flag(
-      help:
-        "Specifies that the input is a Jar file whose public classes will be loaded. The output of Java2Swift will be a configuration file (Java2Swift.config) that can be used as input to a subsequent Java2Swift invocation to generate wrappers for those public classes."
+      help: "Specifies that the input is a *.jar file whose public classes will be loaded. The output of swift-java will be a configuration file (swift-java.config) that can be used as input to a subsequent swift-java invocation to generate wrappers for those public classes."
     )
     var jar: Bool = false
 
+    @Option(
+      name: .long,
+      help: "How to handle an existing swift-java.config; by default 'overwrite' by can be changed to amending a configuration"
+    )
+    var existingConfigFile: ExistingConfigFileMode = .overwrite
+    enum ExistingConfigFileMode: String, ExpressibleByArgument, Codable {
+      case overwrite
+      case amend
+    }
+
     // FIXME: is it used?
     @Option(help: "The name of the Swift module into which the resulting Swift types will be generated.")
     var moduleName: String? // TODO: rename to --swift-module?
 
-    @Option(
-      name: [.customLong("cp"), .customLong("classpath")],
-      help: "Class search path of directories and zip/jar files from which Java classes can be loaded."
-    )
-    var classpath: [String] = []
-
     @OptionGroup var commonOptions: SwiftJava.CommonOptions
     @OptionGroup var commonJVMOptions: SwiftJava.CommonJVMOptions
 
     @Argument(
-      help: "The input file, which is either a Java2Swift configuration file or (if '-jar' was specified) a Jar file."
+      help: "The input file, which is either a swift-java configuration file or (if '-jar' was specified) a Jar file."
     )
     var input: String = ""
   }
@@ -204,7 +256,7 @@ extension SwiftJava.ConfigureCommand {
   mutating func runSwiftJavaCommand(config: inout Configuration) async throws {
     // Form a class path from all of our input sources:
     //   * Command-line option --classpath
-    let classpathOptionEntries: [String] = classpath.flatMap { $0.split(separator: ":").map(String.init) }
+    let classpathOptionEntries: [String] = self.commonJVMOptions.classpath.flatMap { $0.split(separator: ":").map(String.init) }
     let classpathFromEnv = ProcessInfo.processInfo.environment["CLASSPATH"]?.split(separator: ":").map(String.init) ?? []
     let classpathFromConfig: [String] = config.classpath?.split(separator: ":").map(String.init) ?? []
     print("[debug][swift-java] Base classpath from config: \(classpathFromConfig)")
@@ -239,7 +291,7 @@ extension SwiftJava.ConfigureCommand {
     }
     let jvm = try JavaVirtualMachine.shared(classpath: classpathEntries)
 
-    try emitConfiguration(classpath: classpath, environment: jvm.environment())
+    try emitConfiguration(classpath: self.commonJVMOptions.classpath, environment: jvm.environment())
   }
 
   /// Get base configuration, depending on if we are to 'amend' or 'overwrite' the existing configuration.
@@ -249,7 +301,7 @@ extension SwiftJava.ConfigureCommand {
       return (false, .init())
     }
 
-    switch self.existingConfig {
+    switch self.existingConfigFile {
     case .overwrite:
       // always make up a fresh instance if we're overwriting
       return (false, .init())

Sources/SwiftJavaTool/SwiftJava+EmitConfiguration.swift

@@ -137,7 +137,7 @@ extension SwiftJava {
     // The file contents are just plain
     let contents = resolvedClasspath.classpath
 
-    print("[debug][swift-java] Resolved dependency: \(commonOptions.classpath)")
+    print("[debug][swift-java] Resolved dependency: \(commonJVMOptions.classpath)")
 
     // Write the file
     try writeContents(

Sources/SwiftJavaTool/SwiftJava+FetchDependencies.swift

@@ -103,13 +103,6 @@ struct SwiftJava: SwiftJavaBaseAsyncParsableCommand {
       return nil
     }
   }
-  
-  @Option(name: .shortAndLong, help: "How to handle an existing swift-java.config; by default 'overwrite' by can be changed to amending a configuration")
-  var existingConfig: ExistingConfigFileMode = .overwrite
-  public enum ExistingConfigFileMode: String, ExpressibleByArgument, Codable {
-    case overwrite
-    case amend
-  }
 
 //  @Option(name: .shortAndLong, help: "While scanning a classpath, inspect only types included in this package")
 //  var javaPackageFilter: String? = nil
@@ -119,9 +112,6 @@ struct SwiftJava: SwiftJavaBaseAsyncParsableCommand {
 //  )
   var input: String? // FIXME: top level command cannot have input argument like this
 
-  /// Whether we have ensured that the output directory exists.
-  var createdOutputDirectory: Bool = false
-
   // FIXME: this is subcommands
   /// Describes what kind of generation action is being performed by swift-java.
   enum ToolMode {
@@ -231,7 +221,7 @@ struct SwiftJava: SwiftJavaBaseAsyncParsableCommand {
 
       // Form a class path from all of our input sources:
       //   * Command-line option --classpath
-      let classpathOptionEntries: [String] = commonOptions.classpath.flatMap { $0.split(separator: ":").map(String.init) }
+      let classpathOptionEntries: [String] = commonJVMOptions.classpath.flatMap { $0.split(separator: ":").map(String.init) }
       let classpathFromEnv = ProcessInfo.processInfo.environment["CLASSPATH"]?.split(separator: ":").map(String.init) ?? []
       let classpathFromConfig: [String] = config.classpath?.split(separator: ":").map(String.init) ?? []
       print("[debug][swift-java] Base classpath from config: \(classpathFromConfig)")
@@ -368,43 +358,6 @@ struct SwiftJava: SwiftJavaBaseAsyncParsableCommand {
     return (javaClassName, swiftName.javaClassNameToCanonicalName)
   }
 
-  mutating func writeContents(
-    _ contents: String,
-    to filename: String, description: String) throws {
-    try writeContents(
-      contents,
-      outputDirectoryOverride: self.actualOutputDirectory,
-      to: filename,
-      description: description)
-  }
-
-  mutating func writeContents(
-    _ contents: String,
-    outputDirectoryOverride: Foundation.URL?,
-    to filename: String,
-    description: String) throws {
-    guard let outputDir = (outputDirectoryOverride ?? actualOutputDirectory) else {
-      print("// \(filename) - \(description)")
-      print(contents)
-      return
-    }
-
-    // If we haven't tried to create the output directory yet, do so now before
-    // we write any files to it.
-    if !createdOutputDirectory {
-      try FileManager.default.createDirectory(
-        at: outputDir,
-        withIntermediateDirectories: true
-      )
-      createdOutputDirectory = true
-    }
-
-    // Write the file:
-    let file = outputDir.appendingPathComponent(filename)
-    print("[debug][swift-java] Writing \(description) to '\(file.path)'... ", terminator: "")
-    try contents.write(to: file, atomically: true, encoding: .utf8)
-    print("done.".green)
-  }
 }
 
 enum JavaToSwiftError: Error {