Update dependency commander to v11 - autoclosed
This MR contains the following updates:
Package | Type | Update | Change |
---|---|---|---|
commander | dependencies | major | ^8.0.0 -> ^11.0.0 |
Release Notes
tj/commander.js (commander)
v11.1.0
Fixed
- TypeScript: update
OptionValueSource
to allow any string, to match supported use of custom sources ([#1983]) - TypeScript: add that
Command.version()
can also be used as getter ([#1982]) - TypeScript: add null return type to
Commands.executableDir()
, for when not configured ([#1965]) - subcommands with an executable handler and only a short help flag are now handled correctly by the parent's help command ([#1930])
Added
-
registeredArguments
property onCommand
with the array of definedArgument
(likeCommand.options
forOption
) ([#2010]) - TypeScript declarations for Option properties:
envVar
,presetArg
([#2019]) - TypeScript declarations for Argument properties:
argChoices
,defaultValue
,defaultValueDescription
([#2019]) - example file which shows how to configure help to display any custom usage in the list of subcommands ([#1896])
Changed
- (developer) refactor TypeScript configs for multiple use-cases, and enable checks in JavaScript files in supporting editors ([#1969])
Deprecated
-
Command._args
was private anyway, but now available asregisteredArguments
([#2010])
v11.0.0
Fixed
- help command works when help option is disabled ([#1864])
Changed
- leading and trailing spaces are now ignored by the .arguments() method ([#1874])
- refine "types" exports for ESM to follow TypeScript guidelines ([#1886])
- Breaking: Commander 11 requires Node.js v16 or higher
v10.0.1
Added
Fixed
- remove unused
Option.optionFlags
property from TypeScript definition ([#1844])
Changed
- assume boolean option intended if caller passes string instead of hash to
.implies()
([#1854])
v10.0.0
Added
- wrap command description in help ([#1804])
Changed
- Breaking: Commander 10 requires Node.js v14 or higher
v9.5.0
Added
-
.getOptionValueSourceWithGlobals()
([#1832]) -
showGlobalOptions
for.configureHelp{}
andHelp
([#1828])
v9.4.1
Fixed
-
.setOptionValue()
now also clears option source ([#1795]) - TypeScript: add
implied
toOptionValueSource
for option values set by using.implies()
([#1794]) - TypeScript : add
undefined
to return type of.getOptionValueSource()
([#1794])
Changed
- additions to README
v9.4.0
Added
-
preSubcommand
hook called before direct subcommands ([#1763])
Fixed
- export
InvalidOptionArgumentError
in esm ([#1756])
Changed
- update dependencies ([#1767])
v9.3.0
Added
-
.summary()
for a short summary to use instead of description when listing subcommands in help ([#1726]) -
Option.implies()
to set other option values when the option is specified ([#1724]) - updated Chinese README with 9.x changes ([#1727])
Fixed
- TypeScript: add
string[]
to.options()
default value parameter type for use with variadic options ([#1721])
Deprecated
- multi-character short option flag (e.g.
-ws
) ([#1718])
v9.2.0
Added
- conditional export of 'types' for upcoming TypeScript module resolution ([#1703])
- example file showing two ways to add global options to subcommands ([#1708])
Fixed
- detect option conflicts in parent commands of called subcommand ([#1710])
Changed
- replace deprecated
String.prototype.substr
([#1706])
v9.1.0
Added
- Option
.conflicts()
to set conflicting options which can not be specified together ([#1678]) - (developer) CodeQL configuration for GitHub Actions ([#1698])
v9.0.0
Added
- simpler ECMAScript import ([#1589])
- Option.preset() allows specifying value/arg for option when used without option-argument (especially optional, but also boolean option) ([#1652])
-
.executableDir()
for custom search for subcommands ([#1571]) - throw with helpful message if pass
Option
to.option()
or.requiredOption()
([#1655]) - .
error()
for generating errors from client code just like Commander generated errors, with support for.configureOutput()
,.exitOverride()
, and.showHelpAfterError()
([#1675]) -
.optsWithGlobals()
to return merged local and global options ([#1671])
Changed
- Breaking: Commander 9 requires Node.js v12.20.0 or higher
- update package-lock.json to lockfile@2 format ([#1659])
-
showSuggestionAfterError
is now on by default ([#1657]) - Breaking: default value specified for boolean option now always used as default value (see .preset() to match some previous behaviours) ([#1652])
- default value for boolean option only shown in help if true/false ([#1652])
- use command name as prefix for subcommand stand-alone executable name (with fallback to script name for backwards compatibility) ([#1571])
- allow absolute path with
executableFile
([#1571]) - removed restriction that nested subcommands must specify
executableFile
([#1571]) - TypeScript: allow passing readonly string array to
.choices()
([#1667]) - TypeScript: allow passing readonly string array to
.parse()
,.parseAsync()
,.aliases()
([#1669])
Fixed
- option with optional argument not supplied on command line now works when option already has a value, whether from default value or from previous arguments ([#1652])
Removed
-
Breaking: removed internal fallback to
require.main.filename
when script not known from arguments passed to.parse()
(can supply details using.name()
, and.executableDir()
orexecutableFile
) ([#1571])
Configuration
-
If you want to rebase/retry this MR, check this box
This MR has been generated by Renovate Bot.
Edited by Kevin Cox