[Snyk] Upgrade commander from 7.0.0 to 7.2.0 #5
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Snyk has created this PR to upgrade commander from 7.0.0 to 7.2.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.
The recommended version is 2 versions ahead of your current version.
The recommended version was released on 3 years ago.
Release notes
Package name: commander
-
7.2.0 - 2021-03-21
- TypeScript typing for
- TypeScript typing for
- support information in package (#1477)
- improvements to error messages, README, and tests
- update dependencies
-
7.1.0 - 2021-02-15
- support for named imports from ECMAScript modules (#1440)
- add
- allow using option choices and variadic together (#1454)
- replace use of deprecated
- regression for legacy
- regression for
- display best error for combination of unknown command and unknown option (i.e. unknown command) (#1464)
- make TypeScript typings tests stricter (#1453)
- improvements to README and tests
-
7.0.0 - 2021-01-15
- use
- enhance Option class (#1331)
- allow hiding options from help
- allow restricting option arguments to a list of choices
- allow setting how default value is shown in help
- refactor the code generating the help into a separate public Help class (#1365)
- support sorting subcommands and options in help
- support specifying wrap width (columns)
- allow subclassing Help class
- allow configuring Help class without subclassing
- Breaking: options are stored safely by default, not as properties on the command (#1409)
- this especially affects accessing options on program, use
- revert behaviour with
- Breaking: action handlers are passed options and command separately (#1409)
- deprecated callback parameter to
- Breaking: errors now displayed using
- deprecate
- initialise the command description to empty string (previously undefined) (#1365)
- document and annotate deprecated routines (#1349)
- wrapping bugs in help (#1365)
- first line of command description was wrapping two characters early
- pad width calculation was not including help option and help command
- pad width calculation was including hidden options and commands
- improve backwards compatibility for custom command event listeners (#1403)
- Breaking:
- no longer needed as action handler is passed options and command
- Breaking: "extra arguments" parameter to action handler (#1409)
- if being used to detect excess arguments, there is now an error available by setting
from commander GitHub release notesAdded
parentproperty onCommand(#1475).attributeName()onOption(#1483)Changed
Added
.cjsto list of expected script file extensions (#1449)Fixed
process.mainModule(#1448)command('*')and call when command line includes options (#1464)on('command:*', ...)and call when command line includes unknown options (#1464)Changed
Added
.enablePositionalOptions()to let program and subcommand reuse same option (#1427).passThroughOptions()to pass options through to other programs without needing--(#1427).allowExcessArguments(false)to show an error message if there are too many command-arguments on command line for the action handler (#1409).configureOutput()to modify use of stdout and stderr or customise display of errors (#1387).addHelpText()to add text before or after the built-in help, for just current command or also for all subcommands (#1296).createOption()to support subclassing of automatically created options (like.createCommand()) (#1380)Changed
program.opts().storeOptionsAsProperties().help()and.outputHelp()(removed from README) (#1296)process.stderr.write()instead ofconsole.error().on('--help')(removed from README) (#1296)Fixed
Deleted
.passCommandToAction()(#1409).allowExcessArguments(false)Migration Tips
The biggest change is the parsed option values. Previously the options were stored by default as properties on the command object, and now the options are stored separately.
If you wish to restore the old behaviour and get running quickly you can call
.storeOptionsAsProperties().To allow you to move to the new code patterns incrementally, the action handler will be passed the command twice,
to match the new "options" and "command" parameters (see below).
program options
Use the
.opts()method to access the options. This is available on any command but is used most with the program.action handler
The action handler gets passed a parameter for each command-argument you declared. Previously by default the next parameter was the command object with the options as properties. Now the next two parameters are instead the options and the command. If you
only accessed the options there may be no code changes required.
If you already set
.storeOptionsAsProperties(false)you may still need to adjust your code.Important
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: