feat: Show option and flag default values in help output

Closes #34

Author: kylef

CHANGELOG.md

@@ -10,6 +10,9 @@
   [#37](https://github.com/kylef/Commander/issues/37)
 - Argument descriptions are now printed in command help.
   [#33](https://github.com/kylef/Commander/issues/33)
+- Default option and flag default values will now be shown in help output.
+  Only default option types of String and Int are currently supported in help output.
+  [#34](https://github.com/kylef/Commander/issues/34)
 
 ### Bug Fixes
 

Sources/ArgumentDescription.swift

@@ -253,8 +253,12 @@ class BoxedArgumentDescriptor {
 
     if let value = value as? Flag {
       `default` = value.`default`.description
+    } else if let value = value as? Option<String> {
+      `default` = value.`default`.description
+    } else if let value = value as? Option<Int> {
+      `default` = value.`default`.description
     } else {
-      // TODO, default for Option and Options
+      // TODO, default for Option of generic type
       `default` = nil
     }
   }
@@ -343,13 +347,17 @@ class Help : Error, ANSIConvertible, CustomStringConvertible {
     if !options.isEmpty {
       output.append("Options:")
       for option in options {
-        // TODO: default, [default: `\(`default`)`]
+        var line = "    --\(option.name)"
+
+        if let `default` = option.default {
+          line += " [default: \(`default`)]"
+        }
 
         if let description = option.description {
-          output.append("    --\(option.name) - \(description)")
-        } else {
-          output.append("    --\(option.name)")
+          line += " - \(description)"
         }
+
+        output.append(line)
       }
     }
 
@@ -401,13 +409,17 @@ class Help : Error, ANSIConvertible, CustomStringConvertible {
     if !options.isEmpty {
       output.append("Options:")
       for option in options {
-        // TODO: default, [default: `\(`default`)`]
+        var line = "    \(ANSI.blue)--\(option.name)\(ANSI.reset)"
+
+        if let `default` = option.default {
+          line += " [default: \(`default`)]"
+        }
 
         if let description = option.description {
-          output.append("    \(ANSI.blue)--\(option.name)\(ANSI.reset) - \(description)")
-        } else {
-          output.append("    \(ANSI.blue)--\(option.name)\(ANSI.reset)")
+          line += " - \(description)"
         }
+
+        output.append(line)
       }
     }
 

Tests/CommanderTests/ArgumentDescriptionSpec.swift

@@ -13,5 +13,16 @@ public func testArgumentDescription() {
       try expect(help.description) == "Arguments:\n\n    arg1\n    arg2 - an example\n"
       try expect(help.ansiDescription) == "Arguments:\n\n    \(ANSI.blue)arg1\(ANSI.reset)\n    \(ANSI.blue)arg2\(ANSI.reset) - an example\n"
     }
+
+    $0.it("shows options") {
+      let help = Help([
+        BoxedArgumentDescriptor(value: Option<String>("opt1", "example")),
+        BoxedArgumentDescriptor(value: Flag("flag1", description: "an example")),
+        BoxedArgumentDescriptor(value: Flag("flag2", default: true)),
+      ])
+
+      try expect(help.description) == "Options:\n    --opt1 [default: example]\n    --flag1 [default: false] - an example\n    --flag2 [default: true]"
+      try expect(help.ansiDescription) == "Options:\n    \(ANSI.blue)--opt1\(ANSI.reset) [default: example]\n    \(ANSI.blue)--flag1\(ANSI.reset) [default: false] - an example\n    \(ANSI.blue)--flag2\(ANSI.reset) [default: true]"
+    }
   }
 }