Support for hidden commands

[tschaub]

There are cases where it would be nice to hide some commands from the help/usage output. An example would be setup or post-install work that is not part of the typical user workflow (e.g. completion). The help output becomes less useful when it is diluted with these one-time or setup type commands.

This could be supported by not adding usage for commands with false for a description. E.g.

yargs.command('post-install', false, handler);

If someone wanted the completion command to not show up in the help doc, this could be made to work:

yargs.completion('completion', false);

Only commands that are registered with usage are eligible for completion, so "hidden" commands would not show up as completion candidates. I think this is consistent with being hidden.

Prior art:

• commander's noHelp
• nomnom's hidden
• argparse's argparse.SUPPRESS

[bcoe]

I like the idea of explicitly providing a false description, we could continue to have undefined default to a default description.

Big 👍 from me.

[bcoe]

@tschaub I've published your changes to yargs@next:

npm install yargs@next

there's a chance I might do a bit of hacking on yargs this weekend too, and will get a release yargs@latest out the door sometime Sunday.