Merge pull request #1633 from dearchap/issue_1277

Fix:(issue_1277) Remove default text for version/help flags

app_test.go

@@ -145,8 +145,8 @@ func ExampleApp_Run_appHelp() {
 	//
 	// GLOBAL OPTIONS:
 	//    --name value   a name to say (default: "bob")
-	//    --help, -h     show help (default: false)
-	//    --version, -v  print the version (default: false)
+	//    --help, -h     show help
+	//    --version, -v  print the version
 }
 
 func ExampleApp_Run_commandHelp() {
@@ -183,7 +183,7 @@ func ExampleApp_Run_commandHelp() {
 	//    This is how we describe describeit the function
 	//
 	// OPTIONS:
-	//    --help, -h  show help (default: false)
+	//    --help, -h  show help
 }
 
 func ExampleApp_Run_noAction() {
@@ -201,7 +201,7 @@ func ExampleApp_Run_noAction() {
 	//    help, h  Shows a list of commands or help for one command
 	//
 	// GLOBAL OPTIONS:
-	//    --help, -h  show help (default: false)
+	//    --help, -h  show help
 }
 
 func ExampleApp_Run_subcommandNoAction() {
@@ -228,7 +228,7 @@ func ExampleApp_Run_subcommandNoAction() {
 	//    This is how we describe describeit the function
 	//
 	// OPTIONS:
-	//    --help, -h  show help (default: false)
+	//    --help, -h  show help
 
 }
 

flag-spec.yaml

@@ -7,6 +7,8 @@ flag_types:
       - name: Count
         type: int
         pointer: true
+      - name: DisableDefaultText
+        type: bool
       - name: Action
         type: "func(*Context, bool) error"
   float64:

flag.go

@@ -34,18 +34,20 @@ var BashCompletionFlag Flag = &BoolFlag{
 
 // VersionFlag prints the version for the application
 var VersionFlag Flag = &BoolFlag{
-	Name:    "version",
-	Aliases: []string{"v"},
-	Usage:   "print the version",
+	Name:               "version",
+	Aliases:            []string{"v"},
+	Usage:              "print the version",
+	DisableDefaultText: true,
 }
 
 // HelpFlag prints the help for all commands and subcommands.
 // Set to nil to disable the flag.  The subcommand
 // will still be added unless HideHelp or HideHelpCommand is set to true.
 var HelpFlag Flag = &BoolFlag{
-	Name:    "help",
-	Aliases: []string{"h"},
-	Usage:   "show help",
+	Name:               "help",
+	Aliases:            []string{"h"},
+	Usage:              "show help",
+	DisableDefaultText: true,
 }
 
 // FlagStringer converts a flag definition to a string. This is used by help
@@ -337,8 +339,13 @@ func stringifyFlag(f Flag) string {
 
 	defaultValueString := ""
 
-	if s := df.GetDefaultText(); s != "" {
-		defaultValueString = fmt.Sprintf(formatDefault("%s"), s)
+	// set default text for all flags except bool flags
+	// for bool flags display default text if DisableDefaultText is not
+	// set
+	if bf, ok := f.(*BoolFlag); !ok || !bf.DisableDefaultText {
+		if s := df.GetDefaultText(); s != "" {
+			defaultValueString = fmt.Sprintf(formatDefault("%s"), s)
+		}
 	}
 
 	usageWithDefault := strings.TrimSpace(usage + defaultValueString)

godoc-current.txt

@@ -455,6 +455,8 @@ type BoolFlag struct {
 
 	Count *int
 
+	DisableDefaultText bool
+
 	Action func(*Context, bool) error
 	// Has unexported fields.
 }
@@ -881,18 +883,20 @@ var BashCompletionFlag Flag = &BoolFlag{
     BashCompletionFlag enables bash-completion for all commands and subcommands
 
 var HelpFlag Flag = &BoolFlag{
-	Name:    "help",
-	Aliases: []string{"h"},
-	Usage:   "show help",
+	Name:               "help",
+	Aliases:            []string{"h"},
+	Usage:              "show help",
+	DisableDefaultText: true,
 }
     HelpFlag prints the help for all commands and subcommands. Set to nil to
     disable the flag. The subcommand will still be added unless HideHelp or
     HideHelpCommand is set to true.
 
 var VersionFlag Flag = &BoolFlag{
-	Name:    "version",
-	Aliases: []string{"v"},
-	Usage:   "print the version",
+	Name:               "version",
+	Aliases:            []string{"v"},
+	Usage:              "print the version",
+	DisableDefaultText: true,
 }
     VersionFlag prints the version for the application
 

help_test.go

@@ -1366,8 +1366,7 @@ DESCRIPTION:
    case
 
 OPTIONS:
-   --help, -h show help
-      (default: false)
+   --help, -h  show help
 `
 
 	if output.String() != expected {
@@ -1436,8 +1435,7 @@ USAGE:
    even more
 
 OPTIONS:
-   --help, -h show help
-      (default: false)
+   --help, -h  show help
 `
 
 	if output.String() != expected {
@@ -1514,8 +1512,7 @@ USAGE:
 OPTIONS:
    --test-f value my test
       usage
-   --help, -h show help
-      (default: false)
+   --help, -h  show help
 `
 
 	if output.String() != expected {

testdata/godoc-v2.x.txt

@@ -455,6 +455,8 @@ type BoolFlag struct {
 
 	Count *int
 
+	DisableDefaultText bool
+
 	Action func(*Context, bool) error
 	// Has unexported fields.
 }
@@ -881,18 +883,20 @@ var BashCompletionFlag Flag = &BoolFlag{
     BashCompletionFlag enables bash-completion for all commands and subcommands
 
 var HelpFlag Flag = &BoolFlag{
-	Name:    "help",
-	Aliases: []string{"h"},
-	Usage:   "show help",
+	Name:               "help",
+	Aliases:            []string{"h"},
+	Usage:              "show help",
+	DisableDefaultText: true,
 }
     HelpFlag prints the help for all commands and subcommands. Set to nil to
     disable the flag. The subcommand will still be added unless HideHelp or
     HideHelpCommand is set to true.
 
 var VersionFlag Flag = &BoolFlag{
-	Name:    "version",
-	Aliases: []string{"v"},
-	Usage:   "print the version",
+	Name:               "version",
+	Aliases:            []string{"v"},
+	Usage:              "print the version",
+	DisableDefaultText: true,
 }
     VersionFlag prints the version for the application
 

zz_generated.flags.go

@@ -448,6 +448,8 @@ type BoolFlag struct {
 
 	Count *int
 
+	DisableDefaultText bool
+
 	Action func(*Context, bool) error
 }