Skip to content

Latest commit

 

History

History
203 lines (129 loc) · 6.38 KB

CHANGELOG.md

File metadata and controls

203 lines (129 loc) · 6.38 KB
Raw

Changelog

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

The format is based on Keep a Changelog.

The version numbering does not follow semantic versioning but instead aligns with the commander version number. The installed version of this package should match the major and minor version numbers of the installed commander package, but the patch version number is independent (following pattern used by Definitely Typed).

12.1.0 (2024-05-18)

Changed

  • use ESLint for linting (#65)
  • format source files with Prettier (#66)

Removed

  • removed unimplemented Option.fullDescription from TypeScript definition (#70)

12.0.1 (2023-03-02)

Changed

  • include implicit this in parameters for action handler callback #59

12.0.0 (2023-02-04)

Changed

12.0.0-1 (2023-11-13)

Fixed

  • use prerelease Commander version for peerDependencies

12.0.0-0 (2023-11-12)

Changed

11.1.0 (2023-10-15)

Added

  • Option properties: envVar, presetArg (#48)
  • Argument properties: argChoices, defaultValue, defaultValueDescription (#48)
  • Command properties: options, registeredArguments (#50)

Changed

Fixed

  • remove unused Option.optionFlags property (#48)
  • add that Command.version() can also be used as getter (#48)
  • add null return type to Commands.executableDir(), for when not configured (#48)
  • preserve option typings when adding arguments to Command (#49)

11.0.0 (2023-06-16)

Changed

10.0.3 (2023-03-03)

Added

  • narrow types based on .choices() (#29)

Fixed

  • improve Option type inferences for certain combinations of configuration (#31)
  • mark .action() callback as allowing promises (#33)

10.0.2 (2023-01-27)

Fixed

  • createOption passes through description into object constructor. (#25)

10.0.1 (2023-01-17)

Fixed

  • createCommand, createArgument, and createOption pass through arguments into object constructors. (#23)

10.0.0 (2023-01-14)

Changed

9.5.0 (2023-01-07)

Added

  • .getOptionValueSourceWithGlobals() (#18)
  • showGlobalOptions for .configureHelp{} and Help (#19)

Changed

9.4.1 (2022-11-01)

Fixed

  • added esm.mjs to package (#16)

9.4.0 (2022-10-28)

Added

  • type processedArgs
  • infer types from .createOption()
  • infer types from .createArgument()

Changed

0.3.0 (2022-09-07)

Added

  • add CommandUnknownOpts for when Command not strongly typed
  • use CommandUnknownOpts throughout Help, so can pass in commands which are Command or CommandUnknownOpts
  • use CommandUnknownOpts with addCommand
  • type .hook() arguments
  • add inferred option names and types to .getOptionValue(), but allow unknown and return unknown
  • add implied to OptionValueSource

Changed

  • switch OptionValues to returning unknown (goodbye another any!)
  • allow user defined source on get and set

0.2.0 (2022-08-23)

Fixed

  • a missing variadic optional command-line argument should be [] not undefined

Changed

  • use simple array type rather than fancy non-empty tuple, like string[] rather than [string, ...string[]]

0.1.0 (2022-08-16)

Added

  • infer types from
    • .argument()
    • .arguments()
    • .addArgument()
    • .command()
    • .option()
    • .addOption()
  • inferred types for .action()
  • inferred types for .opts()