@decaf-ts/utils
Version:
module management utils for decaf-ts
81 lines • 9.32 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.DefaultCommandValues = exports.DefaultCommandOptions = void 0;
/**
* @description Default command options for CLI commands.
* @summary Defines the structure and default values for common command-line options used across various CLI commands.
* @const DefaultCommandOptions
* @typedef {Object} DefaultCommandOptions
* @property {Object} verbose - Verbosity level option.
* @property {string} verbose.type - The type of the verbose option (number).
* @property {string} verbose.short - The short flag for the verbose option (V).
* @property {number} verbose.default - The default value for verbosity (0).
* @property {Object} version - Version display option.
* @property {string} version.type - The type of the version option (boolean).
* @property {string} version.short - The short flag for the version option (v).
* @property {undefined} version.default - The default value for version display (undefined).
* @property {Object} help - Help display option.
* @property {string} help.type - The type of the help option (boolean).
* @property {string} help.short - The short flag for the help option (h).
* @property {boolean} help.default - The default value for help display (false).
* @property {Object} logLevel - Log level option.
* @property {string} logLevel.type - The type of the logLevel option (string).
* @property {string} logLevel.default - The default value for log level ("info").
* @property {Object} logStyle - Log styling option.
* @property {string} logStyle.type - The type of the logStyle option (boolean).
* @property {boolean} logStyle.default - The default value for log styling (true).
* @property {Object} timestamp - Timestamp display option.
* @property {string} timestamp.type - The type of the timestamp option (boolean).
* @property {boolean} timestamp.default - The default value for timestamp display (true).
* @property {Object} banner - Banner display option.
* @property {string} banner.type - The type of the banner option (boolean).
* @property {boolean} banner.default - The default value for banner display (false).
* @memberOf module:utils
*/
exports.DefaultCommandOptions = {
verbose: {
type: "boolean",
short: "V",
default: undefined,
},
version: {
type: "boolean",
short: "v",
default: undefined,
},
help: {
type: "boolean",
short: "h",
default: false,
},
logLevel: {
type: "string",
default: "info",
},
logStyle: {
type: "boolean",
default: true,
},
timestamp: {
type: "boolean",
default: true,
},
banner: {
type: "boolean",
default: true,
},
};
/**
* @description Default command values derived from DefaultCommandOptions.
* @summary Creates an object with the default values of all options defined in DefaultCommandOptions.
* @const DefaultCommandValues
* @typedef {Object} DefaultCommandValues
* @property {unknown} [key: string] - The default value for each option in DefaultCommandOptions.
* @memberOf module:utils
*/
exports.DefaultCommandValues = Object.keys(exports.DefaultCommandOptions).reduce((acc, key) => {
acc[key] =
exports.DefaultCommandOptions[key].default;
return acc;
}, {});
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NsaS9jb25zdGFudHMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUE7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQThCRztBQUNVLFFBQUEscUJBQXFCLEdBQUc7SUFDbkMsT0FBTyxFQUFFO1FBQ1AsSUFBSSxFQUFFLFNBQVM7UUFDZixLQUFLLEVBQUUsR0FBRztRQUNWLE9BQU8sRUFBRSxTQUFTO0tBQ25CO0lBQ0QsT0FBTyxFQUFFO1FBQ1AsSUFBSSxFQUFFLFNBQVM7UUFDZixLQUFLLEVBQUUsR0FBRztRQUNWLE9BQU8sRUFBRSxTQUFTO0tBQ25CO0lBQ0QsSUFBSSxFQUFFO1FBQ0osSUFBSSxFQUFFLFNBQVM7UUFDZixLQUFLLEVBQUUsR0FBRztRQUNWLE9BQU8sRUFBRSxLQUFLO0tBQ2Y7SUFDRCxRQUFRLEVBQUU7UUFDUixJQUFJLEVBQUUsUUFBUTtRQUNkLE9BQU8sRUFBRSxNQUFNO0tBQ2hCO0lBQ0QsUUFBUSxFQUFFO1FBQ1IsSUFBSSxFQUFFLFNBQVM7UUFDZixPQUFPLEVBQUUsSUFBSTtLQUNkO0lBQ0QsU0FBUyxFQUFFO1FBQ1QsSUFBSSxFQUFFLFNBQVM7UUFDZixPQUFPLEVBQUUsSUFBSTtLQUNkO0lBQ0QsTUFBTSxFQUFFO1FBQ04sSUFBSSxFQUFFLFNBQVM7UUFDZixPQUFPLEVBQUUsSUFBSTtLQUNkO0NBQ0YsQ0FBQztBQUVGOzs7Ozs7O0dBT0c7QUFDVSxRQUFBLG9CQUFvQixHQUU3QixNQUFNLENBQUMsSUFBSSxDQUFDLDZCQUFxQixDQUFDLENBQUMsTUFBTSxDQUMzQyxDQUFDLEdBQXdELEVBQUUsR0FBVyxFQUFFLEVBQUU7SUFDeEUsR0FBRyxDQUFDLEdBQXlDLENBQUM7UUFDNUMsNkJBQXFCLENBQUMsR0FBeUMsQ0FBQyxDQUFDLE9BQU8sQ0FBQztJQUMzRSxPQUFPLEdBQUcsQ0FBQztBQUNiLENBQUMsRUFDRCxFQUF3RCxDQUN6RCxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiLyoqXG4gKiBAZGVzY3JpcHRpb24gRGVmYXVsdCBjb21tYW5kIG9wdGlvbnMgZm9yIENMSSBjb21tYW5kcy5cbiAqIEBzdW1tYXJ5IERlZmluZXMgdGhlIHN0cnVjdHVyZSBhbmQgZGVmYXVsdCB2YWx1ZXMgZm9yIGNvbW1vbiBjb21tYW5kLWxpbmUgb3B0aW9ucyB1c2VkIGFjcm9zcyB2YXJpb3VzIENMSSBjb21tYW5kcy5cbiAqIEBjb25zdCBEZWZhdWx0Q29tbWFuZE9wdGlvbnNcbiAqIEB0eXBlZGVmIHtPYmplY3R9IERlZmF1bHRDb21tYW5kT3B0aW9uc1xuICogQHByb3BlcnR5IHtPYmplY3R9IHZlcmJvc2UgLSBWZXJib3NpdHkgbGV2ZWwgb3B0aW9uLlxuICogQHByb3BlcnR5IHtzdHJpbmd9IHZlcmJvc2UudHlwZSAtIFRoZSB0eXBlIG9mIHRoZSB2ZXJib3NlIG9wdGlvbiAobnVtYmVyKS5cbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSB2ZXJib3NlLnNob3J0IC0gVGhlIHNob3J0IGZsYWcgZm9yIHRoZSB2ZXJib3NlIG9wdGlvbiAoVikuXG4gKiBAcHJvcGVydHkge251bWJlcn0gdmVyYm9zZS5kZWZhdWx0IC0gVGhlIGRlZmF1bHQgdmFsdWUgZm9yIHZlcmJvc2l0eSAoMCkuXG4gKiBAcHJvcGVydHkge09iamVjdH0gdmVyc2lvbiAtIFZlcnNpb24gZGlzcGxheSBvcHRpb24uXG4gKiBAcHJvcGVydHkge3N0cmluZ30gdmVyc2lvbi50eXBlIC0gVGhlIHR5cGUgb2YgdGhlIHZlcnNpb24gb3B0aW9uIChib29sZWFuKS5cbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSB2ZXJzaW9uLnNob3J0IC0gVGhlIHNob3J0IGZsYWcgZm9yIHRoZSB2ZXJzaW9uIG9wdGlvbiAodikuXG4gKiBAcHJvcGVydHkge3VuZGVmaW5lZH0gdmVyc2lvbi5kZWZhdWx0IC0gVGhlIGRlZmF1bHQgdmFsdWUgZm9yIHZlcnNpb24gZGlzcGxheSAodW5kZWZpbmVkKS5cbiAqIEBwcm9wZXJ0eSB7T2JqZWN0fSBoZWxwIC0gSGVscCBkaXNwbGF5IG9wdGlvbi5cbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBoZWxwLnR5cGUgLSBUaGUgdHlwZSBvZiB0aGUgaGVscCBvcHRpb24gKGJvb2xlYW4pLlxuICogQHByb3BlcnR5IHtzdHJpbmd9IGhlbHAuc2hvcnQgLSBUaGUgc2hvcnQgZmxhZyBmb3IgdGhlIGhlbHAgb3B0aW9uIChoKS5cbiAqIEBwcm9wZXJ0eSB7Ym9vbGVhbn0gaGVscC5kZWZhdWx0IC0gVGhlIGRlZmF1bHQgdmFsdWUgZm9yIGhlbHAgZGlzcGxheSAoZmFsc2UpLlxuICogQHByb3BlcnR5IHtPYmplY3R9IGxvZ0xldmVsIC0gTG9nIGxldmVsIG9wdGlvbi5cbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBsb2dMZXZlbC50eXBlIC0gVGhlIHR5cGUgb2YgdGhlIGxvZ0xldmVsIG9wdGlvbiAoc3RyaW5nKS5cbiAqIEBwcm9wZXJ0eSB7c3RyaW5nfSBsb2dMZXZlbC5kZWZhdWx0IC0gVGhlIGRlZmF1bHQgdmFsdWUgZm9yIGxvZyBsZXZlbCAoXCJpbmZvXCIpLlxuICogQHByb3BlcnR5IHtPYmplY3R9IGxvZ1N0eWxlIC0gTG9nIHN0eWxpbmcgb3B0aW9uLlxuICogQHByb3BlcnR5IHtzdHJpbmd9IGxvZ1N0eWxlLnR5cGUgLSBUaGUgdHlwZSBvZiB0aGUgbG9nU3R5bGUgb3B0aW9uIChib29sZWFuKS5cbiAqIEBwcm9wZXJ0eSB7Ym9vbGVhbn0gbG9nU3R5bGUuZGVmYXVsdCAtIFRoZSBkZWZhdWx0IHZhbHVlIGZvciBsb2cgc3R5bGluZyAodHJ1ZSkuXG4gKiBAcHJvcGVydHkge09iamVjdH0gdGltZXN0YW1wIC0gVGltZXN0YW1wIGRpc3BsYXkgb3B0aW9uLlxuICogQHByb3BlcnR5IHtzdHJpbmd9IHRpbWVzdGFtcC50eXBlIC0gVGhlIHR5cGUgb2YgdGhlIHRpbWVzdGFtcCBvcHRpb24gKGJvb2xlYW4pLlxuICogQHByb3BlcnR5IHtib29sZWFufSB0aW1lc3RhbXAuZGVmYXVsdCAtIFRoZSBkZWZhdWx0IHZhbHVlIGZvciB0aW1lc3RhbXAgZGlzcGxheSAodHJ1ZSkuXG4gKiBAcHJvcGVydHkge09iamVjdH0gYmFubmVyIC0gQmFubmVyIGRpc3BsYXkgb3B0aW9uLlxuICogQHByb3BlcnR5IHtzdHJpbmd9IGJhbm5lci50eXBlIC0gVGhlIHR5cGUgb2YgdGhlIGJhbm5lciBvcHRpb24gKGJvb2xlYW4pLlxuICogQHByb3BlcnR5IHtib29sZWFufSBiYW5uZXIuZGVmYXVsdCAtIFRoZSBkZWZhdWx0IHZhbHVlIGZvciBiYW5uZXIgZGlzcGxheSAoZmFsc2UpLlxuICogQG1lbWJlck9mIG1vZHVsZTp1dGlsc1xuICovXG5leHBvcnQgY29uc3QgRGVmYXVsdENvbW1hbmRPcHRpb25zID0ge1xuICB2ZXJib3NlOiB7XG4gICAgdHlwZTogXCJib29sZWFuXCIsXG4gICAgc2hvcnQ6IFwiVlwiLFxuICAgIGRlZmF1bHQ6IHVuZGVmaW5lZCxcbiAgfSxcbiAgdmVyc2lvbjoge1xuICAgIHR5cGU6IFwiYm9vbGVhblwiLFxuICAgIHNob3J0OiBcInZcIixcbiAgICBkZWZhdWx0OiB1bmRlZmluZWQsXG4gIH0sXG4gIGhlbHA6IHtcbiAgICB0eXBlOiBcImJvb2xlYW5cIixcbiAgICBzaG9ydDogXCJoXCIsXG4gICAgZGVmYXVsdDogZmFsc2UsXG4gIH0sXG4gIGxvZ0xldmVsOiB7XG4gICAgdHlwZTogXCJzdHJpbmdcIixcbiAgICBkZWZhdWx0OiBcImluZm9cIixcbiAgfSxcbiAgbG9nU3R5bGU6IHtcbiAgICB0eXBlOiBcImJvb2xlYW5cIixcbiAgICBkZWZhdWx0OiB0cnVlLFxuICB9LFxuICB0aW1lc3RhbXA6IHtcbiAgICB0eXBlOiBcImJvb2xlYW5cIixcbiAgICBkZWZhdWx0OiB0cnVlLFxuICB9LFxuICBiYW5uZXI6IHtcbiAgICB0eXBlOiBcImJvb2xlYW5cIixcbiAgICBkZWZhdWx0OiB0cnVlLFxuICB9LFxufTtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gRGVmYXVsdCBjb21tYW5kIHZhbHVlcyBkZXJpdmVkIGZyb20gRGVmYXVsdENvbW1hbmRPcHRpb25zLlxuICogQHN1bW1hcnkgQ3JlYXRlcyBhbiBvYmplY3Qgd2l0aCB0aGUgZGVmYXVsdCB2YWx1ZXMgb2YgYWxsIG9wdGlvbnMgZGVmaW5lZCBpbiBEZWZhdWx0Q29tbWFuZE9wdGlvbnMuXG4gKiBAY29uc3QgRGVmYXVsdENvbW1hbmRWYWx1ZXNcbiAqIEB0eXBlZGVmIHtPYmplY3R9IERlZmF1bHRDb21tYW5kVmFsdWVzXG4gKiBAcHJvcGVydHkge3Vua25vd259IFtrZXk6IHN0cmluZ10gLSBUaGUgZGVmYXVsdCB2YWx1ZSBmb3IgZWFjaCBvcHRpb24gaW4gRGVmYXVsdENvbW1hbmRPcHRpb25zLlxuICogQG1lbWJlck9mIG1vZHVsZTp1dGlsc1xuICovXG5leHBvcnQgY29uc3QgRGVmYXVsdENvbW1hbmRWYWx1ZXM6IHtcbiAgW2sgaW4ga2V5b2YgdHlwZW9mIERlZmF1bHRDb21tYW5kT3B0aW9uc106IHVua25vd247XG59ID0gT2JqZWN0LmtleXMoRGVmYXVsdENvbW1hbmRPcHRpb25zKS5yZWR1Y2UoXG4gIChhY2M6IFJlY29yZDxrZXlvZiB0eXBlb2YgRGVmYXVsdENvbW1hbmRPcHRpb25zLCB1bmtub3duPiwga2V5OiBzdHJpbmcpID0+IHtcbiAgICBhY2Nba2V5IGFzIGtleW9mIHR5cGVvZiBEZWZhdWx0Q29tbWFuZE9wdGlvbnNdID1cbiAgICAgIERlZmF1bHRDb21tYW5kT3B0aW9uc1trZXkgYXMga2V5b2YgdHlwZW9mIERlZmF1bHRDb21tYW5kT3B0aW9uc10uZGVmYXVsdDtcbiAgICByZXR1cm4gYWNjO1xuICB9LFxuICB7fSBhcyBSZWNvcmQ8a2V5b2YgdHlwZW9mIERlZmF1bHRDb21tYW5kVmFsdWVzLCB1bmtub3duPlxuKTtcbiJdfQ==