Skip to content

Latest commit

 

History

History
137 lines (80 loc) · 2.66 KB

CHANGELOG.md

File metadata and controls

137 lines (80 loc) · 2.66 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.

2.5.1

  • Fix an issue where quietBlank: true could prevent the invalid command message from showing. (@wolfy01)

2.5.0

Added

  • New quietBlank option that prevents the help menu from appearing when an blank new line is entered. (@mbwhite)

2.4.1 - 15 October 2020

Fixed

  • A bug that allowed users to pass more parameters than were allowed by a command.

2.3.0 - 14 February 2019

Changed

  • Parameters can now be enclosed by single (') and double (") quotes.

2.2.0 - 17 September 2019

Added

  • Parameters can now be enclosed with double (") quotes.

2.1.0 - 5 August 2019

Added

  • Support for command aliasing.

2.0.0 - 9 November 2018

Added

  • Support for optional parameters.
  • Support for rest parameters.

Changed

  • The options are specified with { label: string } instead of { option: string }.
  • Most CLI methods return a reference to this, allowing method chaining.
  • command and commands methods have been renamed to addCommand and addCommands respectively.
  • If an action does not return a promise, it is assumed to be synchronous. done is no longer required.

Removed

  • Action functions are no longer passed done. Return a promise instead.

Deprecated

  • command - use addCommand instead.
  • commands - use addCommands instead.
  • registerCommands - use addCommands instead.

1.8.0

Added

  • Shorthand "Action" as an overload.

1.7.0

Added

  • Shorthand command registration.

1.6.0

Added

  • Unit tests.

Fixed

  • Passed values of "false" or "0" are considered false by boolean parameters.

1.5.0

Added

  • Parameters can specify a conversion method as a type.

1.4.0

Added

  • commands An alias for registerCommands.

1.3.0

Added

  • registerCommands for bulk registration of commands.

1.2.0

Added

  • setInfo Set the help menu overview.
  • setName Set the name of the interface for the help menu.
  • setVersion Set a version to be displayed by help.

1.1.0

Added

  • Importable Commands interface.

Changed

  • Type definitions come from a generated .d.ts file.

1.0.6

Added

  • Licesnse text.

1.0.5

Fixed

  • Hide works immediatley.

Changed

  • Extracted some parsers to their own file.
  • We now show help for a command if it is used incorrectly.
  • Log rejected promises in returned by actions.

Added

  • Build instructions to README.md.
  • Build command to package.json.
  • CHANGELOG.md.