Merge pull request #92 from owenv/help-argument-parser

Add a swift-argument-parser dependency and use it in swift-help

Author: DougGregor

CMakeLists.txt

@@ -42,6 +42,7 @@ endif()
 find_package(dispatch QUIET)
 find_package(Foundation QUIET)
 find_package(Yams CONFIG REQUIRED)
+find_package(ArgumentParser CONFIG REQUIRED)
 
 add_subdirectory(Sources)
 add_subdirectory(cmake/modules)

Package.resolved

@@ -1,6 +1,15 @@
 {
   "object": {
     "pins": [
+      {
+        "package": "swift-argument-parser",
+        "repositoryURL": "https://github.com/apple/swift-argument-parser.git",
+        "state": {
+          "branch": null,
+          "revision": "15351c1cd009eba0b6e438bfef55ea9847a8dc4a",
+          "version": "0.3.0"
+        }
+      },
       {
         "package": "llbuild",
         "repositoryURL": "https://github.com/apple/swift-llbuild.git",

Package.swift

@@ -53,7 +53,7 @@ let package = Package(
     /// The help executable.
     .target(
       name: "swift-help",
-      dependencies: ["SwiftOptions"]),
+      dependencies: ["SwiftOptions", "ArgumentParser"]),
 
     /// The `makeOptions` utility (for importing option definitions).
     .target(
@@ -82,10 +82,12 @@ if ProcessInfo.processInfo.environment["SWIFTCI_USE_LOCAL_DEPS"] == nil {
   package.dependencies += [
     .package(url: "https://github.com/apple/swift-tools-support-core.git", .branch("master")),
     .package(url: "https://github.com/jpsim/Yams.git", .upToNextMinor(from: "4.0.0")),
+    .package(url: "https://github.com/apple/swift-argument-parser.git", .exact("0.3.0"))
     ]
 } else {
     package.dependencies += [
         .package(path: "../swiftpm/swift-tools-support-core"),
         .package(path: "../yams"),
+        .package(path: "../swift-argument-parser"),
     ]
 }

README.md

@@ -46,11 +46,12 @@ all with CMake:
   ```
   cmake -B <llbuild-build-dir> -G Ninja <llbuild-source-dir> -DLLBUILD_SUPPORT_BINDINGS="Swift"
   ```
+* [swift-argument-parser](https://github.com/apple/swift-argument-parser)
 * [Yams](https://github.com/jpsim/Yams)
 
 Once those dependencies have built, build `swift-driver` itself:
 ```
-cmake -B <swift-driver-build-dir> -G Ninja <swift-driver-source-dir> -DTSC_DIR=<swift-tools-support-core-build-dir>/cmake/modules -DLLBuild_DIR=<llbuild-build-dir>/cmake/modules -DYams_DIR=<yamls-build-dir>/cmake/modules
+cmake -B <swift-driver-build-dir> -G Ninja <swift-driver-source-dir> -DTSC_DIR=<swift-tools-support-core-build-dir>/cmake/modules -DLLBuild_DIR=<llbuild-build-dir>/cmake/modules -DYams_DIR=<yamls-build-dir>/cmake/modules -DArgumentParser_DIR=<swift-argument-parser-build-dir>
 cmake --build <swift-driver-build-dir>
 ```
 

Sources/swift-help/CMakeLists.txt

@@ -9,5 +9,6 @@
 add_executable(swift-help
   main.swift)
 target_link_libraries(swift-help PUBLIC
-  SwiftOptions)
+  SwiftOptions
+  ArgumentParser)
 

Sources/swift-help/main.swift

@@ -10,42 +10,24 @@
 //
 //===----------------------------------------------------------------------===//
 import SwiftOptions
-import TSCBasic
-import TSCLibc
-import TSCUtility
+import ArgumentParser
 
-extension DriverKind: StringEnumArgument {
-  public static var completion: ShellCompletion { .none }
-}
-
-struct Options {
-  var driverKind: DriverKind = .interactive
-  var showHidden: Bool = false
-}
+extension DriverKind: ExpressibleByArgument {}
 
-let driverOptionTable = OptionTable()
-let parser = ArgumentParser(commandName: "swift help",
-                            usage: " ",
-                            overview: "Swift help tool",
-                            seeAlso: nil)
-let binder = ArgumentBinder<Options>()
-binder.bind(option: parser.add(option: "-show-hidden",
-                               usage: "List hidden (unsupported) options"),
-            to: { $0.showHidden = $1 })
-binder.bind(option: parser.add(option: "-tool", kind: DriverKind.self,
-                               usage: "The tool to list options of"),
-            to: { $0.driverKind = $1 })
+struct SwiftHelp: ParsableCommand {
+  @ArgumentParser.Option(name: .customLong("tool", withSingleDash: true),
+                         help: "The tool to list options of")
+  var tool: DriverKind = .interactive
 
-do {
-  let parseResult = try parser.parse(Array(CommandLine.arguments.dropFirst()))
-  var options = Options()
-  try binder.fill(parseResult: parseResult, into: &options)
+  @Flag(name: .customLong("show-hidden", withSingleDash: true),
+        help: "List hidden (unsupported) options")
+  var showHidden: Bool = false
 
-  // Print the option table.
-  driverOptionTable.printHelp(driverKind: options.driverKind,
-                              includeHidden: options.showHidden)
-} catch {
-  stderrStream <<< "error: " <<< error.localizedDescription
-  stderrStream.flush()
-  exit(EXIT_FAILURE)
+  func run() throws {
+    let driverOptionTable = OptionTable()
+    driverOptionTable.printHelp(driverKind: tool, includeHidden: showHidden)
+  }
 }
+
+// SwiftPM executables don't support @main.
+SwiftHelp.main()