v3.0.0

Compare Source

=================

• Add option to specify executable file name (#​999)
  • e.g. .command('clone', 'clone description', { executableFile: 'myClone' })
• Change docs for .command to contrast action handler vs git-style executable. (#​938)
• Breaking Change TypeScript to use overloaded function for .command. (#​938)
• Change to use straight quotes around strings in error messages (like 'this' instead of `this') (#​915)
• Add TypeScript "reference types" for node (#​974)
• Add support for hyphen as an option argument in subcommands (#​697)
• Add support for a short option flag and its value to be concatenated for action handler subcommands (#​599)
  • e.g. -p 80 can also be supplied as -p80
• Add executable arguments to spawn in win32, for git-style executables (#​611)
  • e.g. node --harmony myCommand.js clone
• Add parent command as prefix of subcommand in help (#​980)
• Add optional custom description to .version (#​963)
  • e.g. program.version('0.0.1', '-v, --vers', 'output the current version')
• Add .helpOption(flags, description) routine to customise help flags and description (#​963)
  • e.g. .helpOption('-e, --HELP', 'read more information')
• Fix behavior of --no-* options (#​795)
  • can now define both --foo and --no-foo
  • Breaking custom event listeners: --no-foo on cli now emits option:no-foo (previously option:foo)
  • Breaking default value: defining --no-foo after defining --foo leaves the default value unchanged (previously set it to false)
  • allow boolean default value, such as from environment (#​987)
• Increment inspector port for spawned subcommands (#​991)
  • e.g. node --inspect myCommand.js clone

Example Breaking Changes

The custom event for a negated option like --no-foo is option:no-foo (previously option:foo).

program
  .option('--no-foo')
  .on('option:no-foo', () => {
    console.log('removing foo');
  });

When using TypeScript, adding a command does not allow an explicit undefined for an unwanted executable description (e.g
for a command with an action handler).

program
  .command('action1', undefined, { noHelp: true }) // No longer valid
  .command('action2', { noHelp: true }) // Correct