@zowe/imperative
Version:
framework for building configurable CLIs
118 lines • 5.59 kB
JavaScript
"use strict";
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.GroupCommandYargs = void 0;
const AbstractCommandYargs_1 = require("./AbstractCommandYargs");
const CommandYargs_1 = require("./CommandYargs");
const constants_1 = require("../../../constants");
/**
* Imperative define group command to Yargs - defines the group and it's children to Yargs.
*/
class GroupCommandYargs extends AbstractCommandYargs_1.AbstractCommandYargs {
/**
* Define the group and its children to Yargs.
* @param {YargsCommandCompleted} commandExecuted: The callback when this command is executed.
*/
defineCommandToYargs(commandExecuted) {
/**
* Define the command to Yargs
*/
this.yargs.command(
/**
* Specify the group name.
*/
[this.definition.name].concat(this.definition.aliases),
/**
* Specify the group description.
*/
this.definition.description,
/**
* The Yargs builder will define the children or child for this command group.
* @param {yargs.Argv} argsForBuilder: The yargs instance to define the options
* @return {yargs.Argv}: The populated instance.
*/
(argsForBuilder) => {
/**
* Define each child to Yargs.
*/
for (const child of this.definition.children) {
/**
* If this "child" is a provider-group or a plain group, create a new "Group" for Yargs.
* Otherwise, define the "child" command.
*/
switch (child.type) {
// case "provider":
case "group":
new GroupCommandYargs({
yargsInstance: this.yargs,
commandDefinition: child,
yargsParent: this,
commandResponseParms: this.responseParms,
helpGeneratorFactory: this.helpGeneratorFactory,
experimentalCommandDescription: this.yargsParms.experimentalCommandDescription,
rootCommandName: this.rootCommandName,
commandLine: this.commandLine,
envVariablePrefix: this.envVariablePrefix,
promptPhrase: this.promptPhrase
}).defineCommandToYargs(commandExecuted);
break;
case "command":
new CommandYargs_1.CommandYargs({
yargsInstance: this.yargs,
commandDefinition: child,
yargsParent: this,
commandResponseParms: this.responseParms,
helpGeneratorFactory: this.helpGeneratorFactory,
experimentalCommandDescription: this.yargsParms.experimentalCommandDescription,
rootCommandName: this.rootCommandName,
commandLine: this.commandLine,
envVariablePrefix: this.envVariablePrefix,
promptPhrase: this.promptPhrase
}).defineCommandToYargs(commandExecuted);
break;
default:
throw new Error(`Imperative Yargs Define Error: Command definition type ` +
`${child.type} invalid.`);
}
}
argsForBuilder.strict();
CommandYargs_1.CommandYargs.defineOptionsToYargs(argsForBuilder, this.definition.options);
return argsForBuilder;
},
/**
* Define the handler. Always invokes the help for a group.
* @param {Arguments} argsForHandler
*/
(argsForHandler) => __awaiter(this, void 0, void 0, function* () {
// TODO: figure out a better way to handle the fact that yargs keeps going after fail()
if (!AbstractCommandYargs_1.AbstractCommandYargs.STOP_YARGS) {
if (!argsForHandler[constants_1.Constants.HELP_WEB_OPTION]) {
this.executeHelp(argsForHandler, commandExecuted);
}
else {
this.executeWebHelp(argsForHandler, commandExecuted);
}
}
}));
}
}
exports.GroupCommandYargs = GroupCommandYargs;
//# sourceMappingURL=GroupCommandYargs.js.map