yargs 13.0.0-candidate.0 → 13.2.2

package/CHANGELOG.md

@@ -2,6 +2,66 @@
 
 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.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)
+
+
+### Bug Fixes
+
+* add zsh script to files array ([3180224](https://github.com/yargs/yargs/commit/3180224))
+* support options/sub-commands in zsh completion ([0a96394](https://github.com/yargs/yargs/commit/0a96394))
+
+
+
+<a name="13.1.0"></a>
+# [13.1.0](https://github.com/yargs/yargs/compare/v13.0.0...v13.1.0) (2019-02-12)
+
+
+### Features
+
+* add applyBeforeValidation, for applying sync middleware before validation ([5be206a](https://github.com/yargs/yargs/commit/5be206a))
+
+
+
+<a name="13.0.0"></a>
+# [13.0.0](https://github.com/yargs/yargs/compare/v12.0.5...v13.0.0) (2019-02-02)
+
+
+### Bug Fixes
+
+* **deps:** Update os-locale to avoid security vulnerability ([#1270](https://github.com/yargs/yargs/issues/1270)) ([27bf739](https://github.com/yargs/yargs/commit/27bf739))
+* **validation:** Use the error as a message when none exists otherwise ([#1268](https://github.com/yargs/yargs/issues/1268)) ([0510fe6](https://github.com/yargs/yargs/commit/0510fe6))
+* better bash path completion ([#1272](https://github.com/yargs/yargs/issues/1272)) ([da75ea2](https://github.com/yargs/yargs/commit/da75ea2))
+* middleware added multiple times due to reference bug ([#1282](https://github.com/yargs/yargs/issues/1282)) ([64af518](https://github.com/yargs/yargs/commit/64af518))
+
+
+### Chores
+
+* ~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))
+
+
+### Features
+
+* Add `.parserConfiguration()` method, deprecating package.json config ([#1262](https://github.com/yargs/yargs/issues/1262)) ([3c6869a](https://github.com/yargs/yargs/commit/3c6869a))
+* adds config option for sorting command output ([#1256](https://github.com/yargs/yargs/issues/1256)) ([6916ce9](https://github.com/yargs/yargs/commit/6916ce9))
+* options/positionals with leading '+' and '0' no longer parse as numbers ([#1286](https://github.com/yargs/yargs/issues/1286)) ([e9dc3aa](https://github.com/yargs/yargs/commit/e9dc3aa))
+* support promises in middleware ([f3a4e4f](https://github.com/yargs/yargs/commit/f3a4e4f))
+
+
+### BREAKING CHANGES
+
+* options with leading '+' or '0' now parse as strings
+* dropping Node 6 which hits end of life in April 2019
+* see [yargs-parser@12.0.0 CHANGELOG](https://github.com/yargs/yargs-parser/blob/master/CHANGELOG.md#breaking-changes)
+* we now warn if the yargs stanza package.json is used.
+
+
+
 <a name="12.0.5"></a>
 ## [12.0.5](https://github.com/yargs/yargs/compare/v12.0.4...v12.0.5) (2018-11-19)
 

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/completion.zsh.hbs

@@ -0,0 +1,17 @@
+###-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/argsert.js

@@ -1,16 +1,18 @@
 'use strict'
+
+// hoisted due to circular dependency on command.
+module.exports = argsert
 const command = require('./command')()
 const YError = require('./yerror')
 
 const positionName = ['first', 'second', 'third', 'fourth', 'fifth', 'sixth']
-
-module.exports = function argsert (expected, callerArguments, length) {
+function argsert (expected, callerArguments, length) {
   // TODO: should this eventually raise an exception.
   try {
     // preface the argument description with "cmd", so
     // that we can run it through yargs' command parser.
     let position = 0
-    let parsed = {demanded: [], optional: []}
+    let parsed = { demanded: [], optional: [] }
     if (typeof expected === 'object') {
       length = callerArguments
       callerArguments = expected

package/lib/command.js

@@ -2,7 +2,7 @@
 
 const inspect = require('util').inspect
 const isPromise = require('./is-promise')
-const {applyMiddleware} = require('./middleware')
+const { applyMiddleware, commandMiddlewareFactory } = require('./middleware')
 const path = require('path')
 const Parser = require('yargs-parser')
 
@@ -17,9 +17,10 @@ module.exports = function command (yargs, usage, validation, globalMiddleware) {
   let aliasMap = {}
   let defaultCommand
   globalMiddleware = globalMiddleware || []
-  self.addHandler = function addHandler (cmd, description, builder, handler, _middlewares) {
+
+  self.addHandler = function addHandler (cmd, description, builder, handler, commandMiddleware) {
     let aliases = []
-    const middlewares = (_middlewares || []).slice(0)
+    const middlewares = commandMiddlewareFactory(commandMiddleware)
     handler = handler || (() => {})
 
     if (Array.isArray(cmd)) {
@@ -224,6 +225,9 @@ module.exports = function command (yargs, usage, validation, globalMiddleware) {
       positionalMap = populatePositionals(commandHandler, innerArgv, currentContext, yargs)
     }
 
+    const middlewares = globalMiddleware.slice(0).concat(commandHandler.middlewares || [])
+    applyMiddleware(innerArgv, yargs, middlewares, true)
+
     // we apply validation post-hoc, so that custom
     // checks get passed populated positional arguments.
     if (!yargs._hasOutput()) yargs._runValidation(innerArgv, aliases, positionalMap, yargs.parsed.error)
@@ -231,9 +235,7 @@ module.exports = function command (yargs, usage, validation, globalMiddleware) {
     if (commandHandler.handler && !yargs._hasOutput()) {
       yargs._setHasOutput()
 
-      const middlewares = globalMiddleware.slice(0).concat(commandHandler.middlewares || [])
-
-      innerArgv = applyMiddleware(innerArgv, middlewares)
+      innerArgv = applyMiddleware(innerArgv, yargs, middlewares, false)
 
       const handlerResult = isPromise(innerArgv)
         ? innerArgv.then(argv => commandHandler.handler(argv))

package/lib/completion.js

@@ -9,6 +9,7 @@ module.exports = function completion (yargs, usage, command) {
     completionKey: 'get-yargs-completions'
   }
 
+  const zshShell = process.env.SHELL && process.env.SHELL.indexOf('zsh') !== -1
   // get a list of completion commands.
   // 'args' is the array of strings from the line to be completed
   self.getCompletion = function getCompletion (args, done) {
@@ -16,6 +17,7 @@ module.exports = function completion (yargs, usage, command) {
     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
     // to completion().
@@ -54,22 +56,33 @@ module.exports = function completion (yargs, usage, command) {
       }
     }
 
-    if (!current.match(/^-/)) {
+    if (!current.match(/^-/) && parentCommands[parentCommands.length - 1] !== current) {
       usage.getCommands().forEach((usageCommand) => {
         const commandName = command.parseCommand(usageCommand[0]).cmd
         if (args.indexOf(commandName) === -1) {
-          completions.push(commandName)
+          if (!zshShell) {
+            completions.push(commandName)
+          } else {
+            const desc = usageCommand[1] || ''
+            completions.push(commandName.replace(/:/g, '\\:') + ':' + desc)
+          }
         }
       })
     }
 
-    if (current.match(/^-/)) {
+    if (current.match(/^-/) || (current === '' && completions.length === 0)) {
+      const descs = usage.getDescriptions()
       Object.keys(yargs.getOptions().key).forEach((key) => {
         // If the key and its aliases aren't in 'args', add the key to 'completions'
         const keyAndAliases = [key].concat(aliases[key] || [])
         const notInArgs = keyAndAliases.every(val => args.indexOf(`--${val}`) === -1)
         if (notInArgs) {
-          completions.push(`--${key}`)
+          if (!zshShell) {
+            completions.push(`--${key}`)
+          } else {
+            const desc = descs[key] || ''
+            completions.push(`--${key.replace(/:/g, '\\:')}:${desc.replace('__yargsString__:', '')}`)
+          }
         }
       })
     }
@@ -80,7 +93,7 @@ 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, '../completion.sh.hbs'),
+      path.resolve(__dirname, zshShell ? '../completion.zsh.hbs' : '../completion.sh.hbs'),
       'utf-8'
     )
     const name = path.basename($0)

package/lib/middleware.js

@@ -1,29 +1,61 @@
+'use strict'
+
+// hoisted due to circular dependency on command.
+module.exports = {
+  applyMiddleware,
+  commandMiddlewareFactory,
+  globalMiddlewareFactory
+}
 const isPromise = require('./is-promise')
+const argsert = require('./argsert')
 
-module.exports = function (globalMiddleware, context) {
-  return function (callback) {
+function globalMiddlewareFactory (globalMiddleware, context) {
+  return function (callback, applyBeforeValidation = false) {
+    argsert('<array|function> [boolean]', [callback, applyBeforeValidation], arguments.length)
     if (Array.isArray(callback)) {
+      for (let i = 0; i < callback.length; i++) {
+        if (typeof callback[i] !== 'function') {
+          throw Error('middleware must be a function')
+        }
+        callback[i].applyBeforeValidation = applyBeforeValidation
+      }
       Array.prototype.push.apply(globalMiddleware, callback)
     } else if (typeof callback === 'function') {
+      callback.applyBeforeValidation = applyBeforeValidation
       globalMiddleware.push(callback)
     }
     return context
   }
 }
 
-module.exports.applyMiddleware = function (argv, middlewares) {
+function commandMiddlewareFactory (commandMiddleware) {
+  if (!commandMiddleware) return []
+  return commandMiddleware.map(middleware => {
+    middleware.applyBeforeValidation = false
+    return middleware
+  })
+}
+
+function applyMiddleware (argv, yargs, middlewares, beforeValidation) {
+  const beforeValidationError = new Error('middleware cannot return a promise when applyBeforeValidation is true')
   return middlewares
     .reduce((accumulation, middleware) => {
+      if (middleware.applyBeforeValidation !== beforeValidation &&
+          !isPromise(accumulation)) {
+        return accumulation
+      }
+
       if (isPromise(accumulation)) {
         return accumulation
           .then(initialObj =>
-            Promise.all([initialObj, middleware(initialObj)])
+            Promise.all([initialObj, middleware(initialObj, yargs)])
           )
           .then(([initialObj, middlewareObj]) =>
             Object.assign(initialObj, middlewareObj)
           )
       } else {
-        const result = middleware(argv)
+        const result = middleware(argv, yargs)
+        if (beforeValidation && isPromise(result)) throw beforeValidationError
 
         return isPromise(result)
           ? result.then(middlewareObj => Object.assign(accumulation, middlewareObj))

package/lib/usage.js

@@ -181,7 +181,7 @@ module.exports = function usage (yargs, y18n) {
         usages.forEach((usage) => {
           ui.div(`${usage[0].replace(/\$0/g, base$0)}`)
           if (usage[1]) {
-            ui.div({text: `${usage[1]}`, padding: [1, 0, 0, 0]})
+            ui.div({ text: `${usage[1]}`, padding: [1, 0, 0, 0] })
           }
         })
         ui.div()
@@ -217,7 +217,7 @@ module.exports = function usage (yargs, y18n) {
             padding: [0, 2, 0, 2],
             width: maxWidth(commands, theWrap, `${base$0}${parentCommands}`) + 4
           },
-          {text: command[1]}
+          { text: command[1] }
         )
         const hints = []
         if (command[2]) hints.push(`[${__('default:').slice(0, -1)}]`) // TODO hacking around i18n here
@@ -225,7 +225,7 @@ module.exports = function usage (yargs, y18n) {
           hints.push(`[${__('aliases:')} ${command[3].join(', ')}]`)
         }
         if (hints.length) {
-          ui.div({text: hints.join(' '), padding: [0, 0, 0, 2], align: 'right'})
+          ui.div({ text: hints.join(' '), padding: [0, 0, 0, 2], align: 'right' })
         } else {
           ui.div()
         }
@@ -301,11 +301,11 @@ module.exports = function usage (yargs, y18n) {
         ].filter(Boolean).join(' ')
 
         ui.span(
-          {text: kswitch, padding: [0, 2, 0, 2], width: maxWidth(switches, theWrap) + 4},
+          { text: kswitch, padding: [0, 2, 0, 2], width: maxWidth(switches, theWrap) + 4 },
           desc
         )
 
-        if (extra) ui.div({text: extra, padding: [0, 0, 0, 2], align: 'right'})
+        if (extra) ui.div({ text: extra, padding: [0, 0, 0, 2], align: 'right' })
         else ui.div()
       })
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yargs",
-  "version": "13.0.0-candidate.0",
+  "version": "13.2.2",
   "description": "yargs the modern, pirate-themed, successor to optimist.",
   "main": "./index.js",
   "contributors": [
@@ -15,6 +15,7 @@
     "lib",
     "locales",
     "completion.sh.hbs",
+    "completion.zsh.hbs",
     "LICENSE"
   ],
   "dependencies": {
@@ -41,8 +42,8 @@
     "mocha": "^5.2.0",
     "nyc": "^13.2.0",
     "rimraf": "^2.6.3",
-    "standard": "^11.0.1",
-    "standard-version": "^4.4.0",
+    "standard": "^12.0.1",
+    "standard-version": "^5.0.0",
     "which": "^1.3.1",
     "yargs-test-extends": "^1.0.1"
   },

package/yargs.js

@@ -11,7 +11,7 @@ const Y18n = require('y18n')
 const objFilter = require('./lib/obj-filter')
 const setBlocking = require('set-blocking')
 const applyExtends = require('./lib/apply-extends')
-const middlewareFactory = require('./lib/middleware')
+const { globalMiddlewareFactory } = require('./lib/middleware')
 const YError = require('./lib/yerror')
 
 exports = module.exports = Yargs
@@ -33,7 +33,7 @@ function Yargs (processArgs, cwd, parentRequire) {
     updateFiles: false
   })
 
-  self.middleware = middlewareFactory(globalMiddleware, self)
+  self.middleware = globalMiddlewareFactory(globalMiddleware, self)
 
   if (!cwd) cwd = process.cwd()
 
@@ -903,7 +903,7 @@ function Yargs (processArgs, cwd, parentRequire) {
     // register the completion command.
     completionCommand = cmd || 'completion'
     if (!desc && desc !== false) {
-      desc = 'generate bash completion script'
+      desc = 'generate completion script'
     }
     self.command(completionCommand, desc)