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

Update dependency commander to v4 #214

Merged
merged 1 commit into from
Nov 12, 2019
Merged

Update dependency commander to v4 #214

merged 1 commit into from
Nov 12, 2019

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Nov 11, 2019

This PR contains the following updates:

Package Type Update Change
commander dependencies major ~2.20.0 -> ~4.0.0

Release Notes

tj/commander.js

v4.0.0

Compare Source

Added
  • automatically wrap and indent help descriptions for options and commands ([#​1051])
  • .exitOverride() allows override of calls to process.exit for additional error handling and to keep program running ([#​1040])
  • support for declaring required options with .requiredOptions() ([#​1071])
  • GitHub Actions support ([#​1027])
  • translation links in README
Changed
  • dev: switch tests from Sinon+Should to Jest with major rewrite of tests ([#​1035])
  • call default subcommand even when there are unknown options ([#​1047])
  • Breaking Commander is only officially supported on Node 8 and above, and requires Node 6 ([#​1053])
Fixed
  • Breaking keep command object out of program.args when action handler called ([#​1048])
    • also, action handler now passed array of unknown arguments
  • complain about unknown options when program argument supplied and action handler ([#​1049])
    • this changes parameters to command:* event to include unknown arguments
  • removed deprecated customFds option from call to child_process.spawn ([#​1052])
  • rework TypeScript declarations to bring all types into imported namespace ([#​1081])

v3.0.2

Compare Source

Fixed
  • Improve tracking of executable subcommands.
Changed
  • update development dependencies

v3.0.1

Compare Source

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

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][#​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
Migration Tips

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

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.

@minrk minrk merged commit d1334b0 into master Nov 12, 2019
@renovate renovate bot deleted the renovate/commander-4.x branch November 12, 2019 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants