Upgrade yargs: 16.2.0 → 17.3.0 (major)

Here is everything you need to know about this upgrade. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ yargs (16.2.0 → 17.3.0) · Repo · Changelog

Release Notes

17.3.0

17.3.0 (2021-11-30)

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

Bug Fixes

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

17.2.0

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

Bug Fixes

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

17.1.0

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

Bug Fixes

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

17.0.0

⚠ 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)
• #1841 (comment) (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)

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by more commits than we can show here.

---

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@​depfu rebase

Rebases against your default branch and redoes this update

@​depfu recreate

Recreates this PR, overwriting any edits that you've made to it

@​depfu merge

Merges this PR once your tests are passing and conflicts are resolved

@​depfu close

Closes this PR and deletes the branch

@​depfu reopen

Restores the branch and reopens this PR (if it's closed)

@​depfu pause

Ignores all future updates for this dependency and closes this PR

@​depfu pause [minor|major]

Ignores all future minor/major updates for this dependency and closes this PR

@​depfu resume

Future versions of this dependency will create PRs again (leaves this PR as is)