Refactor help internals into separate interface/class

package.json

@@ -23,7 +23,8 @@
     "typescript-lint": "eslint typings/*.ts",
     "test": "jest && npm run test-typings",
     "test-typings": "tsc -p tsconfig.json",
-    "typescript-checkJS": "tsc --allowJS --checkJS index.js --noEmit"
+    "typescript-checkJS": "tsc --allowJS --checkJS index.js --noEmit",
+    "test-all": "npm run test && npm run lint && npm run typescript-lint && npm run typescript-checkJS"
   },
   "main": "index",
   "files": [

tests/command.chain.test.js

@@ -129,4 +129,10 @@ describe('Command methods that should return this for chaining', () => {
     const result = program.addHelpText('before', 'example');
     expect(result).toBe(program);
   });
+
+  test('when call .configureHelp() then returns this', () => {
+    const program = new Command();
+    const result = program.configureHelp({ });
+    expect(result).toBe(program);
+  });
 });

tests/command.commandHelp.test.js

@@ -1,19 +1,19 @@
 const commander = require('../');
 
-// Note: .commandHelp is not currently documented in the README. This is a ported legacy test.
+// This is a ported legacy test.
 
-test('when program has command then appears in commandHelp', () => {
+test('when program has command then appears in help', () => {
   const program = new commander.Command();
   program
     .command('bare');
-  const commandHelp = program.commandHelp();
+  const commandHelp = program.helpInformation();
   expect(commandHelp).toMatch(/Commands:\n +bare\n/);
 });
 
-test('when program has command with optional arg then appears in commandHelp', () => {
+test('when program has command with optional arg then appears in help', () => {
   const program = new commander.Command();
   program
     .command('bare [bare-arg]');
-  const commandHelp = program.commandHelp();
+  const commandHelp = program.helpInformation();
   expect(commandHelp).toMatch(/Commands:\n +bare \[bare-arg\]\n/);
 });

tests/command.configureHelp.test.js

@@ -0,0 +1,31 @@
+const commander = require('../');
+
+test('when configure program then affects program helpInformation', () => {
+  const program = new commander.Command();
+  program.configureHelp({ formatHelp: () => { return 'custom'; } });
+  expect(program.helpInformation()).toEqual('custom');
+});
+
+test('when configure program then affects subcommand helpInformation', () => {
+  const program = new commander.Command();
+  program.configureHelp({ formatHelp: () => { return 'custom'; } });
+  const sub = program.command('sub');
+  expect(sub.helpInformation()).toEqual('custom');
+});
+
+test('when configure with unknown property then createHelp has unknown property', () => {
+  const program = new commander.Command();
+  program.configureHelp({ mySecretValue: 'secret' });
+  expect(program.createHelp().mySecretValue).toEqual('secret');
+});
+
+test('when configure with unknown property then helper passed to formatHelp has unknown property', () => {
+  const program = new commander.Command();
+  program.configureHelp({
+    mySecretValue: 'secret',
+    formatHelp: (cmd, helper) => {
+      return helper.mySecretValue;
+    }
+  });
+  expect(program.helpInformation()).toEqual('secret');
+});

tests/command.createHelp.test.js

@@ -0,0 +1,18 @@
+const commander = require('../');
+
+test('when override createCommand then affects help', () => {
+  class MyHelp extends commander.Help {
+    formatHelp(cmd, helper) {
+      return 'custom';
+    }
+  }
+
+  class MyCommand extends commander.Command {
+    createHelp() {
+      return Object.assign(new MyHelp(), this.configureHelp());
+    };
+  }
+
+  const program = new MyCommand();
+  expect(program.helpInformation()).toEqual('custom');
+});

tests/command.helpCommand.test.js

@@ -31,9 +31,9 @@ describe('help command listed in helpInformation', () => {
 
   test('when add custom help command then custom help command', () => {
     const program = new commander.Command();
-    program.addHelpCommand('help command', 'help description');
+    program.addHelpCommand('myHelp', 'help description');
     const helpInformation = program.helpInformation();
-    expect(helpInformation).toMatch(/help command +help description/);
+    expect(helpInformation).toMatch(/myHelp +help description/);
   });
 });
 

tests/help.columns.test.js

@@ -0,0 +1,22 @@
+const commander = require('../');
+
+// These are tests of the Help class, not of the Command help.
+// There is some overlap with the higher level Command tests (which predate Help).
+
+describe('columns', () => {
+  test('when default then columns from stdout', () => {
+    const hold = process.stdout.columns;
+    process.stdout.columns = 123;
+    const program = new commander.Command();
+    const helper = program.createHelp();
+    expect(helper.columns).toEqual(123);
+    process.stdout.columns = hold;
+  });
+
+  test('when configure columns then value from user', () => {
+    const program = new commander.Command();
+    program.configureHelp({ columns: 321 });
+    const helper = program.createHelp();
+    expect(helper.columns).toEqual(321);
+  });
+});

tests/help.commandDescription.test.js

@@ -0,0 +1,20 @@
+const commander = require('../');
+
+// These are tests of the Help class, not of the Command help.
+// There is some overlap with the higher level Command tests (which predate Help).
+
+describe('subcommandDescription', () => {
+  test('when program has no description then empty string', () => {
+    const program = new commander.Command();
+    const helper = new commander.Help();
+    expect(helper.subcommandDescription(program)).toEqual('');
+  });
+
+  test('when program has description then return description', () => {
+    const description = 'description';
+    const program = new commander.Command();
+    program.description(description);
+    const helper = new commander.Help();
+    expect(helper.subcommandDescription(program)).toEqual(description);
+  });
+});

tests/help.commandTerm.test.js

@@ -0,0 +1,43 @@
+const commander = require('../');
+
+// These are tests of the Help class, not of the Command help.
+// There is some overlap with the higher level Command tests (which predate Help).
+
+// subcommandTerm does not currently respect helpOption or ignore hidden options, so not testing those.
+describe('subcommandTerm', () => {
+  test('when plain command then returns name', () => {
+    const command = new commander.Command('program');
+    const helper = new commander.Help();
+    expect(helper.subcommandTerm(command)).toEqual('program');
+  });
+
+  test('when command has alias then returns name|alias', () => {
+    const command = new commander.Command('program')
+      .alias('alias');
+    const helper = new commander.Help();
+    expect(helper.subcommandTerm(command)).toEqual('program|alias');
+  });
+
+  test('when command has options then returns name [options]', () => {
+    const command = new commander.Command('program')
+      .option('-a,--all');
+    const helper = new commander.Help();
+    expect(helper.subcommandTerm(command)).toEqual('program [options]');
+  });
+
+  test('when command has <argument> then returns name <argument>', () => {
+    const command = new commander.Command('program')
+      .arguments('<argument>');
+    const helper = new commander.Help();
+    expect(helper.subcommandTerm(command)).toEqual('program <argument>');
+  });
+
+  test('when command has everything then returns name|alias [options] <argument>', () => {
+    const command = new commander.Command('program')
+      .alias('alias')
+      .option('-a,--all')
+      .arguments('<argument>');
+    const helper = new commander.Help();
+    expect(helper.subcommandTerm(command)).toEqual('program|alias [options] <argument>');
+  });
+});

tests/help.commandUsage.test.js

@@ -0,0 +1,49 @@
+const commander = require('../');
+
+// These are tests of the Help class, not of the Command help.
+// There is some overlap with the higher level Command tests (which predate Help).
+
+describe('commandUsage', () => {
+  test('when single program then "Usage: program [options]"', () => {
+    const program = new commander.Command();
+    program.name('program');
+    const helper = new commander.Help();
+    expect(helper.commandUsage(program)).toEqual('Usage: program [options]');
+  });
+
+  test('when multi program then "Usage: program [options] [command]"', () => {
+    const program = new commander.Command();
+    program.name('program');
+    program.command('sub');
+    const helper = new commander.Help();
+    expect(helper.commandUsage(program)).toEqual('Usage: program [options] [command]');
+  });
+
+  test('when program has alias then usage includes alias', () => {
+    const program = new commander.Command();
+    program
+      .name('program')
+      .alias('alias');
+    const helper = new commander.Help();
+    expect(helper.commandUsage(program)).toEqual('Usage: program|alias [options]');
+  });
+
+  test('when help for subcommand then usage includes hierarchy', () => {
+    const program = new commander.Command();
+    program
+      .name('program');
+    const sub = program.command('sub')
+      .name('sub');
+    const helper = new commander.Help();
+    expect(helper.commandUsage(sub)).toEqual('Usage: program sub [options]');
+  });
+
+  test('when program has argument then usage includes argument', () => {
+    const program = new commander.Command();
+    program
+      .name('program')
+      .arguments('<file>');
+    const helper = new commander.Help();
+    expect(helper.commandUsage(program)).toEqual('Usage: program [options] <file>');
+  });
+});

tests/help.longestArgumentTermLength.test.js

@@ -0,0 +1,32 @@
+const commander = require('../');
+
+// These are tests of the Help class, not of the Command help.
+// There is some overlap with the higher level Command tests (which predate Help).
+
+describe('longestArgumentTermLength', () => {
+  test('when no arguments then returns zero', () => {
+    const program = new commander.Command();
+    const helper = new commander.Help();
+    expect(helper.longestArgumentTermLength(program, helper)).toEqual(0);
+  });
+
+  test('when has argument description then returns argument length', () => {
+    const program = new commander.Command();
+    program.arguments('<wonder>');
+    program.description('dummy', { wonder: 'wonder description' });
+    const helper = new commander.Help();
+    expect(helper.longestArgumentTermLength(program, helper)).toEqual('wonder'.length);
+  });
+
+  test('when has multiple argument descriptions then returns longest', () => {
+    const program = new commander.Command();
+    program.arguments('<alpha> <longest> <beta>');
+    program.description('dummy', {
+      alpha: 'x',
+      longest: 'x',
+      beta: 'x'
+    });
+    const helper = new commander.Help();
+    expect(helper.longestArgumentTermLength(program, helper)).toEqual('longest'.length);
+  });
+});

tests/help.longestCommandTermLength.test.js

@@ -0,0 +1,52 @@
+const commander = require('../');
+
+// These are tests of the Help class, not of the Command help.
+// There is some overlap with the higher level Command tests (which predate Help).
+
+describe('longestSubcommandTermLength', () => {
+  test('when no commands then returns zero', () => {
+    const program = new commander.Command();
+    const helper = new commander.Help();
+    expect(helper.longestSubcommandTermLength(program, helper)).toEqual(0);
+  });
+
+  test('when command and no help then returns length of term', () => {
+    const sub = new commander.Command('sub');
+    const program = new commander.Command();
+    program
+      .addHelpCommand(false)
+      .addCommand(sub);
+    const helper = new commander.Help();
+    expect(helper.longestSubcommandTermLength(program, helper)).toEqual(helper.subcommandTerm(sub).length);
+  });
+
+  test('when command with arg and no help then returns length of term', () => {
+    const sub = new commander.Command('sub <file)');
+    const program = new commander.Command();
+    program
+      .addHelpCommand(false)
+      .addCommand(sub);
+    const helper = new commander.Help();
+    expect(helper.longestSubcommandTermLength(program, helper)).toEqual(helper.subcommandTerm(sub).length);
+  });
+
+  test('when multiple commands then returns longest length', () => {
+    const longestCommandName = 'alphabet-soup <longer_than_help>';
+    const program = new commander.Command();
+    program
+      .addHelpCommand(false)
+      .command('before', 'desc')
+      .command(longestCommandName, 'desc')
+      .command('after', 'desc');
+    const helper = new commander.Help();
+    expect(helper.longestSubcommandTermLength(program, helper)).toEqual(longestCommandName.length);
+  });
+
+  test('when just help command then returns length of help term', () => {
+    const program = new commander.Command();
+    program
+      .addHelpCommand(true);
+    const helper = new commander.Help();
+    expect(helper.longestSubcommandTermLength(program, helper)).toEqual('help [command]'.length);
+  });
+});

tests/help.longestOptionTermLength.test.js

@@ -0,0 +1,30 @@
+const commander = require('../');
+
+// These are tests of the Help class, not of the Command help.
+// There is some overlap with the higher level Command tests (which predate Help).
+
+describe('longestOptionTermLength', () => {
+  test('when no option then returns zero', () => {
+    const program = new commander.Command();
+    program.helpOption(false);
+    const helper = new commander.Help();
+    expect(helper.longestOptionTermLength(program, helper)).toEqual(0);
+  });
+
+  test('when just implicit help option returns length of help flags', () => {
+    const program = new commander.Command();
+    const helper = new commander.Help();
+    expect(helper.longestOptionTermLength(program, helper)).toEqual('-h, --help'.length);
+  });
+
+  test('when multiple option then returns longest length', () => {
+    const longestOptionFlags = '-l, --longest <value>';
+    const program = new commander.Command();
+    program
+      .option('--before', 'optional description of flags')
+      .option(longestOptionFlags)
+      .option('--after');
+    const helper = new commander.Help();
+    expect(helper.longestOptionTermLength(program, helper)).toEqual(longestOptionFlags.length);
+  });
+});