All notable changes to this project will be documented in this file. See standard-version for commit guidelines.
17.0.0 (2021-04-12)
- 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.
- add commands alias (similar to options function) (#1850) (00b74ad)
- add parseSync/parseAsync method (#1898) (6130ad8)
- add support for
showVersion, similar toshowHelp(#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)
- always cache help message when running commands (#1865) (d57ca77), closes #1853
- async: don't call parse callback until async ops complete (#1896) (a93f5ff), closes #1888
- builder: apply default builder for showHelp/getHelp (#1913) (395bb67), closes #1912
- coerce: options using coerce now displayed in help (#1911) (d2128cc), closes #1909
- completion script name clashing on bash (#1903) (8f62d9a)
- deno: use actual names for keys instead of inferring (#1891) (b96ef01)
- exclude positionals from default completion (#1881) (0175677)
- #1841 (comment) (b96ef01)
- showHelp() and .getHelp() now return same output for commands as --help (#1826) (36abf26)
- zsh completion is now autoloadable (#1856) (d731f9f)
- 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)
- command() now accepts an array of modules (f415388)
16.1.1 (2020-11-15)
- expose helpers for legacy versions of Node.js (#1801) (107deaa)
- deno: get yargs working on deno@1.5.x (#1799) (cb01c98)
16.1.0 (2020-10-15)
- 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)
16.0.2 (2020-09-09)
16.0.1 (2020-09-09)
16.0.0 (2020-09-09)
- 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)
- adds strictOptions() (#1738) (b215fba)
- helpers: rebase, Parser, applyExtends now blessed helpers (#1733) (c7debe8)
- adds support for ESM and Deno (#1708) (ac6d5d1)
- drop support for EOL Node 8 (#1686) (863937f)
- i18n for ESM and Deno (#1735) (c71783a)
- tweaks to API surface based on user feedback (#1726) (4151fee)
- usage: single char aliases first in help (#1574) (a552990)