Update dependency yargs to v17

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
yargs (source)	^13.0.0 -> ^17.0.0

---

Release Notes

yargs/yargs

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)

v16.2.0

Compare Source

Features

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

Bug Fixes

• add package.json to module exports (#​1818) (d783a49), closes #​1817

16.1.1 (2020-11-15)

Bug Fixes

• expose helpers for legacy versions of Node.js (#​1801) (107deaa)
• deno: get yargs working on deno@1.5.x (#​1799) (cb01c98)

v16.1.1

Compare Source

v16.1.0

Compare Source

Features

• expose hideBin helper for CJS (#​1768) (63e1173)

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

• code was not passed to process.exit (#​1742) (d1a9930)

v16.0.3

Compare Source

v16.0.2

Compare Source

v16.0.1

Compare Source

v16.0.0

Compare Source

⚠ 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

• 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)

Bug Fixes

• yargs: add missing command(module) signature (#​1707) (0f81024), closes #​1704

Older CHANGELOG Entries

v15.4.1: yargs v15.4.1

Compare Source

decamelize had 12mb dependency, we have downgraded to an earlier version.

v15.4.0: yargs v15.4.0

Compare Source

Features

• adds deprecation option for commands (027a636)
• support array of examples (#​1682) (225ab82)

Bug Fixes

• docs: describe usage of .check() in more detail (932cd11)
• i18n: Japanese translation phrasing (#​1619) (0894175)
• strict mode: report default command unknown arguments (#​1626) (69f29a9)
• usage: translate 'options' group only when displaying help (#​1600) (e60b39b)

Reverts

• Revert "chore(deps): update dependency eslint to v7 (#​1656)" (#​1673) (34949f8), closes #​1656 #​1673

v15.3.1: yargs v15.3.1

Compare Source

Bug Fixes

• _proto__ will now be replaced with __proto___ in parse (#​258), patching a potential
  prototype pollution vulnerability. This was reported by the Snyk Security Research Team. (63810ca)

v15.3.0: yargs v15.3.0

Compare Source

Features

• yargs-parser: introduce single-digit boolean aliases (#​1576) (3af7f04)
• add usage for single-digit boolean aliases (#​1580) (6014e39)

Bug Fixes

• address ambiguity between nargs of 1 and requiresArg (#​1572) (a5edc32)

v15.2.0: yargs v15.2.0

Compare Source

⚠ BREAKING CHANGES

• deps: yargs-parser@17.0.0 no longer implicitly creates arrays out of boolean
  arguments when duplicates are provided

Features

• completion: takes negated flags into account when boolean-negation is set (#​1509) (7293ad5)
• deps: pull in yargs-parser@17.0.0 (#​1553) (b9409da)
• deprecateOption (#​1559) (8aae333)
• display appropriate $0 for electron apps (#​1536) (d0e4379)
• introduces strictCommands() subset of strict mode (#​1540) (1d4cca3)
• deps: yargs-parser with 'greedy-array' configuration (#​1569) (a03a320)

Bug Fixes

• help always displayed for the first command parsed having an async handler (#​1535) (d585b30)
• deps: fix enumeration for normalized path arguments (#​1567) (0b5b1b0)
• locales: only translate default option group name (acc16de)
• locales: remove extra space in French for 'default' (#​1564) (ecfc2c4)
• translations: add French translation for unknown command (#​1563) (18b0b75)
• translations: fix pluralization in error messages. (#​1557) (94fa38c)
• yargs: correct support of bundled electron apps (#​1554) (a0b61ac)

v15.1.0: yargs v15.1.0

Compare Source

Features

• lang: add Finnish localization (language code fi) (222c8fe)
• complete short options with a single dash (#​1507) (99011ab)
• onFinishCommand handler (#​1473) (fe380cd)

Bug Fixes

• getCompletion() was not working for options (#​1495) (463feb2)
• misspelling of package.json engines field (0891d0e)
• populate positionals when unknown-options-as-args is set (#​1508) (bb0f2eb), closes #​1444
• show 2 dashes on help for single digit option key or alias (#​1493) (63b3dd3)
• docs: use recommended cjs import syntax for ts examples (#​1513) (f9a18bf)

v15.0.2: yargs v15.0.2

Compare Source

Bug Fixes

• temporary fix for libraries that call Object.freeze() (#​1483) (99c2dc8)

v15.0.1: yargs v15.0.1

Compare Source

Bug Fixes

• deps: cliui, find-up, and string-width, all drop Node 6 support (#​1479) (6a9ebe2)

v15.0.0: yargs v15.0.0

Compare Source

⚠ BREAKING CHANGES

• deps: yargs-parser now throws on invalid combinations of config (#​1470)
• yargs-parser@16.0.0 drops support for Node 6
• drop Node 6 support (#​1461)
• remove package.json-based parserConfiguration (#​1460)

Features

• deps: yargs-parser now throws on invalid combinations of config (#​1470) (c10c38c)
• expose Parser from require('yargs/yargs') (#​1477) (1840ba2)

Bug Fixes

• docs: TypeScript import to prevent a future major release warning (#​1441) (b1b156a)
• stop-parse was not being respected by commands (#​1459) (12c82e6)
• update to yargs-parser with fix for array default values (#​1463) (ebee59d)
• docs: update boolean description and examples in docs (#​1474) (afd5b48)

Miscellaneous Chores

• drop Node 6 support (#​1461) (2ba8ce0)

Code Refactoring

• remove package.json-based parserConfiguration (#​1460) (0d3642b)

v14.2.3

Compare Source

v14.2.2

Compare Source

v14.2.1

Compare Source

v14.2.0

Compare Source

v14.1.0

Compare Source

v14.0.0

Compare Source

v13.3.2

Compare Source

v13.3.0

Compare Source

Bug Fixes

• deps: yargs-parser update addressing several parsing bugs (#​1357) (e230d5b)

Features

• i18n: swap out os-locale dependency for simple inline implementation (#​1356) (4dfa19b)
• support defaultDescription for positional arguments (812048c)

v13.2.4

Compare Source

v13.2.2

Compare Source

v13.2.1

Compare Source

v13.2.0

Compare Source

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.

---

• If you want to rebase/retry this PR, check this box

---

This PR has been generated by Mend Renovate. View repository job log here.

[renovate]

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.