mirror of
https://gitee.com/dcloud/uni-preset-vue
synced 2026-05-29 00:00:06 +08:00
feat: 支持前后一体登录模板
This commit is contained in:
+299
-178
@@ -1,16 +1,20 @@
|
||||
|
||||
/**
|
||||
* Module dependencies.
|
||||
*/
|
||||
|
||||
var EventEmitter = require('events').EventEmitter;
|
||||
var spawn = require('child_process').spawn;
|
||||
var readlink = require('graceful-readlink').readlinkSync;
|
||||
var path = require('path');
|
||||
var dirname = path.dirname;
|
||||
var basename = path.basename;
|
||||
var fs = require('fs');
|
||||
|
||||
/**
|
||||
* Inherit `Command` from `EventEmitter.prototype`.
|
||||
*/
|
||||
|
||||
require('util').inherits(Command, EventEmitter);
|
||||
|
||||
/**
|
||||
* Expose the root command.
|
||||
*/
|
||||
@@ -39,9 +43,9 @@ exports.Option = Option;
|
||||
|
||||
function Option(flags, description) {
|
||||
this.flags = flags;
|
||||
this.required = ~flags.indexOf('<');
|
||||
this.optional = ~flags.indexOf('[');
|
||||
this.bool = !~flags.indexOf('-no-');
|
||||
this.required = flags.indexOf('<') >= 0;
|
||||
this.optional = flags.indexOf('[') >= 0;
|
||||
this.bool = flags.indexOf('-no-') === -1;
|
||||
flags = flags.split(/[ ,|]+/);
|
||||
if (flags.length > 1 && !/^[[<]/.test(flags[1])) this.short = flags.shift();
|
||||
this.long = flags.shift();
|
||||
@@ -61,6 +65,18 @@ Option.prototype.name = function() {
|
||||
.replace('no-', '');
|
||||
};
|
||||
|
||||
/**
|
||||
* Return option name, in a camelcase format that can be used
|
||||
* as a object attribute key.
|
||||
*
|
||||
* @return {String}
|
||||
* @api private
|
||||
*/
|
||||
|
||||
Option.prototype.attributeName = function() {
|
||||
return camelcase(this.name());
|
||||
};
|
||||
|
||||
/**
|
||||
* Check if `arg` matches the short or long flag.
|
||||
*
|
||||
@@ -70,7 +86,7 @@ Option.prototype.name = function() {
|
||||
*/
|
||||
|
||||
Option.prototype.is = function(arg) {
|
||||
return arg == this.short || arg == this.long;
|
||||
return this.short === arg || this.long === arg;
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -83,18 +99,12 @@ Option.prototype.is = function(arg) {
|
||||
function Command(name) {
|
||||
this.commands = [];
|
||||
this.options = [];
|
||||
this._execs = [];
|
||||
this._execs = {};
|
||||
this._allowUnknownOption = false;
|
||||
this._args = [];
|
||||
this._name = name;
|
||||
this._name = name || '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Inherit from `EventEmitter.prototype`.
|
||||
*/
|
||||
|
||||
Command.prototype.__proto__ = EventEmitter.prototype;
|
||||
|
||||
/**
|
||||
* Add command `name`.
|
||||
*
|
||||
@@ -157,6 +167,10 @@ Command.prototype.__proto__ = EventEmitter.prototype;
|
||||
*/
|
||||
|
||||
Command.prototype.command = function(name, desc, opts) {
|
||||
if (typeof desc === 'object' && desc !== null) {
|
||||
opts = desc;
|
||||
desc = null;
|
||||
}
|
||||
opts = opts || {};
|
||||
var args = name.split(/ +/);
|
||||
var cmd = new Command(args.shift());
|
||||
@@ -165,8 +179,8 @@ Command.prototype.command = function(name, desc, opts) {
|
||||
cmd.description(desc);
|
||||
this.executables = true;
|
||||
this._execs[cmd._name] = true;
|
||||
if (opts.isDefault) this.defaultExecutable = cmd._name;
|
||||
}
|
||||
|
||||
cmd._noHelp = !!opts.noHelp;
|
||||
this.commands.push(cmd);
|
||||
cmd.parseExpectedArgs(args);
|
||||
@@ -182,9 +196,9 @@ Command.prototype.command = function(name, desc, opts) {
|
||||
* @api public
|
||||
*/
|
||||
|
||||
Command.prototype.arguments = function (desc) {
|
||||
Command.prototype.arguments = function(desc) {
|
||||
return this.parseExpectedArgs(desc.split(/ +/));
|
||||
}
|
||||
};
|
||||
|
||||
/**
|
||||
* Add an implicit `help [cmd]` subcommand
|
||||
@@ -278,7 +292,7 @@ Command.prototype.action = function(fn) {
|
||||
if (parsed.args.length) args = parsed.args.concat(args);
|
||||
|
||||
self._args.forEach(function(arg, i) {
|
||||
if (arg.required && null == args[i]) {
|
||||
if (arg.required && args[i] == null) {
|
||||
self.missingArgument(arg.name);
|
||||
} else if (arg.variadic) {
|
||||
if (i !== self._args.length - 1) {
|
||||
@@ -302,8 +316,8 @@ Command.prototype.action = function(fn) {
|
||||
};
|
||||
var parent = this.parent || this;
|
||||
var name = parent === this ? '*' : this._name;
|
||||
parent.on(name, listener);
|
||||
if (this._alias) parent.on(this._alias, listener);
|
||||
parent.on('command:' + name, listener);
|
||||
if (this._alias) parent.on('command:' + this._alias, listener);
|
||||
return this;
|
||||
};
|
||||
|
||||
@@ -350,39 +364,41 @@ Command.prototype.action = function(fn) {
|
||||
*
|
||||
* @param {String} flags
|
||||
* @param {String} description
|
||||
* @param {Function|Mixed} fn or default
|
||||
* @param {Mixed} defaultValue
|
||||
* @param {Function|*} [fn] or default
|
||||
* @param {*} [defaultValue]
|
||||
* @return {Command} for chaining
|
||||
* @api public
|
||||
*/
|
||||
|
||||
Command.prototype.option = function(flags, description, fn, defaultValue) {
|
||||
var self = this
|
||||
, option = new Option(flags, description)
|
||||
, oname = option.name()
|
||||
, name = camelcase(oname);
|
||||
var self = this,
|
||||
option = new Option(flags, description),
|
||||
oname = option.name(),
|
||||
name = option.attributeName();
|
||||
|
||||
// default as 3rd arg
|
||||
if (typeof fn != 'function') {
|
||||
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 {
|
||||
};
|
||||
} else {
|
||||
defaultValue = fn;
|
||||
fn = null;
|
||||
}
|
||||
}
|
||||
|
||||
// preassign default value only for --no-*, [optional], or <required>
|
||||
if (false == option.bool || option.optional || option.required) {
|
||||
if (!option.bool || option.optional || option.required) {
|
||||
// when --no-* we make sure default is true
|
||||
if (false == option.bool) defaultValue = true;
|
||||
if (!option.bool) defaultValue = true;
|
||||
// preassign only if we have a default
|
||||
if (undefined !== defaultValue) self[name] = defaultValue;
|
||||
if (defaultValue !== undefined) {
|
||||
self[name] = defaultValue;
|
||||
option.defaultValue = defaultValue;
|
||||
}
|
||||
}
|
||||
|
||||
// register the option
|
||||
@@ -390,23 +406,23 @@ Command.prototype.option = function(flags, description, fn, defaultValue) {
|
||||
|
||||
// when it's passed assign the value
|
||||
// and conditionally invoke the callback
|
||||
this.on(oname, function(val) {
|
||||
this.on('option:' + oname, function(val) {
|
||||
// coercion
|
||||
if (null !== val && fn) val = fn(val, undefined === self[name]
|
||||
? defaultValue
|
||||
: self[name]);
|
||||
if (val !== null && fn) {
|
||||
val = fn(val, self[name] === undefined ? defaultValue : self[name]);
|
||||
}
|
||||
|
||||
// unassigned or bool
|
||||
if ('boolean' == typeof self[name] || 'undefined' == typeof self[name]) {
|
||||
if (typeof self[name] === 'boolean' || typeof self[name] === 'undefined') {
|
||||
// if no value, bool true, and we have a default, then use it!
|
||||
if (null == val) {
|
||||
if (val == null) {
|
||||
self[name] = option.bool
|
||||
? defaultValue || true
|
||||
: false;
|
||||
} else {
|
||||
self[name] = val;
|
||||
}
|
||||
} else if (null !== val) {
|
||||
} else if (val !== null) {
|
||||
// reassign
|
||||
self[name] = val;
|
||||
}
|
||||
@@ -423,8 +439,8 @@ Command.prototype.option = function(flags, description, fn, defaultValue) {
|
||||
* @api public
|
||||
*/
|
||||
Command.prototype.allowUnknownOption = function(arg) {
|
||||
this._allowUnknownOption = arguments.length === 0 || arg;
|
||||
return this;
|
||||
this._allowUnknownOption = arguments.length === 0 || arg;
|
||||
return this;
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -446,7 +462,7 @@ Command.prototype.parse = function(argv) {
|
||||
this._name = this._name || basename(argv[1], '.js');
|
||||
|
||||
// github-style sub-commands with no sub-command
|
||||
if (this.executables && argv.length < 3) {
|
||||
if (this.executables && argv.length < 3 && !this.defaultExecutable) {
|
||||
// this user needs help
|
||||
argv.push('--help');
|
||||
}
|
||||
@@ -459,7 +475,24 @@ Command.prototype.parse = function(argv) {
|
||||
|
||||
// executable sub-commands
|
||||
var name = result.args[0];
|
||||
if (this._execs[name] && typeof this._execs[name] != "function") {
|
||||
|
||||
var aliasCommand = null;
|
||||
// check alias of sub commands
|
||||
if (name) {
|
||||
aliasCommand = this.commands.filter(function(command) {
|
||||
return command.alias() === name;
|
||||
})[0];
|
||||
}
|
||||
|
||||
if (this._execs[name] === true) {
|
||||
return this.executeSubCommand(argv, args, parsed.unknown);
|
||||
} else if (aliasCommand) {
|
||||
// is alias of a subCommand
|
||||
args[0] = aliasCommand._name;
|
||||
return this.executeSubCommand(argv, args, parsed.unknown);
|
||||
} else if (this.defaultExecutable) {
|
||||
// use the default subcommand
|
||||
args.unshift(this.defaultExecutable);
|
||||
return this.executeSubCommand(argv, args, parsed.unknown);
|
||||
}
|
||||
|
||||
@@ -479,10 +512,10 @@ 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();
|
||||
if (args[0] === 'help' && args.length === 1) this.help();
|
||||
|
||||
// <cmd> --help
|
||||
if ('help' == args[0]) {
|
||||
if (args[0] === 'help') {
|
||||
args[0] = args[1];
|
||||
args[1] = '--help';
|
||||
}
|
||||
@@ -490,28 +523,27 @@ Command.prototype.executeSubCommand = function(argv, args, unknown) {
|
||||
// executable
|
||||
var f = argv[1];
|
||||
// name of the subcommand, link `pm-install`
|
||||
var bin = basename(f, '.js') + '-' + args[0];
|
||||
|
||||
var bin = basename(f, path.extname(f)) + '-' + args[0];
|
||||
|
||||
// In case of globally installed, get the base dir where executable
|
||||
// subcommand file should be located at
|
||||
var baseDir
|
||||
, link = readlink(f);
|
||||
var baseDir;
|
||||
|
||||
// when symbolink is relative path
|
||||
if (link !== f && link.charAt(0) !== '/') {
|
||||
link = path.join(dirname(f), link)
|
||||
}
|
||||
baseDir = dirname(link);
|
||||
var resolvedLink = fs.realpathSync(f);
|
||||
|
||||
baseDir = dirname(resolvedLink);
|
||||
|
||||
// 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
|
||||
// whether bin file is a js script with explicit `.js` or `.ts` extension
|
||||
var isExplicitJS = false;
|
||||
if (exists(localBin + '.js')) {
|
||||
bin = localBin + '.js';
|
||||
isExplicitJS = true;
|
||||
} else if (exists(localBin + '.ts')) {
|
||||
bin = localBin + '.ts';
|
||||
isExplicitJS = true;
|
||||
} else if (exists(localBin)) {
|
||||
bin = localBin;
|
||||
}
|
||||
@@ -521,29 +553,38 @@ Command.prototype.executeSubCommand = function(argv, args, unknown) {
|
||||
var proc;
|
||||
if (process.platform !== 'win32') {
|
||||
if (isExplicitJS) {
|
||||
args.unshift(localBin);
|
||||
args.unshift(bin);
|
||||
// add executable arguments to spawn
|
||||
args = (process.execArgv || []).concat(args);
|
||||
|
||||
proc = spawn('node', args, { stdio: 'inherit', customFds: [0, 1, 2] });
|
||||
proc = spawn(process.argv[0], args, { stdio: 'inherit', customFds: [0, 1, 2] });
|
||||
} else {
|
||||
proc = spawn(bin, args, { stdio: 'inherit', customFds: [0, 1, 2] });
|
||||
}
|
||||
} else {
|
||||
args.unshift(localBin);
|
||||
proc = spawn(process.execPath, args, { stdio: 'inherit'});
|
||||
args.unshift(bin);
|
||||
proc = spawn(process.execPath, args, { stdio: 'inherit' });
|
||||
}
|
||||
|
||||
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);
|
||||
}
|
||||
});
|
||||
});
|
||||
proc.on('close', process.exit.bind(process));
|
||||
proc.on('error', function(err) {
|
||||
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);
|
||||
if (err.code === 'ENOENT') {
|
||||
console.error('error: %s(1) does not exist, try --help', bin);
|
||||
} else if (err.code === 'EACCES') {
|
||||
console.error('error: %s(1) not executable. try chmod or run with root', bin);
|
||||
}
|
||||
process.exit(1);
|
||||
});
|
||||
|
||||
// Store the reference to the child process
|
||||
this.runningCommand = proc;
|
||||
};
|
||||
|
||||
@@ -558,15 +599,15 @@ Command.prototype.executeSubCommand = function(argv, args, unknown) {
|
||||
*/
|
||||
|
||||
Command.prototype.normalize = function(args) {
|
||||
var ret = []
|
||||
, arg
|
||||
, lastOpt
|
||||
, index;
|
||||
var ret = [],
|
||||
arg,
|
||||
lastOpt,
|
||||
index;
|
||||
|
||||
for (var i = 0, len = args.length; i < len; ++i) {
|
||||
arg = args[i];
|
||||
if (i > 0) {
|
||||
lastOpt = this.optionFor(args[i-1]);
|
||||
lastOpt = this.optionFor(args[i - 1]);
|
||||
}
|
||||
|
||||
if (arg === '--') {
|
||||
@@ -575,7 +616,7 @@ Command.prototype.normalize = function(args) {
|
||||
break;
|
||||
} else if (lastOpt && lastOpt.required) {
|
||||
ret.push(arg);
|
||||
} else if (arg.length > 1 && '-' == arg[0] && '-' != arg[1]) {
|
||||
} else if (arg.length > 1 && arg[0] === '-' && arg[1] !== '-') {
|
||||
arg.slice(1).split('').forEach(function(c) {
|
||||
ret.push('-' + c);
|
||||
});
|
||||
@@ -606,10 +647,10 @@ Command.prototype.parseArgs = function(args, unknown) {
|
||||
|
||||
if (args.length) {
|
||||
name = args[0];
|
||||
if (this.listeners(name).length) {
|
||||
this.emit(args.shift(), args, unknown);
|
||||
if (this.listeners('command:' + name).length) {
|
||||
this.emit('command:' + args.shift(), args, unknown);
|
||||
} else {
|
||||
this.emit('*', args);
|
||||
this.emit('command:*', args);
|
||||
}
|
||||
} else {
|
||||
outputHelpIfNecessary(this, unknown);
|
||||
@@ -619,6 +660,10 @@ Command.prototype.parseArgs = function(args, unknown) {
|
||||
if (unknown.length > 0) {
|
||||
this.unknownOption(unknown[0]);
|
||||
}
|
||||
if (this.commands.length === 0 &&
|
||||
this._args.filter(function(a) { return a.required; }).length === 0) {
|
||||
this.emit('command:*');
|
||||
}
|
||||
}
|
||||
|
||||
return this;
|
||||
@@ -650,11 +695,11 @@ Command.prototype.optionFor = function(arg) {
|
||||
*/
|
||||
|
||||
Command.prototype.parseOptions = function(argv) {
|
||||
var args = []
|
||||
, len = argv.length
|
||||
, literal
|
||||
, option
|
||||
, arg;
|
||||
var args = [],
|
||||
len = argv.length,
|
||||
literal,
|
||||
option,
|
||||
arg;
|
||||
|
||||
var unknownOptions = [];
|
||||
|
||||
@@ -663,13 +708,13 @@ Command.prototype.parseOptions = function(argv) {
|
||||
arg = argv[i];
|
||||
|
||||
// literal args after --
|
||||
if ('--' == arg) {
|
||||
literal = true;
|
||||
if (literal) {
|
||||
args.push(arg);
|
||||
continue;
|
||||
}
|
||||
|
||||
if (literal) {
|
||||
args.push(arg);
|
||||
if (arg === '--') {
|
||||
literal = true;
|
||||
continue;
|
||||
}
|
||||
|
||||
@@ -681,32 +726,32 @@ Command.prototype.parseOptions = function(argv) {
|
||||
// requires arg
|
||||
if (option.required) {
|
||||
arg = argv[++i];
|
||||
if (null == arg) return this.optionMissingArgument(option);
|
||||
this.emit(option.name(), arg);
|
||||
if (arg == null) return this.optionMissingArgument(option);
|
||||
this.emit('option:' + option.name(), arg);
|
||||
// optional arg
|
||||
} else if (option.optional) {
|
||||
arg = argv[i+1];
|
||||
if (null == arg || ('-' == arg[0] && '-' != arg)) {
|
||||
arg = argv[i + 1];
|
||||
if (arg == null || (arg[0] === '-' && arg !== '-')) {
|
||||
arg = null;
|
||||
} else {
|
||||
++i;
|
||||
}
|
||||
this.emit(option.name(), arg);
|
||||
this.emit('option:' + option.name(), arg);
|
||||
// bool
|
||||
} else {
|
||||
this.emit(option.name());
|
||||
this.emit('option:' + option.name());
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
// looks like an option
|
||||
if (arg.length > 1 && '-' == arg[0]) {
|
||||
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]) {
|
||||
if ((i + 1) < argv.length && argv[i + 1][0] !== '-') {
|
||||
unknownOptions.push(argv[++i]);
|
||||
}
|
||||
continue;
|
||||
@@ -726,12 +771,12 @@ Command.prototype.parseOptions = function(argv) {
|
||||
* @api public
|
||||
*/
|
||||
Command.prototype.opts = function() {
|
||||
var result = {}
|
||||
, len = this.options.length;
|
||||
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];
|
||||
for (var i = 0; i < len; i++) {
|
||||
var key = this.options[i].attributeName();
|
||||
result[key] = key === this._versionOptionName ? this._version : this[key];
|
||||
}
|
||||
return result;
|
||||
};
|
||||
@@ -744,9 +789,7 @@ Command.prototype.opts = function() {
|
||||
*/
|
||||
|
||||
Command.prototype.missingArgument = function(name) {
|
||||
console.error();
|
||||
console.error(" error: missing required argument `%s'", name);
|
||||
console.error();
|
||||
console.error("error: missing required argument `%s'", name);
|
||||
process.exit(1);
|
||||
};
|
||||
|
||||
@@ -759,13 +802,11 @@ Command.prototype.missingArgument = function(name) {
|
||||
*/
|
||||
|
||||
Command.prototype.optionMissingArgument = function(option, flag) {
|
||||
console.error();
|
||||
if (flag) {
|
||||
console.error(" error: option `%s' argument missing, got `%s'", option.flags, 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("error: option `%s' argument missing", option.flags);
|
||||
}
|
||||
console.error();
|
||||
process.exit(1);
|
||||
};
|
||||
|
||||
@@ -778,9 +819,7 @@ Command.prototype.optionMissingArgument = function(option, flag) {
|
||||
|
||||
Command.prototype.unknownOption = function(flag) {
|
||||
if (this._allowUnknownOption) return;
|
||||
console.error();
|
||||
console.error(" error: unknown option `%s'", flag);
|
||||
console.error();
|
||||
console.error("error: unknown option `%s'", flag);
|
||||
process.exit(1);
|
||||
};
|
||||
|
||||
@@ -792,9 +831,7 @@ Command.prototype.unknownOption = function(flag) {
|
||||
*/
|
||||
|
||||
Command.prototype.variadicArgNotLast = function(name) {
|
||||
console.error();
|
||||
console.error(" error: variadic arguments must be last `%s'", name);
|
||||
console.error();
|
||||
console.error("error: variadic arguments must be last `%s'", name);
|
||||
process.exit(1);
|
||||
};
|
||||
|
||||
@@ -805,17 +842,19 @@ Command.prototype.variadicArgNotLast = function(name) {
|
||||
* which will print the version number when passed.
|
||||
*
|
||||
* @param {String} str
|
||||
* @param {String} flags
|
||||
* @param {String} [flags]
|
||||
* @return {Command} for chaining
|
||||
* @api public
|
||||
*/
|
||||
|
||||
Command.prototype.version = function(str, flags) {
|
||||
if (0 == arguments.length) return this._version;
|
||||
if (arguments.length === 0) return this._version;
|
||||
this._version = str;
|
||||
flags = flags || '-V, --version';
|
||||
this.option(flags, 'output the version number');
|
||||
this.on('version', function() {
|
||||
var versionOption = new Option(flags, 'output the version number');
|
||||
this._versionOptionName = versionOption.long.substr(2) || 'version';
|
||||
this.options.push(versionOption);
|
||||
this.on('option:' + this._versionOptionName, function() {
|
||||
process.stdout.write(str + '\n');
|
||||
process.exit(0);
|
||||
});
|
||||
@@ -826,13 +865,15 @@ Command.prototype.version = function(str, flags) {
|
||||
* Set the description to `str`.
|
||||
*
|
||||
* @param {String} str
|
||||
* @param {Object} argsDescription
|
||||
* @return {String|Command}
|
||||
* @api public
|
||||
*/
|
||||
|
||||
Command.prototype.description = function(str) {
|
||||
if (0 == arguments.length) return this._description;
|
||||
Command.prototype.description = function(str, argsDescription) {
|
||||
if (arguments.length === 0) return this._description;
|
||||
this._description = str;
|
||||
this._argsDescription = argsDescription;
|
||||
return this;
|
||||
};
|
||||
|
||||
@@ -845,8 +886,16 @@ Command.prototype.description = function(str) {
|
||||
*/
|
||||
|
||||
Command.prototype.alias = function(alias) {
|
||||
if (0 == arguments.length) return this._alias;
|
||||
this._alias = alias;
|
||||
var command = this;
|
||||
if (this.commands.length !== 0) {
|
||||
command = this.commands[this.commands.length - 1];
|
||||
}
|
||||
|
||||
if (arguments.length === 0) return command._alias;
|
||||
|
||||
if (alias === command._name) throw new Error('Command alias can\'t be the same as its name');
|
||||
|
||||
command._alias = alias;
|
||||
return this;
|
||||
};
|
||||
|
||||
@@ -863,26 +912,67 @@ Command.prototype.usage = function(str) {
|
||||
return humanReadableArgName(arg);
|
||||
});
|
||||
|
||||
var usage = '[options]'
|
||||
+ (this.commands.length ? ' [command]' : '')
|
||||
+ (this._args.length ? ' ' + args.join(' ') : '');
|
||||
var usage = '[options]' +
|
||||
(this.commands.length ? ' [command]' : '') +
|
||||
(this._args.length ? ' ' + args.join(' ') : '');
|
||||
|
||||
if (0 == arguments.length) return this._usage || usage;
|
||||
if (arguments.length === 0) return this._usage || usage;
|
||||
this._usage = str;
|
||||
|
||||
return this;
|
||||
};
|
||||
|
||||
/**
|
||||
* Get the name of the command
|
||||
* Get or set the name of the command
|
||||
*
|
||||
* @param {String} name
|
||||
* @param {String} str
|
||||
* @return {String|Command}
|
||||
* @api public
|
||||
*/
|
||||
|
||||
Command.prototype.name = function() {
|
||||
return this._name;
|
||||
Command.prototype.name = function(str) {
|
||||
if (arguments.length === 0) return this._name;
|
||||
this._name = str;
|
||||
return this;
|
||||
};
|
||||
|
||||
/**
|
||||
* Return prepared commands.
|
||||
*
|
||||
* @return {Array}
|
||||
* @api private
|
||||
*/
|
||||
|
||||
Command.prototype.prepareCommands = function() {
|
||||
return 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 ? ' ' + args : ''),
|
||||
cmd._description
|
||||
];
|
||||
});
|
||||
};
|
||||
|
||||
/**
|
||||
* Return the largest command length.
|
||||
*
|
||||
* @return {Number}
|
||||
* @api private
|
||||
*/
|
||||
|
||||
Command.prototype.largestCommandLength = function() {
|
||||
var commands = this.prepareCommands();
|
||||
return commands.reduce(function(max, command) {
|
||||
return Math.max(max, command[0].length);
|
||||
}, 0);
|
||||
};
|
||||
|
||||
/**
|
||||
@@ -893,11 +983,52 @@ Command.prototype.name = function() {
|
||||
*/
|
||||
|
||||
Command.prototype.largestOptionLength = function() {
|
||||
return this.options.reduce(function(max, option) {
|
||||
var options = [].slice.call(this.options);
|
||||
options.push({
|
||||
flags: '-h, --help'
|
||||
});
|
||||
return options.reduce(function(max, option) {
|
||||
return Math.max(max, option.flags.length);
|
||||
}, 0);
|
||||
};
|
||||
|
||||
/**
|
||||
* Return the largest arg length.
|
||||
*
|
||||
* @return {Number}
|
||||
* @api private
|
||||
*/
|
||||
|
||||
Command.prototype.largestArgLength = function() {
|
||||
return this._args.reduce(function(max, arg) {
|
||||
return Math.max(max, arg.name.length);
|
||||
}, 0);
|
||||
};
|
||||
|
||||
/**
|
||||
* Return the pad width.
|
||||
*
|
||||
* @return {Number}
|
||||
* @api private
|
||||
*/
|
||||
|
||||
Command.prototype.padWidth = function() {
|
||||
var width = this.largestOptionLength();
|
||||
if (this._argsDescription && this._args.length) {
|
||||
if (this.largestArgLength() > width) {
|
||||
width = this.largestArgLength();
|
||||
}
|
||||
}
|
||||
|
||||
if (this.commands && this.commands.length) {
|
||||
if (this.largestCommandLength() > width) {
|
||||
width = this.largestCommandLength();
|
||||
}
|
||||
}
|
||||
|
||||
return width;
|
||||
};
|
||||
|
||||
/**
|
||||
* Return help for options.
|
||||
*
|
||||
@@ -906,13 +1037,13 @@ Command.prototype.largestOptionLength = function() {
|
||||
*/
|
||||
|
||||
Command.prototype.optionHelp = function() {
|
||||
var width = this.largestOptionLength();
|
||||
var width = this.padWidth();
|
||||
|
||||
// Prepend the help information
|
||||
return [pad('-h, --help', width) + ' ' + 'output usage information']
|
||||
.concat(this.options.map(function(option) {
|
||||
return pad(option.flags, width) + ' ' + option.description;
|
||||
}))
|
||||
// Append the help information
|
||||
return this.options.map(function(option) {
|
||||
return pad(option.flags, width) + ' ' + option.description +
|
||||
((option.bool && option.defaultValue !== undefined) ? ' (default: ' + JSON.stringify(option.defaultValue) + ')' : '');
|
||||
}).concat([pad('-h, --help', width) + ' ' + 'output usage information'])
|
||||
.join('\n');
|
||||
};
|
||||
|
||||
@@ -926,38 +1057,16 @@ Command.prototype.optionHelp = function() {
|
||||
Command.prototype.commandHelp = function() {
|
||||
if (!this.commands.length) return '';
|
||||
|
||||
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
|
||||
, cmd.description()
|
||||
];
|
||||
});
|
||||
|
||||
var width = commands.reduce(function(max, command) {
|
||||
return Math.max(max, command[0].length);
|
||||
}, 0);
|
||||
var commands = this.prepareCommands();
|
||||
var width = this.padWidth();
|
||||
|
||||
return [
|
||||
''
|
||||
, ' Commands:'
|
||||
, ''
|
||||
, commands.map(function(cmd) {
|
||||
return pad(cmd[0], width) + ' ' + cmd[1];
|
||||
}).join('\n').replace(/^/gm, ' ')
|
||||
, ''
|
||||
'Commands:',
|
||||
commands.map(function(cmd) {
|
||||
var desc = cmd[1] ? ' ' + cmd[1] : '';
|
||||
return (desc ? pad(cmd[0], width) : cmd[0]) + desc;
|
||||
}).join('\n').replace(/^/gm, ' '),
|
||||
''
|
||||
].join('\n');
|
||||
};
|
||||
|
||||
@@ -972,9 +1081,20 @@ Command.prototype.helpInformation = function() {
|
||||
var desc = [];
|
||||
if (this._description) {
|
||||
desc = [
|
||||
' ' + this._description
|
||||
, ''
|
||||
this._description,
|
||||
''
|
||||
];
|
||||
|
||||
var argsDescription = this._argsDescription;
|
||||
if (argsDescription && this._args.length) {
|
||||
var width = this.padWidth();
|
||||
desc.push('Arguments:');
|
||||
desc.push('');
|
||||
this._args.forEach(function(arg) {
|
||||
desc.push(' ' + pad(arg.name, width) + ' ' + argsDescription[arg.name]);
|
||||
});
|
||||
desc.push('');
|
||||
}
|
||||
}
|
||||
|
||||
var cmdName = this._name;
|
||||
@@ -982,9 +1102,8 @@ Command.prototype.helpInformation = function() {
|
||||
cmdName = cmdName + '|' + this._alias;
|
||||
}
|
||||
var usage = [
|
||||
'Usage: ' + cmdName + ' ' + this.usage(),
|
||||
''
|
||||
,' Usage: ' + cmdName + ' ' + this.usage()
|
||||
, ''
|
||||
];
|
||||
|
||||
var cmds = [];
|
||||
@@ -992,17 +1111,15 @@ Command.prototype.helpInformation = function() {
|
||||
if (commandHelp) cmds = [commandHelp];
|
||||
|
||||
var options = [
|
||||
' Options:'
|
||||
, ''
|
||||
, '' + this.optionHelp().replace(/^/gm, ' ')
|
||||
, ''
|
||||
, ''
|
||||
'Options:',
|
||||
'' + this.optionHelp().replace(/^/gm, ' '),
|
||||
''
|
||||
];
|
||||
|
||||
return usage
|
||||
.concat(cmds)
|
||||
.concat(desc)
|
||||
.concat(options)
|
||||
.concat(cmds)
|
||||
.join('\n');
|
||||
};
|
||||
|
||||
@@ -1012,8 +1129,13 @@ Command.prototype.helpInformation = function() {
|
||||
* @api public
|
||||
*/
|
||||
|
||||
Command.prototype.outputHelp = function() {
|
||||
process.stdout.write(this.helpInformation());
|
||||
Command.prototype.outputHelp = function(cb) {
|
||||
if (!cb) {
|
||||
cb = function(passthru) {
|
||||
return passthru;
|
||||
};
|
||||
}
|
||||
process.stdout.write(cb(this.helpInformation()));
|
||||
this.emit('--help');
|
||||
};
|
||||
|
||||
@@ -1023,8 +1145,8 @@ Command.prototype.outputHelp = function() {
|
||||
* @api public
|
||||
*/
|
||||
|
||||
Command.prototype.help = function() {
|
||||
this.outputHelp();
|
||||
Command.prototype.help = function(cb) {
|
||||
this.outputHelp(cb);
|
||||
process.exit();
|
||||
};
|
||||
|
||||
@@ -1067,7 +1189,7 @@ function pad(str, width) {
|
||||
function outputHelpIfNecessary(cmd, options) {
|
||||
options = options || [];
|
||||
for (var i = 0; i < options.length; i++) {
|
||||
if (options[i] == '--help' || options[i] == '-h') {
|
||||
if (options[i] === '--help' || options[i] === '-h') {
|
||||
cmd.outputHelp();
|
||||
process.exit(0);
|
||||
}
|
||||
@@ -1087,7 +1209,7 @@ function humanReadableArgName(arg) {
|
||||
|
||||
return arg.required
|
||||
? '<' + nameOutput + '>'
|
||||
: '[' + nameOutput + ']'
|
||||
: '[' + nameOutput + ']';
|
||||
}
|
||||
|
||||
// for versions before node v0.8 when there weren't `fs.existsSync`
|
||||
@@ -1100,4 +1222,3 @@ function exists(file) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
+18
-13
@@ -1,8 +1,9 @@
|
||||
{
|
||||
"name": "commander",
|
||||
"version": "2.8.1",
|
||||
"version": "2.20.3",
|
||||
"description": "the complete solution for node.js command-line programs",
|
||||
"keywords": [
|
||||
"commander",
|
||||
"command",
|
||||
"option",
|
||||
"parser"
|
||||
@@ -13,21 +14,25 @@
|
||||
"type": "git",
|
||||
"url": "https://github.com/tj/commander.js.git"
|
||||
},
|
||||
"devDependencies": {
|
||||
"should": ">= 0.0.1",
|
||||
"sinon": ">= 1.14.1"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "make test"
|
||||
"lint": "eslint index.js",
|
||||
"test": "node test/run.js && npm run test-typings",
|
||||
"test-typings": "tsc -p tsconfig.json"
|
||||
},
|
||||
"main": "index",
|
||||
"engines": {
|
||||
"node": ">= 0.6.x"
|
||||
},
|
||||
"files": [
|
||||
"index.js"
|
||||
"index.js",
|
||||
"typings/index.d.ts"
|
||||
],
|
||||
"dependencies": {
|
||||
"graceful-readlink": ">= 1.0.0"
|
||||
}
|
||||
"dependencies": {},
|
||||
"devDependencies": {
|
||||
"@types/node": "^12.7.8",
|
||||
"eslint": "^6.4.0",
|
||||
"should": "^13.2.3",
|
||||
"sinon": "^7.5.0",
|
||||
"standard": "^14.3.1",
|
||||
"ts-node": "^8.4.1",
|
||||
"typescript": "^3.6.3"
|
||||
},
|
||||
"typings": "typings/index.d.ts"
|
||||
}
|
||||
|
||||
+310
@@ -0,0 +1,310 @@
|
||||
// Type definitions for commander 2.11
|
||||
// Project: https://github.com/visionmedia/commander.js
|
||||
// Definitions by: Alan Agius <https://github.com/alan-agius4>, Marcelo Dezem <https://github.com/mdezem>, vvakame <https://github.com/vvakame>, Jules Randolph <https://github.com/sveinburne>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
declare namespace local {
|
||||
|
||||
class Option {
|
||||
flags: string;
|
||||
required: boolean;
|
||||
optional: boolean;
|
||||
bool: boolean;
|
||||
short?: string;
|
||||
long: string;
|
||||
description: string;
|
||||
|
||||
/**
|
||||
* Initialize a new `Option` with the given `flags` and `description`.
|
||||
*
|
||||
* @param {string} flags
|
||||
* @param {string} [description]
|
||||
*/
|
||||
constructor(flags: string, description?: string);
|
||||
}
|
||||
|
||||
class Command extends NodeJS.EventEmitter {
|
||||
[key: string]: any;
|
||||
|
||||
args: string[];
|
||||
|
||||
/**
|
||||
* Initialize a new `Command`.
|
||||
*
|
||||
* @param {string} [name]
|
||||
*/
|
||||
constructor(name?: string);
|
||||
|
||||
/**
|
||||
* 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
|
||||
* @param {string} [flags]
|
||||
* @returns {Command} for chaining
|
||||
*/
|
||||
version(str: string, flags?: string): Command;
|
||||
|
||||
/**
|
||||
* 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.
|
||||
*
|
||||
* @example
|
||||
* 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')
|
||||
* .action(function() {
|
||||
* console.log('setup');
|
||||
* });
|
||||
*
|
||||
* program
|
||||
* .command('exec <cmd>')
|
||||
* .description('run the given remote command')
|
||||
* .action(function(cmd) {
|
||||
* console.log('exec "%s"', cmd);
|
||||
* });
|
||||
*
|
||||
* program
|
||||
* .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
|
||||
* .command('*')
|
||||
* .description('deploy the given env')
|
||||
* .action(function(env) {
|
||||
* console.log('deploying "%s"', env);
|
||||
* });
|
||||
*
|
||||
* program.parse(process.argv);
|
||||
*
|
||||
* @param {string} name
|
||||
* @param {string} [desc] for git-style sub-commands
|
||||
* @param {CommandOptions} [opts] command options
|
||||
* @returns {Command} the new command
|
||||
*/
|
||||
command(name: string, desc?: string, opts?: commander.CommandOptions): Command;
|
||||
|
||||
/**
|
||||
* Define argument syntax for the top-level command.
|
||||
*
|
||||
* @param {string} desc
|
||||
* @returns {Command} for chaining
|
||||
*/
|
||||
arguments(desc: string): Command;
|
||||
|
||||
/**
|
||||
* Parse expected `args`.
|
||||
*
|
||||
* For example `["[type]"]` becomes `[{ required: false, name: 'type' }]`.
|
||||
*
|
||||
* @param {string[]} args
|
||||
* @returns {Command} for chaining
|
||||
*/
|
||||
parseExpectedArgs(args: string[]): Command;
|
||||
|
||||
/**
|
||||
* Register callback `fn` for the command.
|
||||
*
|
||||
* @example
|
||||
* program
|
||||
* .command('help')
|
||||
* .description('display verbose help')
|
||||
* .action(function() {
|
||||
* // output help here
|
||||
* });
|
||||
*
|
||||
* @param {(...args: any[]) => void} fn
|
||||
* @returns {Command} for chaining
|
||||
*/
|
||||
action(fn: (...args: any[]) => void): Command;
|
||||
|
||||
/**
|
||||
* 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"
|
||||
*
|
||||
* @example
|
||||
* // 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]
|
||||
* @param {((arg1: any, arg2: any) => void) | RegExp} [fn] function or default
|
||||
* @param {*} [defaultValue]
|
||||
* @returns {Command} for chaining
|
||||
*/
|
||||
option(flags: string, description?: string, fn?: ((arg1: any, arg2: any) => void) | RegExp, defaultValue?: any): Command;
|
||||
option(flags: string, description?: string, defaultValue?: any): Command;
|
||||
|
||||
/**
|
||||
* Allow unknown options on the command line.
|
||||
*
|
||||
* @param {boolean} [arg] if `true` or omitted, no error will be thrown for unknown options.
|
||||
* @returns {Command} for chaining
|
||||
*/
|
||||
allowUnknownOption(arg?: boolean): Command;
|
||||
|
||||
/**
|
||||
* Parse `argv`, settings options and invoking commands when defined.
|
||||
*
|
||||
* @param {string[]} argv
|
||||
* @returns {Command} for chaining
|
||||
*/
|
||||
parse(argv: string[]): Command;
|
||||
|
||||
/**
|
||||
* Parse options from `argv` returning `argv` void of these options.
|
||||
*
|
||||
* @param {string[]} argv
|
||||
* @returns {ParseOptionsResult}
|
||||
*/
|
||||
parseOptions(argv: string[]): commander.ParseOptionsResult;
|
||||
|
||||
/**
|
||||
* Return an object containing options as key-value pairs
|
||||
*
|
||||
* @returns {{[key: string]: any}}
|
||||
*/
|
||||
opts(): { [key: string]: any };
|
||||
|
||||
/**
|
||||
* Set the description to `str`.
|
||||
*
|
||||
* @param {string} str
|
||||
* @param {{[argName: string]: string}} argsDescription
|
||||
* @return {(Command | string)}
|
||||
*/
|
||||
description(str: string, argsDescription?: {[argName: string]: string}): Command;
|
||||
description(): string;
|
||||
|
||||
/**
|
||||
* Set an alias for the command.
|
||||
*
|
||||
* @param {string} alias
|
||||
* @return {(Command | string)}
|
||||
*/
|
||||
alias(alias: string): Command;
|
||||
alias(): string;
|
||||
|
||||
/**
|
||||
* Set or get the command usage.
|
||||
*
|
||||
* @param {string} str
|
||||
* @return {(Command | string)}
|
||||
*/
|
||||
usage(str: string): Command;
|
||||
usage(): string;
|
||||
|
||||
/**
|
||||
* Set the name of the command.
|
||||
*
|
||||
* @param {string} str
|
||||
* @return {Command}
|
||||
*/
|
||||
name(str: string): Command;
|
||||
|
||||
/**
|
||||
* Get the name of the command.
|
||||
*
|
||||
* @return {string}
|
||||
*/
|
||||
name(): string;
|
||||
|
||||
/**
|
||||
* Output help information for this command.
|
||||
*
|
||||
* @param {(str: string) => string} [cb]
|
||||
*/
|
||||
outputHelp(cb?: (str: string) => string): void;
|
||||
|
||||
/** Output help information and exit.
|
||||
*
|
||||
* @param {(str: string) => string} [cb]
|
||||
*/
|
||||
help(cb?: (str: string) => string): never;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
declare namespace commander {
|
||||
|
||||
type Command = local.Command
|
||||
|
||||
type Option = local.Option
|
||||
|
||||
interface CommandOptions {
|
||||
noHelp?: boolean;
|
||||
isDefault?: boolean;
|
||||
}
|
||||
|
||||
interface ParseOptionsResult {
|
||||
args: string[];
|
||||
unknown: string[];
|
||||
}
|
||||
|
||||
interface CommanderStatic extends Command {
|
||||
Command: typeof local.Command;
|
||||
Option: typeof local.Option;
|
||||
CommandOptions: CommandOptions;
|
||||
ParseOptionsResult: ParseOptionsResult;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
declare const commander: commander.CommanderStatic;
|
||||
export = commander;
|
||||
Reference in New Issue
Block a user