Upgrade commander: 4.1.1 → 6.2.0 (major)

[depfu]

Here is everything you need to know about this upgrade. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ commander (4.1.1 → 6.2.0) · Repo · Changelog

Release Notes

6.2.0

Added

• added 'tsx' file extension for stand-alone executable subcommands (#1368)
• documented second parameter to .description() to describe command arguments (#1353)
• documentation of special cases with options taking varying numbers of option-arguments (#1332)
• documentation for terminology (#1361)

Fixed

• add missing TypeScript definition for `.addHelpCommand()' (#1375)
• removed blank line after "Arguments:" in help, to match "Options:" and "Commands:" (#1360)

Changed

• update dependencies

6.1.0

Added

• include URL to relevant section of README for error for potential conflict between Command properties and option values (#1306)
• .combineFlagAndOptionalValue(false) to ease upgrade path from older versions of Commander (#1326)
• allow disabling the built-in help option using .helpOption(false) (#1325)
• allow just some arguments in argumentDescription to .description() (#1323)

Changed

• tidy async test and remove lint override (#1312)

Fixed

• executable subcommand launching when script path not known (#1322)

6.0.0

Added

• add support for variadic options (#1250)
• allow options to be added with just a short flag (#1256)
• throw an error if there might be a clash between option name and a Command property, with advice on how to resolve (#

Fixed

• Options which contain -no- in the middle of the option flag should not be treated as negatable. (#1301)

5.1.0

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)

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

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by more commits than we can show here.

---

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@​depfu rebase

Rebases against your default branch and redoes this update

@​depfu recreate

Recreates this PR, overwriting any edits that you've made to it

@​depfu merge

Merges this PR once your tests are passing and conflicts are resolved

@​depfu close

Closes this PR and deletes the branch

@​depfu reopen

Restores the branch and reopens this PR (if it's closed)

@​depfu pause

Ignores all future updates for this dependency and closes this PR

@​depfu pause [minor|major]

Ignores all future minor/major updates for this dependency and closes this PR

@​depfu resume

Future versions of this dependency will create PRs again (leaves this PR as is)