yargs 15.0.2 → 15.1.0

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 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.
 
+## [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)
 
 

package/lib/command.js

@@ -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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yargs",
-  "version": "15.0.2",
+  "version": "15.1.0",
   "description": "yargs the modern, pirate-themed, successor to optimist.",
   "main": "./index.js",
   "contributors": [
@@ -72,7 +72,7 @@
     "command"
   ],
   "license": "MIT",
-  "engine": {
+  "engines": {
     "node": ">=8"
   }
 }

package/yargs.js

@@ -32,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'),
@@ -172,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()
@@ -190,6 +192,7 @@ function Yargs (processArgs, cwd, parentRequire) {
     completionCommand = frozen.completionCommand
     parseFn = frozen.parseFn
     parseContext = frozen.parseContext
+    handlerFinishCommand = frozen.handlerFinishCommand
   }
 
   self.boolean = function (keys) {
@@ -483,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)
@@ -581,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()