Merge pull request #44 from owenv/help-updates

Miscellaneous improvements to -help messages

Author: DougGregor

Sources/SwiftDriver/Driver/Driver.swift

@@ -556,7 +556,7 @@ extension Driver {
     }
 
     if parsedOptions.contains(.help) || parsedOptions.contains(.helpHidden) {
-      optionTable.printHelp(usage: driverKind.usage, title: driverKind.title, includeHidden: parsedOptions.contains(.helpHidden))
+      optionTable.printHelp(driverKind: driverKind, includeHidden: parsedOptions.contains(.helpHidden))
       return
     }
 

Sources/SwiftDriver/Driver/DriverKind.swift

@@ -27,25 +27,7 @@ public enum DriverKind {
 
 extension DriverKind {
   public var usage: String {
-    switch self {
-    case .autolinkExtract:
-      return "swift-autolink-extract"
-
-    case .batch:
-      return "swiftc"
-
-    case .frontend:
-      return "swift -frontend"
-
-    case .indent:
-      return "swift-indent"
-
-    case .interactive:
-      return "swift"
-
-    case .moduleWrap:
-      return "swift-modulewrap"
-    }
+    usageArgs.joined(separator: " ")
   }
 
   public var usageArgs: [String] {
@@ -88,4 +70,21 @@ extension DriverKind {
       return "Swift Module Wrapper"
     }
   }
+  
+  public var seeAlsoHelpMessage: String? {
+    switch self {
+    case .interactive:
+      return """
+             SEE ALSO - PACKAGE MANAGER COMMANDS:
+                     "swift build" Build sources into binary products
+                     "swift package" Perform operations on Swift packages
+                     "swift run" Build and run an executable product
+                     "swift test" Build and run tests
+             """
+    case .batch:
+      return "SEE ALSO: swift build, swift run, swift package, swift test"
+    default:
+      return nil
+    }
+  }
 }

Sources/SwiftDriver/Options/OptionTable.swift

@@ -26,18 +26,19 @@ public struct OptionTable {
 
 extension OptionTable {
   /// Print help information to the terminal.
-  public func printHelp(usage: String, title: String, includeHidden: Bool) {
+  public func printHelp(driverKind: DriverKind, includeHidden: Bool) {
     print("""
-      OVERVIEW: \(title)
+      OVERVIEW: \(driverKind.title)
 
-      USAGE: \(usage)
+      USAGE: \(driverKind.usage)
 
       OPTIONS:
       """)
 
     for option in options {
       if option.isAlias { continue }
       if option.isHelpHidden && !includeHidden { continue }
+      guard option.isAccepted(by: driverKind) else { continue }
       guard let helpText = option.helpText else { continue }
 
       let maxDisplayNameLength = 23
@@ -71,5 +72,8 @@ extension OptionTable {
         print("  \(leftPadding) \(helpText)")
       }
     }
+    if let seeAlsoMessage = driverKind.seeAlsoHelpMessage {
+      print("\n\(seeAlsoMessage)")
+    }
   }
 }