All Versions
106
Latest Version
Avg Release Cycle
36 days
Latest Release
31 days ago

Changelog History
Page 1

  • 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])
  • 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 [email protected] 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() or executableFile) ([#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])
  • 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 method argumentRejected
  • v8.1.0 Changes

    July 27, 2021

    โž• Added

    • .copyInheritedSettings() ([#1557])
    • ๐Ÿ“š update Chinese translations of documentation for Commander v8 ([#1570])
    • Argument methods for .argRequired() and .argOptional() ([#1567])