This repository has been archived by the owner on Oct 16, 2020. It is now read-only.
fix(deps): update dependency commander to v6 #690
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.
This PR contains the following updates:
Release Notes
tj/commander.js
v6.0.0
Compare Source
Added
-n
accessed asopts().n
(previously uppercase)Fixed
v5.1.0
Compare Source
Added
addCommand()
forhidden
andisDefault
([#1232])Fixed
helpOption
([#1248])Changed
arguments
to improve auto-generated help in editors ([#1235]).command()
configurationnoHelp
tohidden
(but not remove old support) ([#1232])v5.0.0
Compare Source
Added
.addCommand()
for adding a separately configured command ([#764][#1149]).addHelpCommand()
([#1149])-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 usesprocess.argv
if arguments not specified ([#1172]).parse()
arguments "from", if not following node conventions ([#512][#1172])commands
property ofCommand
([#1184])program
property ([#1195])createCommand
factory method to simplify subclassing ([#1191])Fixed
command:*
for executable subcommands ([#809][#1149])Changed
.args
contains command arguments with just recognised options removed ([#1032][#1138]).option()
([#1119]).allowUnknownOption()
([#802][#1138]).args
-ab
or--foo=bar
) ([#1145]).parseOptions()
([#1138])args
in returned result renamedoperands
and does not include anything after first unknown optionunknown
in returned result has arguments after first unknown option including operands, not just options and values.on('command:*', callback)
and other command events passed (changed) results from.parseOptions
, i.e. operands and unknown ([#1138])this
rather thanCommand
([#1180]).parseAsync
returnsPromise<this>
to be consistent with.parse()
([#1180])Removed
@types/node
([#1146])normalize
(the functionality has been integrated intoparseOptions
) ([#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 toisDefault:true
with a named command.v4.1.1
Compare Source
Fixed
.action()
should include Promise for async ([#1157])v4.1.0
Compare Source
Added
.parseAsync
to use instead of.parse
if supply async action handlers ([#806][#1118])Fixed
Changed
ts-node
in testsv4.0.1
Compare Source
Fixed
v4.0.0
Compare Source
Added
.exitOverride()
allows override of calls toprocess.exit
for additional error handling and to keep program running ([#1040]).requiredOptions()
([#1071])Changed
Fixed
command:*
event to include unknown argumentscustomFds
option from call tochild_process.spawn
([#1052])Migration Tips
Testing for no arguments
If you were previously using code like:
a partial replacement is:
v3.0.2
Compare Source
Fixed
Changed
Credits:
v3.0.1
Compare Source
Added
executableFile
in CommandOptions (#1028)Changed
const
rather thanvar
in README (#1026)Fixed
v3.0.0
Compare Source
.command('clone', 'clone description', { executableFile: 'myClone' })
.command
to contrast action handler vs git-style executable. (#938 #990).command
. (#938 #990)-p 80
can also be supplied as-p80
node --harmony myCommand.js clone
.version
(#963)program.version('0.0.1', '-v, --vers', 'output the current version')
.helpOption(flags, description)
routine to customise help flags and description (#963).helpOption('-e, --HELP', 'read more information')
--foo
and--no-foo
--no-foo
on cli now emitsoption:no-foo
(previouslyoption:foo
)--no-foo
after defining--foo
leaves the default value unchanged (previously set it to false)node --inspect myCommand.js clone
Migration Tips
The custom event for a negated option like
--no-foo
isoption:no-foo
(previouslyoption:foo
).When using TypeScript, adding a command does not allow an explicit
undefined
for an unwanted executable description (e.g. for a command with an action handler).v2.20.3
Compare Source
Ran "npm unpublish commander@2.20.2". There is no 2.20.2.
Fixed
v2.20.1
Compare Source
Fixed
Changed
Credits:
v2.20.0
Compare Source
v2.19.0
Compare Source
v2.18.0
Compare Source
v2.17.1
Compare Source
v2.17.0
Compare Source
v2.16.0
Compare Source
v2.15.1
Compare Source
fix #777
Released with npm@5.6.0
v2.15.0
Compare Source
v2.14.1
Compare Source
v2.14.0
Compare Source
v2.13.0
Compare Source
v2.12.2
Compare Source
v2.12.1
Compare Source
v2.12.0
Compare Source
outputHelp
takes a string as the first parameterv2.11.0
Compare Source
v2.10.0
Compare Source
--description
Renovate configuration
📅 Schedule: "on the 1st through 7th day of the month" in timezone America/Los_Angeles.
🚦 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.
This PR has been generated by WhiteSource Renovate. View repository job log here.