Add Duration

coder · ammario · Mar 7, 2023 · Feb 25, 2023 · Feb 25, 2023 · Feb 25, 2023
commit 12dcc45b94898cbca66b4b05444010096d600ab0
diff --git a/cli/bigcli/bigcli.go b/cli/bigcli/bigcli.go
@@ -1,8 +1,8 @@
 // Package bigcli offers an all-in-one solution for a highly configurable CLI
 // application. Within Coder, we use it for our `server` subcommand, which
-// demands more than cobra/viper can offer.
+// demands more functionality than cobra/viper can offer.
 //
 // We may extend its usage to the rest of our application, completely replacing
-// cobra/viper, in the future. It's also a candidate to be broken out into its
-// own open-source library.
+// cobra/viper. It's also a candidate to be broken out into its own open-source
+// library, so we avoid deep coupling with Coder concepts.
 package bigcli
diff --git a/cli/bigcli/option.go b/cli/bigcli/option.go
@@ -9,6 +9,8 @@ import (
 	"golang.org/x/xerrors"
 )
 
+// Disable is a sentinel value for Option.Flag and Option.Env to disable
+// features.
 const Disable = "-"
 
 // Option is a configuration option for a CLI application.
@@ -30,12 +32,13 @@ type Option struct {
 	Default string
 	Value   pflag.Value
 
-	// Annotations can be anything and everything you want. It's useful for
+	// Annotations enable extensions to bigcli higher up in the stack. It's useful for
 	// help formatting and documentation generation.
 	Annotations map[string]string
 	Hidden      bool
 }
 
+// FlagName returns the flag name for the option.
 func (o *Option) FlagName() (string, bool) {
 	if o.Flag == Disable {
 		return "", false
@@ -131,7 +134,7 @@ func (os *OptionSet) ParseEnv(globalPrefix string, environ []string) error {
 }
 
 // SetDefaults sets the default values for each Option.
-// It should be called after all parsing (e.g. ParseFlags, ParseEnv, ParseConfig).
+// It should be called after all parsing (e.g. ParseFlags, ParseEnv).
 func (os *OptionSet) SetDefaults() error {
 	var merr *multierror.Error
 	for _, opt := range *os {

diff --git a/cli/bigcli/value.go b/cli/bigcli/value.go
@@ -1,6 +1,12 @@
 package bigcli
 
-import "strconv"
+import (
+	"strconv"
+	"time"
+)
+
+// values.go contains a standard set of value types that can be used as
+// Option Values.
 
 type Int int
 
@@ -32,3 +38,19 @@ func (s String) String() string {
 func (String) Type() string {
 	return "string"
 }
+
+type Duration time.Duration
+
+func (d *Duration) Set(v string) error {
+	dd, err := time.ParseDuration(v)
+	*d = Duration(dd)
+	return err
+}
+
+func (d *Duration) String() string {
+	return time.Duration(*d).String()
+}
+
+func (Duration) Type() string {
+	return "duration"
+}