diff options
Diffstat (limited to 'node_modules/yargs/yargs.js')
| -rw-r--r-- | node_modules/yargs/yargs.js | 633 |
1 files changed, 361 insertions, 272 deletions
diff --git a/node_modules/yargs/yargs.js b/node_modules/yargs/yargs.js index 92eb38f..81d2193 100644 --- a/node_modules/yargs/yargs.js +++ b/node_modules/yargs/yargs.js @@ -1,5 +1,6 @@ +'use strict' const argsert = require('./lib/argsert') -const assign = require('./lib/assign') +const fs = require('fs') const Command = require('./lib/command') const Completion = require('./lib/completion') const Parser = require('yargs-parser') @@ -10,82 +11,91 @@ const Y18n = require('y18n') const objFilter = require('./lib/obj-filter') const setBlocking = require('set-blocking') const applyExtends = require('./lib/apply-extends') +const { globalMiddlewareFactory } = require('./lib/middleware') const YError = require('./lib/yerror') -var exports = module.exports = Yargs +exports = module.exports = Yargs function Yargs (processArgs, cwd, parentRequire) { processArgs = processArgs || [] // handle calling yargs(). const self = {} - var command = null - var completion = null - var groups = {} - var output = '' - var preservedGroups = {} - var usage = null - var validation = null + let command = null + let completion = null + let groups = {} + let globalMiddleware = [] + let output = '' + let preservedGroups = {} + let usage = null + let validation = null const y18n = Y18n({ directory: path.resolve(__dirname, './locales'), updateFiles: false }) + self.middleware = globalMiddlewareFactory(globalMiddleware, self) + if (!cwd) cwd = process.cwd() - self.$0 = process.argv - .slice(0, 2) - .map(function (x, i) { - // ignore the node bin, specify this in your - // bin file with #!/usr/bin/env node - if (i === 0 && /\b(node|iojs)(\.exe)?$/.test(x)) return - var b = rebase(cwd, x) + self.scriptName = function scriptName (scriptName) { + self.$0 = scriptName + return self + } + + // ignore the node bin, specify this in your + // bin file with #!/usr/bin/env node + if (/\b(node|iojs|electron)(\.exe)?$/.test(process.argv[0])) { + self.$0 = process.argv.slice(1, 2) + } else { + self.$0 = process.argv.slice(0, 1) + } + + self.$0 = self.$0 + .map((x, i) => { + const b = rebase(cwd, x) return x.match(/^(\/|([a-zA-Z]:)?\\)/) && b.length < x.length ? b : x }) .join(' ').trim() if (process.env._ !== undefined && process.argv[1] === process.env._) { self.$0 = process.env._.replace( - path.dirname(process.execPath) + '/', '' + `${path.dirname(process.execPath)}/`, '' ) } // use context object to keep track of resets, subcommand execution, etc // submodules should modify and check the state of context as necessary - const context = { resets: -1, commands: [], files: [] } - self.getContext = function () { - return context - } + const context = { resets: -1, commands: [], fullCommands: [], files: [] } + self.getContext = () => context // puts yargs back into an initial state. any keys // that have been set to "global" will not be reset // by this action. - var options - self.resetOptions = self.reset = function (aliases) { + let options + self.resetOptions = self.reset = function resetOptions (aliases) { context.resets++ aliases = aliases || {} options = options || {} // put yargs back into an initial state, this // logic is used to build a nested command // hierarchy. - var tmpOptions = {} + const tmpOptions = {} tmpOptions.local = options.local ? options.local : [] tmpOptions.configObjects = options.configObjects ? options.configObjects : [] // if a key has been explicitly set as local, // we should reset it before passing options to command. - var localLookup = {} - tmpOptions.local.forEach(function (l) { + const localLookup = {} + tmpOptions.local.forEach((l) => { localLookup[l] = true - ;(aliases[l] || []).forEach(function (a) { + ;(aliases[l] || []).forEach((a) => { localLookup[a] = true }) }) // preserve all groups not set to local. - preservedGroups = Object.keys(groups).reduce(function (acc, groupName) { - var keys = groups[groupName].filter(function (key) { - return !(key in localLookup) - }) + preservedGroups = Object.keys(groups).reduce((acc, groupName) => { + const keys = groups[groupName].filter(key => !(key in localLookup)) if (keys.length > 0) { acc[groupName] = keys } @@ -94,26 +104,23 @@ function Yargs (processArgs, cwd, parentRequire) { // groups can now be reset groups = {} - var arrayOptions = [ - 'array', 'boolean', 'string', 'requiresArg', 'skipValidation', - 'count', 'normalize', 'number' + const arrayOptions = [ + 'array', 'boolean', 'string', 'skipValidation', + 'count', 'normalize', 'number', + 'hiddenOptions' ] - var objectOptions = [ + const objectOptions = [ 'narg', 'key', 'alias', 'default', 'defaultDescription', 'config', 'choices', 'demandedOptions', 'demandedCommands', 'coerce' ] - arrayOptions.forEach(function (k) { - tmpOptions[k] = (options[k] || []).filter(function (k) { - return !localLookup[k] - }) + arrayOptions.forEach((k) => { + tmpOptions[k] = (options[k] || []).filter(k => !localLookup[k]) }) - objectOptions.forEach(function (k) { - tmpOptions[k] = objFilter(options[k], function (k, v) { - return !localLookup[k] - }) + objectOptions.forEach((k) => { + tmpOptions[k] = objFilter(options[k], (k, v) => !localLookup[k]) }) tmpOptions.envPrefix = options.envPrefix @@ -123,10 +130,9 @@ function Yargs (processArgs, cwd, parentRequire) { // instances of all our helpers -- otherwise just reset. usage = usage ? usage.reset(localLookup) : Usage(self, y18n) validation = validation ? validation.reset(localLookup) : Validation(self, usage, y18n) - command = command ? command.reset() : Command(self, usage, validation) + command = command ? command.reset() : Command(self, usage, validation, globalMiddleware) if (!completion) completion = Completion(self, usage, command) - if (!strictGlobal) strict = false completionCommand = null output = '' exitError = null @@ -138,7 +144,7 @@ function Yargs (processArgs, cwd, parentRequire) { self.resetOptions() // temporary hack: allow "freezing" of reset-able state for parse(msg, cb) - var frozen + let frozen function freeze () { frozen = {} frozen.options = options @@ -212,7 +218,7 @@ function Yargs (processArgs, cwd, parentRequire) { self.requiresArg = function (keys) { argsert('<array|string>', [keys], arguments.length) - populateParserHintArray('requiresArg', keys) + populateParserHintObject(self.nargs, false, 'narg', keys, 1) return self } @@ -224,7 +230,8 @@ function Yargs (processArgs, cwd, parentRequire) { function populateParserHintArray (type, keys, value) { keys = [].concat(keys) - keys.forEach(function (key) { + keys.forEach((key) => { + key = sanitizeKey(key) options[type].push(key) }) } @@ -280,18 +287,19 @@ 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 () {} - var temp = {} - key.forEach(function (k) { + key.forEach((k) => { temp[k] = value }) builder(temp) } else if (typeof key === 'object') { // an object of key value pairs: {'x': parse () {}, 'y': parse() {}} - Object.keys(key).forEach(function (k) { + Object.keys(key).forEach((k) => { 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) @@ -301,7 +309,29 @@ function Yargs (processArgs, cwd, parentRequire) { } } - self.config = function (key, msg, parseFn) { + // 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. + Object.keys(options).forEach((hintKey) => { + const hint = options[hintKey] + if (Array.isArray(hint)) { + if (~hint.indexOf(optionKey)) hint.splice(hint.indexOf(optionKey), 1) + } else if (typeof hint === 'object') { + delete hint[optionKey] + } + }) + // now delete the description from usage.js. + delete usage.getDescriptions()[optionKey] + } + + self.config = function config (key, msg, parseFn) { argsert('[object|string] [string|function] [function]', [key, msg, parseFn], arguments.length) // allow a config object to be provided directly. if (typeof key === 'object') { @@ -318,7 +348,7 @@ function Yargs (processArgs, cwd, parentRequire) { key = key || 'config' self.describe(key, msg || usage.deferY18nLookup('Path to JSON config file')) - ;(Array.isArray(key) ? key : [key]).forEach(function (k) { + ;(Array.isArray(key) ? key : [key]).forEach((k) => { options.config[k] = parseFn || true }) @@ -331,9 +361,9 @@ function Yargs (processArgs, cwd, parentRequire) { return self } - self.command = function (cmd, description, builder, handler) { - argsert('<string|array|object> [string|boolean] [function|object] [function]', [cmd, description, builder, handler], arguments.length) - command.addHandler(cmd, description, builder, handler) + self.command = function (cmd, description, builder, handler, middlewares) { + argsert('<string|array|object> [string|boolean] [function|object] [function] [array]', [cmd, description, builder, handler, middlewares], arguments.length) + command.addHandler(cmd, description, builder, handler, middlewares) return self } @@ -346,12 +376,12 @@ function Yargs (processArgs, cwd, parentRequire) { // TODO: deprecate self.demand in favor of // .demandCommand() .demandOption(). - self.demand = self.required = self.require = function (keys, max, msg) { + self.demand = self.required = self.require = function demand (keys, max, msg) { // you can optionally provide a 'max' key, // which will raise an exception if too many '_' // options are provided. if (Array.isArray(max)) { - max.forEach(function (key) { + max.forEach((key) => { self.demandOption(key, msg) }) max = Infinity @@ -363,7 +393,7 @@ function Yargs (processArgs, cwd, parentRequire) { if (typeof keys === 'number') { self.demandCommand(keys, max, msg, msg) } else if (Array.isArray(keys)) { - keys.forEach(function (key) { + keys.forEach((key) => { self.demandOption(key, msg) }) } else { @@ -377,8 +407,8 @@ function Yargs (processArgs, cwd, parentRequire) { return self } - self.demandCommand = function (min, max, minMsg, maxMsg) { - argsert('[number] [number|string] [string|null] [string|null]', [min, max, minMsg, maxMsg], arguments.length) + self.demandCommand = function demandCommand (min, max, minMsg, maxMsg) { + argsert('[number] [number|string] [string|null|undefined] [string|null|undefined]', [min, max, minMsg, maxMsg], arguments.length) if (typeof min === 'undefined') min = 1 @@ -390,50 +420,52 @@ function Yargs (processArgs, cwd, parentRequire) { self.global('_', false) options.demandedCommands._ = { - min: min, - max: max, - minMsg: minMsg, - maxMsg: maxMsg + min, + max, + minMsg, + maxMsg } return self } - self.getDemandedOptions = function () { + self.getDemandedOptions = () => { argsert([], 0) return options.demandedOptions } - self.getDemandedCommands = function () { + self.getDemandedCommands = () => { argsert([], 0) return options.demandedCommands } self.implies = function (key, value) { - argsert('<string|object> [string]', [key, value], arguments.length) + argsert('<string|object> [number|string|array]', [key, value], arguments.length) validation.implies(key, value) return self } self.conflicts = function (key1, key2) { - argsert('<string|object> [string]', [key1, key2], arguments.length) + argsert('<string|object> [string|array]', [key1, key2], arguments.length) validation.conflicts(key1, key2) return self } - self.usage = function (msg, opts) { - argsert('<string|null|object> [object]', [msg, opts], arguments.length) + self.usage = function (msg, description, builder, handler) { + argsert('<string|null|undefined> [string|boolean] [function|object] [function]', [msg, description, builder, handler], arguments.length) - if (!opts && typeof msg === 'object') { - opts = msg - msg = null + if (description !== undefined) { + // .usage() can be used as an alias for defining + // a default command. + if ((msg || '').match(/^\$0( |$)/)) { + return self.command(msg, description, builder, handler) + } else { + throw new YError('.usage() description must start with $0 if being used as alias for .command()') + } + } else { + usage.usage(msg) + return self } - - usage.usage(msg) - - if (opts) self.options(opts) - - return self } self.epilogue = self.epilog = function (msg) { @@ -454,60 +486,70 @@ function Yargs (processArgs, cwd, parentRequire) { return self } - self.global = function (globals, global) { + self.global = function global (globals, global) { argsert('<string|array> [boolean]', [globals, global], arguments.length) globals = [].concat(globals) if (global !== false) { - options.local = options.local.filter(function (l) { - return globals.indexOf(l) === -1 - }) + options.local = options.local.filter(l => globals.indexOf(l) === -1) } else { - globals.forEach(function (g) { + globals.forEach((g) => { if (options.local.indexOf(g) === -1) options.local.push(g) }) } return self } - self.pkgConf = function (key, path) { - argsert('<string> [string]', [key, path], arguments.length) - var conf = null + self.pkgConf = function pkgConf (key, rootPath) { + argsert('<string> [string]', [key, rootPath], arguments.length) + let conf = null // prefer cwd to require-main-filename in this method // since we're looking for e.g. "nyc" config in nyc consumer // rather than "yargs" config in nyc (where nyc is the main filename) - var obj = pkgUp(path || cwd) + const obj = pkgUp(rootPath || cwd) // If an object exists in the key, add it to options.configObjects if (obj[key] && typeof obj[key] === 'object') { - conf = applyExtends(obj[key], path || cwd, key) + conf = applyExtends(obj[key], rootPath || cwd) options.configObjects = (options.configObjects || []).concat(conf) } return self } - var pkgs = {} - function pkgUp (path) { - var npath = path || '*' + const pkgs = {} + function pkgUp (rootPath) { + const npath = rootPath || '*' if (pkgs[npath]) return pkgs[npath] - const readPkgUp = require('read-pkg-up') + const findUp = require('find-up') - var obj = {} + let obj = {} try { - obj = readPkgUp.sync({ - cwd: path || require('require-main-filename')(parentRequire || require), - normalize: false + let startDir = rootPath || require('require-main-filename')(parentRequire || require) + + // When called in an environment that lacks require.main.filename, such as a jest test runner, + // startDir is already process.cwd(), and should not be shortened. + // Whether or not it is _actually_ a directory (e.g., extensionless bin) is irrelevant, find-up handles it. + if (!rootPath && path.extname(startDir)) { + startDir = path.dirname(startDir) + } + + const pkgJsonPath = findUp.sync('package.json', { + cwd: startDir }) + obj = JSON.parse(fs.readFileSync(pkgJsonPath)) } catch (noop) {} - pkgs[npath] = obj.pkg || {} + pkgs[npath] = obj || {} return pkgs[npath] } - var parseFn = null - var parseContext = null - self.parse = function (args, shortCircuit, _parseFn) { - argsert('<string|array> [function|boolean|object] [function]', [args, shortCircuit, _parseFn], arguments.length) + let parseFn = null + let parseContext = null + self.parse = function parse (args, shortCircuit, _parseFn) { + argsert('[string|array] [function|boolean|object] [function]', [args, shortCircuit, _parseFn], arguments.length) + if (typeof args === 'undefined') { + return self._parseArgs(processArgs) + } // a context object can optionally be provided, this allows // additional information to be passed to a command handler. @@ -530,25 +572,21 @@ function Yargs (processArgs, cwd, parentRequire) { freeze() if (parseFn) exitProcess = false - var parsed = self._parseArgs(args, shortCircuit) + const parsed = self._parseArgs(args, shortCircuit) if (parseFn) parseFn(exitError, parsed, output) unfreeze() return parsed } - self._getParseContext = function () { - return parseContext || {} - } + self._getParseContext = () => parseContext || {} - self._hasParseCallback = function () { - return !!parseFn - } + self._hasParseCallback = () => !!parseFn - self.option = self.options = function (key, opt) { + self.option = self.options = function option (key, opt) { argsert('<string|object> [object]', [key, opt], arguments.length) if (typeof key === 'object') { - Object.keys(key).forEach(function (k) { + Object.keys(key).forEach((k) => { self.options(k, key[k]) }) } else { @@ -560,7 +598,7 @@ function Yargs (processArgs, cwd, parentRequire) { if (opt.alias) self.alias(key, opt.alias) - var demand = opt.demand || opt.required || opt.require + const demand = opt.demand || opt.required || opt.require // deprecated, use 'demandOption' instead if (demand) { @@ -571,10 +609,6 @@ function Yargs (processArgs, cwd, parentRequire) { self.demandOption(key, typeof opt.demandOption === 'string' ? opt.demandOption : undefined) } - if ('config' in opt) { - self.config(key, opt.configParser) - } - if ('conflicts' in opt) { self.conflicts(key, opt.conflicts) } @@ -591,7 +625,11 @@ function Yargs (processArgs, cwd, parentRequire) { self.nargs(key, opt.nargs) } - if ('normalize' in opt) { + if (opt.config) { + self.config(key, opt.configParser) + } + + if (opt.normalize) { self.normalize(key) } @@ -643,9 +681,10 @@ function Yargs (processArgs, cwd, parentRequire) { self.skipValidation(key) } - var desc = opt.describe || opt.description || opt.desc - if (desc) { - self.describe(key, desc) + const desc = opt.describe || opt.description || opt.desc + self.describe(key, desc) + if (opt.hidden) { + self.hide(key) } if (opt.requiresArg) { @@ -655,29 +694,62 @@ function Yargs (processArgs, cwd, parentRequire) { return self } - self.getOptions = function () { - return options + self.getOptions = () => options + + self.positional = function (key, opts) { + argsert('<string> <object>', [key, opts], arguments.length) + if (context.resets === 0) { + throw new YError(".positional() can only be called in a command's builder function") + } + + // .positional() only supports a subset of the configuration + // options available to .option(). + const supportedOpts = ['default', 'defaultDescription', 'implies', 'normalize', + 'choices', 'conflicts', 'coerce', 'type', 'describe', + 'desc', 'description', 'alias'] + opts = objFilter(opts, (k, v) => { + let accept = supportedOpts.indexOf(k) !== -1 + // type can be one of string|number|boolean. + if (k === 'type' && ['string', 'number', 'boolean'].indexOf(v) === -1) accept = false + return accept + }) + + // copy over any settings that can be inferred from the command string. + const fullCommand = context.fullCommands[context.fullCommands.length - 1] + const parseOptions = fullCommand ? command.cmdToParseOptions(fullCommand) : { + array: [], + alias: {}, + default: {}, + demand: {} + } + Object.keys(parseOptions).forEach((pk) => { + if (Array.isArray(parseOptions[pk])) { + if (parseOptions[pk].indexOf(key) !== -1) opts[pk] = true + } else { + if (parseOptions[pk][key] && !(pk in opts)) opts[pk] = parseOptions[pk][key] + } + }) + self.group(key, usage.getPositionalGroupName()) + return self.option(key, opts) } - self.group = function (opts, groupName) { + self.group = function group (opts, groupName) { argsert('<string|array> <string>', [opts, groupName], arguments.length) - var existing = preservedGroups[groupName] || groups[groupName] + const existing = preservedGroups[groupName] || groups[groupName] if (preservedGroups[groupName]) { // we now only need to track this group name in groups. delete preservedGroups[groupName] } - var seen = {} - groups[groupName] = (existing || []).concat(opts).filter(function (key) { + const seen = {} + groups[groupName] = (existing || []).concat(opts).filter((key) => { if (seen[key]) return false return (seen[key] = true) }) return self } - self.getGroups = function () { - // combine explicit and preserved groups. explicit groups should be first - return assign(groups, preservedGroups) - } + // combine explicit and preserved groups. explicit groups should be first + self.getGroups = () => Object.assign({}, groups, preservedGroups) // as long as options.envPrefix is not undefined, // parser will apply env vars matching prefix to argv @@ -689,45 +761,66 @@ function Yargs (processArgs, cwd, parentRequire) { } self.wrap = function (cols) { - argsert('<number|null>', [cols], arguments.length) + argsert('<number|null|undefined>', [cols], arguments.length) usage.wrap(cols) return self } - var strict = false - var strictGlobal = false - self.strict = function (global) { - argsert('[boolean]', [global], arguments.length) - strict = true - strictGlobal = global !== false + let strict = false + self.strict = function (enabled) { + argsert('[boolean]', [enabled], arguments.length) + strict = enabled !== false return self } - self.getStrict = function () { - return strict + self.getStrict = () => strict + + let parserConfig = {} + self.parserConfiguration = function parserConfiguration (config) { + argsert('<object>', [config], arguments.length) + parserConfig = config + return self } + self.getParserConfiguration = () => parserConfig self.showHelp = function (level) { argsert('[string|function]', [level], arguments.length) if (!self.parsed) self._parseArgs(processArgs) // run parser, if it has not already been executed. + if (command.hasDefaultCommand()) { + context.resets++ // override the restriction on top-level positoinals. + command.runDefaultBuilderOn(self, true) + } usage.showHelp(level) return self } - var versionOpt = null - self.version = function (opt, msg, ver) { - argsert('[string|function] [string|function] [string]', [opt, msg, ver], arguments.length) + let versionOpt = null + self.version = function version (opt, msg, ver) { + const defaultVersionOpt = 'version' + argsert('[boolean|string] [string] [string]', [opt, msg, ver], arguments.length) + + // nuke the key previously configured + // to return version #. + if (versionOpt) { + deleteFromParserHintObject(versionOpt) + usage.version(undefined) + versionOpt = null + } + if (arguments.length === 0) { ver = guessVersion() - opt = 'version' + opt = defaultVersionOpt } else if (arguments.length === 1) { + if (opt === false) { // disable default 'version' key. + return self + } ver = opt - opt = 'version' + opt = defaultVersionOpt } else if (arguments.length === 2) { ver = msg msg = null } - versionOpt = opt + versionOpt = typeof opt === 'string' ? opt : defaultVersionOpt msg = msg || usage.deferY18nLookup('Show version number') usage.version(ver || undefined) @@ -737,44 +830,57 @@ function Yargs (processArgs, cwd, parentRequire) { } function guessVersion () { - var obj = pkgUp() + const obj = pkgUp() return obj.version || 'unknown' } - var helpOpt = null - var useHelpOptAsCommand = false // a call to .help() will enable this - self.addHelpOpt = self.help = function (opt, msg, addImplicitCmd) { - argsert('[string|boolean] [string|boolean] [boolean]', [opt, msg, addImplicitCmd], arguments.length) + let helpOpt = null + self.addHelpOpt = self.help = function addHelpOpt (opt, msg) { + const defaultHelpOpt = 'help' + argsert('[string|boolean] [string]', [opt, msg], arguments.length) - // argument shuffle - if (arguments.length === 0) { - useHelpOptAsCommand = true - } else if (arguments.length === 1) { - if (typeof opt === 'boolean') { - useHelpOptAsCommand = opt - opt = null - } else { - useHelpOptAsCommand = true - } - } else if (arguments.length === 2) { - if (typeof msg === 'boolean') { - useHelpOptAsCommand = msg - msg = null - } else { - useHelpOptAsCommand = true - } - } else { - useHelpOptAsCommand = Boolean(addImplicitCmd) + // nuke the key previously configured + // to return help. + if (helpOpt) { + deleteFromParserHintObject(helpOpt) + helpOpt = null + } + + if (arguments.length === 1) { + if (opt === false) return self } + // use arguments, fallback to defaults for opt and msg - helpOpt = opt || 'help' + helpOpt = typeof opt === 'string' ? opt : defaultHelpOpt self.boolean(helpOpt) self.describe(helpOpt, msg || usage.deferY18nLookup('Show help')) return self } - self.showHelpOnFail = function (enabled, message) { + const defaultShowHiddenOpt = 'show-hidden' + options.showHiddenOpt = defaultShowHiddenOpt + self.addShowHiddenOpt = self.showHidden = function addShowHiddenOpt (opt, msg) { + argsert('[string|boolean] [string]', [opt, msg], arguments.length) + + if (arguments.length === 1) { + if (opt === false) return self + } + + const showHiddenOpt = typeof opt === 'string' ? opt : defaultShowHiddenOpt + self.boolean(showHiddenOpt) + self.describe(showHiddenOpt, msg || usage.deferY18nLookup('Show hidden options')) + options.showHiddenOpt = showHiddenOpt + return self + } + + self.hide = function hide (key) { + argsert('<string|object>', [key], arguments.length) + options.hiddenOptions.push(key) + return self + } + + self.showHelpOnFail = function showHelpOnFail (enabled, message) { argsert('[boolean|string] [string]', [enabled, message], arguments.length) usage.showHelpOnFail(enabled, message) return self @@ -789,9 +895,7 @@ function Yargs (processArgs, cwd, parentRequire) { exitProcess = enabled return self } - self.getExitProcess = function () { - return exitProcess - } + self.getExitProcess = () => exitProcess var completionCommand = null self.completion = function (cmd, desc, fn) { @@ -808,7 +912,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) @@ -821,7 +925,7 @@ function Yargs (processArgs, cwd, parentRequire) { self.showCompletionScript = function ($0) { argsert('[string]', [$0], arguments.length) $0 = $0 || self.$0 - _logger.log(completion.generateCompletionScript($0)) + _logger.log(completion.generateCompletionScript($0, completionCommand)) return self } @@ -848,21 +952,19 @@ function Yargs (processArgs, cwd, parentRequire) { return self } - var detectLocale = true + let detectLocale = true self.detectLocale = function (detect) { argsert('<boolean>', [detect], arguments.length) detectLocale = detect return self } - self.getDetectLocale = function () { - return detectLocale - } + self.getDetectLocale = () => detectLocale var hasOutput = false var exitError = null // maybe exit, always capture // context about why we wanted to exit. - self.exit = function (code, err) { + self.exit = (code, err) => { hasOutput = true exitError = err if (exitProcess) process.exit(code) @@ -870,78 +972,74 @@ function Yargs (processArgs, cwd, parentRequire) { // we use a custom logger that buffers output, // so that we can print to non-CLIs, e.g., chat-bots. - var _logger = { - log: function () { + const _logger = { + log () { const args = [] - for (var i = 0; i < arguments.length; i++) args.push(arguments[i]) + for (let i = 0; i < arguments.length; i++) args.push(arguments[i]) if (!self._hasParseCallback()) console.log.apply(console, args) hasOutput = true if (output.length) output += '\n' output += args.join(' ') }, - error: function () { + error () { const args = [] - for (var i = 0; i < arguments.length; i++) args.push(arguments[i]) + for (let i = 0; i < arguments.length; i++) args.push(arguments[i]) if (!self._hasParseCallback()) console.error.apply(console, args) hasOutput = true if (output.length) output += '\n' output += args.join(' ') } } - self._getLoggerInstance = function () { - return _logger - } + self._getLoggerInstance = () => _logger // has yargs output an error our help // message in the current execution context. - self._hasOutput = function () { - return hasOutput - } + self._hasOutput = () => hasOutput - self._setHasOutput = function () { + self._setHasOutput = () => { hasOutput = true } - var recommendCommands + let recommendCommands self.recommendCommands = function (recommend) { argsert('[boolean]', [recommend], arguments.length) recommendCommands = typeof recommend === 'boolean' ? recommend : true return self } - self.getUsageInstance = function () { - return usage - } + self.getUsageInstance = () => usage - self.getValidationInstance = function () { - return validation - } + self.getValidationInstance = () => validation - self.getCommandInstance = function () { - return command - } + self.getCommandInstance = () => command - self.terminalWidth = function () { + self.terminalWidth = () => { argsert([], 0) return typeof process.stdout.columns !== 'undefined' ? process.stdout.columns : null } Object.defineProperty(self, 'argv', { - get: function () { - return self._parseArgs(processArgs) - }, + get: () => self._parseArgs(processArgs), enumerable: true }) - self._parseArgs = function (args, shortCircuit, _skipValidation) { - var skipValidation = !!_skipValidation + self._parseArgs = function parseArgs (args, shortCircuit, _skipValidation, commandIndex) { + let skipValidation = !!_skipValidation args = args || processArgs options.__ = y18n.__ - options.configuration = pkgUp()['yargs'] || {} + 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 the next major release, please use the JS API instead.') + options.configuration = Object.assign({}, pkgConfig, options.configuration) + } + const parsed = Parser.detailed(args, options) - var argv = parsed.argv - if (parseContext) argv = assign(argv, parseContext) - var aliases = parsed.aliases + let argv = parsed.argv + if (parseContext) argv = Object.assign({}, argv, parseContext) + const aliases = parsed.aliases argv.$0 = self.$0 self.parsed = parsed @@ -956,89 +1054,87 @@ function Yargs (processArgs, cwd, parentRequire) { return argv } - if (argv._.length) { - // check for helpOpt in argv._ before running commands - // assumes helpOpt must be valid if useHelpOptAsCommand is true - if (useHelpOptAsCommand) { - // consider any multi-char helpOpt alias as a valid help command - // unless all helpOpt aliases are single-char - // note that parsed.aliases is a normalized bidirectional map :) - var helpCmds = [helpOpt].concat(aliases[helpOpt] || []) - var multiCharHelpCmds = helpCmds.filter(function (k) { - return k.length > 1 - }) - if (multiCharHelpCmds.length) helpCmds = multiCharHelpCmds - // look for and strip any helpCmds from argv._ - argv._ = argv._.filter(function (cmd) { - if (~helpCmds.indexOf(cmd)) { - argv[helpOpt] = true - return false - } - return true - }) + // if there's a handler associated with a + // command defer processing to it. + if (helpOpt) { + // consider any multi-char helpOpt alias as a valid help command + // unless all helpOpt aliases are single-char + // note that parsed.aliases is a normalized bidirectional map :) + const helpCmds = [helpOpt] + .concat(aliases[helpOpt] || []) + .filter(k => k.length > 1) + // check if help should trigger and strip it from _. + if (~helpCmds.indexOf(argv._[argv._.length - 1])) { + argv._.pop() + argv[helpOpt] = true } + } + + const handlerKeys = command.getCommands() + const requestCompletions = completion.completionKey in argv + const skipRecommendation = argv[helpOpt] || requestCompletions + const skipDefaultCommand = skipRecommendation && (handlerKeys.length > 1 || handlerKeys[0] !== '$0') - // if there's a handler associated with a - // command defer processing to it. - var handlerKeys = command.getCommands() + if (argv._.length) { if (handlerKeys.length) { - var firstUnknownCommand - for (var i = 0, cmd; argv._[i] !== undefined; i++) { + let firstUnknownCommand + for (let i = (commandIndex || 0), cmd; argv._[i] !== undefined; i++) { cmd = String(argv._[i]) if (~handlerKeys.indexOf(cmd) && cmd !== completionCommand) { - setPlaceholderKeys(argv) - return command.runCommand(cmd, self, parsed) + // commands are executed using a recursive algorithm that executes + // the deepest command first; we keep track of the position in the + // argv._ array that is currently being executed. + return command.runCommand(cmd, self, parsed, i + 1) } else if (!firstUnknownCommand && cmd !== completionCommand) { firstUnknownCommand = cmd + break } } // run the default command, if defined - if (command.hasDefaultCommand() && !argv[helpOpt]) { - setPlaceholderKeys(argv) + if (command.hasDefaultCommand() && !skipDefaultCommand) { return command.runCommand(null, self, parsed) } // recommend a command if recommendCommands() has // been enabled, and no commands were found to execute - if (recommendCommands && firstUnknownCommand) { + if (recommendCommands && firstUnknownCommand && !skipRecommendation) { validation.recommendCommands(firstUnknownCommand, handlerKeys) } } // generate a completion script for adding to ~/.bashrc. - if (completionCommand && ~argv._.indexOf(completionCommand) && !argv[completion.completionKey]) { + if (completionCommand && ~argv._.indexOf(completionCommand) && !requestCompletions) { if (exitProcess) setBlocking(true) self.showCompletionScript() self.exit(0) } - } else if (command.hasDefaultCommand() && !argv[helpOpt]) { - setPlaceholderKeys(argv) + } else if (command.hasDefaultCommand() && !skipDefaultCommand) { return command.runCommand(null, self, parsed) } // we must run completions first, a user might // want to complete the --help or --version option. - if (completion.completionKey in argv) { + if (requestCompletions) { if (exitProcess) setBlocking(true) // we allow for asynchronous completions, // e.g., loading in a list of commands from an API. - var completionArgs = args.slice(args.indexOf('--' + completion.completionKey) + 1) - completion.getCompletion(completionArgs, function (completions) { - ;(completions || []).forEach(function (completion) { + const completionArgs = args.slice(args.indexOf(`--${completion.completionKey}`) + 1) + completion.getCompletion(completionArgs, (completions) => { + ;(completions || []).forEach((completion) => { _logger.log(completion) }) self.exit(0) }) - return setPlaceholderKeys(argv) + return argv } // Handle 'help' and 'version' options // if we haven't already output help! if (!hasOutput) { - Object.keys(argv).forEach(function (key) { + Object.keys(argv).forEach((key) => { if (key === helpOpt && argv[key]) { if (exitProcess) setBlocking(true) @@ -1057,9 +1153,7 @@ function Yargs (processArgs, cwd, parentRequire) { // Check if any of the options to skip validation were provided if (!skipValidation && options.skipValidation.length > 0) { - skipValidation = Object.keys(argv).some(function (key) { - return options.skipValidation.indexOf(key) >= 0 && argv[key] === true - }) + skipValidation = Object.keys(argv).some(key => options.skipValidation.indexOf(key) >= 0 && argv[key] === true) } // If the help or version options where used and exitProcess is false, @@ -1069,7 +1163,7 @@ function Yargs (processArgs, cwd, parentRequire) { // if we're executed via bash completion, don't // bother with validation. - if (!argv[completion.completionKey]) { + if (!requestCompletions) { self._runValidation(argv, aliases, {}, parsed.error) } } @@ -1078,13 +1172,12 @@ function Yargs (processArgs, cwd, parentRequire) { else throw err } - return setPlaceholderKeys(argv) + return argv } - self._runValidation = function (argv, aliases, positionalMap, parseErrors) { - if (parseErrors) throw new YError(parseErrors.message) + self._runValidation = function runValidation (argv, aliases, positionalMap, parseErrors) { + if (parseErrors) throw new YError(parseErrors.message || parseErrors) validation.nonOptionCount(argv) - validation.missingArgumentValue(argv) validation.requiredArguments(argv) if (strict) validation.unknownArguments(argv, aliases, positionalMap) validation.customChecks(argv, aliases) @@ -1097,23 +1190,19 @@ 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'. } } - function setPlaceholderKeys (argv) { - Object.keys(options.key).forEach(function (key) { - // don't set placeholder keys for dot - // notation options 'foo.bar'. - if (~key.indexOf('.')) return - if (typeof argv[key] === 'undefined') argv[key] = undefined - }) - return argv - } + // an app should almost always have --version and --help, + // if you *really* want to disable this use .help(false)/.version(false). + self.help() + self.version() return self } |