v17.7.1

Compare Source

Bug Fixes

• address display bug with default sub-commands (#​2303) (9aa2490)

v17.7.0

Compare Source

Features

• add method to hide option extras (#​2156) (2c144c4)
• convert line break to whitespace for the description of the option (#​2271) (4cb41dc)

Bug Fixes

• copy the description of the option to its alias in completion (#​2269) (f37ee6f)

v17.6.2

Compare Source

Bug Fixes

• deps: update dependency yargs-parser to v21.1.1 (#​2231) (75b4d52)
• lang: typo in Finnish unknown argument singular form (#​2222) (a6dfd0a)

v17.6.1

Compare Source

Bug Fixes

• lang: fix "Not enough non-option arguments" message for the Czech language (#​2242) (3987b13)

v17.6.0

Compare Source

Features

• lang: Czech locale (#​2220) (5895cf1)
• usage: add YARGS_DISABLE_WRAP env variable to disable wrap (#​2210) (b680ace)

Bug Fixes

• deno: use 'globalThis' instead of 'window' (#​2186) (#​2215) (561fc7a)
• deps: cliui with forced strip-ansi update (#​2241) (38e8df1)
• dont clobber description for multiple option calls (#​2171) (f91d9b3)
• typescript: address warning with objectKeys (394f5f8)

17.5.1 (2022-05-16)

Bug Fixes

• add missing entries to published files (#​2185) (5685382)
• address bug when strict and async middleware used together (#​2164) (cbc2eb7)
• completion: correct zsh installation instructions (22e9af2)
• handle multiple node_modules folders determining mainFilename for ESM (#​2123) (e0823dd)
• lang: add missing terms to Russian translation (#​2181) (1c331f2)
• prevent infinite loop with empty locale (#​2179) (b672e70)
• veriadic arguments override array provided in config (the same as multiple dash arguments). (4dac5b8)

v17.5.1

Compare Source

v17.5.0

Compare Source

Features

• add browser.d.ts and check for existence of Error.captureStackTrace() (#​2144) (6192990)

Bug Fixes

• completion: support for default flags (db35423)
• import yargs/yargs in esm projects (#​2151) (95aed1c)

17.4.1 (2022-04-09)

Bug Fixes

• coerce pollutes argv (#​2161) (2d1136d)
• completion: don't show positional args choices with option choices (#​2148) (b58b5bc)
• hide hidden options from completion (#​2143) (e086dfa), closes #​2142
• show message when showHelpOnFail is chained globally (#​2154) (ad9fcac)

v17.4.1

Compare Source

v17.4.0

Compare Source

Features

• completion: choices will now work for all possible aliases of an option and not just the default long option (30edd50)
• completion: positional arguments completion (#​2090) (00e4ebb)

Bug Fixes

• completion: changed the check for option arguments to match options that begin with '-', instead of '--', to include short options (30edd50)
• completion: fix for completions that contain non-leading hyphens (30edd50)
• failed command usage string is missing arg descriptions and optional args (#​2105) (d6e342d)
• wrap unknown args in quotes (#​2092) (6a29778)

17.3.1 (2021-12-23)

Bug Fixes

• translations: correct Korean translation (#​2095) (c7c2b9e)

v17.3.1

Compare Source

v17.3.0

Compare Source

Features

• fallback to default bash completion (74c0ba5)

Bug Fixes

• avoid legacy accessors (#​2013) (adb0d11)
• deps: update dependency yargs-parser to v21 (#​2063) (76c1951)
• don't fail if "fileURLToPath(import.meta.url)" throws (3a44796)
• re-add options to check callback (#​2079) (e75319d)

17.2.1 (2021-09-25)

Bug Fixes

• docs: stop advertising .argv property (#​2036) (4f5ecc1), closes #​2035

v17.2.1

Compare Source

v17.2.0

Compare Source

Features

• autocomplete choices for options (#​2018) (01b2c6a)
• locales: Added Uzbek translation (#​2024) (ee047b9)

Bug Fixes

• boolean option should work with strict (#​1996) (e9379e2)
• cast error types as TypeScript 4.4 infers them as unknown instead of any (#​2016) (01b2c6a)
• conflicts and strip-dashed (#​1998) (59a86fb)
• emit warning on version name collision (#​1986) (d0e8292)
• help command spacing when scriptName is empty (#​1994) (d33e997)

17.1.1 (2021-08-13)

Bug Fixes

• positional array defaults should not be combined with provided values (#​2006) (832222d)

v17.1.1

Compare Source

v17.1.0

Compare Source

Features

• update Levenshtein to Damerau-Levenshtein (#​1973) (d2c121b)

Bug Fixes

• coerce middleware should be applied once (#​1978) (14bd6be)
• implies should not fail when implied key's value is 0, false or empty string (#​1985) (8010472)
• positionals should not overwrite options (#​1992) (9d84309)
• strict should fail unknown arguments (#​1977) (c804f0d)
• wrap(null) no longer causes strange indentation behavior (#​1988) (e1871aa)

17.0.1 (2021-05-03)

Bug Fixes

• build: Node 12 is now minimum version (#​1936) (0924566)

v17.0.1

Compare Source

v17.0.0

Compare Source

⚠ 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

• 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
• builder: nested builder is now awaited (#​1925) (b5accd6)
• 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)
• https://github.com/yargs/yargs/issues/1841#issuecomment-804770453 (b96ef01)
• showHelp() and .getHelp() now return same output for commands as --help (#​1826) (36abf26)
• zsh completion is now autoloadable (#​1856) (d731f9f)

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)