CHANGELOG.md

Changelog

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

15.2.0 (2020-11-15)

⚠ BREAKING CHANGES

• tweaks to ESM/Deno API surface: now exports yargs function by default; getProcessArgvWithoutBin becomes hidBin; 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
• ts: yargs now ships with its own types
• drop support for EOL Node 8 (#1686)
• deps: yargs-parser@17.0.0 no longer implicitly creates arrays out of boolean

Features

• adds strictOptions() (#1738) (b215fba)
• expose hideBin helper for CJS (#1768) (63e1173)
• helpers: rebase, Parser, applyExtends now blessed helpers (#1733) (c7debe8)
• add usage for single-digit boolean aliases (#1580) (6014e39)
• adds deprecation option for commands (027a636)
• adds support for ESM and Deno (#1708) (ac6d5d1)
• deprecateOption (#1559) (8aae333)
• display appropriate $0 for electron apps (#1536) (d0e4379)
• drop support for EOL Node 8 (#1686) (863937f)
• i18n for ESM and Deno (#1735) (c71783a)
• support array of examples (#1682) (225ab82)
• tweaks to API surface based on user feedback (#1726) (4151fee)
• completion: takes negated flags into account when boolean-negation is set (#1509) (7293ad5)
• deps: pull in yargs-parser@17.0.0 (#1553) (b9409da)
• deps: yargs-parser with 'greedy-array' configuration (#1569) (a03a320)
• usage: single char aliases first in help (#1574) (a552990)
• yargs-parser: introduce single-digit boolean aliases (#1576) (3af7f04)
• introduces strictCommands() subset of strict mode (#1540) (1d4cca3)

Bug Fixes

• expose helpers for legacy versions of Node.js (#1801) (107deaa)
• deno: get yargs working on deno@1.5.x (#1799) (cb01c98)
• deno: update types for deno ^1.4.0 (#1772) (0801752)
• docs: describe usage of .check() in more detail (932cd11)
• exports: node 13.0-13.6 require a string fallback (#1776) (b45c43a)
• i18n: Japanese translation phrasing (#1619) (0894175)
• modules: module path was incorrect (#1759) (95a4a0a)
• positional: positional strings no longer drop decimals (#1761) (e1a300f)
• address ambiguity between nargs of 1 and requiresArg (#1572) (a5edc32)
• code was not passed to process.exit (#1742) (d1a9930)
• help always displayed for the first command parsed having an async handler (#1535) (d585b30)
• make positionals in -- count towards validation (#1752) (eb2b29d)
• move yargs.cjs to yargs to fix Node 10 imports (#1747) (5bfb85b)
• 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)
• strict mode: report default command unknown arguments (#1626) (69f29a9)
• translations: add French translation for unknown command (#1563) (18b0b75)
• translations: fix pluralization in error messages. (#1557) (94fa38c)
• typescript: yargs-parser was breaking @types/yargs (#1745) (2253284)
• usage: translate 'options' group only when displaying help (#1600) (e60b39b)
• yargs: add missing command(module) signature (#1707) (0f81024), closes #1704
• proto will now be replaced with proto in parse (#1591) (2474c38)
• yargs: correct support of bundled electron apps (#1554) (a0b61ac)

Reverts

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

Code Refactoring

• ts: ship yargs.d.ts (#1671) (c06f886)

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)

16.1.0 (2020-10-15)

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)

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

• 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