[Snyk] Upgrade commander from 3.0.1 to 5.0.0

[snyk-bot]

Snyk has created this PR to upgrade commander from 3.0.1 to 5.0.0.

ℹ️ Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.

---

Warning: This is a major version upgrade, and may be a breaking change.

• The recommended version is 13 versions ahead of your current version.
• The recommended version was released a month ago, on 2020-03-14.

Release notes

Package name: commander

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

• 5.0.0-4 - 2020-03-03
  
  • createCommand factory method to simplify subclassing (#1191)
• 5.0.0-3 - 2020-02-20
  

  Added

  • TypeScript definition for commands property of Command ([#1184])
  • export program property ([#1195])
• 5.0.0-2 - 2020-02-11
  

  Added

  • suggest help option along with unknown command error (#1179)

  Changed

  • TypeScript fluent return types changed to be more subclass friendly, return this rather than Command (#1180)
• 5.0.0-1 - 2020-02-08
  

  Changes since 5.0.0-0

  Added

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

  Changed

  • changes to error handling (#1165)
    • throw for author error, not just display message
    • preflight for variadic error
    • add tips to missing subcommand executable
  • update dependencies
• 5.0.0-0 - 2020-02-01
  

  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)

  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)

  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.

• 4.1.1 - 2020-02-03
  

  Fixed

  • TypeScript definition for .action() should include Promise for async ([#1157])
• 4.1.0 - 2020-01-06
  

  Added

  • two routines to change how option values are handled, and eliminate name clashes with command properties (#933 #1102)
    • see storeOptionsAsProperties and passCommandToAction in README
  • .parseAsync to use instead of .parse if supply async action handlers (#806 #1118)

  Fixed

  • Remove trailing blanks from wrapped help text (#1096)

  Changed

  • update dependencies
  • extend security coverage for Commander 2.x to 2020-02-03
  • improvements to README
  • improvements to TypeScript definition documentation
  • move old versions out of main CHANGELOG
  • removed explicit use of ts-node in tests
• 4.0.1 - 2019-11-11
  

  Fixed

  • display help when requested, even if there are missing required options (#1091)
• 4.0.0 - 2019-11-01
• 4.0.0-1 - 2019-10-08
• 4.0.0-0 - 2019-10-01
• 3.0.2 - 2019-09-26
• 3.0.1 - 2019-08-30

from commander GitHub release notes

Commit messages

Package name: commander

• 2aad525 Update dependencies (#1214)
• f86d878 Add cli keyword (#1213)
• 83af0fd Prepare for 5.0.0 (#1211)
• f14df07 Add eslint settings for TypeScript (#1205)
• 95e0d19 5.0.0-4
• bd5a49e Add factory to CHANGELOG
• 8c3dd6f createCommand factory routine (#1191)
• 3c9f33f Say we support LTS, so do not need to update when node changes (#1204)
• 3cf8cff Expand typescript checks (#1198)
• a3f453f 5.0.0-3
• 87bfca6 Add CHANGELOG entries for 5.0.0-3
• 1757564 Use a tidier global command (#1200)
• 0a50bd6 Add program to exports (#1195)
• 77e511f Enable TypeScript checking of javascript, and resolve or suppress errors (#1194)
• 2491c76 URLEncode several chinese toc link
• bdad7dc update Readme_zh-CN.md for v5.0
• 516a14c Added `fail-fast: false` to GitHub actions settings (#1187)
• 46f886f Shorten example fragment and make obvious which code to supply (#1189)
• 733047f Add parse result test (#1188)
• 08ec04e Type commands property (#1184)
• 729e432 Prefix items consistently with past usage
• 1a84b80 Prepare for 5.0.0-2 (#1183)
• 31f1878 Use basic types in JSDoc rather than object types (#1178)
• 28b649d Suggest help when unknown command (#1179)

Compare

---

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.

For more information:

🧐 View latest project report

🛠 Adjust upgrade PR settings

🔕 Ignore this dependency or unsubscribe from future upgrade PRs