Always align flag defaults in usage text (#187)

Author: FollowTheProcess

command.go

@@ -459,7 +459,7 @@ func stripFlags(cmd *Command, args []string) []string {
 // showHelp is the default for a command's helpFunc.
 func showHelp(cmd *Command) error {
 	if cmd == nil {
-		return errors.New("defaultHelp called on a nil Command")
+		return errors.New("showHelp called on a nil Command")
 	}
 
 	usage, err := cmd.flagSet().Usage()

internal/flag/flag.go

@@ -48,21 +48,26 @@ func New[T flag.Flaggable](p *T, name string, short rune, usage string, config C
 
 	*p = config.DefaultValue
 
-	// If the default value is not the zero value for the type, it is treated as
-	// significant and shown to the user
-	if !isZeroIsh(*p) {
-		// \t so that defaults get aligned by tabwriter when the command
-		// dumps the flags
-		usage += fmt.Sprintf("\t[default: %v]", *p)
-	}
-
 	flag := Flag[T]{
 		value: p,
 		name:  name,
 		usage: usage,
 		short: short,
 	}
 
+	// TODO(@FollowTheProcess): This needs to live in command.go and we should iterate over the flagset
+	// adding the values to the tabwriter as we go rather than relying on the flagset.Usage() method
+	// to provide *all* the usage
+
+	// If the default value is not the zero value for the type, it is treated as
+	// significant and shown to the user
+	flag.usage += "\t"
+	if !isZeroIsh(*p) {
+		// \t so that defaults get aligned by tabwriter when the command
+		// dumps the flags
+		flag.usage += fmt.Sprintf("[default: %s]", flag.String())
+	}
+
 	return flag, nil
 }
 

internal/flag/testdata/snapshots/TestUsage/full.snap.txt

@@ -1,5 +1,5 @@
-  -c   --count    int     Count things
-  -h   --help     bool    Show help for test
-  -t   --thing    string  Name the thing
-  N/A  --update   bool    Update something
-  -V   --version  bool    Show version info for test
+  -c   --count    int     Count things                
+  -h   --help     bool    Show help for test          
+  -t   --thing    string  Name the thing              
+  N/A  --update   bool    Update something            
+  -V   --version  bool    Show version info for test  

internal/flag/testdata/snapshots/TestUsage/no_shorthand.snap.txt

@@ -1,3 +1,3 @@
-  -h   --help     bool  Show help for test
-  N/A  --update   bool  Update something
-  -V   --version  bool  Show version info for test
+  -h   --help     bool  Show help for test          
+  N/A  --update   bool  Update something            
+  -V   --version  bool  Show version info for test  

internal/flag/testdata/snapshots/TestUsage/simple.snap.txt

@@ -1,2 +1,2 @@
-  -h  --help     bool  Show help for test
-  -V  --version  bool  Show version info for test
+  -h  --help     bool  Show help for test          
+  -V  --version  bool  Show version info for test  

testdata/snapshots/TestHelp/default_long.snap.txt

@@ -4,5 +4,5 @@ Usage: test [OPTIONS] ARGS...
 
 Options:
 
-  -h  --help     bool  Show help for test
-  -V  --version  bool  Show version info for test
+  -h  --help     bool  Show help for test          
+  -V  --version  bool  Show version info for test  

testdata/snapshots/TestHelp/default_short.snap.txt

@@ -4,5 +4,5 @@ Usage: test [OPTIONS] ARGS...
 
 Options:
 
-  -h  --help     bool  Show help for test
-  -V  --version  bool  Show version info for test
+  -h  --help     bool  Show help for test          
+  -V  --version  bool  Show version info for test  

testdata/snapshots/TestHelp/full_description_strip_whitespace.snap.txt

@@ -6,5 +6,5 @@ Usage: test [OPTIONS] ARGS...
 
 Options:
 
-  -h  --help     bool  Show help for test
-  -V  --version  bool  Show version info for test
+  -h  --help     bool  Show help for test          
+  -V  --version  bool  Show version info for test  

testdata/snapshots/TestHelp/subcommands_different_lengths.snap.txt

@@ -12,7 +12,7 @@ Commands:
 
 Options:
 
-  -h  --help     bool  Show help for test
-  -V  --version  bool  Show version info for test
+  -h  --help     bool  Show help for test          
+  -V  --version  bool  Show version info for test  
 
 Use "test [command] -h/--help" for more information about a command.

testdata/snapshots/TestHelp/with_examples.snap.txt

@@ -12,5 +12,5 @@ Examples:
 
 Options:
 
-  -h  --help     bool  Show help for test
-  -V  --version  bool  Show version info for test
+  -h  --help     bool  Show help for test          
+  -V  --version  bool  Show version info for test