Skip to content

Latest commit

 

History

History
151 lines (94 loc) · 12.3 KB

CHANGELOG.md

File metadata and controls

151 lines (94 loc) · 12.3 KB

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

17.0.1 (2021-05-03)

Bug Fixes

17.0.0 (2021-05-02)

⚠ BREAKING CHANGES

  • node: drop Node 10 (#1919)
  • implicitly private methods are now actually private
  • deprecated reset() method is now private (call yargs() instead).
  • yargs-factory: refactor yargs-factory to use class (#1895)
  • .positional() now allowed at root level of yargs.
  • coerce: coerce is now applied before validation.
  • async: yargs now returns a promise if async or check are asynchronous.
  • middleware: global middleware now applied when no command is configured.
  • #1823 contains the following breaking API changes:
    • now returns a promise if handler is async.
    • onFinishCommand removed, in favor of being able to await promise.
    • getCompletion now invokes callback with err and `completions, returns promise of completions.

Features

  • add commands alias (similar to options function) (#1850) (00b74ad)
  • add parseSync/parseAsync method (#1898) (6130ad8)
  • add support for showVersion, similar to showHelp (#1831) (1a1e2d5)
  • adds support for async builder (#1888) (ade29b8), closes #1042
  • allow calling standard completion function from custom one (#1855) (31765cb)
  • allow default completion to be referenced and modified, in custom completion (#1878) (01619f6)
  • async: add support for async check and coerce (#1872) (8b95f57)
  • improve support for async/await (#1823) (169b815)
  • locale: add Ukrainian locale (#1893) (c872dfc)
  • middleware: async middleware can now be used before validation. (e0f9363)
  • middleware: global middleware now applied when no command is configured. (e0f9363)
  • node: drop Node 10 (#1919) (5edeb9e)

Bug Fixes

Code Refactoring

  • coerce: coerce is now applied before validation. (8b95f57)
  • deprecated reset() method is now private (call yargs() instead). (376f892)
  • implicitly private methods are now actually private (376f892)
  • yargs-factory: refactor yargs-factory to use class (#1895) (376f892)

16.2.0 (2020-12-05)

Features

  • command() now accepts an array of modules (f415388)

Bug Fixes

16.1.1 (2020-11-15)

Bug Fixes

16.1.0 (2020-10-15)

Features

Bug Fixes

  • deno: update types for deno ^1.4.0 (#1772) (0801752)
  • exports: node 13.0-13.6 require a string fallback (#1776) (b45c43a)
  • modules: module path was incorrect (#1759) (95a4a0a)
  • positional: positional strings no longer drop decimals (#1761) (e1a300f)
  • make positionals in -- count towards validation (#1752) (eb2b29d)

16.0.3 (2020-09-10)

Bug Fixes

  • move yargs.cjs to yargs to fix Node 10 imports (#1747) (5bfb85b)

16.0.2 (2020-09-09)

Bug Fixes

  • typescript: yargs-parser was breaking @types/yargs (#1745) (2253284)

16.0.1 (2020-09-09)

Bug Fixes

16.0.0 (2020-09-09)

⚠ BREAKING CHANGES

  • tweaks to ESM/Deno API surface: now exports yargs function by default; getProcessArgvWithoutBin becomes hideBin; types now exported for Deno.
  • find-up replaced with escalade; export map added (limits importable files in Node >= 12); yarser-parser@19.x.x (new decamelize/camelcase implementation).
  • usage: single character aliases are now shown first in help output
  • rebase helper is no longer provided on yargs instance.
  • drop support for EOL Node 8 (#1686)

Features

Bug Fixes

Older CHANGELOG Entries