fix: a
This commit is contained in:
16
node_modules/commander/lib/argument.js
generated
vendored
16
node_modules/commander/lib/argument.js
generated
vendored
@@ -50,7 +50,7 @@ class Argument {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api private
|
||||
* @package
|
||||
*/
|
||||
|
||||
_concatValue(value, previous) {
|
||||
@@ -98,7 +98,9 @@ class Argument {
|
||||
this.argChoices = values.slice();
|
||||
this.parseArg = (arg, previous) => {
|
||||
if (!this.argChoices.includes(arg)) {
|
||||
throw new InvalidArgumentError(`Allowed choices are ${this.argChoices.join(', ')}.`);
|
||||
throw new InvalidArgumentError(
|
||||
`Allowed choices are ${this.argChoices.join(', ')}.`,
|
||||
);
|
||||
}
|
||||
if (this.variadic) {
|
||||
return this._concatValue(arg, previous);
|
||||
@@ -110,6 +112,8 @@ class Argument {
|
||||
|
||||
/**
|
||||
* Make argument required.
|
||||
*
|
||||
* @returns {Argument}
|
||||
*/
|
||||
argRequired() {
|
||||
this.required = true;
|
||||
@@ -118,6 +122,8 @@ class Argument {
|
||||
|
||||
/**
|
||||
* Make argument optional.
|
||||
*
|
||||
* @returns {Argument}
|
||||
*/
|
||||
argOptional() {
|
||||
this.required = false;
|
||||
@@ -130,15 +136,13 @@ class Argument {
|
||||
*
|
||||
* @param {Argument} arg
|
||||
* @return {string}
|
||||
* @api private
|
||||
* @private
|
||||
*/
|
||||
|
||||
function humanReadableArgName(arg) {
|
||||
const nameOutput = arg.name() + (arg.variadic === true ? '...' : '');
|
||||
|
||||
return arg.required
|
||||
? '<' + nameOutput + '>'
|
||||
: '[' + nameOutput + ']';
|
||||
return arg.required ? '<' + nameOutput + '>' : '[' + nameOutput + ']';
|
||||
}
|
||||
|
||||
exports.Argument = Argument;
|
||||
|
||||
1191
node_modules/commander/lib/command.js
generated
vendored
1191
node_modules/commander/lib/command.js
generated
vendored
File diff suppressed because it is too large
Load Diff
4
node_modules/commander/lib/error.js
generated
vendored
4
node_modules/commander/lib/error.js
generated
vendored
@@ -1,6 +1,5 @@
|
||||
/**
|
||||
* CommanderError class
|
||||
* @class
|
||||
*/
|
||||
class CommanderError extends Error {
|
||||
/**
|
||||
@@ -8,7 +7,6 @@ class CommanderError extends Error {
|
||||
* @param {number} exitCode suggested exit code which could be used with process.exit
|
||||
* @param {string} code an id string representing the error
|
||||
* @param {string} message human-readable description of the error
|
||||
* @constructor
|
||||
*/
|
||||
constructor(exitCode, code, message) {
|
||||
super(message);
|
||||
@@ -23,13 +21,11 @@ class CommanderError extends Error {
|
||||
|
||||
/**
|
||||
* InvalidArgumentError class
|
||||
* @class
|
||||
*/
|
||||
class InvalidArgumentError extends CommanderError {
|
||||
/**
|
||||
* Constructs the InvalidArgumentError class
|
||||
* @param {string} [message] explanation of why argument is invalid
|
||||
* @constructor
|
||||
*/
|
||||
constructor(message) {
|
||||
super(1, 'commander.invalidArgument', message);
|
||||
|
||||
447
node_modules/commander/lib/help.js
generated
vendored
447
node_modules/commander/lib/help.js
generated
vendored
@@ -12,11 +12,24 @@ const { humanReadableArgName } = require('./argument.js');
|
||||
class Help {
|
||||
constructor() {
|
||||
this.helpWidth = undefined;
|
||||
this.minWidthToWrap = 40;
|
||||
this.sortSubcommands = false;
|
||||
this.sortOptions = false;
|
||||
this.showGlobalOptions = false;
|
||||
}
|
||||
|
||||
/**
|
||||
* prepareContext is called by Commander after applying overrides from `Command.configureHelp()`
|
||||
* and just before calling `formatHelp()`.
|
||||
*
|
||||
* Commander just uses the helpWidth and the rest is provided for optional use by more complex subclasses.
|
||||
*
|
||||
* @param {{ error?: boolean, helpWidth?: number, outputHasColors?: boolean }} contextOptions
|
||||
*/
|
||||
prepareContext(contextOptions) {
|
||||
this.helpWidth = this.helpWidth ?? contextOptions.helpWidth ?? 80;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an array of the visible subcommands. Includes a placeholder for the implicit help command, if there is one.
|
||||
*
|
||||
@@ -25,19 +38,14 @@ class Help {
|
||||
*/
|
||||
|
||||
visibleCommands(cmd) {
|
||||
const visibleCommands = cmd.commands.filter(cmd => !cmd._hidden);
|
||||
if (cmd._hasImplicitHelpCommand()) {
|
||||
// Create a command matching the implicit help command.
|
||||
const [, helpName, helpArgs] = cmd._helpCommandnameAndArgs.match(/([^ ]+) *(.*)/);
|
||||
const helpCommand = cmd.createCommand(helpName)
|
||||
.helpOption(false);
|
||||
helpCommand.description(cmd._helpCommandDescription);
|
||||
if (helpArgs) helpCommand.arguments(helpArgs);
|
||||
const visibleCommands = cmd.commands.filter((cmd) => !cmd._hidden);
|
||||
const helpCommand = cmd._getHelpCommand();
|
||||
if (helpCommand && !helpCommand._hidden) {
|
||||
visibleCommands.push(helpCommand);
|
||||
}
|
||||
if (this.sortSubcommands) {
|
||||
visibleCommands.sort((a, b) => {
|
||||
// @ts-ignore: overloaded return type
|
||||
// @ts-ignore: because overloaded return type
|
||||
return a.name().localeCompare(b.name());
|
||||
});
|
||||
}
|
||||
@@ -49,12 +57,14 @@ class Help {
|
||||
*
|
||||
* @param {Option} a
|
||||
* @param {Option} b
|
||||
* @returns number
|
||||
* @returns {number}
|
||||
*/
|
||||
compareOptions(a, b) {
|
||||
const getSortKey = (option) => {
|
||||
// WYSIWYG for order displayed in help. Short used for comparison if present. No special handling for negated.
|
||||
return option.short ? option.short.replace(/^-/, '') : option.long.replace(/^--/, '');
|
||||
return option.short
|
||||
? option.short.replace(/^-/, '')
|
||||
: option.long.replace(/^--/, '');
|
||||
};
|
||||
return getSortKey(a).localeCompare(getSortKey(b));
|
||||
}
|
||||
@@ -68,19 +78,23 @@ class Help {
|
||||
|
||||
visibleOptions(cmd) {
|
||||
const visibleOptions = cmd.options.filter((option) => !option.hidden);
|
||||
// Implicit help
|
||||
const showShortHelpFlag = cmd._hasHelpOption && cmd._helpShortFlag && !cmd._findOption(cmd._helpShortFlag);
|
||||
const showLongHelpFlag = cmd._hasHelpOption && !cmd._findOption(cmd._helpLongFlag);
|
||||
if (showShortHelpFlag || showLongHelpFlag) {
|
||||
let helpOption;
|
||||
if (!showShortHelpFlag) {
|
||||
helpOption = cmd.createOption(cmd._helpLongFlag, cmd._helpDescription);
|
||||
} else if (!showLongHelpFlag) {
|
||||
helpOption = cmd.createOption(cmd._helpShortFlag, cmd._helpDescription);
|
||||
} else {
|
||||
helpOption = cmd.createOption(cmd._helpFlags, cmd._helpDescription);
|
||||
// Built-in help option.
|
||||
const helpOption = cmd._getHelpOption();
|
||||
if (helpOption && !helpOption.hidden) {
|
||||
// Automatically hide conflicting flags. Bit dubious but a historical behaviour that is convenient for single-command programs.
|
||||
const removeShort = helpOption.short && cmd._findOption(helpOption.short);
|
||||
const removeLong = helpOption.long && cmd._findOption(helpOption.long);
|
||||
if (!removeShort && !removeLong) {
|
||||
visibleOptions.push(helpOption); // no changes needed
|
||||
} else if (helpOption.long && !removeLong) {
|
||||
visibleOptions.push(
|
||||
cmd.createOption(helpOption.long, helpOption.description),
|
||||
);
|
||||
} else if (helpOption.short && !removeShort) {
|
||||
visibleOptions.push(
|
||||
cmd.createOption(helpOption.short, helpOption.description),
|
||||
);
|
||||
}
|
||||
visibleOptions.push(helpOption);
|
||||
}
|
||||
if (this.sortOptions) {
|
||||
visibleOptions.sort(this.compareOptions);
|
||||
@@ -99,8 +113,14 @@ class Help {
|
||||
if (!this.showGlobalOptions) return [];
|
||||
|
||||
const globalOptions = [];
|
||||
for (let ancestorCmd = cmd.parent; ancestorCmd; ancestorCmd = ancestorCmd.parent) {
|
||||
const visibleOptions = ancestorCmd.options.filter((option) => !option.hidden);
|
||||
for (
|
||||
let ancestorCmd = cmd.parent;
|
||||
ancestorCmd;
|
||||
ancestorCmd = ancestorCmd.parent
|
||||
) {
|
||||
const visibleOptions = ancestorCmd.options.filter(
|
||||
(option) => !option.hidden,
|
||||
);
|
||||
globalOptions.push(...visibleOptions);
|
||||
}
|
||||
if (this.sortOptions) {
|
||||
@@ -119,13 +139,14 @@ class Help {
|
||||
visibleArguments(cmd) {
|
||||
// Side effect! Apply the legacy descriptions before the arguments are displayed.
|
||||
if (cmd._argsDescription) {
|
||||
cmd.registeredArguments.forEach(argument => {
|
||||
argument.description = argument.description || cmd._argsDescription[argument.name()] || '';
|
||||
cmd.registeredArguments.forEach((argument) => {
|
||||
argument.description =
|
||||
argument.description || cmd._argsDescription[argument.name()] || '';
|
||||
});
|
||||
}
|
||||
|
||||
// If there are any arguments with a description then return all the arguments.
|
||||
if (cmd.registeredArguments.find(argument => argument.description)) {
|
||||
if (cmd.registeredArguments.find((argument) => argument.description)) {
|
||||
return cmd.registeredArguments;
|
||||
}
|
||||
return [];
|
||||
@@ -140,11 +161,15 @@ class Help {
|
||||
|
||||
subcommandTerm(cmd) {
|
||||
// Legacy. Ignores custom usage string, and nested commands.
|
||||
const args = cmd.registeredArguments.map(arg => humanReadableArgName(arg)).join(' ');
|
||||
return cmd._name +
|
||||
const args = cmd.registeredArguments
|
||||
.map((arg) => humanReadableArgName(arg))
|
||||
.join(' ');
|
||||
return (
|
||||
cmd._name +
|
||||
(cmd._aliases[0] ? '|' + cmd._aliases[0] : '') +
|
||||
(cmd.options.length ? ' [options]' : '') + // simplistic check for non-help option
|
||||
(args ? ' ' + args : '');
|
||||
(args ? ' ' + args : '')
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -179,7 +204,12 @@ class Help {
|
||||
|
||||
longestSubcommandTermLength(cmd, helper) {
|
||||
return helper.visibleCommands(cmd).reduce((max, command) => {
|
||||
return Math.max(max, helper.subcommandTerm(command).length);
|
||||
return Math.max(
|
||||
max,
|
||||
this.displayWidth(
|
||||
helper.styleSubcommandTerm(helper.subcommandTerm(command)),
|
||||
),
|
||||
);
|
||||
}, 0);
|
||||
}
|
||||
|
||||
@@ -193,7 +223,10 @@ class Help {
|
||||
|
||||
longestOptionTermLength(cmd, helper) {
|
||||
return helper.visibleOptions(cmd).reduce((max, option) => {
|
||||
return Math.max(max, helper.optionTerm(option).length);
|
||||
return Math.max(
|
||||
max,
|
||||
this.displayWidth(helper.styleOptionTerm(helper.optionTerm(option))),
|
||||
);
|
||||
}, 0);
|
||||
}
|
||||
|
||||
@@ -207,7 +240,10 @@ class Help {
|
||||
|
||||
longestGlobalOptionTermLength(cmd, helper) {
|
||||
return helper.visibleGlobalOptions(cmd).reduce((max, option) => {
|
||||
return Math.max(max, helper.optionTerm(option).length);
|
||||
return Math.max(
|
||||
max,
|
||||
this.displayWidth(helper.styleOptionTerm(helper.optionTerm(option))),
|
||||
);
|
||||
}, 0);
|
||||
}
|
||||
|
||||
@@ -221,7 +257,12 @@ class Help {
|
||||
|
||||
longestArgumentTermLength(cmd, helper) {
|
||||
return helper.visibleArguments(cmd).reduce((max, argument) => {
|
||||
return Math.max(max, helper.argumentTerm(argument).length);
|
||||
return Math.max(
|
||||
max,
|
||||
this.displayWidth(
|
||||
helper.styleArgumentTerm(helper.argumentTerm(argument)),
|
||||
),
|
||||
);
|
||||
}, 0);
|
||||
}
|
||||
|
||||
@@ -239,7 +280,11 @@ class Help {
|
||||
cmdName = cmdName + '|' + cmd._aliases[0];
|
||||
}
|
||||
let ancestorCmdNames = '';
|
||||
for (let ancestorCmd = cmd.parent; ancestorCmd; ancestorCmd = ancestorCmd.parent) {
|
||||
for (
|
||||
let ancestorCmd = cmd.parent;
|
||||
ancestorCmd;
|
||||
ancestorCmd = ancestorCmd.parent
|
||||
) {
|
||||
ancestorCmdNames = ancestorCmd.name() + ' ' + ancestorCmdNames;
|
||||
}
|
||||
return ancestorCmdNames + cmdName + ' ' + cmd.usage();
|
||||
@@ -253,7 +298,7 @@ class Help {
|
||||
*/
|
||||
|
||||
commandDescription(cmd) {
|
||||
// @ts-ignore: overloaded return type
|
||||
// @ts-ignore: because overloaded return type
|
||||
return cmd.description();
|
||||
}
|
||||
|
||||
@@ -266,7 +311,7 @@ class Help {
|
||||
*/
|
||||
|
||||
subcommandDescription(cmd) {
|
||||
// @ts-ignore: overloaded return type
|
||||
// @ts-ignore: because overloaded return type
|
||||
return cmd.summary() || cmd.description();
|
||||
}
|
||||
|
||||
@@ -283,15 +328,20 @@ class Help {
|
||||
if (option.argChoices) {
|
||||
extraInfo.push(
|
||||
// use stringify to match the display of the default value
|
||||
`choices: ${option.argChoices.map((choice) => JSON.stringify(choice)).join(', ')}`);
|
||||
`choices: ${option.argChoices.map((choice) => JSON.stringify(choice)).join(', ')}`,
|
||||
);
|
||||
}
|
||||
if (option.defaultValue !== undefined) {
|
||||
// default for boolean and negated more for programmer than end user,
|
||||
// but show true/false for boolean option as may be for hand-rolled env or config processing.
|
||||
const showDefault = option.required || option.optional ||
|
||||
const showDefault =
|
||||
option.required ||
|
||||
option.optional ||
|
||||
(option.isBoolean() && typeof option.defaultValue === 'boolean');
|
||||
if (showDefault) {
|
||||
extraInfo.push(`default: ${option.defaultValueDescription || JSON.stringify(option.defaultValue)}`);
|
||||
extraInfo.push(
|
||||
`default: ${option.defaultValueDescription || JSON.stringify(option.defaultValue)}`,
|
||||
);
|
||||
}
|
||||
}
|
||||
// preset for boolean and negated are more for programmer than end user
|
||||
@@ -320,17 +370,20 @@ class Help {
|
||||
if (argument.argChoices) {
|
||||
extraInfo.push(
|
||||
// use stringify to match the display of the default value
|
||||
`choices: ${argument.argChoices.map((choice) => JSON.stringify(choice)).join(', ')}`);
|
||||
`choices: ${argument.argChoices.map((choice) => JSON.stringify(choice)).join(', ')}`,
|
||||
);
|
||||
}
|
||||
if (argument.defaultValue !== undefined) {
|
||||
extraInfo.push(`default: ${argument.defaultValueDescription || JSON.stringify(argument.defaultValue)}`);
|
||||
extraInfo.push(
|
||||
`default: ${argument.defaultValueDescription || JSON.stringify(argument.defaultValue)}`,
|
||||
);
|
||||
}
|
||||
if (extraInfo.length > 0) {
|
||||
const extraDescripton = `(${extraInfo.join(', ')})`;
|
||||
const extraDescription = `(${extraInfo.join(', ')})`;
|
||||
if (argument.description) {
|
||||
return `${argument.description} ${extraDescripton}`;
|
||||
return `${argument.description} ${extraDescription}`;
|
||||
}
|
||||
return extraDescripton;
|
||||
return extraDescription;
|
||||
}
|
||||
return argument.description;
|
||||
}
|
||||
@@ -345,65 +398,177 @@ class Help {
|
||||
|
||||
formatHelp(cmd, helper) {
|
||||
const termWidth = helper.padWidth(cmd, helper);
|
||||
const helpWidth = helper.helpWidth || 80;
|
||||
const itemIndentWidth = 2;
|
||||
const itemSeparatorWidth = 2; // between term and description
|
||||
function formatItem(term, description) {
|
||||
if (description) {
|
||||
const fullText = `${term.padEnd(termWidth + itemSeparatorWidth)}${description}`;
|
||||
return helper.wrap(fullText, helpWidth - itemIndentWidth, termWidth + itemSeparatorWidth);
|
||||
}
|
||||
return term;
|
||||
}
|
||||
function formatList(textArray) {
|
||||
return textArray.join('\n').replace(/^/gm, ' '.repeat(itemIndentWidth));
|
||||
const helpWidth = helper.helpWidth ?? 80; // in case prepareContext() was not called
|
||||
|
||||
function callFormatItem(term, description) {
|
||||
return helper.formatItem(term, termWidth, description, helper);
|
||||
}
|
||||
|
||||
// Usage
|
||||
let output = [`Usage: ${helper.commandUsage(cmd)}`, ''];
|
||||
let output = [
|
||||
`${helper.styleTitle('Usage:')} ${helper.styleUsage(helper.commandUsage(cmd))}`,
|
||||
'',
|
||||
];
|
||||
|
||||
// Description
|
||||
const commandDescription = helper.commandDescription(cmd);
|
||||
if (commandDescription.length > 0) {
|
||||
output = output.concat([helper.wrap(commandDescription, helpWidth, 0), '']);
|
||||
output = output.concat([
|
||||
helper.boxWrap(
|
||||
helper.styleCommandDescription(commandDescription),
|
||||
helpWidth,
|
||||
),
|
||||
'',
|
||||
]);
|
||||
}
|
||||
|
||||
// Arguments
|
||||
const argumentList = helper.visibleArguments(cmd).map((argument) => {
|
||||
return formatItem(helper.argumentTerm(argument), helper.argumentDescription(argument));
|
||||
return callFormatItem(
|
||||
helper.styleArgumentTerm(helper.argumentTerm(argument)),
|
||||
helper.styleArgumentDescription(helper.argumentDescription(argument)),
|
||||
);
|
||||
});
|
||||
if (argumentList.length > 0) {
|
||||
output = output.concat(['Arguments:', formatList(argumentList), '']);
|
||||
output = output.concat([
|
||||
helper.styleTitle('Arguments:'),
|
||||
...argumentList,
|
||||
'',
|
||||
]);
|
||||
}
|
||||
|
||||
// Options
|
||||
const optionList = helper.visibleOptions(cmd).map((option) => {
|
||||
return formatItem(helper.optionTerm(option), helper.optionDescription(option));
|
||||
return callFormatItem(
|
||||
helper.styleOptionTerm(helper.optionTerm(option)),
|
||||
helper.styleOptionDescription(helper.optionDescription(option)),
|
||||
);
|
||||
});
|
||||
if (optionList.length > 0) {
|
||||
output = output.concat(['Options:', formatList(optionList), '']);
|
||||
output = output.concat([
|
||||
helper.styleTitle('Options:'),
|
||||
...optionList,
|
||||
'',
|
||||
]);
|
||||
}
|
||||
|
||||
if (this.showGlobalOptions) {
|
||||
const globalOptionList = helper.visibleGlobalOptions(cmd).map((option) => {
|
||||
return formatItem(helper.optionTerm(option), helper.optionDescription(option));
|
||||
});
|
||||
if (helper.showGlobalOptions) {
|
||||
const globalOptionList = helper
|
||||
.visibleGlobalOptions(cmd)
|
||||
.map((option) => {
|
||||
return callFormatItem(
|
||||
helper.styleOptionTerm(helper.optionTerm(option)),
|
||||
helper.styleOptionDescription(helper.optionDescription(option)),
|
||||
);
|
||||
});
|
||||
if (globalOptionList.length > 0) {
|
||||
output = output.concat(['Global Options:', formatList(globalOptionList), '']);
|
||||
output = output.concat([
|
||||
helper.styleTitle('Global Options:'),
|
||||
...globalOptionList,
|
||||
'',
|
||||
]);
|
||||
}
|
||||
}
|
||||
|
||||
// Commands
|
||||
const commandList = helper.visibleCommands(cmd).map((cmd) => {
|
||||
return formatItem(helper.subcommandTerm(cmd), helper.subcommandDescription(cmd));
|
||||
return callFormatItem(
|
||||
helper.styleSubcommandTerm(helper.subcommandTerm(cmd)),
|
||||
helper.styleSubcommandDescription(helper.subcommandDescription(cmd)),
|
||||
);
|
||||
});
|
||||
if (commandList.length > 0) {
|
||||
output = output.concat(['Commands:', formatList(commandList), '']);
|
||||
output = output.concat([
|
||||
helper.styleTitle('Commands:'),
|
||||
...commandList,
|
||||
'',
|
||||
]);
|
||||
}
|
||||
|
||||
return output.join('\n');
|
||||
}
|
||||
|
||||
/**
|
||||
* Return display width of string, ignoring ANSI escape sequences. Used in padding and wrapping calculations.
|
||||
*
|
||||
* @param {string} str
|
||||
* @returns {number}
|
||||
*/
|
||||
displayWidth(str) {
|
||||
return stripColor(str).length;
|
||||
}
|
||||
|
||||
/**
|
||||
* Style the title for displaying in the help. Called with 'Usage:', 'Options:', etc.
|
||||
*
|
||||
* @param {string} str
|
||||
* @returns {string}
|
||||
*/
|
||||
styleTitle(str) {
|
||||
return str;
|
||||
}
|
||||
|
||||
styleUsage(str) {
|
||||
// Usage has lots of parts the user might like to color separately! Assume default usage string which is formed like:
|
||||
// command subcommand [options] [command] <foo> [bar]
|
||||
return str
|
||||
.split(' ')
|
||||
.map((word) => {
|
||||
if (word === '[options]') return this.styleOptionText(word);
|
||||
if (word === '[command]') return this.styleSubcommandText(word);
|
||||
if (word[0] === '[' || word[0] === '<')
|
||||
return this.styleArgumentText(word);
|
||||
return this.styleCommandText(word); // Restrict to initial words?
|
||||
})
|
||||
.join(' ');
|
||||
}
|
||||
styleCommandDescription(str) {
|
||||
return this.styleDescriptionText(str);
|
||||
}
|
||||
styleOptionDescription(str) {
|
||||
return this.styleDescriptionText(str);
|
||||
}
|
||||
styleSubcommandDescription(str) {
|
||||
return this.styleDescriptionText(str);
|
||||
}
|
||||
styleArgumentDescription(str) {
|
||||
return this.styleDescriptionText(str);
|
||||
}
|
||||
styleDescriptionText(str) {
|
||||
return str;
|
||||
}
|
||||
styleOptionTerm(str) {
|
||||
return this.styleOptionText(str);
|
||||
}
|
||||
styleSubcommandTerm(str) {
|
||||
// This is very like usage with lots of parts! Assume default string which is formed like:
|
||||
// subcommand [options] <foo> [bar]
|
||||
return str
|
||||
.split(' ')
|
||||
.map((word) => {
|
||||
if (word === '[options]') return this.styleOptionText(word);
|
||||
if (word[0] === '[' || word[0] === '<')
|
||||
return this.styleArgumentText(word);
|
||||
return this.styleSubcommandText(word); // Restrict to initial words?
|
||||
})
|
||||
.join(' ');
|
||||
}
|
||||
styleArgumentTerm(str) {
|
||||
return this.styleArgumentText(str);
|
||||
}
|
||||
styleOptionText(str) {
|
||||
return str;
|
||||
}
|
||||
styleArgumentText(str) {
|
||||
return str;
|
||||
}
|
||||
styleSubcommandText(str) {
|
||||
return str;
|
||||
}
|
||||
styleCommandText(str) {
|
||||
return str;
|
||||
}
|
||||
|
||||
/**
|
||||
* Calculate the pad width from the maximum term length.
|
||||
*
|
||||
@@ -417,46 +582,128 @@ class Help {
|
||||
helper.longestOptionTermLength(cmd, helper),
|
||||
helper.longestGlobalOptionTermLength(cmd, helper),
|
||||
helper.longestSubcommandTermLength(cmd, helper),
|
||||
helper.longestArgumentTermLength(cmd, helper)
|
||||
helper.longestArgumentTermLength(cmd, helper),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Wrap the given string to width characters per line, with lines after the first indented.
|
||||
* Do not wrap if insufficient room for wrapping (minColumnWidth), or string is manually formatted.
|
||||
* Detect manually wrapped and indented strings by checking for line break followed by whitespace.
|
||||
*
|
||||
* @param {string} str
|
||||
* @returns {boolean}
|
||||
*/
|
||||
preformatted(str) {
|
||||
return /\n[^\S\r\n]/.test(str);
|
||||
}
|
||||
|
||||
/**
|
||||
* Format the "item", which consists of a term and description. Pad the term and wrap the description, indenting the following lines.
|
||||
*
|
||||
* So "TTT", 5, "DDD DDDD DD DDD" might be formatted for this.helpWidth=17 like so:
|
||||
* TTT DDD DDDD
|
||||
* DD DDD
|
||||
*
|
||||
* @param {string} term
|
||||
* @param {number} termWidth
|
||||
* @param {string} description
|
||||
* @param {Help} helper
|
||||
* @returns {string}
|
||||
*/
|
||||
formatItem(term, termWidth, description, helper) {
|
||||
const itemIndent = 2;
|
||||
const itemIndentStr = ' '.repeat(itemIndent);
|
||||
if (!description) return itemIndentStr + term;
|
||||
|
||||
// Pad the term out to a consistent width, so descriptions are aligned.
|
||||
const paddedTerm = term.padEnd(
|
||||
termWidth + term.length - helper.displayWidth(term),
|
||||
);
|
||||
|
||||
// Format the description.
|
||||
const spacerWidth = 2; // between term and description
|
||||
const helpWidth = this.helpWidth ?? 80; // in case prepareContext() was not called
|
||||
const remainingWidth = helpWidth - termWidth - spacerWidth - itemIndent;
|
||||
let formattedDescription;
|
||||
if (
|
||||
remainingWidth < this.minWidthToWrap ||
|
||||
helper.preformatted(description)
|
||||
) {
|
||||
formattedDescription = description;
|
||||
} else {
|
||||
const wrappedDescription = helper.boxWrap(description, remainingWidth);
|
||||
formattedDescription = wrappedDescription.replace(
|
||||
/\n/g,
|
||||
'\n' + ' '.repeat(termWidth + spacerWidth),
|
||||
);
|
||||
}
|
||||
|
||||
// Construct and overall indent.
|
||||
return (
|
||||
itemIndentStr +
|
||||
paddedTerm +
|
||||
' '.repeat(spacerWidth) +
|
||||
formattedDescription.replace(/\n/g, `\n${itemIndentStr}`)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Wrap a string at whitespace, preserving existing line breaks.
|
||||
* Wrapping is skipped if the width is less than `minWidthToWrap`.
|
||||
*
|
||||
* @param {string} str
|
||||
* @param {number} width
|
||||
* @param {number} indent
|
||||
* @param {number} [minColumnWidth=40]
|
||||
* @return {string}
|
||||
*
|
||||
* @returns {string}
|
||||
*/
|
||||
boxWrap(str, width) {
|
||||
if (width < this.minWidthToWrap) return str;
|
||||
|
||||
wrap(str, width, indent, minColumnWidth = 40) {
|
||||
// Full \s characters, minus the linefeeds.
|
||||
const indents = ' \\f\\t\\v\u00a0\u1680\u2000-\u200a\u202f\u205f\u3000\ufeff';
|
||||
// Detect manually wrapped and indented strings by searching for line break followed by spaces.
|
||||
const manualIndent = new RegExp(`[\\n][${indents}]+`);
|
||||
if (str.match(manualIndent)) return str;
|
||||
// Do not wrap if not enough room for a wrapped column of text (as could end up with a word per line).
|
||||
const columnWidth = width - indent;
|
||||
if (columnWidth < minColumnWidth) return str;
|
||||
const rawLines = str.split(/\r\n|\n/);
|
||||
// split up text by whitespace
|
||||
const chunkPattern = /[\s]*[^\s]+/g;
|
||||
const wrappedLines = [];
|
||||
rawLines.forEach((line) => {
|
||||
const chunks = line.match(chunkPattern);
|
||||
if (chunks === null) {
|
||||
wrappedLines.push('');
|
||||
return;
|
||||
}
|
||||
|
||||
const leadingStr = str.slice(0, indent);
|
||||
const columnText = str.slice(indent).replace('\r\n', '\n');
|
||||
const indentString = ' '.repeat(indent);
|
||||
const zeroWidthSpace = '\u200B';
|
||||
const breaks = `\\s${zeroWidthSpace}`;
|
||||
// Match line end (so empty lines don't collapse),
|
||||
// or as much text as will fit in column, or excess text up to first break.
|
||||
const regex = new RegExp(`\n|.{1,${columnWidth - 1}}([${breaks}]|$)|[^${breaks}]+?([${breaks}]|$)`, 'g');
|
||||
const lines = columnText.match(regex) || [];
|
||||
return leadingStr + lines.map((line, i) => {
|
||||
if (line === '\n') return ''; // preserve empty lines
|
||||
return ((i > 0) ? indentString : '') + line.trimEnd();
|
||||
}).join('\n');
|
||||
let sumChunks = [chunks.shift()];
|
||||
let sumWidth = this.displayWidth(sumChunks[0]);
|
||||
chunks.forEach((chunk) => {
|
||||
const visibleWidth = this.displayWidth(chunk);
|
||||
// Accumulate chunks while they fit into width.
|
||||
if (sumWidth + visibleWidth <= width) {
|
||||
sumChunks.push(chunk);
|
||||
sumWidth += visibleWidth;
|
||||
return;
|
||||
}
|
||||
wrappedLines.push(sumChunks.join(''));
|
||||
|
||||
const nextChunk = chunk.trimStart(); // trim space at line break
|
||||
sumChunks = [nextChunk];
|
||||
sumWidth = this.displayWidth(nextChunk);
|
||||
});
|
||||
wrappedLines.push(sumChunks.join(''));
|
||||
});
|
||||
|
||||
return wrappedLines.join('\n');
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Strip style ANSI escape sequences from the string. In particular, SGR (Select Graphic Rendition) codes.
|
||||
*
|
||||
* @param {string} str
|
||||
* @returns {string}
|
||||
* @package
|
||||
*/
|
||||
|
||||
function stripColor(str) {
|
||||
// eslint-disable-next-line no-control-regex
|
||||
const sgrPattern = /\x1b\[\d*(;\d*)*m/g;
|
||||
return str.replace(sgrPattern, '');
|
||||
}
|
||||
|
||||
exports.Help = Help;
|
||||
exports.stripColor = stripColor;
|
||||
|
||||
84
node_modules/commander/lib/option.js
generated
vendored
84
node_modules/commander/lib/option.js
generated
vendored
@@ -18,7 +18,7 @@ class Option {
|
||||
this.variadic = /\w\.\.\.[>\]]$/.test(flags); // The option can take multiple values.
|
||||
this.mandatory = false; // The option must have a value after parsing, which usually means it must be specified on command line.
|
||||
const optionFlags = splitOptionFlags(flags);
|
||||
this.short = optionFlags.shortFlag;
|
||||
this.short = optionFlags.shortFlag; // May be a short flag, undefined, or even a long flag (if option has two long flags).
|
||||
this.long = optionFlags.longFlag;
|
||||
this.negate = false;
|
||||
if (this.long) {
|
||||
@@ -74,7 +74,7 @@ class Option {
|
||||
* new Option('--rgb').conflicts('cmyk');
|
||||
* new Option('--js').conflicts(['ts', 'jsx']);
|
||||
*
|
||||
* @param {string | string[]} names
|
||||
* @param {(string | string[])} names
|
||||
* @return {Option}
|
||||
*/
|
||||
|
||||
@@ -93,7 +93,7 @@ class Option {
|
||||
* .addOption(new Option('--log', 'write logging information to file'))
|
||||
* .addOption(new Option('--trace', 'log extra details').implies({ log: 'trace.txt' }));
|
||||
*
|
||||
* @param {Object} impliedOptionValues
|
||||
* @param {object} impliedOptionValues
|
||||
* @return {Option}
|
||||
*/
|
||||
implies(impliedOptionValues) {
|
||||
@@ -158,7 +158,7 @@ class Option {
|
||||
}
|
||||
|
||||
/**
|
||||
* @api private
|
||||
* @package
|
||||
*/
|
||||
|
||||
_concatValue(value, previous) {
|
||||
@@ -180,7 +180,9 @@ class Option {
|
||||
this.argChoices = values.slice();
|
||||
this.parseArg = (arg, previous) => {
|
||||
if (!this.argChoices.includes(arg)) {
|
||||
throw new InvalidArgumentError(`Allowed choices are ${this.argChoices.join(', ')}.`);
|
||||
throw new InvalidArgumentError(
|
||||
`Allowed choices are ${this.argChoices.join(', ')}.`,
|
||||
);
|
||||
}
|
||||
if (this.variadic) {
|
||||
return this._concatValue(arg, previous);
|
||||
@@ -205,14 +207,16 @@ class Option {
|
||||
|
||||
/**
|
||||
* Return option name, in a camelcase format that can be used
|
||||
* as a object attribute key.
|
||||
* as an object attribute key.
|
||||
*
|
||||
* @return {string}
|
||||
* @api private
|
||||
*/
|
||||
|
||||
attributeName() {
|
||||
return camelcase(this.name().replace(/^no-/, ''));
|
||||
if (this.negate) {
|
||||
return camelcase(this.name().replace(/^no-/, ''));
|
||||
}
|
||||
return camelcase(this.name());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -220,7 +224,7 @@ class Option {
|
||||
*
|
||||
* @param {string} arg
|
||||
* @return {boolean}
|
||||
* @api private
|
||||
* @package
|
||||
*/
|
||||
|
||||
is(arg) {
|
||||
@@ -233,7 +237,7 @@ class Option {
|
||||
* Options are one of boolean, negated, required argument, or optional argument.
|
||||
*
|
||||
* @return {boolean}
|
||||
* @api private
|
||||
* @package
|
||||
*/
|
||||
|
||||
isBoolean() {
|
||||
@@ -256,7 +260,7 @@ class DualOptions {
|
||||
this.positiveOptions = new Map();
|
||||
this.negativeOptions = new Map();
|
||||
this.dualOptions = new Set();
|
||||
options.forEach(option => {
|
||||
options.forEach((option) => {
|
||||
if (option.negate) {
|
||||
this.negativeOptions.set(option.attributeName(), option);
|
||||
} else {
|
||||
@@ -283,7 +287,7 @@ class DualOptions {
|
||||
|
||||
// Use the value to deduce if (probably) came from the option.
|
||||
const preset = this.negativeOptions.get(optionKey).presetArg;
|
||||
const negativeValue = (preset !== undefined) ? preset : false;
|
||||
const negativeValue = preset !== undefined ? preset : false;
|
||||
return option.negate === (negativeValue === value);
|
||||
}
|
||||
}
|
||||
@@ -293,7 +297,7 @@ class DualOptions {
|
||||
*
|
||||
* @param {string} str
|
||||
* @return {string}
|
||||
* @api private
|
||||
* @private
|
||||
*/
|
||||
|
||||
function camelcase(str) {
|
||||
@@ -305,25 +309,59 @@ function camelcase(str) {
|
||||
/**
|
||||
* Split the short and long flag out of something like '-m,--mixed <value>'
|
||||
*
|
||||
* @api private
|
||||
* @private
|
||||
*/
|
||||
|
||||
function splitOptionFlags(flags) {
|
||||
let shortFlag;
|
||||
let longFlag;
|
||||
// Use original very loose parsing to maintain backwards compatibility for now,
|
||||
// which allowed for example unintended `-sw, --short-word` [sic].
|
||||
const flagParts = flags.split(/[ |,]+/);
|
||||
if (flagParts.length > 1 && !/^[[<]/.test(flagParts[1])) shortFlag = flagParts.shift();
|
||||
longFlag = flagParts.shift();
|
||||
// Add support for lone short flag without significantly changing parsing!
|
||||
if (!shortFlag && /^-[^-]$/.test(longFlag)) {
|
||||
// short flag, single dash and single character
|
||||
const shortFlagExp = /^-[^-]$/;
|
||||
// long flag, double dash and at least one character
|
||||
const longFlagExp = /^--[^-]/;
|
||||
|
||||
const flagParts = flags.split(/[ |,]+/).concat('guard');
|
||||
// Normal is short and/or long.
|
||||
if (shortFlagExp.test(flagParts[0])) shortFlag = flagParts.shift();
|
||||
if (longFlagExp.test(flagParts[0])) longFlag = flagParts.shift();
|
||||
// Long then short. Rarely used but fine.
|
||||
if (!shortFlag && shortFlagExp.test(flagParts[0]))
|
||||
shortFlag = flagParts.shift();
|
||||
// Allow two long flags, like '--ws, --workspace'
|
||||
// This is the supported way to have a shortish option flag.
|
||||
if (!shortFlag && longFlagExp.test(flagParts[0])) {
|
||||
shortFlag = longFlag;
|
||||
longFlag = undefined;
|
||||
longFlag = flagParts.shift();
|
||||
}
|
||||
|
||||
// Check for unprocessed flag. Fail noisily rather than silently ignore.
|
||||
if (flagParts[0].startsWith('-')) {
|
||||
const unsupportedFlag = flagParts[0];
|
||||
const baseError = `option creation failed due to '${unsupportedFlag}' in option flags '${flags}'`;
|
||||
if (/^-[^-][^-]/.test(unsupportedFlag))
|
||||
throw new Error(
|
||||
`${baseError}
|
||||
- a short flag is a single dash and a single character
|
||||
- either use a single dash and a single character (for a short flag)
|
||||
- or use a double dash for a long option (and can have two, like '--ws, --workspace')`,
|
||||
);
|
||||
if (shortFlagExp.test(unsupportedFlag))
|
||||
throw new Error(`${baseError}
|
||||
- too many short flags`);
|
||||
if (longFlagExp.test(unsupportedFlag))
|
||||
throw new Error(`${baseError}
|
||||
- too many long flags`);
|
||||
|
||||
throw new Error(`${baseError}
|
||||
- unrecognised flag format`);
|
||||
}
|
||||
if (shortFlag === undefined && longFlag === undefined)
|
||||
throw new Error(
|
||||
`option creation failed due to no flags found in '${flags}'.`,
|
||||
);
|
||||
|
||||
return { shortFlag, longFlag };
|
||||
}
|
||||
|
||||
exports.Option = Option;
|
||||
exports.splitOptionFlags = splitOptionFlags;
|
||||
exports.DualOptions = DualOptions;
|
||||
|
||||
9
node_modules/commander/lib/suggestSimilar.js
generated
vendored
9
node_modules/commander/lib/suggestSimilar.js
generated
vendored
@@ -6,7 +6,8 @@ function editDistance(a, b) {
|
||||
// (Simple implementation.)
|
||||
|
||||
// Quick early exit, return worst case.
|
||||
if (Math.abs(a.length - b.length) > maxDistance) return Math.max(a.length, b.length);
|
||||
if (Math.abs(a.length - b.length) > maxDistance)
|
||||
return Math.max(a.length, b.length);
|
||||
|
||||
// distance between prefix substrings of a and b
|
||||
const d = [];
|
||||
@@ -32,7 +33,7 @@ function editDistance(a, b) {
|
||||
d[i][j] = Math.min(
|
||||
d[i - 1][j] + 1, // deletion
|
||||
d[i][j - 1] + 1, // insertion
|
||||
d[i - 1][j - 1] + cost // substitution
|
||||
d[i - 1][j - 1] + cost, // substitution
|
||||
);
|
||||
// transposition
|
||||
if (i > 1 && j > 1 && a[i - 1] === b[j - 2] && a[i - 2] === b[j - 1]) {
|
||||
@@ -60,7 +61,7 @@ function suggestSimilar(word, candidates) {
|
||||
const searchingOptions = word.startsWith('--');
|
||||
if (searchingOptions) {
|
||||
word = word.slice(2);
|
||||
candidates = candidates.map(candidate => candidate.slice(2));
|
||||
candidates = candidates.map((candidate) => candidate.slice(2));
|
||||
}
|
||||
|
||||
let similar = [];
|
||||
@@ -85,7 +86,7 @@ function suggestSimilar(word, candidates) {
|
||||
|
||||
similar.sort((a, b) => a.localeCompare(b));
|
||||
if (searchingOptions) {
|
||||
similar = similar.map(candidate => `--${candidate}`);
|
||||
similar = similar.map((candidate) => `--${candidate}`);
|
||||
}
|
||||
|
||||
if (similar.length > 1) {
|
||||
|
||||
Reference in New Issue
Block a user