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 v5 #229

Merged
merged 1 commit into from
May 29, 2020
Merged

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Mar 14, 2020

This PR contains the following updates:

Package Type Update Change
commander dependencies major ~4.1.0 -> ~5.1.0

Release Notes

tj/commander.js

v5.1.0

Compare Source

Added
  • support for multiple command aliases, the first of which is shown in the auto-generated help ([#​531], [#​1236])
  • configuration support in addCommand() for hidden and isDefault ([#​1232])
Fixed
  • omit masked help flags from the displayed help ([#​645], [#​1247])
  • remove old short help flag when change help flags using helpOption ([#​1248])
Changed
  • remove use of arguments to improve auto-generated help in editors ([#​1235])
  • rename .command() configuration noHelp to hidden (but not remove old support) ([#​1232])
  • improvements to documentation
  • update dependencies
  • update tested versions of node
  • eliminate lint errors in TypeScript ([#​1208])

v5.0.0

Compare Source

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])
  • .parseAsync returns Promise<this> to be consistent with .parse() ([#​1180])
  • update dependencies
Removed
  • removed EventEmitter from TypeScript definition for Command, eliminating implicit peer dependency on @types/node ([#​1146])
  • removed private function normalize (the functionality has been integrated into parseOptions) ([#​1145])
  • parseExpectedArgs is now private ([#​1149])
Migration Tips

If you use .on('command:*') or more complicated tests to detect an unrecognised subcommand, you may be able to delete the code and rely on the default behaviour.

If you use program.args or more complicated tests to detect a missing subcommand, you may be able to delete the code and rely on the default behaviour.

If you use .command('*') to add a default command, you may be be able to switch to isDefault:true with a named command.


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 you tick the rebase/retry checkbox.

🔕 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 WhiteSource Renovate. View repository job log here.

Sorry, something went wrong.

Verified

This commit was signed with the committer’s verified signature.
renovate-bot Mend Renovate
@renovate renovate bot force-pushed the renovate/commander-5.x branch from 59e6459 to ce77cb5 Compare April 25, 2020 02:32
@consideRatio
Copy link
Member

This should be checked manually for breaking changes before merge I think - didn't want to get down doing that right now though, but the provided changelog was a good reference on whats breaking in 5.0.0

@consideRatio consideRatio merged commit bed9462 into master May 29, 2020
@consideRatio
Copy link
Member

Looked through breaking changes, LGTM.

@renovate renovate bot deleted the renovate/commander-5.x branch May 29, 2020 11:34
@consideRatio consideRatio added the dependencies Pull requests that update a dependency file label Oct 24, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants