@hugo-fixit/fixit-releaser
Version:
Versioning, change-log and release tool.
1,454 lines (1,452 loc) • 884 kB
JavaScript
#!/usr/bin/env node
//#region rolldown:runtime
var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __getProtoOf = Object.getPrototypeOf;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __commonJS = (cb, mod) => function() {
return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
};
var __copyProps = (to, from, except, desc) => {
if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
key = keys[i];
if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
get: ((k) => from[k]).bind(null, key),
enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
});
}
return to;
};
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
value: mod,
enumerable: true
}) : target, mod));
//#endregion
const node_path = __toESM(require("node:path"));
const node_process = __toESM(require("node:process"));
const node_child_process = __toESM(require("node:child_process"));
const node_fs = __toESM(require("node:fs"));
//#region node_modules/.pnpm/commander@7.2.0/node_modules/commander/index.js
var require_commander = /* @__PURE__ */ __commonJS({ "node_modules/.pnpm/commander@7.2.0/node_modules/commander/index.js": ((exports, module) => {
/**
* Module dependencies.
*/
const EventEmitter = require("events").EventEmitter;
const childProcess = require("child_process");
const path$1 = require("path");
const fs$3 = require("fs");
var Help = class {
constructor() {
this.helpWidth = void 0;
this.sortSubcommands = false;
this.sortOptions = false;
}
/**
* Get an array of the visible subcommands. Includes a placeholder for the implicit help command, if there is one.
*
* @param {Command} cmd
* @returns {Command[]}
*/
visibleCommands(cmd$4) {
const visibleCommands = cmd$4.commands.filter((cmd$5) => !cmd$5._hidden);
if (cmd$4._hasImplicitHelpCommand()) {
const args$1 = cmd$4._helpCommandnameAndArgs.split(/ +/);
const helpCommand = cmd$4.createCommand(args$1.shift()).helpOption(false);
helpCommand.description(cmd$4._helpCommandDescription);
helpCommand._parseExpectedArgs(args$1);
visibleCommands.push(helpCommand);
}
if (this.sortSubcommands) visibleCommands.sort((a, b) => {
return a.name().localeCompare(b.name());
});
return visibleCommands;
}
/**
* Get an array of the visible options. Includes a placeholder for the implicit help option, if there is one.
*
* @param {Command} cmd
* @returns {Option[]}
*/
visibleOptions(cmd$4) {
const visibleOptions = cmd$4.options.filter((option) => !option.hidden);
const showShortHelpFlag = cmd$4._hasHelpOption && cmd$4._helpShortFlag && !cmd$4._findOption(cmd$4._helpShortFlag);
const showLongHelpFlag = cmd$4._hasHelpOption && !cmd$4._findOption(cmd$4._helpLongFlag);
if (showShortHelpFlag || showLongHelpFlag) {
let helpOption;
if (!showShortHelpFlag) helpOption = cmd$4.createOption(cmd$4._helpLongFlag, cmd$4._helpDescription);
else if (!showLongHelpFlag) helpOption = cmd$4.createOption(cmd$4._helpShortFlag, cmd$4._helpDescription);
else helpOption = cmd$4.createOption(cmd$4._helpFlags, cmd$4._helpDescription);
visibleOptions.push(helpOption);
}
if (this.sortOptions) {
const getSortKey = (option) => {
return option.short ? option.short.replace(/^-/, "") : option.long.replace(/^--/, "");
};
visibleOptions.sort((a, b) => {
return getSortKey(a).localeCompare(getSortKey(b));
});
}
return visibleOptions;
}
/**
* Get an array of the arguments which have descriptions.
*
* @param {Command} cmd
* @returns {{ term: string, description:string }[]}
*/
visibleArguments(cmd$4) {
if (cmd$4._argsDescription && cmd$4._args.length) return cmd$4._args.map((argument) => {
return {
term: argument.name,
description: cmd$4._argsDescription[argument.name] || ""
};
}, 0);
return [];
}
/**
* Get the command term to show in the list of subcommands.
*
* @param {Command} cmd
* @returns {string}
*/
subcommandTerm(cmd$4) {
const args$1 = cmd$4._args.map((arg) => humanReadableArgName(arg)).join(" ");
return cmd$4._name + (cmd$4._aliases[0] ? "|" + cmd$4._aliases[0] : "") + (cmd$4.options.length ? " [options]" : "") + (args$1 ? " " + args$1 : "");
}
/**
* Get the option term to show in the list of options.
*
* @param {Option} option
* @returns {string}
*/
optionTerm(option) {
return option.flags;
}
/**
* Get the longest command term length.
*
* @param {Command} cmd
* @param {Help} helper
* @returns {number}
*/
longestSubcommandTermLength(cmd$4, helper) {
return helper.visibleCommands(cmd$4).reduce((max, command) => {
return Math.max(max, helper.subcommandTerm(command).length);
}, 0);
}
/**
* Get the longest option term length.
*
* @param {Command} cmd
* @param {Help} helper
* @returns {number}
*/
longestOptionTermLength(cmd$4, helper) {
return helper.visibleOptions(cmd$4).reduce((max, option) => {
return Math.max(max, helper.optionTerm(option).length);
}, 0);
}
/**
* Get the longest argument term length.
*
* @param {Command} cmd
* @param {Help} helper
* @returns {number}
*/
longestArgumentTermLength(cmd$4, helper) {
return helper.visibleArguments(cmd$4).reduce((max, argument) => {
return Math.max(max, argument.term.length);
}, 0);
}
/**
* Get the command usage to be displayed at the top of the built-in help.
*
* @param {Command} cmd
* @returns {string}
*/
commandUsage(cmd$4) {
let cmdName = cmd$4._name;
if (cmd$4._aliases[0]) cmdName = cmdName + "|" + cmd$4._aliases[0];
let parentCmdNames = "";
for (let parentCmd = cmd$4.parent; parentCmd; parentCmd = parentCmd.parent) parentCmdNames = parentCmd.name() + " " + parentCmdNames;
return parentCmdNames + cmdName + " " + cmd$4.usage();
}
/**
* Get the description for the command.
*
* @param {Command} cmd
* @returns {string}
*/
commandDescription(cmd$4) {
return cmd$4.description();
}
/**
* Get the command description to show in the list of subcommands.
*
* @param {Command} cmd
* @returns {string}
*/
subcommandDescription(cmd$4) {
return cmd$4.description();
}
/**
* Get the option description to show in the list of options.
*
* @param {Option} option
* @return {string}
*/
optionDescription(option) {
if (option.negate) return option.description;
const extraInfo = [];
if (option.argChoices) extraInfo.push(`choices: ${option.argChoices.map((choice) => JSON.stringify(choice)).join(", ")}`);
if (option.defaultValue !== void 0) extraInfo.push(`default: ${option.defaultValueDescription || JSON.stringify(option.defaultValue)}`);
if (extraInfo.length > 0) return `${option.description} (${extraInfo.join(", ")})`;
return option.description;
}
/**
* Generate the built-in help text.
*
* @param {Command} cmd
* @param {Help} helper
* @returns {string}
*/
formatHelp(cmd$4, helper) {
const termWidth = helper.padWidth(cmd$4, helper);
const helpWidth = helper.helpWidth || 80;
const itemIndentWidth = 2;
const itemSeparatorWidth = 2;
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));
}
let output = [`Usage: ${helper.commandUsage(cmd$4)}`, ""];
const commandDescription = helper.commandDescription(cmd$4);
if (commandDescription.length > 0) output = output.concat([commandDescription, ""]);
const argumentList = helper.visibleArguments(cmd$4).map((argument) => {
return formatItem(argument.term, argument.description);
});
if (argumentList.length > 0) output = output.concat([
"Arguments:",
formatList(argumentList),
""
]);
const optionList = helper.visibleOptions(cmd$4).map((option) => {
return formatItem(helper.optionTerm(option), helper.optionDescription(option));
});
if (optionList.length > 0) output = output.concat([
"Options:",
formatList(optionList),
""
]);
const commandList = helper.visibleCommands(cmd$4).map((cmd$5) => {
return formatItem(helper.subcommandTerm(cmd$5), helper.subcommandDescription(cmd$5));
});
if (commandList.length > 0) output = output.concat([
"Commands:",
formatList(commandList),
""
]);
return output.join("\n");
}
/**
* Calculate the pad width from the maximum term length.
*
* @param {Command} cmd
* @param {Help} helper
* @returns {number}
*/
padWidth(cmd$4, helper) {
return Math.max(helper.longestOptionTermLength(cmd$4, helper), helper.longestSubcommandTermLength(cmd$4, helper), helper.longestArgumentTermLength(cmd$4, 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.
*
* @param {string} str
* @param {number} width
* @param {number} indent
* @param {number} [minColumnWidth=40]
* @return {string}
*
*/
wrap(str, width, indent, minColumnWidth = 40) {
if (str.match(/[\n]\s+/)) return str;
const columnWidth = width - indent;
if (columnWidth < minColumnWidth) return str;
const leadingStr = str.substr(0, indent);
const columnText = str.substr(indent);
const indentString = " ".repeat(indent);
const regex = new RegExp(".{1," + (columnWidth - 1) + "}([\\s]|$)|[^\\s]+?([\\s]|$)", "g");
const lines = columnText.match(regex) || [];
return leadingStr + lines.map((line, i) => {
if (line.slice(-1) === "\n") line = line.slice(0, line.length - 1);
return (i > 0 ? indentString : "") + line.trimRight();
}).join("\n");
}
};
var Option = class {
/**
* Initialize a new `Option` with the given `flags` and `description`.
*
* @param {string} flags
* @param {string} [description]
*/
constructor(flags, description) {
this.flags = flags;
this.description = description || "";
this.required = flags.includes("<");
this.optional = flags.includes("[");
this.variadic = /\w\.\.\.[>\]]$/.test(flags);
this.mandatory = false;
const optionFlags = _parseOptionFlags(flags);
this.short = optionFlags.shortFlag;
this.long = optionFlags.longFlag;
this.negate = false;
if (this.long) this.negate = this.long.startsWith("--no-");
this.defaultValue = void 0;
this.defaultValueDescription = void 0;
this.parseArg = void 0;
this.hidden = false;
this.argChoices = void 0;
}
/**
* Set the default value, and optionally supply the description to be displayed in the help.
*
* @param {any} value
* @param {string} [description]
* @return {Option}
*/
default(value, description) {
this.defaultValue = value;
this.defaultValueDescription = description;
return this;
}
/**
* Set the custom handler for processing CLI option arguments into option values.
*
* @param {Function} [fn]
* @return {Option}
*/
argParser(fn) {
this.parseArg = fn;
return this;
}
/**
* Whether the option is mandatory and must have a value after parsing.
*
* @param {boolean} [mandatory=true]
* @return {Option}
*/
makeOptionMandatory(mandatory = true) {
this.mandatory = !!mandatory;
return this;
}
/**
* Hide option in help.
*
* @param {boolean} [hide=true]
* @return {Option}
*/
hideHelp(hide = true) {
this.hidden = !!hide;
return this;
}
/**
* @api private
*/
_concatValue(value, previous) {
if (previous === this.defaultValue || !Array.isArray(previous)) return [value];
return previous.concat(value);
}
/**
* Only allow option value to be one of choices.
*
* @param {string[]} values
* @return {Option}
*/
choices(values) {
this.argChoices = values;
this.parseArg = (arg, previous) => {
if (!values.includes(arg)) throw new InvalidOptionArgumentError(`Allowed choices are ${values.join(", ")}.`);
if (this.variadic) return this._concatValue(arg, previous);
return arg;
};
return this;
}
/**
* Return option name.
*
* @return {string}
*/
name() {
if (this.long) return this.long.replace(/^--/, "");
return this.short.replace(/^-/, "");
}
/**
* Return option name, in a camelcase format that can be used
* as a object attribute key.
*
* @return {string}
* @api private
*/
attributeName() {
return camelcase(this.name().replace(/^no-/, ""));
}
/**
* Check if `arg` matches the short or long flag.
*
* @param {string} arg
* @return {boolean}
* @api private
*/
is(arg) {
return this.short === arg || this.long === arg;
}
};
/**
* CommanderError class
* @class
*/
var CommanderError = class extends Error {
/**
* Constructs the CommanderError class
* @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);
Error.captureStackTrace(this, this.constructor);
this.name = this.constructor.name;
this.code = code;
this.exitCode = exitCode;
this.nestedError = void 0;
}
};
/**
* InvalidOptionArgumentError class
* @class
*/
var InvalidOptionArgumentError = class extends CommanderError {
/**
* Constructs the InvalidOptionArgumentError class
* @param {string} [message] explanation of why argument is invalid
* @constructor
*/
constructor(message) {
super(1, "commander.invalidOptionArgument", message);
Error.captureStackTrace(this, this.constructor);
this.name = this.constructor.name;
}
};
var Command$1 = class Command$1 extends EventEmitter {
/**
* Initialize a new `Command`.
*
* @param {string} [name]
*/
constructor(name$1) {
super();
this.commands = [];
this.options = [];
this.parent = null;
this._allowUnknownOption = false;
this._allowExcessArguments = true;
this._args = [];
this.rawArgs = null;
this._scriptPath = null;
this._name = name$1 || "";
this._optionValues = {};
this._storeOptionsAsProperties = false;
this._actionResults = [];
this._actionHandler = null;
this._executableHandler = false;
this._executableFile = null;
this._defaultCommandName = null;
this._exitCallback = null;
this._aliases = [];
this._combineFlagAndOptionalValue = true;
this._description = "";
this._argsDescription = void 0;
this._enablePositionalOptions = false;
this._passThroughOptions = false;
this._outputConfiguration = {
writeOut: (str) => process.stdout.write(str),
writeErr: (str) => process.stderr.write(str),
getOutHelpWidth: () => process.stdout.isTTY ? process.stdout.columns : void 0,
getErrHelpWidth: () => process.stderr.isTTY ? process.stderr.columns : void 0,
outputError: (str, write$1) => write$1(str)
};
this._hidden = false;
this._hasHelpOption = true;
this._helpFlags = "-h, --help";
this._helpDescription = "display help for command";
this._helpShortFlag = "-h";
this._helpLongFlag = "--help";
this._addImplicitHelpCommand = void 0;
this._helpCommandName = "help";
this._helpCommandnameAndArgs = "help [command]";
this._helpCommandDescription = "display help for command";
this._helpConfiguration = {};
}
/**
* Define a command.
*
* There are two styles of command: pay attention to where to put the description.
*
* Examples:
*
* // Command implemented using action handler (description is supplied separately to `.command`)
* program
* .command('clone <source> [destination]')
* .description('clone a repository into a newly created directory')
* .action((source, destination) => {
* console.log('clone command called');
* });
*
* // Command implemented using separate executable file (description is second parameter to `.command`)
* program
* .command('start <service>', 'start named service')
* .command('stop [service]', 'stop named service, or all if no name supplied');
*
* @param {string} nameAndArgs - command name and arguments, args are `<required>` or `[optional]` and last may also be `variadic...`
* @param {Object|string} [actionOptsOrExecDesc] - configuration options (for action), or description (for executable)
* @param {Object} [execOpts] - configuration options (for executable)
* @return {Command} returns new command for action handler, or `this` for executable command
*/
command(nameAndArgs, actionOptsOrExecDesc, execOpts) {
let desc = actionOptsOrExecDesc;
let opts = execOpts;
if (typeof desc === "object" && desc !== null) {
opts = desc;
desc = null;
}
opts = opts || {};
const args$1 = nameAndArgs.split(/ +/);
const cmd$4 = this.createCommand(args$1.shift());
if (desc) {
cmd$4.description(desc);
cmd$4._executableHandler = true;
}
if (opts.isDefault) this._defaultCommandName = cmd$4._name;
cmd$4._outputConfiguration = this._outputConfiguration;
cmd$4._hidden = !!(opts.noHelp || opts.hidden);
cmd$4._hasHelpOption = this._hasHelpOption;
cmd$4._helpFlags = this._helpFlags;
cmd$4._helpDescription = this._helpDescription;
cmd$4._helpShortFlag = this._helpShortFlag;
cmd$4._helpLongFlag = this._helpLongFlag;
cmd$4._helpCommandName = this._helpCommandName;
cmd$4._helpCommandnameAndArgs = this._helpCommandnameAndArgs;
cmd$4._helpCommandDescription = this._helpCommandDescription;
cmd$4._helpConfiguration = this._helpConfiguration;
cmd$4._exitCallback = this._exitCallback;
cmd$4._storeOptionsAsProperties = this._storeOptionsAsProperties;
cmd$4._combineFlagAndOptionalValue = this._combineFlagAndOptionalValue;
cmd$4._allowExcessArguments = this._allowExcessArguments;
cmd$4._enablePositionalOptions = this._enablePositionalOptions;
cmd$4._executableFile = opts.executableFile || null;
this.commands.push(cmd$4);
cmd$4._parseExpectedArgs(args$1);
cmd$4.parent = this;
if (desc) return this;
return cmd$4;
}
/**
* Factory routine to create a new unattached command.
*
* See .command() for creating an attached subcommand, which uses this routine to
* create the command. You can override createCommand to customise subcommands.
*
* @param {string} [name]
* @return {Command} new command
*/
createCommand(name$1) {
return new Command$1(name$1);
}
/**
* You can customise the help with a subclass of Help by overriding createHelp,
* or by overriding Help properties using configureHelp().
*
* @return {Help}
*/
createHelp() {
return Object.assign(new Help(), this.configureHelp());
}
/**
* You can customise the help by overriding Help properties using configureHelp(),
* or with a subclass of Help by overriding createHelp().
*
* @param {Object} [configuration] - configuration options
* @return {Command|Object} `this` command for chaining, or stored configuration
*/
configureHelp(configuration) {
if (configuration === void 0) return this._helpConfiguration;
this._helpConfiguration = configuration;
return this;
}
/**
* The default output goes to stdout and stderr. You can customise this for special
* applications. You can also customise the display of errors by overriding outputError.
*
* The configuration properties are all functions:
*
* // functions to change where being written, stdout and stderr
* writeOut(str)
* writeErr(str)
* // matching functions to specify width for wrapping help
* getOutHelpWidth()
* getErrHelpWidth()
* // functions based on what is being written out
* outputError(str, write) // used for displaying errors, and not used for displaying help
*
* @param {Object} [configuration] - configuration options
* @return {Command|Object} `this` command for chaining, or stored configuration
*/
configureOutput(configuration) {
if (configuration === void 0) return this._outputConfiguration;
Object.assign(this._outputConfiguration, configuration);
return this;
}
/**
* Add a prepared subcommand.
*
* See .command() for creating an attached subcommand which inherits settings from its parent.
*
* @param {Command} cmd - new subcommand
* @param {Object} [opts] - configuration options
* @return {Command} `this` command for chaining
*/
addCommand(cmd$4, opts) {
if (!cmd$4._name) throw new Error("Command passed to .addCommand() must have a name");
function checkExplicitNames(commandArray) {
commandArray.forEach((cmd$5) => {
if (cmd$5._executableHandler && !cmd$5._executableFile) throw new Error(`Must specify executableFile for deeply nested executable: ${cmd$5.name()}`);
checkExplicitNames(cmd$5.commands);
});
}
checkExplicitNames(cmd$4.commands);
opts = opts || {};
if (opts.isDefault) this._defaultCommandName = cmd$4._name;
if (opts.noHelp || opts.hidden) cmd$4._hidden = true;
this.commands.push(cmd$4);
cmd$4.parent = this;
return this;
}
/**
* Define argument syntax for the command.
*/
arguments(desc) {
return this._parseExpectedArgs(desc.split(/ +/));
}
/**
* Override default decision whether to add implicit help command.
*
* addHelpCommand() // force on
* addHelpCommand(false); // force off
* addHelpCommand('help [cmd]', 'display help for [cmd]'); // force on with custom details
*
* @return {Command} `this` command for chaining
*/
addHelpCommand(enableOrNameAndArgs, description) {
if (enableOrNameAndArgs === false) this._addImplicitHelpCommand = false;
else {
this._addImplicitHelpCommand = true;
if (typeof enableOrNameAndArgs === "string") {
this._helpCommandName = enableOrNameAndArgs.split(" ")[0];
this._helpCommandnameAndArgs = enableOrNameAndArgs;
}
this._helpCommandDescription = description || this._helpCommandDescription;
}
return this;
}
/**
* @return {boolean}
* @api private
*/
_hasImplicitHelpCommand() {
if (this._addImplicitHelpCommand === void 0) return this.commands.length && !this._actionHandler && !this._findCommand("help");
return this._addImplicitHelpCommand;
}
/**
* Parse expected `args`.
*
* For example `["[type]"]` becomes `[{ required: false, name: 'type' }]`.
*
* @param {Array} args
* @return {Command} `this` command for chaining
* @api private
*/
_parseExpectedArgs(args$1) {
if (!args$1.length) return;
args$1.forEach((arg) => {
const argDetails = {
required: false,
name: "",
variadic: false
};
switch (arg[0]) {
case "<":
argDetails.required = true;
argDetails.name = arg.slice(1, -1);
break;
case "[":
argDetails.name = arg.slice(1, -1);
break;
}
if (argDetails.name.length > 3 && argDetails.name.slice(-3) === "...") {
argDetails.variadic = true;
argDetails.name = argDetails.name.slice(0, -3);
}
if (argDetails.name) this._args.push(argDetails);
});
this._args.forEach((arg, i) => {
if (arg.variadic && i < this._args.length - 1) throw new Error(`only the last argument can be variadic '${arg.name}'`);
});
return this;
}
/**
* Register callback to use as replacement for calling process.exit.
*
* @param {Function} [fn] optional callback which will be passed a CommanderError, defaults to throwing
* @return {Command} `this` command for chaining
*/
exitOverride(fn) {
if (fn) this._exitCallback = fn;
else this._exitCallback = (err) => {
if (err.code !== "commander.executeSubCommandAsync") throw err;
};
return this;
}
/**
* Call process.exit, and _exitCallback if defined.
*
* @param {number} exitCode exit code for using with process.exit
* @param {string} code an id string representing the error
* @param {string} message human-readable description of the error
* @return never
* @api private
*/
_exit(exitCode, code, message) {
if (this._exitCallback) this._exitCallback(new CommanderError(exitCode, code, message));
process.exit(exitCode);
}
/**
* Register callback `fn` for the command.
*
* Examples:
*
* program
* .command('help')
* .description('display verbose help')
* .action(function() {
* // output help here
* });
*
* @param {Function} fn
* @return {Command} `this` command for chaining
*/
action(fn) {
const listener = (args$1) => {
const expectedArgsCount = this._args.length;
const actionArgs = args$1.slice(0, expectedArgsCount);
if (this._storeOptionsAsProperties) actionArgs[expectedArgsCount] = this;
else actionArgs[expectedArgsCount] = this.opts();
actionArgs.push(this);
const actionResult = fn.apply(this, actionArgs);
let rootCommand = this;
while (rootCommand.parent) rootCommand = rootCommand.parent;
rootCommand._actionResults.push(actionResult);
};
this._actionHandler = listener;
return this;
}
/**
* Factory routine to create a new unattached option.
*
* See .option() for creating an attached option, which uses this routine to
* create the option. You can override createOption to return a custom option.
*
* @param {string} flags
* @param {string} [description]
* @return {Option} new option
*/
createOption(flags, description) {
return new Option(flags, description);
}
/**
* Add an option.
*
* @param {Option} option
* @return {Command} `this` command for chaining
*/
addOption(option) {
const oname = option.name();
const name$1 = option.attributeName();
let defaultValue = option.defaultValue;
if (option.negate || option.optional || option.required || typeof defaultValue === "boolean") {
if (option.negate) {
const positiveLongFlag = option.long.replace(/^--no-/, "--");
defaultValue = this._findOption(positiveLongFlag) ? this._getOptionValue(name$1) : true;
}
if (defaultValue !== void 0) this._setOptionValue(name$1, defaultValue);
}
this.options.push(option);
this.on("option:" + oname, (val) => {
const oldValue = this._getOptionValue(name$1);
if (val !== null && option.parseArg) try {
val = option.parseArg(val, oldValue === void 0 ? defaultValue : oldValue);
} catch (err) {
if (err.code === "commander.invalidOptionArgument") {
const message = `error: option '${option.flags}' argument '${val}' is invalid. ${err.message}`;
this._displayError(err.exitCode, err.code, message);
}
throw err;
}
else if (val !== null && option.variadic) val = option._concatValue(val, oldValue);
if (typeof oldValue === "boolean" || typeof oldValue === "undefined") if (val == null) this._setOptionValue(name$1, option.negate ? false : defaultValue || true);
else this._setOptionValue(name$1, val);
else if (val !== null) this._setOptionValue(name$1, option.negate ? false : val);
});
return this;
}
/**
* Internal implementation shared by .option() and .requiredOption()
*
* @api private
*/
_optionEx(config, flags, description, fn, defaultValue) {
const option = this.createOption(flags, description);
option.makeOptionMandatory(!!config.mandatory);
if (typeof fn === "function") option.default(defaultValue).argParser(fn);
else if (fn instanceof RegExp) {
const regex = fn;
fn = (val, def) => {
const m = regex.exec(val);
return m ? m[0] : def;
};
option.default(defaultValue).argParser(fn);
} else option.default(fn);
return this.addOption(option);
}
/**
* Define option with `flags`, `description` and optional
* coercion `fn`.
*
* The `flags` string contains the short and/or 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 undefined
* program.option('-p, --pepper', 'add pepper');
*
* program.pepper
* // => undefined
*
* --pepper
* program.pepper
* // => true
*
* // simple boolean defaulting to true (unless non-negated option is also defined)
* 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 {Function|*} [fn] - custom option processing function or default value
* @param {*} [defaultValue]
* @return {Command} `this` command for chaining
*/
option(flags, description, fn, defaultValue) {
return this._optionEx({}, flags, description, fn, defaultValue);
}
/**
* Add a required option which must have a value after parsing. This usually means
* the option must be specified on the command line. (Otherwise the same as .option().)
*
* The `flags` string contains the short and/or long flags, separated by comma, a pipe or space.
*
* @param {string} flags
* @param {string} [description]
* @param {Function|*} [fn] - custom option processing function or default value
* @param {*} [defaultValue]
* @return {Command} `this` command for chaining
*/
requiredOption(flags, description, fn, defaultValue) {
return this._optionEx({ mandatory: true }, flags, description, fn, defaultValue);
}
/**
* Alter parsing of short flags with optional values.
*
* Examples:
*
* // for `.option('-f,--flag [value]'):
* .combineFlagAndOptionalValue(true) // `-f80` is treated like `--flag=80`, this is the default behaviour
* .combineFlagAndOptionalValue(false) // `-fb` is treated like `-f -b`
*
* @param {Boolean} [combine=true] - if `true` or omitted, an optional value can be specified directly after the flag.
*/
combineFlagAndOptionalValue(combine = true) {
this._combineFlagAndOptionalValue = !!combine;
return this;
}
/**
* Allow unknown options on the command line.
*
* @param {Boolean} [allowUnknown=true] - if `true` or omitted, no error will be thrown
* for unknown options.
*/
allowUnknownOption(allowUnknown = true) {
this._allowUnknownOption = !!allowUnknown;
return this;
}
/**
* Allow excess command-arguments on the command line. Pass false to make excess arguments an error.
*
* @param {Boolean} [allowExcess=true] - if `true` or omitted, no error will be thrown
* for excess arguments.
*/
allowExcessArguments(allowExcess = true) {
this._allowExcessArguments = !!allowExcess;
return this;
}
/**
* Enable positional options. Positional means global options are specified before subcommands which lets
* subcommands reuse the same option names, and also enables subcommands to turn on passThroughOptions.
* The default behaviour is non-positional and global options may appear anywhere on the command line.
*
* @param {Boolean} [positional=true]
*/
enablePositionalOptions(positional = true) {
this._enablePositionalOptions = !!positional;
return this;
}
/**
* Pass through options that come after command-arguments rather than treat them as command-options,
* so actual command-options come before command-arguments. Turning this on for a subcommand requires
* positional options to have been enabled on the program (parent commands).
* The default behaviour is non-positional and options may appear before or after command-arguments.
*
* @param {Boolean} [passThrough=true]
* for unknown options.
*/
passThroughOptions(passThrough = true) {
this._passThroughOptions = !!passThrough;
if (!!this.parent && passThrough && !this.parent._enablePositionalOptions) throw new Error("passThroughOptions can not be used without turning on enablePositionalOptions for parent command(s)");
return this;
}
/**
* Whether to store option values as properties on command object,
* or store separately (specify false). In both cases the option values can be accessed using .opts().
*
* @param {boolean} [storeAsProperties=true]
* @return {Command} `this` command for chaining
*/
storeOptionsAsProperties(storeAsProperties = true) {
this._storeOptionsAsProperties = !!storeAsProperties;
if (this.options.length) throw new Error("call .storeOptionsAsProperties() before adding options");
return this;
}
/**
* Store option value
*
* @param {string} key
* @param {Object} value
* @api private
*/
_setOptionValue(key, value) {
if (this._storeOptionsAsProperties) this[key] = value;
else this._optionValues[key] = value;
}
/**
* Retrieve option value
*
* @param {string} key
* @return {Object} value
* @api private
*/
_getOptionValue(key) {
if (this._storeOptionsAsProperties) return this[key];
return this._optionValues[key];
}
/**
* Parse `argv`, setting options and invoking commands when defined.
*
* The default expectation is that the arguments are from node and have the application as argv[0]
* and the script being run in argv[1], with user parameters after that.
*
* Examples:
*
* program.parse(process.argv);
* program.parse(); // implicitly use process.argv and auto-detect node vs electron conventions
* program.parse(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
*
* @param {string[]} [argv] - optional, defaults to process.argv
* @param {Object} [parseOptions] - optionally specify style of options with from: node/user/electron
* @param {string} [parseOptions.from] - where the args are from: 'node', 'user', 'electron'
* @return {Command} `this` command for chaining
*/
parse(argv, parseOptions$4) {
if (argv !== void 0 && !Array.isArray(argv)) throw new Error("first parameter to parse must be array or undefined");
parseOptions$4 = parseOptions$4 || {};
if (argv === void 0) {
argv = process.argv;
if (process.versions && process.versions.electron) parseOptions$4.from = "electron";
}
this.rawArgs = argv.slice();
let userArgs;
switch (parseOptions$4.from) {
case void 0:
case "node":
this._scriptPath = argv[1];
userArgs = argv.slice(2);
break;
case "electron":
if (process.defaultApp) {
this._scriptPath = argv[1];
userArgs = argv.slice(2);
} else userArgs = argv.slice(1);
break;
case "user":
userArgs = argv.slice(0);
break;
default: throw new Error(`unexpected parse option { from: '${parseOptions$4.from}' }`);
}
if (!this._scriptPath && require.main) this._scriptPath = require.main.filename;
this._name = this._name || this._scriptPath && path$1.basename(this._scriptPath, path$1.extname(this._scriptPath));
this._parseCommand([], userArgs);
return this;
}
/**
* Parse `argv`, setting options and invoking commands when defined.
*
* Use parseAsync instead of parse if any of your action handlers are async. Returns a Promise.
*
* The default expectation is that the arguments are from node and have the application as argv[0]
* and the script being run in argv[1], with user parameters after that.
*
* Examples:
*
* program.parseAsync(process.argv);
* program.parseAsync(); // implicitly use process.argv and auto-detect node vs electron conventions
* program.parseAsync(my-args, { from: 'user' }); // just user supplied arguments, nothing special about argv[0]
*
* @param {string[]} [argv]
* @param {Object} [parseOptions]
* @param {string} parseOptions.from - where the args are from: 'node', 'user', 'electron'
* @return {Promise}
*/
parseAsync(argv, parseOptions$4) {
this.parse(argv, parseOptions$4);
return Promise.all(this._actionResults).then(() => this);
}
/**
* Execute a sub-command executable.
*
* @api private
*/
_executeSubCommand(subcommand, args$1) {
args$1 = args$1.slice();
let launchWithNode = false;
const sourceExt = [
".js",
".ts",
".tsx",
".mjs",
".cjs"
];
this._checkForMissingMandatoryOptions();
let scriptPath = this._scriptPath;
if (!scriptPath && require.main) scriptPath = require.main.filename;
let baseDir;
try {
const resolvedLink = fs$3.realpathSync(scriptPath);
baseDir = path$1.dirname(resolvedLink);
} catch (e) {
baseDir = ".";
}
let bin = path$1.basename(scriptPath, path$1.extname(scriptPath)) + "-" + subcommand._name;
if (subcommand._executableFile) bin = subcommand._executableFile;
const localBin = path$1.join(baseDir, bin);
if (fs$3.existsSync(localBin)) bin = localBin;
else sourceExt.forEach((ext) => {
if (fs$3.existsSync(`${localBin}${ext}`)) bin = `${localBin}${ext}`;
});
launchWithNode = sourceExt.includes(path$1.extname(bin));
let proc;
if (process.platform !== "win32") if (launchWithNode) {
args$1.unshift(bin);
args$1 = incrementNodeInspectorPort(process.execArgv).concat(args$1);
proc = childProcess.spawn(process.argv[0], args$1, { stdio: "inherit" });
} else proc = childProcess.spawn(bin, args$1, { stdio: "inherit" });
else {
args$1.unshift(bin);
args$1 = incrementNodeInspectorPort(process.execArgv).concat(args$1);
proc = childProcess.spawn(process.execPath, args$1, { stdio: "inherit" });
}
const signals = [
"SIGUSR1",
"SIGUSR2",
"SIGTERM",
"SIGINT",
"SIGHUP"
];
signals.forEach((signal) => {
process.on(signal, () => {
if (proc.killed === false && proc.exitCode === null) proc.kill(signal);
});
});
const exitCallback = this._exitCallback;
if (!exitCallback) proc.on("close", process.exit.bind(process));
else proc.on("close", () => {
exitCallback(new CommanderError(process.exitCode || 0, "commander.executeSubCommandAsync", "(close)"));
});
proc.on("error", (err) => {
if (err.code === "ENOENT") {
const executableMissing = `'${bin}' does not exist
- if '${subcommand._name}' is not meant to be an executable command, remove description parameter from '.command()' and use '.description()' instead
- if the default executable name is not suitable, use the executableFile option to supply a custom name`;
throw new Error(executableMissing);
} else if (err.code === "EACCES") throw new Error(`'${bin}' not executable`);
if (!exitCallback) process.exit(1);
else {
const wrappedError = new CommanderError(1, "commander.executeSubCommandAsync", "(error)");
wrappedError.nestedError = err;
exitCallback(wrappedError);
}
});
this.runningCommand = proc;
}
/**
* @api private
*/
_dispatchSubcommand(commandName, operands, unknown) {
const subCommand = this._findCommand(commandName);
if (!subCommand) this.help({ error: true });
if (subCommand._executableHandler) this._executeSubCommand(subCommand, operands.concat(unknown));
else subCommand._parseCommand(operands, unknown);
}
/**
* Process arguments in context of this command.
*
* @api private
*/
_parseCommand(operands, unknown) {
const parsed = this.parseOptions(unknown);
operands = operands.concat(parsed.operands);
unknown = parsed.unknown;
this.args = operands.concat(unknown);
if (operands && this._findCommand(operands[0])) this._dispatchSubcommand(operands[0], operands.slice(1), unknown);
else if (this._hasImplicitHelpCommand() && operands[0] === this._helpCommandName) if (operands.length === 1) this.help();
else this._dispatchSubcommand(operands[1], [], [this._helpLongFlag]);
else if (this._defaultCommandName) {
outputHelpIfRequested(this, unknown);
this._dispatchSubcommand(this._defaultCommandName, operands, unknown);
} else {
if (this.commands.length && this.args.length === 0 && !this._actionHandler && !this._defaultCommandName) this.help({ error: true });
outputHelpIfRequested(this, parsed.unknown);
this._checkForMissingMandatoryOptions();
const checkForUnknownOptions = () => {
if (parsed.unknown.length > 0) this.unknownOption(parsed.unknown[0]);
};
const commandEvent = `command:${this.name()}`;
if (this._actionHandler) {
checkForUnknownOptions();
const args$1 = this.args.slice();
this._args.forEach((arg, i) => {
if (arg.required && args$1[i] == null) this.missingArgument(arg.name);
else if (arg.variadic) {
args$1[i] = args$1.splice(i);
args$1.length = Math.min(i + 1, args$1.length);
}
});
if (args$1.length > this._args.length) this._excessArguments(args$1);
this._actionHandler(args$1);
if (this.parent) this.parent.emit(commandEvent, operands, unknown);
} else if (this.parent && this.parent.listenerCount(commandEvent)) {
checkForUnknownOptions();
this.parent.emit(commandEvent, operands, unknown);
} else if (operands.length) if (this._findCommand("*")) this._dispatchSubcommand("*", operands, unknown);
else if (this.listenerCount("command:*")) this.emit("command:*", operands, unknown);
else if (this.commands.length) this.unknownCommand();
else checkForUnknownOptions();
else if (this.commands.length) this.help({ error: true });
else checkForUnknownOptions();
}
}
/**
* Find matching command.
*
* @api private
*/
_findCommand(name$1) {
if (!name$1) return void 0;
return this.commands.find((cmd$4) => cmd$4._name === name$1 || cmd$4._aliases.includes(name$1));
}
/**
* Return an option matching `arg` if any.
*
* @param {string} arg
* @return {Option}
* @api private
*/
_findOption(arg) {
return this.options.find((option) => option.is(arg));
}
/**
* Display an error message if a mandatory option does not have a value.
* Lazy calling after checking for help flags from leaf subcommand.
*
* @api private
*/
_checkForMissingMandatoryOptions() {
for (let cmd$4 = this; cmd$4; cmd$4 = cmd$4.parent) cmd$4.options.forEach((anOption) => {
if (anOption.mandatory && cmd$4._getOptionValue(anOption.attributeName()) === void 0) cmd$4.missingMandatoryOptionValue(anOption);
});
}
/**
* Parse options from `argv` removing known options,
* and return argv split into operands and unknown arguments.
*
* Examples:
*
* argv => operands, unknown
* --known kkk op => [op], []
* op --known kkk => [op], []
* sub --unknown uuu op => [sub], [--unknown uuu op]
* sub -- --unknown uuu op => [sub --unknown uuu op], []
*
* @param {String[]} argv
* @return {{operands: String[], unknown: String[]}}
*/
parseOptions(argv) {
const operands = [];
const unknown = [];
let dest = operands;
const args$1 = argv.slice();
function maybeOption(arg) {
return arg.length > 1 && arg[0] === "-";
}
let activeVariadicOption = null;
while (args$1.length) {
const arg = args$1.shift();
if (arg === "--") {
if (dest === unknown) dest.push(arg);
dest.push(...args$1);
break;
}
if (activeVariadicOption && !maybeOption(arg)) {
this.emit(`option:${activeVariadicOption.name()}`, arg);
continue;
}
activeVariadicOption = null;
if (maybeOption(arg)) {
const option = this._findOption(arg);
if (option) {
if (option.required) {
const value = args$1.shift();
if (value === void 0) this.optionMissingArgument(option);
this.emit(`option:${option.name()}`, value);
} else if (option.optional) {
let value = null;
if (args$1.length > 0 && !maybeOption(args$1[0])) value = args$1.shift();
this.emit(`option:${option.name()}`, value);
} else this.emit(`option:${option.name()}`);
activeVariadicOption = option.variadic ? option : null;
continue;
}
}
if (arg.length > 2 && arg[0] === "-" && arg[1] !== "-") {
const option = this._findOption(`-${arg[1]}`);
if (option) {
if (option.required || option.optional && this._combineFlagAndOptionalValue) this.emit(`option:${option.name()}`, arg.slice(2));
else {
this.emit(`option:${option.name()}`);
args$1.unshift(`-${arg.slice(2)}`);
}
continue;
}
}
if (/^--[^=]+=/.test(arg)) {
const index = arg.indexOf("=");
const option = this._findOption(arg.slice(0, index));
if (option && (option.required || option.optional)) {
this.emit(`option:${option.name()}`, arg.slice(index + 1));
continue;
}
}
if (maybeOption(arg)) dest = unknown;
if ((this._enablePositionalOptions || this._passThroughOptions) && operands.length === 0 && unknown.length === 0) {
if (this._findCommand(arg)) {
operands.push(arg);
if (args$1.length > 0) unknown.push(...args$1);
break;
} else if (arg === this._helpCommandName && this._hasImplicitHelpCommand()) {
operands.push(arg);
if (args$1.length > 0) operands.push(...args$1);
break;
} else if (this._defaultCommandName) {
unknown.push(arg);
if (args$1.length > 0) unknown.push(...args$1);
break;
}
}
if (this._passThroughOptions) {
dest.push(arg);
if (args$1.length > 0) dest.push(...args$1);
break;
}
dest.push(arg);
}
return {
operands,
unknown
};
}
/**
* Return an object containing options as key-value pairs
*
* @return {Object}
*/
opts() {
if (this._storeOptionsAsProperties) {
const result = {};
const len = this.options.length;
for (let i = 0; i < len; i++) {
const key = this.options[i].attributeName();
result[key] = key === this._versionOptionName ? this._version : this[key];
}
return result;
}
return this._optionValues;
}
/**
* Internal bottleneck for handling of parsing errors.
*
* @api private
*/
_displayError(exitCode, code, message) {
this._outputConfiguration.outputError(`${message}\n`, this._outputConfiguration.writeErr);
this._exit(exitCode, code, message);
}
/**
* Argument `name` is missing.
*
* @param {string} name
* @api private
*/
missingArgument(name$1) {
const message = `error: missing required argument '${name$1}'`;
this._displayError(1, "commander.missingArgument", message);
}
/**
* `Option` is missing an argument.
*
* @param {Option} option
* @api private
*/
optionMissingArgument(option) {
const message = `error: option '${option.flags}' argument missing`;
this._displayError(1, "commander.optionMissingArgument", message);
}
/**
* `Option` does not have a value, and is a mandatory option.
*
* @param {Option} option
* @api private
*/
missingMandatoryOptionValue(option) {
const message = `error: required option '${option.flags}' not specified`;
this._displayError(1, "commander.missingMandatoryOptionValue", message);
}
/**
* Unknown option `flag`.
*
* @param {string} flag
* @api private
*/
unknownOption(flag) {
if (this._allowUnknownOption) return;
const message = `error: unknown option '${flag}'`;
this._displayError(1, "commander.unknownOption", message);
}
/**
* Excess arguments, more than expected.
*
* @param {string[]} receivedArgs
* @api private
*/
_excessArguments(receivedArgs) {
if (this._allowExcessArguments) return;
const expected = this._args.length;
const s = expected === 1 ? "" : "s";
const forSubcommand = this.parent ? ` for '${this.name()}'` : "";
const message = `error: too many arguments${forSubcommand}. Expected ${expected} argument${s} but got ${receivedArgs.length}.`;
this._displayError(1, "commander.excessArguments", message);
}
/**
* Unknown command.
*
* @api private
*/
unknownCommand() {
const partCommands = [this.name()];
for (let parentCmd = this.parent; parentCmd; parentCmd = parentCmd.parent) partCommands.unshift(parentCmd.name());
const fullCommand = partCommands.join(" ");
const message = `error: unknown command '${this.args[0]}'.` + (this._hasHelpOption ? ` See '${fullCommand} ${this._helpLongFlag}'.` : "");
this._displayError(1, "commander.unknownCommand", message);
}
/**
* Set the program version to `str`.
*
* This method auto-registers the "-V, --version" flag
* which will print the version number when passed.
*
* You can optionally supply the flags and description to override the defaults.
*
* @param {string} str
* @param {string} [flags]
* @param {string} [description]
* @return {this | string} `this` command for chaining, or version string if no arguments
*/
version(str, flags, description) {
if (str === void 0) return this._version;
this._version = str;
flags = flags || "-V, --version";
description = description || "output the version number";
const versionOption = this.createOption(flags, description);
this._versionOptionName = versionOption.attributeName();
this.options.push(versionOption);
this.on("option:" + versionOption.name(), () => {
this._