Keep help as-is, add helpOption method

Readme.md

@@ -439,13 +439,13 @@ function make_red(txt) {
 }
 ```
 
-## .help(flags, description)
+## .helpOption(flags, description)
 
   Override the default help flags and description.
 
 ```js
 program
-  .help('-e, --HELP', 'read more information');
+  .helpOption('-e, --HELP', 'read more information');
 ```
 
 ## .help(cb)

examples/custom-help-description

@@ -7,7 +7,7 @@
 var program = require('../');
 
 program
-  .help('-c, --HELP', 'custom help message')
+  .helpOption('-c, --HELP', 'custom help message')
   .option('-s, --sessions', 'add session support')
   .option('-t, --template <engine>', 'specify template engine (jade|ejs) [jade]', 'jade');
 

index.js

@@ -1164,36 +1164,40 @@ Command.prototype.outputHelp = function(cb) {
 };
 
 /**
- * When called with no arguments, or with a callback, this will
- * output help information and exit.
- *
  * You can pass in flags and a description to override the help
  * flags and help description for your command.
  *
- * @param {Function|String} [flagsOrCb]
- * @param {String} [description]
- * @return {Command?}
+ * @param {String} flags
+ * @param {String} description
+ * @return {Command}
  * @api public
  */
 
-Command.prototype.help = function(flagsOrCb, description) {
-  if (typeof cb === 'function' || arguments.length === 0) {
-    this.outputHelp(flagsOrCb);
-    process.exit();
-  }
-
-  this._helpFlags = flagsOrCb || this._helpFlags;
+Command.prototype.helpOption = function(flags, description) {
+  this._helpFlags = flags || this._helpFlags;
   this._helpDescription = description || this._helpDescription;
 
-  var flags = this._helpFlags.split(/[ ,|]+/);
+  var splitFlags = this._helpFlags.split(/[ ,|]+/);
 
-  if (flags.length > 1) this._helpShortFlag = flags.shift();
+  if (splitFlags.length > 1) this._helpShortFlag = splitFlags.shift();
 
-  this._helpLongFlag = flags.shift();
+  this._helpLongFlag = splitFlags.shift();
 
   return this;
 };
 
+/**
+ * Output help information and exit.
+ *
+ * @param {Function} cb
+ * @api public
+ */
+
+Command.prototype.help = function(cb) {
+  this.outputHelp(cb);
+  process.exit();
+};
+
 /**
  * Camel-case the given `flag`
  *

test/test.command.helpInformation.custom.js

@@ -5,7 +5,7 @@ var program = require('../')
 sinon.stub(process, 'exit');
 sinon.stub(process.stdout, 'write');
 
-program.help('-c, --HELP', 'custom help output');
+program.helpOption('-c, --HELP', 'custom help output');
 program.command('somecommand');
 program.command('anothercommand [options]');
 

test/test.command.helpSubCommand.customFlags.js

@@ -8,7 +8,7 @@ sinon.stub(process.stdout, 'write');
 // Test that subcommands inherit the help flags
 // but can also override help flags
 program
-  .help('-i, --ihelp', 'foo foo');
+  .helpOption('-i, --ihelp', 'foo foo');
 
 program
   .command('child')
@@ -19,7 +19,7 @@ program
 
 program
   .command('family')
-  .help('-h, --help')
+  .helpOption('-h, --help')
   .action((cmd) => {
     console.log('Familysubcommand...');
   });

typings/index.d.ts

@@ -282,10 +282,18 @@ declare namespace local {
      * You can pass in flags and a description to override the help
      * flags and help description for your command.
      *
-     * @param {string | (str: string) => string} [flagsOrCb]
+     * @param {string} [flags]
+     * @param {string} [description]
+     * @return {Command}
+     */
+    helpOption(flags?: string, description?: string): Command;
+
+    /** Output help information and exit.
+     *
+     * @param {(str: string) => string} [cb]
      * @param {string} [description]
      */
-    help(flagsOrCb?: string | helpCallback, description?: string): never;
+    help(cb: helpCallback, description?: string): never;
   }
 
 }