feat!: pass Options to Usage

Author: tmzane

README.md

@@ -227,7 +227,7 @@ var cfg struct {
 if err := env.Load(&cfg, nil); err != nil {
     fmt.Println(err)
     fmt.Println("Usage:")
-    env.Usage(&cfg, os.Stdout)
+    env.Usage(&cfg, os.Stdout, nil)
 }
 ```
 
@@ -238,12 +238,12 @@ Usage:
   HTTP_PORT  int     default 8080  http server port
 ```
 
-The format of the message can be customized by implementing the `Usage([]env.Var, io.Writer)` method:
+The format of the message can be customized by implementing the `Usage([]env.Var, io.Writer, *env.Options)` method:
 
 ```go
-type config struct{ ... }
+type Config struct{ ... }
 
-func (config) Usage(vars []env.Var, w io.Writer) {
+func (Config) Usage(vars []env.Var, w io.Writer, opts *env.Options) {
     for v := range vars {
         // write to w.
     }

env_test.go

@@ -31,7 +31,7 @@ func TestLoad(t *testing.T) {
 				load := func() { _ = env.Load(cfg, &env.Options{Source: env.Map{}}) }
 				assert.Panics[E](t, load, panicMsg)
 
-				usage := func() { env.Usage(cfg, io.Discard) }
+				usage := func() { env.Usage(cfg, io.Discard, nil) }
 				assert.Panics[E](t, usage, panicMsg)
 			})
 		}

example_test.go

@@ -146,7 +146,7 @@ func ExampleUsage() {
 	if err := env.Load(&cfg, nil); err != nil {
 		fmt.Println(err)
 		fmt.Println("Usage:")
-		env.Usage(&cfg, os.Stdout)
+		env.Usage(&cfg, os.Stdout, nil)
 	}
 
 	// Output: env: DB_HOST DB_PORT are required but not set

usage.go

@@ -13,8 +13,8 @@ import (
 //	var cfg struct {
 //		Port int `env:"PORT"`
 //	}
-//	env.Load(&cfg, nil)        // 1. sets cfg.Port to 8080
-//	env.Usage(&cfg, os.Stdout) // 2. prints cfg.Port's default == 8080 (instead of 0)
+//	env.Load(&cfg, nil)             // 1. sets cfg.Port to 8080
+//	env.Usage(&cfg, os.Stdout, nil) // 2. prints cfg.Port's default == 8080 (instead of 0)
 //
 // It also speeds up [Usage], since there is no need to parse the struct again.
 var cache = make(map[reflect.Type][]Var)
@@ -34,8 +34,8 @@ type Var struct {
 
 // Usage writes a usage message documenting all defined environment variables to the given [io.Writer].
 // An optional usage string can be added for each environment variable via the `usage:"STRING"` struct tag.
-// The format of the message can be customized by implementing the Usage([]env.Var, io.Writer) method on the cfg's type.
-func Usage(cfg any, w io.Writer) {
+// The format of the message can be customized by implementing the Usage([]env.Var, io.Writer, *env.Options) method on the cfg's type.
+func Usage(cfg any, w io.Writer, opts *Options) {
 	pv := reflect.ValueOf(cfg)
 	if !structPtr(pv) {
 		panic("env: cfg must be a non-nil struct pointer")
@@ -47,14 +47,18 @@ func Usage(cfg any, w io.Writer) {
 		vars = parseVars(v)
 	}
 
-	if u, ok := cfg.(interface{ Usage([]Var, io.Writer) }); ok {
-		u.Usage(vars, w)
+	if u, ok := cfg.(interface {
+		Usage([]Var, io.Writer, *Options)
+	}); ok {
+		u.Usage(vars, w, opts)
 	} else {
-		defaultUsage(vars, w)
+		defaultUsage(vars, w, opts)
 	}
 }
 
-func defaultUsage(vars []Var, w io.Writer) {
+func defaultUsage(vars []Var, w io.Writer, _ *Options) {
+	// TODO: use opts.SliceSep to parse slice values.
+
 	tw := tabwriter.NewWriter(w, 0, 0, 2, ' ', 0)
 	defer tw.Flush()
 

usage_test.go

@@ -16,14 +16,14 @@ func TestUsage(t *testing.T) {
 		var cfg struct {
 			Foo string `env:"FOO" default:""`
 		}
-		env.Usage(&cfg, &buf)
+		env.Usage(&cfg, &buf, nil)
 		assert.Equal[E](t, buf.String(), "  FOO  string  default <empty>\n")
 	})
 
 	t.Run("custom usage message", func(t *testing.T) {
 		var buf bytes.Buffer
-		var cfg config
-		env.Usage(&cfg, &buf)
+		var cfg Config
+		env.Usage(&cfg, &buf, nil)
 		assert.Equal[E](t, buf.String(), "custom")
 	})
 
@@ -38,13 +38,13 @@ func TestUsage(t *testing.T) {
 		assert.Equal[E](t, cfg.Foo, 1)
 
 		var buf bytes.Buffer
-		env.Usage(&cfg, &buf)
+		env.Usage(&cfg, &buf, nil)
 		assert.Equal[E](t, buf.String(), "  FOO  int  default 0\n")
 	})
 }
 
-type config struct{}
+type Config struct{}
 
-func (config) Usage(_ []env.Var, w io.Writer) {
+func (Config) Usage(_ []env.Var, w io.Writer, _ *env.Options) {
 	_, _ = w.Write([]byte("custom"))
 }