All Versions
107
Latest Version
Avg Release Cycle
37 days
Latest Release
568 days ago
Changelog History
Page 1
Changelog History
Page 1
-
v9.4.1 Changes
September 30, 2022๐ 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 Changes
July 15, 2022โ Added
preSubcommand
hook called before direct subcommands ([#1763])
๐ Fixed
- export
InvalidOptionArgumentError
in esm ([#1756])
๐ Changed
- โก๏ธ update dependencies ([#1767])
-
v9.3.0 Changes
May 28, 2022โ 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
- 0๏ธโฃ 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 Changes
April 15, 2022โ 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 Changes
March 19, 2022โ Added
- Option
.conflicts()
to set conflicting options which can not be specified together ([#1678]) - ๐ง (developer) CodeQL configuration for GitHub Actions ([#1698])
- Option
-
v9.0.0 Changes
January 28, 2022โ 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])
- 0๏ธโฃ
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])
- 0๏ธโฃ 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
- 0๏ธโฃ 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])
-
v9.0.0-1 Changes
January 15, 2022๐ (Released in 9.0.0)
-
v9.0.0-0 Changes
December 22, 2021๐ (Released in 9.0.0)
-
v8.3.0 Changes
October 22, 2021โ Added
- 0๏ธโฃ
.getOptionValueSource()
and.setOptionValueWithSource()
, where expected values for source are one of 'default', 'env', 'config', 'cli' ([#1613])
๐ Deprecated
- 0๏ธโฃ
.command('*')
, use default command instead ([#1612]) on('command:*')
, use.showSuggestionAfterError()
instead ([#1612])
- 0๏ธโฃ
-
v8.2.0 Changes
September 10, 2021โ Added
.showSuggestionAfterError()
to show suggestions after unknown command or unknown option ([#1590])- โ add
Option
support for values from environment variables using.env()
([#1587])
๐ Changed
- ๐ show error for unknown global option before subcommand (rather than just help) ([#1590])
โ Removed
- TypeScript declaration of unimplemented
Option
methodargumentRejected