wallet-core/node_modules/commander/index.js

1138 lines
25 KiB
JavaScript
Raw Normal View History

2016-10-10 03:43:44 +02:00
/**
* Module dependencies.
*/
var EventEmitter = require('events').EventEmitter;
var spawn = require('child_process').spawn;
var path = require('path');
var dirname = path.dirname;
var basename = path.basename;
2017-05-24 15:10:37 +02:00
var fs = require('fs');
2016-10-10 03:43:44 +02:00
/**
* Expose the root command.
*/
2017-05-24 15:10:37 +02:00
exports = module.exports = new Command();
2016-10-10 03:43:44 +02:00
/**
* Expose `Command`.
*/
exports.Command = Command;
/**
* Expose `Option`.
*/
exports.Option = Option;
/**
* Initialize a new `Option` with the given `flags` and `description`.
*
* @param {String} flags
* @param {String} description
* @api public
*/
function Option(flags, description) {
this.flags = flags;
this.required = ~flags.indexOf('<');
this.optional = ~flags.indexOf('[');
this.bool = !~flags.indexOf('-no-');
flags = flags.split(/[ ,|]+/);
if (flags.length > 1 && !/^[[<]/.test(flags[1])) this.short = flags.shift();
this.long = flags.shift();
this.description = description || '';
}
/**
* Return option name.
*
* @return {String}
* @api private
*/
2017-05-24 15:10:37 +02:00
Option.prototype.name = function() {
2016-10-10 03:43:44 +02:00
return this.long
.replace('--', '')
.replace('no-', '');
};
/**
* Check if `arg` matches the short or long flag.
*
* @param {String} arg
* @return {Boolean}
* @api private
*/
2017-05-24 15:10:37 +02:00
Option.prototype.is = function(arg) {
return arg == this.short || arg == this.long;
2016-10-10 03:43:44 +02:00
};
/**
* Initialize a new `Command`.
*
* @param {String} name
* @api public
*/
function Command(name) {
this.commands = [];
this.options = [];
2017-05-24 15:10:37 +02:00
this._execs = {};
this._allowUnknownOption = false;
2016-10-10 03:43:44 +02:00
this._args = [];
2017-05-24 15:10:37 +02:00
this._name = name || '';
2016-10-10 03:43:44 +02:00
}
/**
* Inherit from `EventEmitter.prototype`.
*/
Command.prototype.__proto__ = EventEmitter.prototype;
/**
* Add command `name`.
*
* The `.action()` callback is invoked when the
* command `name` is specified via __ARGV__,
* and the remaining arguments are applied to the
* function for access.
*
* When the `name` is "*" an un-matched command
* will be passed as the first arg, followed by
* the rest of __ARGV__ remaining.
*
* Examples:
*
* program
* .version('0.0.1')
* .option('-C, --chdir <path>', 'change the working directory')
* .option('-c, --config <path>', 'set config path. defaults to ./deploy.conf')
* .option('-T, --no-tests', 'ignore test hook')
*
* program
* .command('setup')
* .description('run remote setup commands')
2017-05-24 15:10:37 +02:00
* .action(function() {
2016-10-10 03:43:44 +02:00
* console.log('setup');
* });
*
* program
* .command('exec <cmd>')
* .description('run the given remote command')
2017-05-24 15:10:37 +02:00
* .action(function(cmd) {
2016-10-10 03:43:44 +02:00
* console.log('exec "%s"', cmd);
* });
*
* program
2017-05-24 15:10:37 +02:00
* .command('teardown <dir> [otherDirs...]')
* .description('run teardown commands')
* .action(function(dir, otherDirs) {
* console.log('dir "%s"', dir);
* if (otherDirs) {
* otherDirs.forEach(function (oDir) {
* console.log('dir "%s"', oDir);
* });
* }
* });
*
* program
2016-10-10 03:43:44 +02:00
* .command('*')
* .description('deploy the given env')
2017-05-24 15:10:37 +02:00
* .action(function(env) {
2016-10-10 03:43:44 +02:00
* console.log('deploying "%s"', env);
* });
*
* program.parse(process.argv);
*
* @param {String} name
2017-05-24 15:10:37 +02:00
* @param {String} [desc] for git-style sub-commands
2016-10-10 03:43:44 +02:00
* @return {Command} the new command
* @api public
*/
2017-05-24 15:10:37 +02:00
Command.prototype.command = function(name, desc, opts) {
opts = opts || {};
2016-10-10 03:43:44 +02:00
var args = name.split(/ +/);
var cmd = new Command(args.shift());
2017-05-24 15:10:37 +02:00
if (desc) {
cmd.description(desc);
this.executables = true;
this._execs[cmd._name] = true;
if (opts.isDefault) this.defaultExecutable = cmd._name;
}
cmd._noHelp = !!opts.noHelp;
2016-10-10 03:43:44 +02:00
this.commands.push(cmd);
cmd.parseExpectedArgs(args);
cmd.parent = this;
2017-05-24 15:10:37 +02:00
2016-10-10 03:43:44 +02:00
if (desc) return this;
return cmd;
};
2017-05-24 15:10:37 +02:00
/**
* Define argument syntax for the top-level command.
*
* @api public
*/
Command.prototype.arguments = function (desc) {
return this.parseExpectedArgs(desc.split(/ +/));
};
2016-10-10 03:43:44 +02:00
/**
* Add an implicit `help [cmd]` subcommand
* which invokes `--help` for the given command.
*
* @api private
*/
Command.prototype.addImplicitHelpCommand = function() {
this.command('help [cmd]', 'display help for [cmd]');
};
/**
* Parse expected `args`.
*
* For example `["[type]"]` becomes `[{ required: false, name: 'type' }]`.
*
* @param {Array} args
* @return {Command} for chaining
* @api public
*/
2017-05-24 15:10:37 +02:00
Command.prototype.parseExpectedArgs = function(args) {
2016-10-10 03:43:44 +02:00
if (!args.length) return;
var self = this;
2017-05-24 15:10:37 +02:00
args.forEach(function(arg) {
var argDetails = {
required: false,
name: '',
variadic: false
};
2016-10-10 03:43:44 +02:00
switch (arg[0]) {
case '<':
2017-05-24 15:10:37 +02:00
argDetails.required = true;
argDetails.name = arg.slice(1, -1);
2016-10-10 03:43:44 +02:00
break;
case '[':
2017-05-24 15:10:37 +02:00
argDetails.name = arg.slice(1, -1);
2016-10-10 03:43:44 +02:00
break;
}
2017-05-24 15:10:37 +02:00
if (argDetails.name.length > 3 && argDetails.name.slice(-3) === '...') {
argDetails.variadic = true;
argDetails.name = argDetails.name.slice(0, -3);
}
if (argDetails.name) {
self._args.push(argDetails);
}
2016-10-10 03:43:44 +02:00
});
return this;
};
/**
* Register callback `fn` for the command.
*
* Examples:
*
* program
* .command('help')
* .description('display verbose help')
2017-05-24 15:10:37 +02:00
* .action(function() {
2016-10-10 03:43:44 +02:00
* // output help here
* });
*
* @param {Function} fn
* @return {Command} for chaining
* @api public
*/
2017-05-24 15:10:37 +02:00
Command.prototype.action = function(fn) {
2016-10-10 03:43:44 +02:00
var self = this;
2017-05-24 15:10:37 +02:00
var listener = function(args, unknown) {
2016-10-10 03:43:44 +02:00
// Parse any so-far unknown options
args = args || [];
unknown = unknown || [];
var parsed = self.parseOptions(unknown);
// Output help if necessary
outputHelpIfNecessary(self, parsed.unknown);
// If there are still any unknown options, then we simply
// die, unless someone asked for help, in which case we give it
// to them, and then we die.
if (parsed.unknown.length > 0) {
self.unknownOption(parsed.unknown[0]);
}
// Leftover arguments need to be pushed back. Fixes issue #56
if (parsed.args.length) args = parsed.args.concat(args);
2017-05-24 15:10:37 +02:00
self._args.forEach(function(arg, i) {
2016-10-10 03:43:44 +02:00
if (arg.required && null == args[i]) {
self.missingArgument(arg.name);
2017-05-24 15:10:37 +02:00
} else if (arg.variadic) {
if (i !== self._args.length - 1) {
self.variadicArgNotLast(arg.name);
}
args[i] = args.splice(i);
2016-10-10 03:43:44 +02:00
}
});
// Always append ourselves to the end of the arguments,
// to make sure we match the number of arguments the user
// expects
if (self._args.length) {
args[self._args.length] = self;
} else {
args.push(self);
}
2017-05-24 15:10:37 +02:00
fn.apply(self, args);
2016-10-10 03:43:44 +02:00
};
2017-05-24 15:10:37 +02:00
var parent = this.parent || this;
var name = parent === this ? '*' : this._name;
2017-08-14 05:01:11 +02:00
parent.on('command:' + name, listener);
if (this._alias) parent.on('command:' + this._alias, listener);
2016-10-10 03:43:44 +02:00
return this;
};
/**
* Define option with `flags`, `description` and optional
* coercion `fn`.
*
* The `flags` string should contain both the short and long flags,
* separated by comma, a pipe or space. The following are all valid
* all will output this way when `--help` is used.
*
* "-p, --pepper"
* "-p|--pepper"
* "-p --pepper"
*
* Examples:
*
* // simple boolean defaulting to false
* program.option('-p, --pepper', 'add pepper');
*
* --pepper
* program.pepper
* // => Boolean
*
* // simple boolean defaulting to true
* program.option('-C, --no-cheese', 'remove cheese');
*
* program.cheese
* // => true
*
* --no-cheese
* program.cheese
* // => false
*
* // required argument
* program.option('-C, --chdir <path>', 'change the working directory');
*
* --chdir /tmp
* program.chdir
* // => "/tmp"
*
* // optional argument
* program.option('-c, --cheese [type]', 'add cheese [marble]');
*
* @param {String} flags
* @param {String} description
2017-08-14 05:01:11 +02:00
* @param {Function|*} [fn] or default
* @param {*} [defaultValue]
2016-10-10 03:43:44 +02:00
* @return {Command} for chaining
* @api public
*/
2017-05-24 15:10:37 +02:00
Command.prototype.option = function(flags, description, fn, defaultValue) {
2016-10-10 03:43:44 +02:00
var self = this
, option = new Option(flags, description)
, oname = option.name()
, name = camelcase(oname);
// default as 3rd arg
2017-05-24 15:10:37 +02:00
if (typeof fn != 'function') {
if (fn instanceof RegExp) {
var regex = fn;
fn = function(val, def) {
var m = regex.exec(val);
return m ? m[0] : def;
}
}
else {
defaultValue = fn;
fn = null;
}
}
2016-10-10 03:43:44 +02:00
// preassign default value only for --no-*, [optional], or <required>
if (false == option.bool || option.optional || option.required) {
// when --no-* we make sure default is true
if (false == option.bool) defaultValue = true;
// preassign only if we have a default
if (undefined !== defaultValue) self[name] = defaultValue;
}
// register the option
this.options.push(option);
// when it's passed assign the value
// and conditionally invoke the callback
2017-08-14 05:01:11 +02:00
this.on('option:' + oname, function(val) {
2016-10-10 03:43:44 +02:00
// coercion
2017-05-24 15:10:37 +02:00
if (null !== val && fn) val = fn(val, undefined === self[name]
? defaultValue
: self[name]);
2016-10-10 03:43:44 +02:00
// unassigned or bool
if ('boolean' == typeof self[name] || 'undefined' == typeof self[name]) {
// if no value, bool true, and we have a default, then use it!
if (null == val) {
self[name] = option.bool
? defaultValue || true
: false;
} else {
self[name] = val;
}
} else if (null !== val) {
// reassign
self[name] = val;
}
});
return this;
};
2017-05-24 15:10:37 +02:00
/**
* Allow unknown options on the command line.
*
* @param {Boolean} arg if `true` or omitted, no error will be thrown
* for unknown options.
* @api public
*/
Command.prototype.allowUnknownOption = function(arg) {
this._allowUnknownOption = arguments.length === 0 || arg;
return this;
};
2016-10-10 03:43:44 +02:00
/**
* Parse `argv`, settings options and invoking commands when defined.
*
* @param {Array} argv
* @return {Command} for chaining
* @api public
*/
2017-05-24 15:10:37 +02:00
Command.prototype.parse = function(argv) {
2016-10-10 03:43:44 +02:00
// implicit help
if (this.executables) this.addImplicitHelpCommand();
// store raw args
this.rawArgs = argv;
// guess name
this._name = this._name || basename(argv[1], '.js');
2017-05-24 15:10:37 +02:00
// github-style sub-commands with no sub-command
if (this.executables && argv.length < 3 && !this.defaultExecutable) {
// this user needs help
argv.push('--help');
}
2016-10-10 03:43:44 +02:00
// process argv
var parsed = this.parseOptions(this.normalize(argv.slice(2)));
var args = this.args = parsed.args;
var result = this.parseArgs(this.args, parsed.unknown);
// executable sub-commands
var name = result.args[0];
2017-08-14 05:01:11 +02:00
var aliasCommand = null;
// check alias of sub commands
if (name) {
aliasCommand = this.commands.filter(function(command) {
return command.alias() === name;
})[0];
}
2017-05-24 15:10:37 +02:00
if (this._execs[name] && typeof this._execs[name] != "function") {
return this.executeSubCommand(argv, args, parsed.unknown);
2017-08-14 05:01:11 +02:00
} else if (aliasCommand) {
// is alias of a subCommand
args[0] = aliasCommand._name;
return this.executeSubCommand(argv, args, parsed.unknown);
2017-05-24 15:10:37 +02:00
} else if (this.defaultExecutable) {
// use the default subcommand
2017-08-14 05:01:11 +02:00
args.unshift(this.defaultExecutable);
2017-05-24 15:10:37 +02:00
return this.executeSubCommand(argv, args, parsed.unknown);
}
2016-10-10 03:43:44 +02:00
return result;
};
/**
* Execute a sub-command executable.
*
* @param {Array} argv
* @param {Array} args
* @param {Array} unknown
* @api private
*/
Command.prototype.executeSubCommand = function(argv, args, unknown) {
args = args.concat(unknown);
if (!args.length) this.help();
if ('help' == args[0] && 1 == args.length) this.help();
// <cmd> --help
if ('help' == args[0]) {
args[0] = args[1];
args[1] = '--help';
}
// executable
2017-05-24 15:10:37 +02:00
var f = argv[1];
// name of the subcommand, link `pm-install`
var bin = basename(f, '.js') + '-' + args[0];
2016-10-10 03:43:44 +02:00
2017-05-24 15:10:37 +02:00
// In case of globally installed, get the base dir where executable
// subcommand file should be located at
var baseDir
2017-08-14 05:01:11 +02:00
, link = fs.lstatSync(f).isSymbolicLink() ? fs.readlinkSync(f) : f;
2017-05-24 15:10:37 +02:00
// when symbolink is relative path
if (link !== f && link.charAt(0) !== '/') {
link = path.join(dirname(f), link)
}
baseDir = dirname(link);
// prefer local `./<bin>` to bin in the $PATH
var localBin = path.join(baseDir, bin);
// whether bin file is a js script with explicit `.js` extension
var isExplicitJS = false;
if (exists(localBin + '.js')) {
bin = localBin + '.js';
isExplicitJS = true;
} else if (exists(localBin)) {
bin = localBin;
}
2016-10-10 03:43:44 +02:00
args = args.slice(1);
2017-05-24 15:10:37 +02:00
var proc;
if (process.platform !== 'win32') {
if (isExplicitJS) {
2017-08-14 05:01:11 +02:00
args.unshift(bin);
2017-05-24 15:10:37 +02:00
// add executable arguments to spawn
args = (process.execArgv || []).concat(args);
proc = spawn('node', args, { stdio: 'inherit', customFds: [0, 1, 2] });
} else {
proc = spawn(bin, args, { stdio: 'inherit', customFds: [0, 1, 2] });
}
} else {
2017-08-14 05:01:11 +02:00
args.unshift(bin);
2017-05-24 15:10:37 +02:00
proc = spawn(process.execPath, args, { stdio: 'inherit'});
}
2017-08-14 05:01:11 +02:00
var signals = ['SIGUSR1', 'SIGUSR2', 'SIGTERM', 'SIGINT', 'SIGHUP'];
signals.forEach(function(signal) {
process.on(signal, function(){
if ((proc.killed === false) && (proc.exitCode === null)){
proc.kill(signal);
}
});
});
2017-05-24 15:10:37 +02:00
proc.on('close', process.exit.bind(process));
proc.on('error', function(err) {
2016-10-10 03:43:44 +02:00
if (err.code == "ENOENT") {
console.error('\n %s(1) does not exist, try --help\n', bin);
} else if (err.code == "EACCES") {
console.error('\n %s(1) not executable. try chmod or run with root\n', bin);
}
2017-05-24 15:10:37 +02:00
process.exit(1);
2016-10-10 03:43:44 +02:00
});
2017-05-24 15:10:37 +02:00
// Store the reference to the child process
2016-10-10 03:43:44 +02:00
this.runningCommand = proc;
};
/**
* Normalize `args`, splitting joined short flags. For example
* the arg "-abc" is equivalent to "-a -b -c".
* This also normalizes equal sign and splits "--abc=def" into "--abc def".
*
* @param {Array} args
* @return {Array}
* @api private
*/
2017-05-24 15:10:37 +02:00
Command.prototype.normalize = function(args) {
2016-10-10 03:43:44 +02:00
var ret = []
, arg
, lastOpt
, index;
for (var i = 0, len = args.length; i < len; ++i) {
arg = args[i];
2017-05-24 15:10:37 +02:00
if (i > 0) {
lastOpt = this.optionFor(args[i-1]);
}
2016-10-10 03:43:44 +02:00
2017-05-24 15:10:37 +02:00
if (arg === '--') {
// Honor option terminator
ret = ret.concat(args.slice(i));
break;
} else if (lastOpt && lastOpt.required) {
ret.push(arg);
2016-10-10 03:43:44 +02:00
} else if (arg.length > 1 && '-' == arg[0] && '-' != arg[1]) {
2017-05-24 15:10:37 +02:00
arg.slice(1).split('').forEach(function(c) {
2016-10-10 03:43:44 +02:00
ret.push('-' + c);
});
} else if (/^--/.test(arg) && ~(index = arg.indexOf('='))) {
ret.push(arg.slice(0, index), arg.slice(index + 1));
} else {
ret.push(arg);
}
}
return ret;
};
/**
* Parse command `args`.
*
* When listener(s) are available those
* callbacks are invoked, otherwise the "*"
* event is emitted and those actions are invoked.
*
* @param {Array} args
* @return {Command} for chaining
* @api private
*/
2017-05-24 15:10:37 +02:00
Command.prototype.parseArgs = function(args, unknown) {
var name;
2016-10-10 03:43:44 +02:00
if (args.length) {
name = args[0];
2017-08-14 05:01:11 +02:00
if (this.listeners('command:' + name).length) {
this.emit('command:' + args.shift(), args, unknown);
2016-10-10 03:43:44 +02:00
} else {
2017-08-14 05:01:11 +02:00
this.emit('command:*', args);
2016-10-10 03:43:44 +02:00
}
} else {
outputHelpIfNecessary(this, unknown);
// If there were no args and we have unknown options,
// then they are extraneous and we need to error.
if (unknown.length > 0) {
this.unknownOption(unknown[0]);
}
}
return this;
};
/**
* Return an option matching `arg` if any.
*
* @param {String} arg
* @return {Option}
* @api private
*/
2017-05-24 15:10:37 +02:00
Command.prototype.optionFor = function(arg) {
2016-10-10 03:43:44 +02:00
for (var i = 0, len = this.options.length; i < len; ++i) {
if (this.options[i].is(arg)) {
return this.options[i];
}
}
};
/**
* Parse options from `argv` returning `argv`
* void of these options.
*
* @param {Array} argv
* @return {Array}
* @api public
*/
2017-05-24 15:10:37 +02:00
Command.prototype.parseOptions = function(argv) {
2016-10-10 03:43:44 +02:00
var args = []
, len = argv.length
, literal
, option
, arg;
var unknownOptions = [];
// parse options
for (var i = 0; i < len; ++i) {
arg = argv[i];
// literal args after --
2017-08-14 05:01:11 +02:00
if (literal) {
args.push(arg);
2016-10-10 03:43:44 +02:00
continue;
}
2017-08-14 05:01:11 +02:00
if ('--' == arg) {
literal = true;
2016-10-10 03:43:44 +02:00
continue;
}
// find matching Option
option = this.optionFor(arg);
// option is defined
if (option) {
// requires arg
if (option.required) {
arg = argv[++i];
if (null == arg) return this.optionMissingArgument(option);
2017-08-14 05:01:11 +02:00
this.emit('option:' + option.name(), arg);
2016-10-10 03:43:44 +02:00
// optional arg
} else if (option.optional) {
arg = argv[i+1];
if (null == arg || ('-' == arg[0] && '-' != arg)) {
arg = null;
} else {
++i;
}
2017-08-14 05:01:11 +02:00
this.emit('option:' + option.name(), arg);
2016-10-10 03:43:44 +02:00
// bool
} else {
2017-08-14 05:01:11 +02:00
this.emit('option:' + option.name());
2016-10-10 03:43:44 +02:00
}
continue;
}
// looks like an option
if (arg.length > 1 && '-' == arg[0]) {
unknownOptions.push(arg);
// If the next argument looks like it might be
// an argument for this option, we pass it on.
// If it isn't, then it'll simply be ignored
if (argv[i+1] && '-' != argv[i+1][0]) {
unknownOptions.push(argv[++i]);
}
continue;
}
// arg
args.push(arg);
}
return { args: args, unknown: unknownOptions };
};
2017-05-24 15:10:37 +02:00
/**
* Return an object containing options as key-value pairs
*
* @return {Object}
* @api public
*/
Command.prototype.opts = function() {
var result = {}
, len = this.options.length;
for (var i = 0 ; i < len; i++) {
var key = camelcase(this.options[i].name());
result[key] = key === 'version' ? this._version : this[key];
}
return result;
};
2016-10-10 03:43:44 +02:00
/**
* Argument `name` is missing.
*
* @param {String} name
* @api private
*/
2017-05-24 15:10:37 +02:00
Command.prototype.missingArgument = function(name) {
2016-10-10 03:43:44 +02:00
console.error();
console.error(" error: missing required argument `%s'", name);
console.error();
process.exit(1);
};
/**
* `Option` is missing an argument, but received `flag` or nothing.
*
* @param {String} option
* @param {String} flag
* @api private
*/
2017-05-24 15:10:37 +02:00
Command.prototype.optionMissingArgument = function(option, flag) {
2016-10-10 03:43:44 +02:00
console.error();
if (flag) {
console.error(" error: option `%s' argument missing, got `%s'", option.flags, flag);
} else {
console.error(" error: option `%s' argument missing", option.flags);
}
console.error();
process.exit(1);
};
/**
* Unknown option `flag`.
*
* @param {String} flag
* @api private
*/
2017-05-24 15:10:37 +02:00
Command.prototype.unknownOption = function(flag) {
if (this._allowUnknownOption) return;
2016-10-10 03:43:44 +02:00
console.error();
console.error(" error: unknown option `%s'", flag);
console.error();
process.exit(1);
};
2017-05-24 15:10:37 +02:00
/**
* Variadic argument with `name` is not the last argument as required.
*
* @param {String} name
* @api private
*/
Command.prototype.variadicArgNotLast = function(name) {
console.error();
console.error(" error: variadic arguments must be last `%s'", name);
console.error();
process.exit(1);
};
2016-10-10 03:43:44 +02:00
/**
* Set the program version to `str`.
*
* This method auto-registers the "-V, --version" flag
* which will print the version number when passed.
*
* @param {String} str
2017-08-14 05:01:11 +02:00
* @param {String} [flags]
2016-10-10 03:43:44 +02:00
* @return {Command} for chaining
* @api public
*/
2017-05-24 15:10:37 +02:00
Command.prototype.version = function(str, flags) {
2016-10-10 03:43:44 +02:00
if (0 == arguments.length) return this._version;
this._version = str;
flags = flags || '-V, --version';
this.option(flags, 'output the version number');
2017-08-14 05:01:11 +02:00
this.on('option:version', function() {
2017-05-24 15:10:37 +02:00
process.stdout.write(str + '\n');
2016-10-10 03:43:44 +02:00
process.exit(0);
});
return this;
};
/**
2017-05-24 15:10:37 +02:00
* Set the description to `str`.
2016-10-10 03:43:44 +02:00
*
* @param {String} str
* @return {String|Command}
* @api public
*/
2017-05-24 15:10:37 +02:00
Command.prototype.description = function(str) {
if (0 === arguments.length) return this._description;
2016-10-10 03:43:44 +02:00
this._description = str;
return this;
};
/**
* Set an alias for the command
*
* @param {String} alias
* @return {String|Command}
* @api public
*/
2017-05-24 15:10:37 +02:00
Command.prototype.alias = function(alias) {
2017-08-14 05:01:11 +02:00
var command = this;
if(this.commands.length !== 0) {
command = this.commands[this.commands.length - 1]
}
if (arguments.length === 0) return command._alias;
command._alias = alias;
2016-10-10 03:43:44 +02:00
return this;
};
/**
* Set / get the command usage `str`.
*
* @param {String} str
* @return {String|Command}
* @api public
*/
2017-05-24 15:10:37 +02:00
Command.prototype.usage = function(str) {
var args = this._args.map(function(arg) {
return humanReadableArgName(arg);
2016-10-10 03:43:44 +02:00
});
2017-05-24 15:10:37 +02:00
var usage = '[options]'
+ (this.commands.length ? ' [command]' : '')
+ (this._args.length ? ' ' + args.join(' ') : '');
2016-10-10 03:43:44 +02:00
if (0 == arguments.length) return this._usage || usage;
this._usage = str;
return this;
};
2017-05-24 15:10:37 +02:00
/**
2017-08-14 05:01:11 +02:00
* Get or set the name of the command
2017-05-24 15:10:37 +02:00
*
2017-08-14 05:01:11 +02:00
* @param {String} str
2017-05-24 15:10:37 +02:00
* @return {String|Command}
* @api public
*/
2017-08-14 05:01:11 +02:00
Command.prototype.name = function(str) {
if (0 === arguments.length) return this._name;
this._name = str;
return this;
2017-05-24 15:10:37 +02:00
};
2016-10-10 03:43:44 +02:00
/**
* Return the largest option length.
*
* @return {Number}
* @api private
*/
2017-05-24 15:10:37 +02:00
Command.prototype.largestOptionLength = function() {
return this.options.reduce(function(max, option) {
2016-10-10 03:43:44 +02:00
return Math.max(max, option.flags.length);
}, 0);
};
/**
* Return help for options.
*
* @return {String}
* @api private
*/
2017-05-24 15:10:37 +02:00
Command.prototype.optionHelp = function() {
2016-10-10 03:43:44 +02:00
var width = this.largestOptionLength();
2017-08-14 05:01:11 +02:00
// Append the help information
return this.options.map(function(option) {
return pad(option.flags, width) + ' ' + option.description;
}).concat([pad('-h, --help', width) + ' ' + 'output usage information'])
.join('\n');
2016-10-10 03:43:44 +02:00
};
/**
* Return command help documentation.
*
* @return {String}
* @api private
*/
2017-05-24 15:10:37 +02:00
Command.prototype.commandHelp = function() {
2016-10-10 03:43:44 +02:00
if (!this.commands.length) return '';
2017-05-24 15:10:37 +02:00
var commands = this.commands.filter(function(cmd) {
return !cmd._noHelp;
}).map(function(cmd) {
var args = cmd._args.map(function(arg) {
return humanReadableArgName(arg);
}).join(' ');
return [
cmd._name
+ (cmd._alias ? '|' + cmd._alias : '')
+ (cmd.options.length ? ' [options]' : '')
+ ' ' + args
2017-08-14 05:01:11 +02:00
, cmd._description
2017-05-24 15:10:37 +02:00
];
});
var width = commands.reduce(function(max, command) {
return Math.max(max, command[0].length);
}, 0);
2016-10-10 03:43:44 +02:00
return [
2017-05-24 15:10:37 +02:00
''
2016-10-10 03:43:44 +02:00
, ' Commands:'
, ''
2017-05-24 15:10:37 +02:00
, commands.map(function(cmd) {
var desc = cmd[1] ? ' ' + cmd[1] : '';
return pad(cmd[0], width) + desc;
2016-10-10 03:43:44 +02:00
}).join('\n').replace(/^/gm, ' ')
, ''
].join('\n');
};
/**
* Return program help documentation.
*
* @return {String}
* @api private
*/
2017-05-24 15:10:37 +02:00
Command.prototype.helpInformation = function() {
var desc = [];
if (this._description) {
desc = [
' ' + this._description
, ''
];
}
var cmdName = this._name;
if (this._alias) {
cmdName = cmdName + '|' + this._alias;
}
var usage = [
''
,' Usage: ' + cmdName + ' ' + this.usage()
, ''
];
var cmds = [];
var commandHelp = this.commandHelp();
if (commandHelp) cmds = [commandHelp];
var options = [
2017-08-14 05:01:11 +02:00
''
, ' Options:'
2016-10-10 03:43:44 +02:00
, ''
, '' + this.optionHelp().replace(/^/gm, ' ')
, ''
2017-05-24 15:10:37 +02:00
];
return usage
.concat(desc)
.concat(options)
2017-08-14 05:01:11 +02:00
.concat(cmds)
2017-05-24 15:10:37 +02:00
.join('\n');
2016-10-10 03:43:44 +02:00
};
/**
* Output help information for this command
*
* @api public
*/
2017-05-24 15:10:37 +02:00
Command.prototype.outputHelp = function(cb) {
if (!cb) {
cb = function(passthru) {
return passthru;
}
}
process.stdout.write(cb(this.helpInformation()));
2016-10-10 03:43:44 +02:00
this.emit('--help');
};
/**
* Output help information and exit.
*
* @api public
*/
2017-05-24 15:10:37 +02:00
Command.prototype.help = function(cb) {
this.outputHelp(cb);
2016-10-10 03:43:44 +02:00
process.exit();
};
/**
* Camel-case the given `flag`
*
* @param {String} flag
* @return {String}
* @api private
*/
function camelcase(flag) {
2017-05-24 15:10:37 +02:00
return flag.split('-').reduce(function(str, word) {
2016-10-10 03:43:44 +02:00
return str + word[0].toUpperCase() + word.slice(1);
});
}
/**
* Pad `str` to `width`.
*
* @param {String} str
* @param {Number} width
* @return {String}
* @api private
*/
function pad(str, width) {
var len = Math.max(0, width - str.length);
return str + Array(len + 1).join(' ');
}
/**
* Output help information if necessary
*
* @param {Command} command to output help for
* @param {Array} array of options to search for -h or --help
* @api private
*/
function outputHelpIfNecessary(cmd, options) {
options = options || [];
for (var i = 0; i < options.length; i++) {
if (options[i] == '--help' || options[i] == '-h') {
cmd.outputHelp();
process.exit(0);
}
}
}
2017-05-24 15:10:37 +02:00
/**
* Takes an argument an returns its human readable equivalent for help usage.
*
* @param {Object} arg
* @return {String}
* @api private
*/
function humanReadableArgName(arg) {
var nameOutput = arg.name + (arg.variadic === true ? '...' : '');
return arg.required
? '<' + nameOutput + '>'
: '[' + nameOutput + ']'
}
// for versions before node v0.8 when there weren't `fs.existsSync`
function exists(file) {
try {
if (fs.statSync(file).isFile()) {
return true;
}
} catch (e) {
return false;
}
}