Make Option by default a string option. (#26)

Fixes #13.

Author: floitsch

examples/main.toit

@@ -122,7 +122,7 @@ create_device_command -> cli.Command:
           last used device is used.
         """
       --options=[
-        cli.OptionString "device" --short_name="d"
+        cli.Option "device" --short_name="d"
             --short_help="The device to operate on."
       ]
   device_cmd.add create_reset_command

main.toit

@@ -13,7 +13,7 @@ main args:
           --short_name="f"
           --short_help="Output format"
           --default="long",
-        arguments.OptionString "global" --short_help="global required flag" --required,
+        arguments.Option "global" --short_help="global required flag" --required,
       ]
       --examples=[
         arguments.Example "Example of subcommand"
@@ -29,13 +29,13 @@ main args:
         Multiple lines.
         """
       --options=[
-        arguments.OptionString "other" --short_help="other option",
+        arguments.Option "other" --short_help="other option",
         arguments.OptionInt "other_int" --short_help="other int option\ntwo lines" --default=42,
         arguments.OptionInt "other_int2" --required --multi,
       ]
       --rest=[
-        arguments.OptionString "input" --short_help="Input file" --required --type="file",
-        arguments.OptionString "output" --short_help="Output file" --multi --required --type="file",
+        arguments.Option "input" --short_help="Input file" --required --type="file",
+        arguments.Option "output" --short_help="Output file" --multi --required --type="file",
       ]
       --examples=[
         arguments.Example "Use a long output format"
@@ -47,8 +47,8 @@ main args:
       --run=:: | parsed | run_other parsed
       --short_help="""Some short help for the other2 command.\nTwo lines."""
       --rest=[
-        arguments.OptionString "input" --short_help="Input file" --required --type="file",
-        arguments.OptionString "output" --short_help="Output file" --multi --required --type="file",
+        arguments.Option "input" --short_help="Input file" --required --type="file",
+        arguments.Option "output" --short_help="Output file" --multi --required --type="file",
         arguments.Flag "flag_rest"
       ]
       --examples=[

src/cli.toit

@@ -251,9 +251,32 @@ abstract class Option:
   is_multi/bool
   should_split_commas/bool
 
+  /** An alias for $OptionString. */
+  constructor name/string
+      --default/string?=null
+      --type/string="string"
+      --short_name/string?=null
+      --short_help/string?=null
+      --required/bool=false
+      --hidden/bool=false
+      --multi/bool=false
+      --split_commas/bool=false:
+    return OptionString name
+        --default=default
+        --type=type
+        --short_name=short_name
+        --short_help=short_help
+        --required=required
+        --hidden=hidden
+        --multi=multi
+        --split_commas=split_commas
+
   /**
   Creates an option with the given $name.
 
+  This constructor is intended to be called from subclasses. Also see $Option.constructor
+    which is an alias for the $OptionString constructor.
+
   The $name sets the name of the option. It must be unique among all options of a command.
     It is also used to extract the parsed value from the $Parsed object. For multi-word
     options kebab case ('foo-bar') is recommended. The constructor automatically converts
@@ -275,9 +298,8 @@ abstract class Option:
 
   If $split_commas is true, then $multi must be true too. Values given to this option are then
     split on commas. For example, `--option a,b,c` will result in the list `["a", "b", "c"]`.
-
   */
-  constructor .name --.short_name --.short_help --required --hidden --multi --split_commas:
+  constructor.from_subclass .name --.short_name --.short_help --required --hidden --multi --split_commas:
     name = to_kebab name
     is_required = required
     is_hidden = hidden
@@ -355,7 +377,7 @@ class OptionString extends Option:
       --split_commas/bool=false:
     if multi and default: throw "Multi option can't have default value."
     if required and default: throw "Option can't have default value and be required."
-    super name --short_name=short_name --short_help=short_help \
+    super.from_subclass name --short_name=short_name --short_help=short_help \
         --required=required --hidden=hidden --multi=multi \
         --split_commas=split_commas
 
@@ -398,7 +420,7 @@ class OptionEnum extends Option:
       --split_commas/bool=false:
     if multi and default: throw "Multi option can't have default value."
     if required and default: throw "Option can't have default value and be required."
-    super name --short_name=short_name --short_help=short_help \
+    super.from_subclass name --short_name=short_name --short_help=short_help \
         --required=required --hidden=hidden --multi=multi \
         --split_commas=split_commas
     if default and not values.contains default:
@@ -439,7 +461,7 @@ class OptionInt extends Option:
       --split_commas/bool=false:
     if multi and default: throw "Multi option can't have default value."
     if required and default: throw "Option can't have default value and be required."
-    super name --short_name=short_name --short_help=short_help \
+    super.from_subclass name --short_name=short_name --short_help=short_help \
         --required=required --hidden=hidden --multi=multi \
         --split_commas=split_commas
 
@@ -478,7 +500,7 @@ class Flag extends Option:
       --multi/bool=false:
     if multi and default != null: throw "Multi option can't have default value."
     if required and default != null: throw "Option can't have default value and be required."
-    super name --short_name=short_name --short_help=short_help \
+    super.from_subclass name --short_name=short_name --short_help=short_help \
         --required=required --hidden=hidden --multi=multi --no-split_commas
 
   type -> string:

tests/check_test.toit

@@ -39,37 +39,37 @@ missing_run:
 ambiguous_option:
   root := cli.Command "root"
       --options=[
-        cli.OptionString "foo" --short_name="a",
-        cli.OptionString "foo" --short_name="b",
+        cli.Option "foo" --short_name="a",
+        cli.Option "foo" --short_name="b",
       ]
       --run=(:: null)
 
   expect_throw "Ambiguous option of 'root': --foo.": root.check --invoked_command="root"
 
   root = cli.Command "root"
       --options=[
-        cli.OptionString "foo" --short_name="a",
-        cli.OptionString "bar" --short_name="a",
+        cli.Option "foo" --short_name="a",
+        cli.Option "bar" --short_name="a",
       ]
       --run=(:: null)
   expect_throw "Ambiguous option of 'root': -a.": root.check --invoked_command="root"
 
   root = cli.Command "root"
       --options=[
-        cli.OptionString "foo" --short_name="a",
-        cli.OptionString "bar" --short_name="ab",
+        cli.Option "foo" --short_name="a",
+        cli.Option "bar" --short_name="ab",
       ]
       --run=(:: null)
   expect_throw "Ambiguous option of 'root': -ab.": root.check --invoked_command="root"
 
   root = cli.Command "root"
       --options=[
-        cli.OptionString "foo" --short_name="a",
+        cli.Option "foo" --short_name="a",
       ]
 
   sub := cli.Command "sub"
       --options=[
-        cli.OptionString "foo" --short_name="b",
+        cli.Option "foo" --short_name="b",
       ]
       --run=(:: null)
   root.add sub
@@ -78,11 +78,11 @@ ambiguous_option:
 
   root = cli.Command "root"
       --options=[
-        cli.OptionString "foo" --short_name="a",
+        cli.Option "foo" --short_name="a",
       ]
   sub = cli.Command "sub"
       --options=[
-        cli.OptionString "bar" --short_name="a",
+        cli.Option "bar" --short_name="a",
       ]
       --run=(:: null)
   root.add sub
@@ -91,11 +91,11 @@ ambiguous_option:
 
   root = cli.Command "root"
       --options=[
-        cli.OptionString "foo" --short_name="a",
+        cli.Option "foo" --short_name="a",
       ]
   sub = cli.Command "sub"
       --options=[
-        cli.OptionString "bar" --short_name="ab",
+        cli.Option "bar" --short_name="ab",
       ]
       --run=(:: null)
   root.add sub
@@ -104,11 +104,11 @@ ambiguous_option:
 
   root = cli.Command "root"
       --options=[
-        cli.OptionString "machine_32" --short_name="m32",
+        cli.Option "machine_32" --short_name="m32",
       ]
   sub = cli.Command "sub"
       --options=[
-        cli.OptionString "machine_64" --short_name="m64",
+        cli.Option "machine_64" --short_name="m64",
       ]
       --run=(:: null)
   root.add sub
@@ -117,13 +117,13 @@ ambiguous_option:
   root = cli.Command "root"
   sub1 := cli.Command "sub1"
       --options=[
-        cli.OptionString "foo" --short_name="a",
+        cli.Option "foo" --short_name="a",
       ]
       --run=(:: null)
   root.add sub1
   sub2 := cli.Command "sub2"
       --options=[
-        cli.OptionString "foo" --short_name="a",
+        cli.Option "foo" --short_name="a",
       ]
       --run=(:: null)
   root.add sub2
@@ -144,7 +144,7 @@ ambiguous_command:
 rest_and_command:
   root := cli.Command "root"
       --rest=[
-        cli.OptionString "rest" --multi,
+        cli.Option "rest" --multi,
       ]
   sub := cli.Command "sub"
       --run=(:: null)
@@ -154,7 +154,7 @@ rest_and_command:
   expect_throw "Cannot have both subcommands and rest arguments.":
     root = cli.Command "root"
         --rest=[
-          cli.OptionString "rest" --multi,
+          cli.Option "rest" --multi,
         ]
         --subcommands=[
           cli.Command "sub" --run=(:: null),
@@ -179,47 +179,47 @@ run_and_command:
 rest:
   root := cli.Command "root"
       --rest=[
-        cli.OptionString "rest" --multi,
-        cli.OptionString "other",
+        cli.Option "rest" --multi,
+        cli.Option "other",
       ]
       --run=(:: null)
   expect_throw "Multi-option 'rest' of 'root' must be the last rest argument.":
     root.check --invoked_command="root"
 
   root = cli.Command "root"
       --rest=[
-        cli.OptionString "foo",
-        cli.OptionString "bar" --required,
+        cli.Option "foo",
+        cli.Option "bar" --required,
       ]
       --run=(:: null)
   expect_throw "Required rest argument 'bar' of 'root' cannot follow optional rest argument.":
     root.check --invoked_command="root"
 
   root = cli.Command "root"
       --options=[
-        cli.OptionString "foo",
+        cli.Option "foo",
       ]
       --rest=[
-        cli.OptionString "foo",
+        cli.Option "foo",
       ]
       --run=(:: null)
   expect_throw "Rest name 'foo' of 'root' already used.": root.check --invoked_command="root"
 
   root = cli.Command "root"
       --rest=[
-        cli.OptionString "foo",
-        cli.OptionString "foo",
+        cli.Option "foo",
+        cli.Option "foo",
       ]
       --run=(:: null)
   expect_throw "Rest name 'foo' of 'root' already used.": root.check --invoked_command="root"
 
   root = cli.Command "root"
       --options=[
-        cli.OptionString "foo",
+        cli.Option "foo",
       ]
   sub := cli.Command "sub"
       --rest=[
-        cli.OptionString "foo",
+        cli.Option "foo",
       ]
       --run=(:: null)
   root.add sub
@@ -229,7 +229,7 @@ rest:
 hidden_rest:
   root := cli.Command "root"
       --rest=[
-        cli.OptionString "foo" --hidden,
+        cli.Option "foo" --hidden,
       ]
       --run=(:: null)
   expect_throw "Rest argument 'foo' of 'root' cannot be hidden.":
@@ -239,8 +239,8 @@ snake_kebab:
   // Test that kebab and snake case lead to ambiguous options.
   root := cli.Command "root"
       --options=[
-        cli.OptionString "foo-bar",
-        cli.OptionString "foo_bar"
+        cli.Option "foo-bar",
+        cli.Option "foo_bar"
       ]
       --run=:: | parsed/cli.Parsed |
         unreachable