Allow option to set global header/banner for all commands

[tlylt]

Hello,

I am hoping to add a common banner that will be displayed as the first thing in the output when running any command. Similar to #578, but for general commands and not for the help command. (Is Life cycle hooks the solution to my question?)

So for example a command output could become:

=====
MyProgram version 1.2.3
=====
Run successfully!

I have searched through the issues and found out that support has been added to customize help text and make it possible to do the above for help commands, via addHelpText() or configureOutput(). Although a solution has been suggested in this comment: #1272 (comment), would it be possible to add this functionality as part of commander.js?

So I imagine something like:

program.banner("Custom Banner")

Thanks!

[shadowspawn]

As you suggested, I think a "preAction" hook might be a solution for your case.

program.hook("preAction", () => console.log('BEFORE'));

program.command('foo')
  .action(() => console.log('hello'));

program.parse();

% node index.js foo 
BEFORE
hello

% node index.js foo --silly   
error: unknown option '--silly'

[tlylt]

As you suggested, I think a "preAction" hook might be a solution for your case.

program.hook("preAction", () => console.log('BEFORE'));

program.command('foo')
  .action(() => console.log('hello'));

program.parse();

% node index.js foo 
BEFORE
hello

% node index.js foo --silly   
error: unknown option '--silly'

Thank you for the speedy reply! After playing around with it, I think it would serve my purpose just right 😄