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

Bump commander from 4.1.1 to 5.0.0 #5614

Merged
merged 1 commit into from Mar 14, 2020

Conversation

dependabot-preview[bot]
Copy link
Contributor

Bumps commander from 4.1.1 to 5.0.0.

Release notes

Sourced from commander's releases.

v5.0.0

Added

  • support for nested commands with action-handlers (#1 #764 #1149)
  • .addCommand() for adding a separately configured command (#764 #1149)
  • allow a non-executable to be set as the default command (#742 #1149)
  • implicit help command when there are subcommands (previously only if executables) (#1149)
  • customise implicit help command with .addHelpCommand() (#1149)
  • display error message for unknown subcommand, by default (#432 #1088 #1149)
  • display help for missing subcommand, by default (#1088 #1149)
  • combined short options as single argument may include boolean flags and value flag and value (e.g. -a -b -p 80 can be written as -abp80) (#1145)
  • .parseOption() includes short flag and long flag expansions (#1145)
  • .helpInformation() returns help text as a string, previously a private routine (#1169)
  • .parse() implicitly uses process.argv if arguments not specified (#1172)
  • optionally specify where .parse() arguments "from", if not following node conventions (#512 #1172)
  • suggest help option along with unknown command error (#1179)
  • TypeScript definition for commands property of Command (#1184)
  • export program property (#1195)
  • createCommand factory method to simplify subclassing (#1191)

Fixed

  • preserve argument order in subcommands (#508 #962 #1138)
  • do not emit command:* for executable subcommands (#809 #1149)
  • action handler called whether or not there are non-option arguments (#1062 #1149)
  • combining option short flag and value in single argument now works for subcommands (#1145)
  • only add implicit help command when it will not conflict with other uses of argument (#1153 #1149)
  • implicit help command works with command aliases (#948 #1149)
  • options are validated whether or not there is an action handler (#1149)

Changed

  • Breaking .args contains command arguments with just recognised options removed (#1032 #1138)
  • Breaking display error if required argument for command is missing (#995 #1149)
  • tighten TypeScript definition of custom option processing function passed to .option() (#1119)
  • Breaking .allowUnknownOption() (#802 #1138)
    • unknown options included in arguments passed to command action handler
    • unknown options included in .args
  • only recognised option short flags and long flags are expanded (e.g. -ab or --foo=bar) (#1145)
  • Breaking .parseOptions() (#1138)
    • args in returned result renamed operands and does not include anything after first unknown option
    • unknown in returned result has arguments after first unknown option including operands, not just options and values
  • Breaking .on('command:*', callback) and other command events passed (changed) results from .parseOptions, i.e. operands and unknown (#1138)
  • refactor Option from prototype to class (#1133)
  • refactor Command from prototype to class (#1159)
  • changes to error handling (#1165)
    • throw for author error, not just display message
    • preflight for variadic error
    • add tips to missing subcommand executable
  • TypeScript fluent return types changed to be more subclass friendly, return this rather than Command (#1180)
... (truncated)
Changelog

Sourced from commander's changelog.

[5.0.0] (2020-03-14)

Added

  • support for nested commands with action-handlers (#1 #764 #1149)
  • .addCommand() for adding a separately configured command (#764 #1149)
  • allow a non-executable to be set as the default command (#742 #1149)
  • implicit help command when there are subcommands (previously only if executables) (#1149)
  • customise implicit help command with .addHelpCommand() (#1149)
  • display error message for unknown subcommand, by default (#432 #1088 #1149)
  • display help for missing subcommand, by default (#1088 #1149)
  • combined short options as single argument may include boolean flags and value flag and value (e.g. -a -b -p 80 can be written as -abp80) (#1145)
  • .parseOption() includes short flag and long flag expansions (#1145)
  • .helpInformation() returns help text as a string, previously a private routine (#1169)
  • .parse() implicitly uses process.argv if arguments not specified (#1172)
  • optionally specify where .parse() arguments "from", if not following node conventions (#512 #1172)
  • suggest help option along with unknown command error (#1179)
  • TypeScript definition for commands property of Command (#1184)
  • export program property (#1195)
  • createCommand factory method to simplify subclassing (#1191)

Fixed

  • preserve argument order in subcommands (#508 #962 #1138)
  • do not emit command:* for executable subcommands (#809 #1149)
  • action handler called whether or not there are non-option arguments (#1062 #1149)
  • combining option short flag and value in single argument now works for subcommands (#1145)
  • only add implicit help command when it will not conflict with other uses of argument (#1153 #1149)
  • implicit help command works with command aliases (#948 #1149)
  • options are validated whether or not there is an action handler (#1149)

Changed

  • Breaking .args contains command arguments with just recognised options removed (#1032 #1138)
  • Breaking display error if required argument for command is missing (#995 #1149)
  • tighten TypeScript definition of custom option processing function passed to .option() (#1119)
  • Breaking .allowUnknownOption() (#802 #1138)
    • unknown options included in arguments passed to command action handler
    • unknown options included in .args
  • only recognised option short flags and long flags are expanded (e.g. -ab or --foo=bar) (#1145)
  • Breaking .parseOptions() (#1138)
    • args in returned result renamed operands and does not include anything after first unknown option
    • unknown in returned result has arguments after first unknown option including operands, not just options and values
  • Breaking .on('command:*', callback) and other command events passed (changed) results from .parseOptions, i.e. operands and unknown (#1138)
  • refactor Option from prototype to class (#1133)
  • refactor Command from prototype to class (#1159)
  • changes to error handling (#1165)
    • throw for author error, not just display message
    • preflight for variadic error
    • add tips to missing subcommand executable
... (truncated)
Commits

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

If all status checks pass Dependabot will automatically merge this pull request.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
  • @dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in the .dependabot/config.yml file in this repo:

  • Update frequency
  • Automerge options (never/patch/minor, and dev/runtime dependencies)
  • Out-of-range updates (receive only lockfile updates, if desired)
  • Security updates (receive only security updates, if desired)

Bumps [commander](https://github.com/tj/commander.js) from 4.1.1 to 5.0.0.
- [Release notes](https://github.com/tj/commander.js/releases)
- [Changelog](https://github.com/tj/commander.js/blob/master/CHANGELOG.md)
- [Commits](tj/commander.js@v4.1.1...v5.0.0)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
@dependabot-preview dependabot-preview bot added dependencies Update the dependencies javascript labels Mar 14, 2020
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dependabot-preview dependabot-preview bot merged commit 53cad9a into master Mar 14, 2020
@dependabot-preview dependabot-preview bot deleted the dependabot/npm_and_yarn/commander-5.0.0 branch March 14, 2020 01:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Update the dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants