Skip to content

Latest commit

 

History

History
396 lines (305 loc) · 16 KB

CHANGELOG.md

File metadata and controls

396 lines (305 loc) · 16 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning. (Format adopted after v3.0.0.)

Unreleased (date goes here)

Migration Tips

The biggest change is the parsed option values. Previously the options were stored by default as properties on the command object, and now the options are stored separately.

If you wish to restore the old behaviour and get running quickly you can call .storeOptionsAsProperties(). To allow you to move to the new code patterns incrementally, the action handler will be passed the command twice, to match the new "options" and "command" parameters (see below).

program options

Use the .opts() method to access the options. This is available on any command but is used most with the program.

program.option('-d, --debug');
program.parse();
// Old code before Commander 7
if (program.debug) console.log(`Program name is ${program.name()}`);
// New code
const options = program.opts();
if (options.debug) console.log(`Program name is ${program.name()}`);

action handler

The action handler gets passed a parameter for each command-argument you declared. Previously by default the next parameter was the command object with the options as properties. Now the next two parameters are instead the options and the command. If you only accessed the options there may be no code changes required.

program
  .command('compress <filename>')
  .option('-t, --trace')
  // Old code before Commander 7
  .action((filename, cmd)) => {
    if (cmd.trace) console.log(`Command name is ${cmd.name()}`);
  });
  // New code
  .action((filename, options, command)) => {
    if (options.trace) console.log(`Command name is ${command.name()}`);
  });

If you already set .storeOptionsAsProperties(false) you may still need to adjust your code.

program
  .command('compress <filename>')
  .storeOptionsAsProperties(false)
  .option('-t, --trace')
  // Old code before Commander 7
  .action((filename, command)) => {
    if (command.opts().trace) console.log(`Command name is ${command.name()}`);
  });
   // New code
   .action((filename, options, command)) => {
      if (command.opts().trace) console.log(`Command name is ${command.name()}`);
   });

excess command-arguments

There is now an error if there are too many command-arguments on the command line (only checked if there is an action handler). If the extra arguments are supported by your command then you can either declare the expected arguments, or allow excess arguments.

// Old code before Commander 7
program
  .action(() => {});
program.parse(['a', 'b', 'c'], { from: 'user' }); // now causes an error
// New code, declare arguments
program
  .arguments('[args...]')
  .action(() => {});
// New code, allow excess arguments
program
  .allowExcessArguments()
  .action(() => {});

7.0.0-1 (2020-11-21)

Added

  • .createOption() to support subclassing of automatically created options (like .createCommand()) (#1380)
  • .configureOutput() to modify use of stdout and stderr or customise display of errors (#1387)

Breaking changes relative to 7.0.0-0

  • rework new Help.wrap() for simpler usage pattern (#1395)
  • rename new "columns" properties (#1396)
    • Help.columns -> helpWidth
    • getOutColumns() -> getOutHelpWidth()
    • getErrColumns() -> getErrHelpWidth()

7.0.0-0 (2020-10-25)

Added

  • use .addHelpText() to add text before or after the built-in help, for just current command or also for all subcommands (#1296)
  • enhance Option class (#1331)
    • allow hiding options from help
    • allow restricting option arguments to a list of choices
    • allow setting how default value is shown in help
  • refactor the code generating the help into a separate public Help class (#1365)
    • support sorting subcommands and options in help
    • support specifying wrap width (columns)
    • allow subclassing Help class
    • allow configuring Help class without subclassing

Fixed

  • wrapping bugs in help (#1365)
    • first line of command description was wrapping two characters early
    • pad width calculation was not including help option and help command
    • pad width calculation was including hidden options and commands

Changed

  • document and annotate deprecated routines (#1349)
  • deprecated callback parameter to .help() and .outputHelp() (removed from README) (#1296)
  • deprecate .on('--help') (removed from README) (#1296)
  • initialise the command description to empty string (previously undefined) (#1365)

6.2.0 (2020-10-25)

Added

  • added 'tsx' file extension for stand-alone executable subcommands (#1368)
  • documented second parameter to .description() to describe command arguments (#1353)
  • documentation of special cases with options taking varying numbers of option-arguments (#1332)
  • documentation for terminology (#1361)

Fixed

  • add missing TypeScript definition for `.addHelpCommand()' (#1375)
  • removed blank line after "Arguments:" in help, to match "Options:" and "Commands:" (#1360)

Changed

  • update dependencies

6.1.0 (2020-08-28)

Added

  • include URL to relevant section of README for error for potential conflict between Command properties and option values (#1306)
  • .combineFlagAndOptionalValue(false) to ease upgrade path from older versions of Commander (#1326)
  • allow disabling the built-in help option using .helpOption(false) (#1325)
  • allow just some arguments in argumentDescription to .description() (#1323)

Changed

  • tidy async test and remove lint override (#1312)

Fixed

  • executable subcommand launching when script path not known (#1322)

6.0.0 (2020-07-21)

Added

  • add support for variadic options (#1250)
  • allow options to be added with just a short flag (#1256)
    • Breaking the option property has same case as flag. e.g. flag -n accessed as opts().n (previously uppercase)
  • Breaking throw an error if there might be a clash between option name and a Command property, with advice on how to resolve (#1275)

Fixed

  • Options which contain -no- in the middle of the option flag should not be treated as negatable. (#1301)

6.0.0-0 (2020-06-20)

(Released in 6.0.0)

5.1.0 (2020-04-25)

Added

  • support for multiple command aliases, the first of which is shown in the auto-generated help (#531, #1236)
  • configuration support in addCommand() for hidden and isDefault (#1232)

Fixed

  • omit masked help flags from the displayed help (#645, #1247)
  • remove old short help flag when change help flags using helpOption (#1248)

Changed

  • remove use of arguments to improve auto-generated help in editors (#1235)
  • rename .command() configuration noHelp to hidden (but not remove old support) (#1232)
  • improvements to documentation
  • update dependencies
  • update tested versions of node
  • eliminate lint errors in TypeScript (#1208)

5.0.0 (2020-03-14)

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)
  • display error message for unknown subcommand, by default (#432 #1088 #1149)
  • 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)
  • .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)
  • suggest help option along with unknown command error (#1179)
  • TypeScript definition for commands property of Command (#1184)
  • export program property (#1195)
  • createCommand factory method to simplify subclassing (#1191)

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)
  • changes to error handling (#1165)
    • throw for author error, not just display message
    • preflight for variadic error
    • add tips to missing subcommand executable
  • TypeScript fluent return types changed to be more subclass friendly, return this rather than Command (#1180)
  • .parseAsync returns Promise<this> to be consistent with .parse() (#1180)
  • update dependencies

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.

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

If you want to continue combining short options with optional values as though they were boolean flags, set combineFlagAndOptionalValue(false) to expand -fb to -f -b rather than -f b.

5.0.0-4 (2020-03-03)

(Released in 5.0.0)

5.0.0-3 (2020-02-20)

(Released in 5.0.0)

5.0.0-2 (2020-02-10)

(Released in 5.0.0)

5.0.0-1 (2020-02-08)

(Released in 5.0.0)

5.0.0-0 (2020-02-02)

(Released in 5.0.0)

Older versions