Skip to content

Releases: tj/commander.js

v11.1.0

13 Oct 00:32
f1ae2db

Choose a tag to compare

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 on Command with the array of defined Argument (like Command.options for Option) (#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 as registeredArguments (#2010)

v11.0.0

16 Jun 00:50

Choose a tag to compare

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

15 Apr 05:02

Choose a tag to compare

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

14 Jan 01:54

Choose a tag to compare

Added

  • wrap command description in help (#1804)

Changed

  • Breaking: Commander 10 requires Node.js v14 or higher

v9.5.0

07 Jan 07:07

Choose a tag to compare

Added

  • .getOptionValueSourceWithGlobals() (#1832)
  • showGlobalOptions for .configureHelp{} and Help (#1828)

v9.4.1

30 Sep 07:29

Choose a tag to compare

Fixed

  • .setOptionValue() now also clears option source (#1795)
  • TypeScript: add implied to OptionValueSource for option values set by using .implies() (#1794)
  • TypeScript : add undefined to return type of .getOptionValueSource() (#1794)

Changed

  • additions to README

v9.4.0

15 Jul 06:21

Choose a tag to compare

Added

  • preSubcommand hook called before direct subcommands (#1763)

Fixed

  • export InvalidOptionArgumentError in esm (#1756)

Changed

  • update dependencies (#1767)

v9.3.0

28 May 02:49

Choose a tag to compare

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

15 Apr 07:12

Choose a tag to compare

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

18 Mar 05:57

Choose a tag to compare

Added

  • Option .conflicts() to set conflicting options which can not be specified together (#1678)
  • (developer) CodeQL configuration for GitHub Actions (#1698)