Commander.js changelog

Changelog History

Page 1

• v9.4.1 Changes

  September 30, 2022

  🛠 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 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

• 1
• 2
• 3
• 4
• 5
• Next ›
• Last »