• 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#990)
• Breaking Change TypeScript to use overloaded function for.command. (#938#990)
• 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 emitsoption:no-foo (previouslyoption: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 isoption:no-foo (previouslyoption:foo).

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

When using TypeScript, adding a command does not allow an explicitundefined 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

The new version differs by 104 commits.

• 3b0127bupdate Readme_zh-CN to v3.0.0 and modify some old translation problems
• bfcd39aSet release date for 3.0.0
• d1469c0Bump version for release
• 41d0bdbAdd explicit breaking notes (#1006)
• 5b1b2feAdd links for issues (so work for direct viewing of CHANGELOG)
• fb56370Add Tidelift links (#1004)
• f743bf4Expand changelog for prerelease
• e5bce2fAdd #987 to CHANGELOG
• a9503bbAllow boolean default for flag option (#987)
• 55e88dcAdd missing changes to v3.0.0 changelog
• fb00b0eMerge branch 'master' into release/3.0.0
• 831d52fMerge pull request #999 from shadowspawn/feature/specifyExecutableFile
• a59e90fMerge pull request #998 from shadowspawn/feature/develop
• 6d68637Increment inspector port for spawned subcommands (#991)
• facd66fAdd debugging note with issue for mixed action/executable

There are 104 commits in total.

See thefull diff

There is a collection offrequently asked questions. If those don’t help, you can alwaysask the humans behind Greenkeeper.