yargs 13.2.1 → 13.3.2

package/CHANGELOG.md

@@ -1,7 +1,48 @@
-# Change Log
+# Changelog
 
 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.
 
+## [13.3.0](https://www.github.com/yargs/yargs/compare/v13.2.4...v13.3.0) (2019-06-10)
+
+
+### Bug Fixes
+
+* **deps:** yargs-parser update addressing several parsing bugs ([#1357](https://www.github.com/yargs/yargs/issues/1357)) ([e230d5b](https://www.github.com/yargs/yargs/commit/e230d5b))
+
+
+### Features
+
+* **i18n:** swap out os-locale dependency for simple inline implementation ([#1356](https://www.github.com/yargs/yargs/issues/1356)) ([4dfa19b](https://www.github.com/yargs/yargs/commit/4dfa19b))
+* support defaultDescription for positional arguments ([812048c](https://www.github.com/yargs/yargs/commit/812048c))
+
+### [13.2.4](https://github.com/yargs/yargs/compare/v13.2.3...v13.2.4) (2019-05-13)
+
+
+### Bug Fixes
+
+* **i18n:** rename unclear 'implication failed' to 'missing dependent arguments' ([#1317](https://github.com/yargs/yargs/issues/1317)) ([bf46813](https://github.com/yargs/yargs/commit/bf46813))
+
+
+
+### [13.2.3](https://github.com/yargs/yargs/compare/v13.2.2...v13.2.3) (2019-05-05)
+
+
+### Bug Fixes
+
+* **deps:** upgrade cliui for compatibility with latest chalk. ([#1330](https://github.com/yargs/yargs/issues/1330)) ([b20db65](https://github.com/yargs/yargs/commit/b20db65))
+* address issues with dutch translation ([#1316](https://github.com/yargs/yargs/issues/1316)) ([0295132](https://github.com/yargs/yargs/commit/0295132))
+
+
+### Tests
+
+* accept differently formatted output ([#1327](https://github.com/yargs/yargs/issues/1327)) ([c294d1b](https://github.com/yargs/yargs/commit/c294d1b))
+
+
+
+## [13.2.2](https://github.com/yargs/yargs/compare/v13.2.1...v13.2.2) (2019-03-06)
+
+
+
 ## [13.2.1](https://github.com/yargs/yargs/compare/v13.2.0...v13.2.1) (2019-02-18)
 
 
@@ -11,6 +52,13 @@ All notable changes to this project will be documented in this file. See [standa
 * support options/sub-commands in zsh completion ([0a96394](https://github.com/yargs/yargs/commit/0a96394))
 
 
+# [13.2.0](https://github.com/yargs/yargs/compare/v13.1.0...v13.2.0) (2019-02-15)
+
+
+### Features
+
+* zsh auto completion ([#1292](https://github.com/yargs/yargs/issues/1292)) ([16c5d25](https://github.com/yargs/yargs/commit/16c5d25)), closes [#1156](https://github.com/yargs/yargs/issues/1156)
+
 
 <a name="13.1.0"></a>
 # [13.1.0](https://github.com/yargs/yargs/compare/v13.0.0...v13.1.0) (2019-02-12)
@@ -36,7 +84,8 @@ All notable changes to this project will be documented in this file. See [standa
 
 ### Chores
 
-* drop Node 6 from testing matrix ([#1287](https://github.com/yargs/yargs/issues/1287)) ([ef16792](https://github.com/yargs/yargs/commit/ef16792))
+* ~drop Node 6 from testing matrix ([#1287](https://github.com/yargs/yargs/issues/1287)) ([ef16792](https://github.com/yargs/yargs/commit/ef16792))~
+  * _opting to not drop Node 6 support until April, [see](https://github.com/nodejs/Release)._
 * update dependencies ([#1284](https://github.com/yargs/yargs/issues/1284)) ([f25de4f](https://github.com/yargs/yargs/commit/f25de4f))
 
 

package/README.md

@@ -31,12 +31,12 @@ It gives you:
 
 Stable version:
 ```bash
-npm i yargs --save
+npm i yargs
 ```
 
 Bleeding edge version with the most recent features:
 ```bash
-npm i yargs@next --save
+npm i yargs@next
 ```
 
 ## Usage :

package/lib/completion-templates.js

@@ -0,0 +1,49 @@
+exports.completionShTemplate =
+`###-begin-{{app_name}}-completions-###
+#
+# yargs command completion script
+#
+# Installation: {{app_path}} {{completion_command}} >> ~/.bashrc
+#    or {{app_path}} {{completion_command}} >> ~/.bash_profile on OSX.
+#
+_yargs_completions()
+{
+    local cur_word args type_list
+
+    cur_word="\${COMP_WORDS[COMP_CWORD]}"
+    args=("\${COMP_WORDS[@]}")
+
+    # ask yargs to generate completions.
+    type_list=$({{app_path}} --get-yargs-completions "\${args[@]}")
+
+    COMPREPLY=( $(compgen -W "\${type_list}" -- \${cur_word}) )
+
+    # if no match was found, fall back to filename completion
+    if [ \${#COMPREPLY[@]} -eq 0 ]; then
+      COMPREPLY=()
+    fi
+
+    return 0
+}
+complete -o default -F _yargs_completions {{app_name}}
+###-end-{{app_name}}-completions-###
+`
+
+exports.completionZshTemplate = `###-begin-{{app_name}}-completions-###
+#
+# yargs command completion script
+#
+# Installation: {{app_path}} {{completion_command}} >> ~/.zshrc
+#    or {{app_path}} {{completion_command}} >> ~/.zsh_profile on OSX.
+#
+_{{app_name}}_yargs_completions()
+{
+  local reply
+  local si=$IFS
+  IFS=$'\n' reply=($(COMP_CWORD="$((CURRENT-1))" COMP_LINE="$BUFFER" COMP_POINT="$CURSOR" {{app_path}} --get-yargs-completions "\${words[@]}"))
+  IFS=$si
+  _describe 'values' reply
+}
+compdef _{{app_name}}_yargs_completions {{app_name}}
+###-end-{{app_name}}-completions-###
+`

package/lib/completion.js

@@ -1,5 +1,4 @@
 'use strict'
-const fs = require('fs')
 const path = require('path')
 
 // add bash completions to your
@@ -92,10 +91,8 @@ module.exports = function completion (yargs, usage, command) {
 
   // generate the completion script to add to your .bashrc.
   self.generateCompletionScript = function generateCompletionScript ($0, cmd) {
-    let script = fs.readFileSync(
-      path.resolve(__dirname, zshShell ? '../completion.zsh.hbs' : '../completion.sh.hbs'),
-      'utf-8'
-    )
+    const templates = require('./completion-templates')
+    let script = zshShell ? templates.completionZshTemplate : templates.completionShTemplate
     const name = path.basename($0)
 
     // add ./to applications not yet installed as bin.

package/locales/de.json

@@ -29,7 +29,7 @@
   "Invalid values:": "Unzulässige Werte:",
   "Argument: %s, Given: %s, Choices: %s": "Argument: %s, Gegeben: %s, Möglichkeiten: %s",
   "Argument check failed: %s": "Argumente-Check fehlgeschlagen: %s",
-  "Implications failed:": "Implikationen fehlgeschlagen:",
+  "Implications failed:": "Fehlende abhängige Argumente:",
   "Not enough arguments following: %s": "Nicht genügend Argumente nach: %s",
   "Invalid JSON config file: %s": "Fehlerhafte JSON-Config Datei: %s",
   "Path to JSON config file": "Pfad zur JSON-Config Datei",

package/locales/en.json

@@ -29,7 +29,7 @@
   "Invalid values:": "Invalid values:",
   "Argument: %s, Given: %s, Choices: %s": "Argument: %s, Given: %s, Choices: %s",
   "Argument check failed: %s": "Argument check failed: %s",
-  "Implications failed:": "Implications failed:",
+  "Implications failed:": "Missing dependent arguments:",
   "Not enough arguments following: %s": "Not enough arguments following: %s",
   "Invalid JSON config file: %s": "Invalid JSON config file: %s",
   "Path to JSON config file": "Path to JSON config file",

package/locales/fr.json

@@ -28,7 +28,7 @@
   "Invalid values:": "Valeurs invalides:",
   "Argument: %s, Given: %s, Choices: %s": "Argument: %s, Donné: %s, Choix: %s",
   "Argument check failed: %s": "Echec de la vérification de l'argument: %s",
-  "Implications failed:": "Implications échouées:",
+  "Implications failed:": "Arguments dépendants manquants:",
   "Not enough arguments following: %s": "Pas assez d'arguments suivant: %s",
   "Invalid JSON config file: %s": "Fichier de configuration JSON invalide: %s",
   "Path to JSON config file": "Chemin du fichier de configuration JSON",

package/locales/it.json

@@ -29,7 +29,7 @@
   "Invalid values:": "Valori non validi:",
   "Argument: %s, Given: %s, Choices: %s": "Argomento: %s, Richiesto: %s, Scelte: %s",
   "Argument check failed: %s": "Controllo dell'argomento fallito: %s",
-  "Implications failed:": "Argomenti impliciti non soddisfatti:",
+  "Implications failed:": "Argomenti dipendenti mancanti:",
   "Not enough arguments following: %s": "Argomenti insufficienti dopo: %s",
   "Invalid JSON config file: %s": "File di configurazione JSON non valido: %s",
   "Path to JSON config file": "Percorso del file di configurazione JSON",

package/locales/nl.json

@@ -1,42 +1,42 @@
 {
-  "Commands:": "Opdrachten:",
+  "Commands:": "Commando's:",
   "Options:": "Opties:",
   "Examples:": "Voorbeelden:",
-  "boolean": "boolean",
+  "boolean": "booleaans",
   "count": "aantal",
-  "string": "text",
-  "number": "nummer",
+  "string": "string",
+  "number": "getal",
   "array": "lijst",
   "required": "verplicht",
   "default:": "standaard:",
   "choices:": "keuzes:",
   "aliases:": "aliassen:",
   "generated-value": "gegenereerde waarde",
-  "Not enough non-option arguments: got %s, need at least %s": "Niet genoeg non-optie argumenten. Gekregen: %s, minstens nodig: %s",
-  "Too many non-option arguments: got %s, maximum of %s": "Te veel non-optie argumenten. Gekregen: %s, maximum: %s",
+  "Not enough non-option arguments: got %s, need at least %s": "Niet genoeg niet-optie-argumenten: %s gekregen, minstens %s nodig",
+  "Too many non-option arguments: got %s, maximum of %s": "Te veel niet-optie-argumenten: %s gekregen, maximum is %s",
   "Missing argument value: %s": {
-    "one": "Missing argument value: %s",
-    "other": "Missing argument values: %s"
+    "one": "Missende argumentwaarde: %s",
+    "other": "Missende argumentwaarden: %s"
   },
   "Missing required argument: %s": {
-    "one": "Missend verplichte argument: %s",
+    "one": "Missend verplicht argument: %s",
     "other": "Missende verplichte argumenten: %s"
   },
   "Unknown argument: %s": {
     "one": "Onbekend argument: %s",
     "other": "Onbekende argumenten: %s"
   },
-  "Invalid values:": "Ongeldige waardes:",
+  "Invalid values:": "Ongeldige waarden:",
   "Argument: %s, Given: %s, Choices: %s": "Argument: %s, Gegeven: %s, Keuzes: %s",
-  "Argument check failed: %s": "Argument check mislukt: %s",
-  "Implications failed:": "Implicaties mislukt:",
+  "Argument check failed: %s": "Argumentcontrole mislukt: %s",
+  "Implications failed:": "Ontbrekende afhankelijke argumenten:",
   "Not enough arguments following: %s": "Niet genoeg argumenten na: %s",
-  "Invalid JSON config file: %s": "Ongeldig JSON configuratiebestand: %s",
-  "Path to JSON config file": "Pad naar JSON configuratiebestand",
+  "Invalid JSON config file: %s": "Ongeldig JSON-config-bestand: %s",
+  "Path to JSON config file": "Pad naar JSON-config-bestand",
   "Show help": "Toon help",
-  "Show version number": "Toon versie nummer",
+  "Show version number": "Toon versienummer",
   "Did you mean %s?": "Bedoelde u misschien %s?",
-  "Arguments %s and %s are mutually exclusive": "Argumenten %s en %s zijn onderling uitsluitend",
+  "Arguments %s and %s are mutually exclusive": "Argumenten %s en %s kunnen niet tegelijk gebruikt worden",
   "Positionals:": "Positie-afhankelijke argumenten",
   "command": "commando"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yargs",
-  "version": "13.2.1",
+  "version": "13.3.2",
   "description": "yargs the modern, pirate-themed, successor to optimist.",
   "main": "./index.js",
   "contributors": [
@@ -19,31 +19,30 @@
     "LICENSE"
   ],
   "dependencies": {
-    "cliui": "^4.0.0",
+    "cliui": "^5.0.0",
     "find-up": "^3.0.0",
     "get-caller-file": "^2.0.1",
-    "os-locale": "^3.1.0",
     "require-directory": "^2.1.1",
     "require-main-filename": "^2.0.0",
     "set-blocking": "^2.0.0",
     "string-width": "^3.0.0",
     "which-module": "^2.0.0",
     "y18n": "^4.0.0",
-    "yargs-parser": "^13.0.0"
+    "yargs-parser": "^13.1.2"
   },
   "devDependencies": {
     "chai": "^4.2.0",
     "chalk": "^2.4.2",
-    "coveralls": "^3.0.2",
+    "coveralls": "^3.0.3",
     "cpr": "^3.0.1",
     "cross-spawn": "^6.0.4",
     "es6-promise": "^4.2.5",
     "hashish": "0.0.4",
     "mocha": "^5.2.0",
-    "nyc": "^13.2.0",
+    "nyc": "^14.1.0",
     "rimraf": "^2.6.3",
     "standard": "^12.0.1",
-    "standard-version": "^5.0.0",
+    "standard-version": "^6.0.1",
     "which": "^1.3.1",
     "yargs-test-extends": "^1.0.1"
   },

package/yargs.js

@@ -231,6 +231,7 @@ function Yargs (processArgs, cwd, parentRequire) {
   function populateParserHintArray (type, keys, value) {
     keys = [].concat(keys)
     keys.forEach((key) => {
+      key = sanitizeKey(key)
       options[type].push(key)
     })
   }
@@ -286,8 +287,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
       })
@@ -298,6 +299,7 @@ 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)
@@ -307,6 +309,13 @@ 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.
@@ -694,8 +703,8 @@ function Yargs (processArgs, cwd, parentRequire) {
     }
 
     // .positional() only supports a subset of the configuration
-    // options availble to .option().
-    const supportedOpts = ['default', 'implies', 'normalize',
+    // options available to .option().
+    const supportedOpts = ['default', 'defaultDescription', 'implies', 'normalize',
       'choices', 'conflicts', 'coerce', 'type', 'describe',
       'desc', 'description', 'alias']
     opts = objFilter(opts, (k, v) => {
@@ -1181,8 +1190,9 @@ function Yargs (processArgs, cwd, parentRequire) {
     if (!detectLocale) return
 
     try {
-      const osLocale = require('os-locale')
-      self.locale(osLocale.sync({ spawn: false }))
+      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'.

package/completion.sh.hbs

@@ -1,28 +0,0 @@
-###-begin-{{app_name}}-completions-###
-#
-# yargs command completion script
-#
-# Installation: {{app_path}} {{completion_command}} >> ~/.bashrc
-#    or {{app_path}} {{completion_command}} >> ~/.bash_profile on OSX.
-#
-_yargs_completions()
-{
-    local cur_word args type_list
-
-    cur_word="${COMP_WORDS[COMP_CWORD]}"
-    args=("${COMP_WORDS[@]}")
-
-    # ask yargs to generate completions.
-    type_list=$({{app_path}} --get-yargs-completions "${args[@]}")
-
-    COMPREPLY=( $(compgen -W "${type_list}" -- ${cur_word}) )
-
-    # if no match was found, fall back to filename completion
-    if [ ${#COMPREPLY[@]} -eq 0 ]; then
-      COMPREPLY=()
-    fi
-
-    return 0
-}
-complete -o default -F _yargs_completions {{app_name}}
-###-end-{{app_name}}-completions-###

package/completion.zsh.hbs

@@ -1,17 +0,0 @@
-###-begin-{{app_name}}-completions-###
-#
-# yargs command completion script
-#
-# Installation: {{app_path}} {{completion_command}} >> ~/.zshrc
-#    or {{app_path}} {{completion_command}} >> ~/.zsh_profile on OSX.
-#
-_{{app_name}}_yargs_completions()
-{
-  local reply
-  local si=$IFS
-  IFS=$'\n' reply=($(COMP_CWORD="$((CURRENT-1))" COMP_LINE="$BUFFER" COMP_POINT="$CURSOR" {{app_path}} --get-yargs-completions "${words[@]}"))
-  IFS=$si
-  _describe 'values' reply
-}
-compdef _{{app_name}}_yargs_completions {{app_name}}
-###-end-{{app_name}}-completions-###