Commander.js changelog

Changelog History

Page 4

• v5.0.0-2 Changes

  February 11, 2020

  ➕ Added

  • suggest help option along with unknown command error (#1179)

  🔄 Changed

  • TypeScript fluent return types changed to be more subclass friendly, return this rather than Command (#1180)

• v5.0.0-1 Changes

  February 08, 2020

  🔄 Changes since 5.0.0-0

  ➕ Added

  • .helpInformation() returns help text as a string, previously a private routine (#1169)
  • 📜 .parse() implicitly uses process.argv if arguments not specified (#1172)
  • 📜 optionally specify where .parse() arguments "from", if not following node conventions (#512 #1172)

  🔄 Changed

  • 🔄 changes to error handling (#1165)
    • throw for author error, not just display message
    • preflight for variadic error
    • add tips to missing subcommand executable
  • ⚡️ update dependencies

• v5.0.0-0 Changes

  February 01, 2020

  ➕ Added

  • 👌 support for nested commands with action-handlers (#1 #764 #1149)
  • 🔧 .addCommand() for adding a separately configured command (#764 #1149)
  • 👍 allow a non-executable to be set as the default command (#742 #1149)
  • implicit help command when there are subcommands (previously only if executables) (#1149)
  • customise implicit help command with .addHelpCommand() (#1149)
  • 0️⃣ display error message for unknown subcommand, by default (#432 #1088 #1149)
  • 0️⃣ display help for missing subcommand, by default (#1088 #1149)
  • combined short options as single argument may include boolean flags and value flag and value (e.g. -a -b -p 80 can be written as -abp80) (#1145)
  • 📜 .parseOption() includes short flag and long flag expansions (#1145)

  🛠 Fixed

  • preserve argument order in subcommands (#508 #962 #1138)
  • do not emit command:* for executable subcommands (#809 #1149)
  • action handler called whether or not there are non-option arguments (#1062 #1149)
  • combining option short flag and value in single argument now works for subcommands (#1145)
  • only add implicit help command when it will not conflict with other uses of argument (#1153 #1149)
  • implicit help command works with command aliases (#948 #1149)
  • options are validated whether or not there is an action handler (#1149)

  🔄 Changed

  • 💥 Breaking .args contains command arguments with just recognised options removed (#1032 #1138)
  • 💥 Breaking display error if required argument for command is missing (#995 #1149)
  • tighten TypeScript definition of custom option processing function passed to .option() (#1119)
  • 💥 Breaking .allowUnknownOption() (#802 #1138)
    • unknown options included in arguments passed to command action handler
    • unknown options included in .args
  • only recognised option short flags and long flags are expanded (e.g. -ab or --foo=bar) (#1145)
  • 💥 Breaking .parseOptions() (#1138)
    • args in returned result renamed operands and does not include anything after first unknown option
    • unknown in returned result has arguments after first unknown option including operands, not just options and values
  • 💥 Breaking .on('command:*', callback) and other command events passed (changed) results from .parseOptions, i.e. operands and unknown (#1138)
  • 🔨 refactor Option from prototype to class (#1133)
  • 🔨 refactor Command from prototype to class (#1159)

  ✂ Removed

  • ✂ removed EventEmitter from TypeScript definition for Command, eliminating implicit peer dependency on @types/node (#1146)
  • ✂ removed private function normalize (the functionality has been integrated into parseOptions) (#1145)
  • 👀 parseExpectedArgs is now private (#1149)

  Migration Tips

  ✅ If you use .on('command:*') or more complicated tests to detect an unrecognised subcommand, you may be able to delete the code and rely on the default behaviour.

  ✅ If you use program.args or more complicated tests to detect a missing subcommand, you may be able to delete the code and rely on the default behaviour.

  0️⃣ If you use .command('*') to add a default command, you may be be able to switch to isDefault:true with a named command.

• v4.1.1 Changes

  February 02, 2020

  🛠 Fixed

  • TypeScript definition for .action() should include Promise for async ([#1157])

• v4.1.0 Changes

  January 06, 2020

  ➕ Added

  • two routines to change how option values are handled, and eliminate name clashes with command properties (#933 #1102)
    • see storeOptionsAsProperties and passCommandToAction in README
  • 📜 .parseAsync to use instead of .parse if supply async action handlers (#806 #1118)

  🛠 Fixed

  • ✂ Remove trailing blanks from wrapped help text (#1096)

  🔄 Changed

  • ⚡️ update dependencies
  • 🔒 extend security coverage for Commander 2.x to 2020-02-03
  • 👌 improvements to README
  • 👌 improvements to TypeScript definition documentation
  • 🚚 move old versions out of main CHANGELOG
  • ✂ removed explicit use of ts-node in tests

• v4.1.0-0

  December 11, 2019

• v4.0.1 Changes

  November 12, 2019

  🛠 Fixed

  • display help when requested, even if there are missing required options (#1091)

• v4.0.0 Changes

  November 02, 2019

  ➕ Added

  • automatically wrap and indent help descriptions for options and commands (#1051)
  • .exitOverride() allows override of calls to process.exit for additional error handling and to keep program running (#1040)
  • 👌 support for declaring required options with .requiredOptions() (#1071)
  • 👍 GitHub Actions support (#1027)
  • 🌐 translation links in README

  🔄 Changed

  • ✅ dev: switch tests from Sinon+Should to Jest with major rewrite of tests (#1035)
  • 0️⃣ call default subcommand even when there are unknown options (#1047)
  • 💥 Breaking Commander is only officially supported on Node 8 and above, and requires Node 6 (#1053)

  🛠 Fixed

  • 💥 Breaking keep command object out of program.args when action handler called (#1048)
    • also, action handler now passed array of unknown arguments
  • complain about unknown options when program argument supplied and action handler (#1049)
    • this changes parameters to command:* event to include unknown arguments
  • ✂ removed deprecated customFds option from call to child_process.spawn (#1052)
  • rework TypeScript declarations to bring all types into imported namespace (#1081)

  Migration Tips

  ✅ Testing for no arguments

  If you were previously using code like:

  if (!program.args.length) ...
  

  a partial replacement is:

  if (program.rawArgs.length < 3) ...
  

• v4.0.0-1 Changes

  October 08, 2019

  ➕ Added

  • 👌 support for declaring required options with .requiredOptions() (#1071)

• v4.0.0-0 Changes

  October 01, 2019

  ➕ Added

  • automatically wrap and indent help descriptions for options and commands (#1051)
  • .exitOverride() allows override of calls to process.exit for additional error handling and to keep program running (#1040)
  • 🚧 dev: work in progress GitHub Actions support (#1027)

  🔄 Changed

  • ✅ dev: switch tests from Sinon+Should to Jest with major rewrite of tests (#1035)
  • 0️⃣ call default subcommand even when there are unknown options (#1047)
  • 💥 Breaking Commander is only officially supported on Node 8 and above (#1053)

  🛠 Fixed

  • 💥 Breaking keep command object out of program.args when action handler called (#1048)
    • also, action handler now passed array of unknown arguments
  • complain about unknown options when program argument supplied and action handler (#1049)
    • this changes parameters to command:* event to include unknown arguments
  • ✂ removed deprecated customFds option from call to child_process.spawn (#1052)

• « First
• ‹ Prev
• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• Next ›
• Last »