summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--usage.go2
-rw-r--r--usage_test.go32
2 files changed, 33 insertions, 1 deletions
diff --git a/usage.go b/usage.go
index e936811..7d2a517 100644
--- a/usage.go
+++ b/usage.go
@@ -301,7 +301,7 @@ func (p *Parser) printOption(w io.Writer, spec *spec) {
ways = append(ways, synopsis(spec, "-"+spec.short))
}
if len(ways) > 0 {
- printTwoCols(w, strings.Join(ways, ", "), spec.help, spec.defaultVal, spec.env)
+ printTwoCols(w, strings.Join(ways, ", "), spec.help, spec.defaultString, spec.env)
}
}
diff --git a/usage_test.go b/usage_test.go
index 10072c1..8fb32c8 100644
--- a/usage_test.go
+++ b/usage_test.go
@@ -601,3 +601,35 @@ error: something went wrong
assert.Equal(t, expectedStdout[1:], b.String())
assert.Equal(t, -1, exitCode)
}
+
+type lengthOf struct {
+ Length int
+}
+
+func (p *lengthOf) UnmarshalText(b []byte) error {
+ p.Length = len(b)
+ return nil
+}
+
+func TestHelpShowsDefaultValueFromOriginalTag(t *testing.T) {
+ // check that the usage text prints the original string from the default tag, not
+ // the serialization of the parsed value
+
+ expectedHelp := `
+Usage: example [--test TEST]
+
+Options:
+ --test TEST [default: some_default_value]
+ --help, -h display this help and exit
+`
+
+ var args struct {
+ Test *lengthOf `default:"some_default_value"`
+ }
+ p, err := NewParser(Config{Program: "example"}, &args)
+ require.NoError(t, err)
+
+ var help bytes.Buffer
+ p.WriteHelp(&help)
+ assert.Equal(t, expectedHelp[1:], help.String())
+}