Collect: help

[shadowspawn]

Collecting help issues that have come up multiple times.

Override or disable help option:

• Make auto help optional #242 Make auto help optional
• Hiding auto generated help options? #542 Hiding auto generated help options?
• Don't Show options when there are no options #689 Don't Show options when there are no options
• Override --help? #893 Override --help?
• Prevent/override automatic help generation #1215 Prevent/override automatic help generation
• Add method to get help option description #1370 Add method to get help option description

Struck out items included in Command v6.1.0

[shadowspawn]

Customisation, especially prefix/banner:

• Add Support For Title? #46 Add Support For Title?
• Show an arbitrary banner message (Feature request) #78 Show an arbitrary banner message (Feature request)
• Option to prefix help with text #578 Option to prefix help with text
• move output information to printer #779 move output information to printer
• Customize help message for a command #1023 Customize help message for a command
• usage and description display order #1234 usage and description display order
• Question: Is it possible to have a splash screen? #1272 Question: Is it possible to have a splash screen?

Struck out items included in Commander v7.0.0

[shadowspawn]

A possible syntax for disabling the built-in help option could be:

program.helpOption(false);

with some symmetry with:

program.addHelpCommand(false);

Update: shipped this in Command v6.1

[shadowspawn]

Trying .addHelpText() which takes a position as first parameter, and a string to add or a function returning a string. Position is 'before' or 'after' to affect just this command, and 'beforeAll' or 'afterAll' to affect this command and all its subcommands.

.help() and .outputHelp() can be passed { error: true } to write to stderr.

For example:

program.addHelpText('afterAll', '/nSee the web site for more information');

See #1296 for more info. Coming in v7.

[shadowspawn]

Major improvements to custom help included in v7.0.0 pre-release #1386

[shadowspawn]

Commander 7.0.0 has shipped. Most of the collected issues have now been addressed.