Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(deps): update dependency commander to v3 #101

merged 1 commit into from Oct 9, 2019


Copy link

commented Sep 27, 2019

This PR contains the following updates:

Package Type Update Change
commander dependencies major ^2.19.0 -> ^3.0.0

Release Notes



Compare Source

  • Improve tracking of executable subcommands.
  • update development dependencies


Compare Source

  • .name and .usage to README ([#​1010])
  • Table of Contents to README ([#​1010])
  • TypeScript definition for executableFile in CommandOptions ([#​1028])
  • consistently use const rather than var in README ([#​1026])
  • help for sub commands with custom executableFile ([#​1018])


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][#​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 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).

  .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).

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

Renovate configuration

📅 Schedule: At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻️ Rebasing: Whenever PR becomes conflicted, or if you modify the PR title to begin with "rebase!".

🔕 Ignore: Close this PR and you won't be reminded about this update again.

  • If you want to rebase/retry this PR, check this box

This PR has been generated by Renovate Bot. View repository job log here.

@renovate renovate bot force-pushed the renovate/commander-3.x branch 2 times, most recently from 349f1e9 to b33a565 Oct 9, 2019
@renovate renovate bot force-pushed the renovate/commander-3.x branch from b33a565 to de55f54 Oct 9, 2019
@faustbrian faustbrian merged commit 1e41ce0 into master Oct 9, 2019
@faustbrian faustbrian deleted the renovate/commander-3.x branch Oct 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
2 participants
You can’t perform that action at this time.