yargs 14.2.3 → 15.1.0

package/CHANGELOG.md

@@ -2,18 +2,70 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-### 14.2.2
+## [15.1.0](https://www.github.com/yargs/yargs/compare/v15.0.2...v15.1.0) (2020-01-02)
+
+
+### Features
+
+* **lang:** add Finnish localization (language code fi) ([222c8fe](https://www.github.com/yargs/yargs/commit/222c8fef2e2ad46e314c337dec96940f896bec35))
+* complete short options with a single dash ([#1507](https://www.github.com/yargs/yargs/issues/1507)) ([99011ab](https://www.github.com/yargs/yargs/commit/99011ab5ba90232506ece0a17e59e2001a1ab562))
+* onFinishCommand handler ([#1473](https://www.github.com/yargs/yargs/issues/1473)) ([fe380cd](https://www.github.com/yargs/yargs/commit/fe380cd356aa33aef0449facd59c22cab8930ac9))
+
+
+### Bug Fixes
+
+* getCompletion() was not working for options ([#1495](https://www.github.com/yargs/yargs/issues/1495)) ([463feb2](https://www.github.com/yargs/yargs/commit/463feb2870158eb9df670222b0f0a40a05cf18d0))
+* misspelling of package.json `engines` field ([0891d0e](https://www.github.com/yargs/yargs/commit/0891d0ed35b30c83a6d9e9f6a5c5f84d13c546a0))
+* populate positionals when unknown-options-as-args is set ([#1508](https://www.github.com/yargs/yargs/issues/1508)) ([bb0f2eb](https://www.github.com/yargs/yargs/commit/bb0f2eb996fa4e19d330b31a01c2036cafa99a7e)), closes [#1444](https://www.github.com/yargs/yargs/issues/1444)
+* show 2 dashes on help for single digit option key or alias ([#1493](https://www.github.com/yargs/yargs/issues/1493)) ([63b3dd3](https://www.github.com/yargs/yargs/commit/63b3dd31a455d428902220c1992ae930e18aff5c))
+* **docs:** use recommended cjs import syntax for ts examples ([#1513](https://www.github.com/yargs/yargs/issues/1513)) ([f9a18bf](https://www.github.com/yargs/yargs/commit/f9a18bfd624a5013108084f690cd8a1de794c430))
+
+### [15.0.2](https://www.github.com/yargs/yargs/compare/v15.0.1...v15.0.2) (2019-11-19)
+
 
 ### Bug Fixes
 
 * temporary fix for libraries that call Object.freeze() ([#1483](https://www.github.com/yargs/yargs/issues/1483)) ([99c2dc8](https://www.github.com/yargs/yargs/commit/99c2dc850e67c606644f8b0c0bca1a59c87dcbcd))
 
-### [14.2.1](https://github.com/yargs/yargs/compare/v14.2.0...v14.2.1) (2019-10-30)
+### [15.0.1](https://www.github.com/yargs/yargs/compare/v15.0.0...v15.0.1) (2019-11-16)
+
+
+### Bug Fixes
+
+* **deps:** cliui, find-up, and string-width, all drop Node 6 support ([#1479](https://www.github.com/yargs/yargs/issues/1479)) ([6a9ebe2](https://www.github.com/yargs/yargs/commit/6a9ebe2d955e3e979e76c07ffbb1c17fef64cb49))
+
+## [15.0.0](https://www.github.com/yargs/yargs/compare/v14.2.0...v15.0.0) (2019-11-10)
+
+
+### ⚠ 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](https://www.github.com/yargs/yargs/issues/1470)) ([c10c38c](https://www.github.com/yargs/yargs/commit/c10c38cca04298f96b55a7e374a9a134abefffa7))
+* expose `Parser` from `require('yargs/yargs')` ([#1477](https://www.github.com/yargs/yargs/issues/1477)) ([1840ba2](https://www.github.com/yargs/yargs/commit/1840ba22f1a24c0ece8e32bbd31db4134a080aee))
 
 
 ### Bug Fixes
 
-* stop-parse was not being respected by commands ([#1459](https://github.com/yargs/yargs/issues/1459)) ([e78e76e](https://github.com/yargs/yargs/commit/e78e76e3ac0551d4f30c71a05ddb21582960fcef))
+* **docs:** TypeScript import to prevent a future major release warning ([#1441](https://www.github.com/yargs/yargs/issues/1441)) ([b1b156a](https://www.github.com/yargs/yargs/commit/b1b156a3eb4ddd6803fbbd56c611a77919293000))
+* stop-parse was not being respected by commands ([#1459](https://www.github.com/yargs/yargs/issues/1459)) ([12c82e6](https://www.github.com/yargs/yargs/commit/12c82e62663e928148a7ee2f51629aa26a0f9bb2))
+* update to yargs-parser with fix for array default values ([#1463](https://www.github.com/yargs/yargs/issues/1463)) ([ebee59d](https://www.github.com/yargs/yargs/commit/ebee59d9022da538410e69a5c025019ed46d13d2))
+* **docs:** update boolean description and examples in docs ([#1474](https://www.github.com/yargs/yargs/issues/1474)) ([afd5b48](https://www.github.com/yargs/yargs/commit/afd5b4871bfeb90d58351ac56c5c44a83ef033e6))
+
+
+### Miscellaneous Chores
+
+* drop Node 6 support ([#1461](https://www.github.com/yargs/yargs/issues/1461)) ([2ba8ce0](https://www.github.com/yargs/yargs/commit/2ba8ce05e8fefbeffc6cb7488d9ebf6e86cceb1d))
+
+
+### Code Refactoring
+
+* remove package.json-based parserConfiguration ([#1460](https://www.github.com/yargs/yargs/issues/1460)) ([0d3642b](https://www.github.com/yargs/yargs/commit/0d3642b6f829b637938774c0c6ce5f6bfe1afa51))
 
 ## [14.2.0](https://github.com/yargs/yargs/compare/v14.1.0...v14.2.0) (2019-10-07)
 

package/README.md

@@ -98,6 +98,10 @@ npm i @types/yargs --save-dev
 
 See usage examples in [docs](/docs/typescript.md).
 
+## Webpack
+
+See usage examples of yargs with webpack in [docs](/docs/webpack.md).
+
 ## Community :
 
 Having problems? want to contribute? join our [community slack](http://devtoolscommunity.herokuapp.com).

package/lib/command.js

@@ -79,7 +79,7 @@ module.exports = function command (yargs, usage, validation, globalMiddleware) {
       description: description,
       handler,
       builder: builder || {},
-      middlewares: middlewares || [],
+      middlewares,
       demanded: parsedCommand.demanded,
       optional: parsedCommand.optional
     }
@@ -218,7 +218,7 @@ module.exports = function command (yargs, usage, validation, globalMiddleware) {
       positionalMap = populatePositionals(commandHandler, innerArgv, currentContext, yargs)
     }
 
-    const middlewares = globalMiddleware.slice(0).concat(commandHandler.middlewares || [])
+    const middlewares = globalMiddleware.slice(0).concat(commandHandler.middlewares)
     applyMiddleware(innerArgv, yargs, middlewares, true)
 
     // we apply validation post-hoc, so that custom
@@ -240,15 +240,26 @@ module.exports = function command (yargs, usage, validation, globalMiddleware) {
         handlerResult = commandHandler.handler(innerArgv)
       }
 
+      const handlerFinishCommand = yargs.getHandlerFinishCommand()
       if (isPromise(handlerResult)) {
         yargs.getUsageInstance().cacheHelpMessage()
-        handlerResult.catch(error => {
-          try {
-            yargs.getUsageInstance().fail(null, error)
-          } catch (err) {
+        handlerResult
+          .then(value => {
+            if (handlerFinishCommand) {
+              handlerFinishCommand(value)
+            }
+          })
+          .catch(error => {
+            try {
+              yargs.getUsageInstance().fail(null, error)
+            } catch (err) {
             // fail's throwing would cause an unhandled rejection.
-          }
-        })
+            }
+          })
+      } else {
+        if (handlerFinishCommand) {
+          handlerFinishCommand(handlerResult)
+        }
       }
     }
 
@@ -344,6 +355,7 @@ module.exports = function command (yargs, usage, validation, globalMiddleware) {
     const unparsed = []
     Object.keys(positionalMap).forEach((key) => {
       positionalMap[key].map((value) => {
+        if (options.configuration['unknown-options-as-args']) options.key[key] = true
         unparsed.push(`--${key}`)
         unparsed.push(value)
       })

package/lib/completion.js

@@ -8,6 +8,11 @@ module.exports = function completion (yargs, usage, command) {
     completionKey: 'get-yargs-completions'
   }
 
+  let aliases
+  self.setParsed = function setParsed (parsed) {
+    aliases = parsed.aliases
+  }
+
   const zshShell = (process.env.SHELL && process.env.SHELL.indexOf('zsh') !== -1) ||
     (process.env.ZSH_NAME && process.env.ZSH_NAME.indexOf('zsh') !== -1)
   // get a list of completion commands.
@@ -16,7 +21,6 @@ module.exports = function completion (yargs, usage, command) {
     const completions = []
     const current = args.length ? args[args.length - 1] : ''
     const argv = yargs.parse(args, true)
-    const aliases = yargs.parsed.aliases
     const parentCommands = yargs.getContext().commands
 
     // a custom completion function can be provided
@@ -77,11 +81,14 @@ module.exports = function completion (yargs, usage, command) {
         const keyAndAliases = [key].concat(aliases[key] || [])
         const notInArgs = keyAndAliases.every(val => args.indexOf(`--${val}`) === -1)
         if (notInArgs) {
+          const startsByTwoDashes = s => /^--/.test(s)
+          const isShortOption = s => /^[^0-9]$/.test(s)
+          const dashes = !startsByTwoDashes(current) && isShortOption(key) ? '-' : '--'
           if (!zshShell) {
-            completions.push(`--${key}`)
+            completions.push(dashes + key)
           } else {
             const desc = descs[key] || ''
-            completions.push(`--${key.replace(/:/g, '\\:')}:${desc.replace('__yargsString__:', '')}`)
+            completions.push(dashes + `${key.replace(/:/g, '\\:')}:${desc.replace('__yargsString__:', '')}`)
           }
         }
       })

package/lib/usage.js

@@ -272,7 +272,7 @@ module.exports = function usage (yargs, y18n) {
             // for the special positional group don't
             // add '--' or '-' prefix.
             if (groupName === self.getPositionalGroupName()) return sw
-            else return (sw.length > 1 ? '--' : '-') + sw
+            else return (/^[^0-9]$/.test(sw) ? '-' : '--') + sw
           })
           .join(', ')
 

package/locales/fi.json

@@ -0,0 +1,42 @@
+{
+  "Commands:": "Komennot:",
+  "Options:": "Valinnat:",
+  "Examples:": "Esimerkkejä:",
+  "boolean": "totuusarvo",
+  "count": "lukumäärä",
+  "string": "merkkijono",
+  "number": "numero",
+  "array": "taulukko",
+  "required": "pakollinen",
+  "default:": "oletusarvo:",
+  "choices:": "vaihtoehdot:",
+  "aliases:": "aliakset:",
+  "generated-value": "generoitu-arvo",
+  "Not enough non-option arguments: got %s, need at least %s": "Liian vähän argumentteja, jotka eivät ole valintoja: annettu %s, vaaditaan vähintään %s",
+  "Too many non-option arguments: got %s, maximum of %s": "Liikaa argumentteja, jotka eivät ole valintoja: annettu %s, sallitaan enintään %s",
+  "Missing argument value: %s": {
+    "one": "Argumentin arvo puuttuu: %s",
+    "other": "Argumentin arvot puuttuvat: %s"
+  },
+  "Missing required argument: %s": {
+    "one": "Pakollinen argumentti puuttuu: %s",
+    "other": "Pakollisia argumentteja puuttuu: %s"
+  },
+  "Unknown argument: %s": {
+    "one": "Tuntematon argumenttn: %s",
+    "other": "Tuntemattomia argumentteja: %s"
+  },
+  "Invalid values:": "Virheelliset arvot:",
+  "Argument: %s, Given: %s, Choices: %s": "Argumentti: %s, Annettu: %s, Vaihtoehdot: %s",
+  "Argument check failed: %s": "Argumentin tarkistus epäonnistui: %s",
+  "Implications failed:": "Riippuvia argumentteja puuttuu:",
+  "Not enough arguments following: %s": "Argumentin perässä ei ole tarpeeksi argumentteja: %s",
+  "Invalid JSON config file: %s": "Epävalidi JSON-asetustiedosto: %s",
+  "Path to JSON config file": "JSON-asetustiedoston polku",
+  "Show help": "Näytä ohje",
+  "Show version number": "Näytä versionumero",
+  "Did you mean %s?": "Tarkoititko %s?",
+  "Arguments %s and %s are mutually exclusive" : "Argumentit %s ja %s eivät ole yhteensopivat",
+  "Positionals:": "Sijaintiparametrit:",
+  "command": "komento"
+}

package/locales/fr.json

@@ -33,5 +33,6 @@
   "Invalid JSON config file: %s": "Fichier de configuration JSON invalide: %s",
   "Path to JSON config file": "Chemin du fichier de configuration JSON",
   "Show help": "Affiche de l'aide",
-  "Show version number": "Affiche le numéro de version"
+  "Show version number": "Affiche le numéro de version",
+  "Arguments %s and %s are mutually exclusive" : "Les arguments %s et %s sont mutuellement exclusifs"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yargs",
-  "version": "14.2.3",
+  "version": "15.1.0",
   "description": "yargs the modern, pirate-themed, successor to optimist.",
   "main": "./index.js",
   "contributors": [
@@ -19,19 +19,20 @@
     "LICENSE"
   ],
   "dependencies": {
-    "cliui": "^5.0.0",
+    "cliui": "^6.0.0",
     "decamelize": "^1.2.0",
-    "find-up": "^3.0.0",
+    "find-up": "^4.1.0",
     "get-caller-file": "^2.0.1",
     "require-directory": "^2.1.1",
     "require-main-filename": "^2.0.0",
     "set-blocking": "^2.0.0",
-    "string-width": "^3.0.0",
+    "string-width": "^4.2.0",
     "which-module": "^2.0.0",
     "y18n": "^4.0.0",
-    "yargs-parser": "^15.0.1"
+    "yargs-parser": "^16.1.0"
   },
   "devDependencies": {
+    "c8": "^6.0.1",
     "chai": "^4.2.0",
     "chalk": "^2.4.2",
     "coveralls": "^3.0.3",
@@ -40,18 +41,16 @@
     "es6-promise": "^4.2.5",
     "hashish": "0.0.4",
     "mocha": "^5.2.0",
-    "nyc": "^14.1.0",
     "rimraf": "^2.6.3",
     "standard": "^12.0.1",
-    "standard-version": "^7.0.0",
     "which": "^1.3.1",
     "yargs-test-extends": "^1.0.1"
   },
   "scripts": {
-    "pretest": "standard",
-    "test": "nyc --cache mocha --require ./test/before.js --timeout=12000 --check-leaks",
-    "coverage": "nyc report --reporter=text-lcov | coveralls",
-    "release": "standard-version"
+    "fix": "standard --fix",
+    "posttest": "standard",
+    "test": "c8 --reporter=html --reporter=text mocha --require ./test/before.js --timeout=12000 --check-leaks",
+    "coverage": "c8 report --reporter=text-lcov | coveralls"
   },
   "repository": {
     "type": "git",
@@ -73,7 +72,7 @@
     "command"
   ],
   "license": "MIT",
-  "engine": {
-    "node": ">=6"
+  "engines": {
+    "node": ">=8"
   }
 }

package/yargs.js

@@ -1,4 +1,9 @@
 'use strict'
+
+// an async function fails early in Node.js versions prior to 8.
+async function requiresNode8OrGreater () {}
+requiresNode8OrGreater()
+
 const argsert = require('./lib/argsert')
 const fs = require('fs')
 const Command = require('./lib/command')
@@ -27,6 +32,7 @@ function Yargs (processArgs, cwd, parentRequire) {
   let preservedGroups = {}
   let usage = null
   let validation = null
+  let handlerFinishCommand = null
 
   const y18n = Y18n({
     directory: path.resolve(__dirname, './locales'),
@@ -167,6 +173,7 @@ function Yargs (processArgs, cwd, parentRequire) {
     frozen.parsed = self.parsed
     frozen.parseFn = parseFn
     frozen.parseContext = parseContext
+    frozen.handlerFinishCommand = handlerFinishCommand
   }
   function unfreeze () {
     let frozen = frozens.pop()
@@ -185,6 +192,7 @@ function Yargs (processArgs, cwd, parentRequire) {
     completionCommand = frozen.completionCommand
     parseFn = frozen.parseFn
     parseContext = frozen.parseContext
+    handlerFinishCommand = frozen.handlerFinishCommand
   }
 
   self.boolean = function (keys) {
@@ -238,7 +246,6 @@ function Yargs (processArgs, cwd, parentRequire) {
   function populateParserHintArray (type, keys, value) {
     keys = [].concat(keys)
     keys.forEach((key) => {
-      key = sanitizeKey(key)
       options[type].push(key)
     })
   }
@@ -294,8 +301,8 @@ function Yargs (processArgs, cwd, parentRequire) {
 
   function populateParserHintObject (builder, isArray, type, key, value) {
     if (Array.isArray(key)) {
-      const temp = Object.create(null)
       // an array of keys with one value ['x', 'y', 'z'], function parse () {}
+      const temp = {}
       key.forEach((k) => {
         temp[k] = value
       })
@@ -306,7 +313,6 @@ function Yargs (processArgs, cwd, parentRequire) {
         builder(k, key[k])
       })
     } else {
-      key = sanitizeKey(key)
       // a single key value pair 'x', parse() {}
       if (isArray) {
         options[type][key] = (options[type][key] || []).concat(value)
@@ -316,13 +322,6 @@ function Yargs (processArgs, cwd, parentRequire) {
     }
   }
 
-  // TODO(bcoe): in future major versions move more objects towards
-  // Object.create(null):
-  function sanitizeKey (key) {
-    if (key === '__proto__') return '___proto___'
-    return key
-  }
-
   function deleteFromParserHintObject (optionKey) {
     // delete from all parsing hints:
     // boolean, array, key, alias, etc.
@@ -487,6 +486,14 @@ function Yargs (processArgs, cwd, parentRequire) {
     return self
   }
 
+  self.onFinishCommand = function (f) {
+    argsert('<function>', [f], arguments.length)
+    handlerFinishCommand = f
+    return self
+  }
+
+  self.getHandlerFinishCommand = () => handlerFinishCommand
+
   self.check = function (f, _global) {
     argsert('<function> [boolean]', [f, _global], arguments.length)
     validation.check(f, _global !== false)
@@ -585,6 +592,7 @@ function Yargs (processArgs, cwd, parentRequire) {
     if (parseFn) exitProcess = false
 
     const parsed = self._parseArgs(args, shortCircuit)
+    completion.setParsed(self.parsed)
     if (parseFn) parseFn(exitError, parsed, output)
     unfreeze()
 
@@ -612,7 +620,7 @@ function Yargs (processArgs, cwd, parentRequire) {
 
       const demand = opt.demand || opt.required || opt.require
 
-      // deprecated, use 'demandOption' instead
+      // A required option can be specified via "demand: true".
       if (demand) {
         self.demand(key, demand)
       }
@@ -1040,12 +1048,6 @@ function Yargs (processArgs, cwd, parentRequire) {
 
     options.__ = y18n.__
     options.configuration = self.getParserConfiguration()
-    // Deprecated
-    let pkgConfig = pkgUp()['yargs']
-    if (pkgConfig) {
-      console.warn('Configuring yargs through package.json is deprecated and will be removed in a future major release, please use the JS API instead.')
-      options.configuration = Object.assign({}, pkgConfig, options.configuration)
-    }
 
     const populateDoubleDash = !!options.configuration['populate--']
     const config = Object.assign({}, options.configuration, {
@@ -1213,7 +1215,7 @@ function Yargs (processArgs, cwd, parentRequire) {
   }
 
   self._runValidation = function runValidation (argv, aliases, positionalMap, parseErrors) {
-    if (parseErrors) throw new YError(parseErrors.message || parseErrors)
+    if (parseErrors) throw new YError(parseErrors.message)
     validation.nonOptionCount(argv)
     validation.requiredArguments(argv)
     if (strict) validation.unknownArguments(argv, aliases, positionalMap)
@@ -1225,15 +1227,8 @@ function Yargs (processArgs, cwd, parentRequire) {
 
   function guessLocale () {
     if (!detectLocale) return
-
-    try {
-      const { env } = process
-      const locale = env.LC_ALL || env.LC_MESSAGES || env.LANG || env.LANGUAGE || 'en_US'
-      self.locale(locale.replace(/[.:].*/, ''))
-    } catch (err) {
-      // if we explode looking up locale just noop
-      // we'll keep using the default language 'en'.
-    }
+    const locale = process.env.LC_ALL || process.env.LC_MESSAGES || process.env.LANG || process.env.LANGUAGE || 'en_US'
+    self.locale(locale.replace(/[.:].*/, ''))
   }
 
   // an app should almost always have --version and --help,
@@ -1244,6 +1239,9 @@ function Yargs (processArgs, cwd, parentRequire) {
   return self
 }
 
+// allow consumers to directly use the version of yargs-parser used by yargs
+exports.Parser = Parser
+
 // rebase an absolute path to a relative one with respect to a base directory
 // exported for tests
 exports.rebase = rebase