Merge pull request #1723 from dearchap/issue_1689

Fix:(issue 1689) Match markdown output with help output
urfave · Apr 30, 2023 · 97e1edb · 97e1edb
2 parents c0cc5c2 + 5b9c03e
commit 97e1edb
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 13 deletions.
diff --git a/docs.go b/docs.go
@@ -153,9 +153,14 @@ func prepareFlags(
 // flagDetails returns a string containing the flags metadata
 func flagDetails(flag DocGenerationFlag) string {
 	description := flag.GetUsage()
-	value := flag.GetValue()
-	if value != "" {
-		description += " (default: " + value + ")"
+	if flag.TakesValue() {
+		defaultText := flag.GetDefaultText()
+		if defaultText == "" {
+			defaultText = flag.GetValue()
+		}
+		if defaultText != "" {
+			description += " (default: " + defaultText + ")"
+		}
 	}
 	return ": " + description
 }

diff --git a/fish_test.go b/fish_test.go
@@ -27,11 +27,12 @@ func testApp() *App {
 	app.Name = "greet"
 	app.Flags = []Flag{
 		&StringFlag{
-			Name:      "socket",
-			Aliases:   []string{"s"},
-			Usage:     "some 'usage' text",
-			Value:     "value",
-			TakesFile: true,
+			Name:        "socket",
+			Aliases:     []string{"s"},
+			Usage:       "some 'usage' text",
+			Value:       "value",
+			DefaultText: "/some/path",
+			TakesFile:   true,
 		},
 		&StringFlag{Name: "flag", Aliases: []string{"fl", "f"}},
 		&BoolFlag{

diff --git a/testdata/expected-doc-full.man b/testdata/expected-doc-full.man
@@ -47,7 +47,7 @@ app [first_arg] [second_arg]
 \fB--flag, --fl, -f\fP="":
 
 .PP
-\fB--socket, -s\fP="": some 'usage' text (default: value)
+\fB--socket, -s\fP="": some 'usage' text (default: /some/path)
 
 
 .SH COMMANDS

diff --git a/testdata/expected-doc-full.md b/testdata/expected-doc-full.md
@@ -28,7 +28,7 @@ app [first_arg] [second_arg]
 
 **--flag, --fl, -f**="": 
 
-**--socket, -s**="": some 'usage' text (default: value)
+**--socket, -s**="": some 'usage' text (default: /some/path)
 
 
 # COMMANDS

diff --git a/testdata/expected-doc-no-authors.md b/testdata/expected-doc-no-authors.md
@@ -28,7 +28,7 @@ app [first_arg] [second_arg]
 
 **--flag, --fl, -f**="": 
 
-**--socket, -s**="": some 'usage' text (default: value)
+**--socket, -s**="": some 'usage' text (default: /some/path)
 
 
 # COMMANDS

diff --git a/testdata/expected-doc-no-commands.md b/testdata/expected-doc-no-commands.md
@@ -28,5 +28,5 @@ app [first_arg] [second_arg]
 
 **--flag, --fl, -f**="": 
 
-**--socket, -s**="": some 'usage' text (default: value)
+**--socket, -s**="": some 'usage' text (default: /some/path)
 
diff --git a/testdata/expected-doc-no-usagetext.md b/testdata/expected-doc-no-usagetext.md
@@ -28,7 +28,7 @@ greet [GLOBAL OPTIONS] command [COMMAND OPTIONS] [ARGUMENTS...]
 
 **--flag, --fl, -f**="": 
 
-**--socket, -s**="": some 'usage' text (default: value)
+**--socket, -s**="": some 'usage' text (default: /some/path)
 
 
 # COMMANDS