glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2025-05-06 13:27:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add DisableHelpSubCommand option

Browse source 
This option stops the creation of a "help" subcommand for when a CLI
tool only wants to have "-h" and "--help" to get examples/usage.

This can (in certain situations) help reduce abiguity in documentation.
Instead of having two ways to get help about a subcommand ("app help foo"
and "app foo --help") there can be only one.

As this option defaults to false, the default behavior remains the same.
This commit is contained in:
Joe Richey 2019-05-16 22:36:57 -07:00
parent 67fc4837d2
commit 22d125a408
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
command.go
View file

@ -130,6 +130,10 @@ type Command struct {
// line of a command when printing help or generating docs // line of a command when printing help or generating docs
DisableFlagsInUseLine bool DisableFlagsInUseLine bool
// DisableHelpSubCommand will disable the addition of the "help" subcommand.
// The "-h" and "--help" flags will still be available.
DisableHelpSubCommand bool
// DisableSuggestions disables the suggestions based on Levenshtein distance // DisableSuggestions disables the suggestions based on Levenshtein distance
// that go along with 'unknown command' messages. // that go along with 'unknown command' messages.
DisableSuggestions bool DisableSuggestions bool
@ -938,7 +942,7 @@ func (c *Command) InitDefaultVersionFlag() {
// It is called automatically by executing the c or by calling help and usage. // It is called automatically by executing the c or by calling help and usage.
// If c already has help command or c has no subcommands, it will do nothing. // If c already has help command or c has no subcommands, it will do nothing.
func (c *Command) InitDefaultHelpCmd() { func (c *Command) InitDefaultHelpCmd() {
if !c.HasSubCommands() { if c.DisableHelpSubCommand || !c.HasSubCommands() {
return return
} }