Arg with default needs the square brackets (#101)

FollowTheProcess · Sep 27, 2024 · cdb7573 · cdb7573
1 parent 0ff93a9
commit cdb7573
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/command.go b/command.go
@@ -579,12 +579,16 @@ func defaultHelp(cmd *Command) error {
 // format for the top level usage string in the help text string builder.
 func writePositionalArgs(cmd *Command, s *strings.Builder) {
 	for _, arg := range cmd.positionalArgs {
+		displayName := strings.ToUpper(arg.name)
 		if arg.defaultValue != "" {
-			s.WriteString(strings.ToUpper(arg.name))
-		} else {
+			// If it has a default, it's an optional argument so wrap it
+			// in brackets e.g. [FILE]
 			s.WriteString("[")
-			s.WriteString(strings.ToUpper(arg.name))
+			s.WriteString(displayName)
 			s.WriteString("]")
+		} else {
+			// It's required, so just FILE
+			s.WriteString(displayName)
 		}
 		s.WriteString(" ")
 	}

diff --git a/docs/img/quickstart.gif b/docs/img/quickstart.gif
diff --git a/testdata/TestHelp/with-named-arguments.txt b/testdata/TestHelp/with-named-arguments.txt
@@ -1,6 +1,6 @@
 A placeholder for something cool
 
-Usage: test [OPTIONS] [SRC] DEST 
+Usage: test [OPTIONS] SRC [DEST] 
 
 Arguments:
   src   The file to copy