StringsOption with delimiter #204
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -149,6 +149,18 @@ func NewOption(kind reflect.Kind, names ...string) Option { | |
| } | ||
|
|
||
| func (o *option) WithDefault(v interface{}) Option { | ||
| if v == nil { | ||
| panic(fmt.Errorf("cannot use nil as a default")) | ||
| } | ||
|
Comment on lines
+152
to
+154
There was a problem hiding this comment. I'm not seeing any problem with this ATM, it seems like so far all of our types are concrete and even for the pointer types we do have (i.e. []string) as long as people pass in |
||
|
|
||
| // if type of value does not match the option type | ||
| if vKind, oKind := reflect.TypeOf(v).Kind(), o.Type(); vKind != oKind { | ||
aschmahmann marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // if the reason they do not match is not because of Slice vs Array equivalence | ||
| // Note: Figuring out if the type of Slice/Array matches is not done in this function | ||
| if !((vKind == reflect.Array || vKind == reflect.Slice) && (oKind == reflect.Array || oKind == reflect.Slice)) { | ||
|
There was a problem hiding this comment. This can be removed, but basically is just a hack for StringsOption so that it can still opaquely call this function and everything works. Doesn't seem too unreasonable though. |
||
| panic(fmt.Errorf("invalid default for the given type, expected %s got %s", o.Type(), vKind)) | ||
| } | ||
| } | ||
| o.defaultVal = v | ||
| return o | ||
| } | ||
|
|
@@ -184,6 +196,44 @@ func FloatOption(names ...string) Option { | |
| func StringOption(names ...string) Option { | ||
| return NewOption(String, names...) | ||
| } | ||
|
|
||
| // StringsOption is a command option that can handle a slice of strings | ||
| func StringsOption(names ...string) Option { | ||
| return DelimitedStringsOption("", names...) | ||
| } | ||
|
|
||
| // DelimitedStringsOption like StringsOption is a command option that can handle a slice of strings. | ||
| // However, DelimitedStringsOption will automatically break up the associated CLI inputs based on the delimiter. | ||
| // For example, instead of passing `command --option=val1 --option=val2` you can pass `command --option=val1,val2` or | ||
| // even `command --option=val1,val2 --option=val3,val4`. | ||
| // | ||
| // A delimiter of "" means that no delimiter is used | ||
|
There was a problem hiding this comment. This is as opposed to strings.Split where an empty delimiter means to split on every character. We could add this behavior, but I'm not currently seeing the utility. There was a problem hiding this comment. I think it is best to avoid splitting on every character and insist on a delimiter to separate items in an option string. You could even go one step farther, and not allow an empty delimiter to be passed to There was a problem hiding this comment. @gammazero @lidel I pushed an update here that panics when an empty delimiter is passed, but still uses the same underlying struct for StringsOption and DelimitedStringsOption with StringsOption using an empty delimiter. let me know what you think and we'll merge 🚢 |
||
| func DelimitedStringsOption(delimiter string, names ...string) Option { | ||
aschmahmann marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| return &stringsOption{ | ||
| Option: NewOption(Strings, names...), | ||
| delimiter: delimiter, | ||
| } | ||
| } | ||
|
|
||
| type stringsOption struct { | ||
| Option | ||
| delimiter string | ||
| } | ||
|
|
||
| func (s *stringsOption) WithDefault(v interface{}) Option { | ||
| if v == nil { | ||
| return s.Option.WithDefault(v) | ||
| } | ||
|
|
||
| defVal := v.([]string) | ||
| s.Option = s.Option.WithDefault(defVal) | ||
| return s | ||
| } | ||
|
|
||
| func (s *stringsOption) Parse(v string) (interface{}, error) { | ||
| if s.delimiter == "" { | ||
| return []string{v}, nil | ||
| } | ||
|
|
||
| return strings.Split(v, s.delimiter), nil | ||
| } | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this was just extracted from the function below