@pnp/cli-microsoft365 6.0.0-beta.f94d570 → 6.0.0-beta.fa2dfa8

package/dist/cli/Cli.js

@@ -19,7 +19,9 @@ const Command_1 = require("../Command");
 const config_1 = require("../config");
 const request_1 = require("../request");
 const settingsNames_1 = require("../settingsNames");
-const utils_1 = require("../utils");
+const formatting_1 = require("../utils/formatting");
+const fsUtil_1 = require("../utils/fsUtil");
+const md_1 = require("../utils/md");
 const packageJSON = require('../../package.json');
 class Cli {
     // eslint-disable-next-line @typescript-eslint/no-empty-function
@@ -96,54 +98,9 @@ class Cli {
                 showHelp ||
                 parsedArgs.h ||
                 parsedArgs.help) {
-                this.printHelp();
+                this.printHelp(this.getHelpMode(parsedArgs));
                 return Promise.resolve();
             }
-            // if the command doesn't allow unknown options, check if all specified
-            // options match command options
-            if (!this.commandToExecute.command.allowUnknownOptions()) {
-                for (const optionFromArgs in this.optionsFromArgs.options) {
-                    if (optionFromArgs === '_') {
-                        // ignore catch-all option
-                        continue;
-                    }
-                    let matches = false;
-                    for (let i = 0; i < this.commandToExecute.options.length; i++) {
-                        const option = this.commandToExecute.options[i];
-                        if (optionFromArgs === option.long ||
-                            optionFromArgs === option.short) {
-                            matches = true;
-                            break;
-                        }
-                    }
-                    if (!matches) {
-                        return this.closeWithError(`Invalid option: '${optionFromArgs}'${os.EOL}`, this.optionsFromArgs, true);
-                    }
-                }
-            }
-            const shouldPrompt = this.getSettingWithDefaultValue(settingsNames_1.settingsNames.prompt, false);
-            let inquirer;
-            for (let i = 0; i < this.commandToExecute.options.length; i++) {
-                if (this.commandToExecute.options[i].required &&
-                    typeof this.optionsFromArgs.options[this.commandToExecute.options[i].name] === 'undefined') {
-                    if (!shouldPrompt) {
-                        return this.closeWithError(`Required option ${this.commandToExecute.options[i].name} not specified`, this.optionsFromArgs, true);
-                    }
-                    if (i === 0) {
-                        Cli.log('Provide values for the following parameters:');
-                    }
-                    if (!inquirer) {
-                        inquirer = require('inquirer');
-                    }
-                    const missingRequireOptionValue = yield inquirer
-                        .prompt({
-                        name: 'missingRequireOptionValue',
-                        message: `${this.commandToExecute.options[i].name}: `
-                    })
-                        .then(result => result.missingRequireOptionValue);
-                    this.optionsFromArgs.options[this.commandToExecute.options[i].name] = missingRequireOptionValue;
-                }
-            }
             const optionsWithoutShorts = Cli.removeShortOptions(this.optionsFromArgs);
             try {
                 // replace values staring with @ with file contents
@@ -161,23 +118,10 @@ class Cli {
             }
             // if output not specified, set the configured output value (if any)
             if (optionsWithoutShorts.options.output === undefined) {
-                optionsWithoutShorts.options.output = this.getSettingWithDefaultValue(settingsNames_1.settingsNames.output, undefined);
-            }
-            // validate options sets defined by the command
-            const optionsSets = this.commandToExecute.command.optionSets();
-            const argsOptions = Object.keys(this.optionsFromArgs.options);
-            const cmdArgs = this.optionsFromArgs;
-            optionsSets === null || optionsSets === void 0 ? void 0 : optionsSets.forEach((optionSet) => {
-                const commonOptions = argsOptions.filter(opt => optionSet.includes(opt));
-                if (commonOptions.length === 0) {
-                    return this.closeWithError(`Specify one of the following options: ${optionSet.map(opt => opt).join(', ')}.`, cmdArgs, true);
-                }
-                if (commonOptions.length > 1) {
-                    return this.closeWithError(`Specify one of the following options: ${optionSet.map(opt => opt).join(', ')}, but not multiple.`, cmdArgs, true);
-                }
-            });
-            const validationResult = this.commandToExecute.command.validate(optionsWithoutShorts);
-            if (typeof validationResult === 'string') {
+                optionsWithoutShorts.options.output = this.getSettingWithDefaultValue(settingsNames_1.settingsNames.output, 'json');
+            }
+            const validationResult = yield this.commandToExecute.command.validate(optionsWithoutShorts, this.commandToExecute);
+            if (validationResult !== true) {
                 return this.closeWithError(validationResult, optionsWithoutShorts, true);
             }
             return Cli
@@ -186,7 +130,7 @@ class Cli {
         });
     }
     static executeCommand(command, args) {
-        return new Promise((resolve, reject) => {
+        return __awaiter(this, void 0, void 0, function* () {
             const logger = {
                 log: (message) => {
                     const output = Cli.formatOutput(message, args.options);
@@ -203,22 +147,21 @@ class Cli {
             const cli = Cli.getInstance();
             const parentCommandName = cli.currentCommandName;
             cli.currentCommandName = command.getCommandName(cli.currentCommandName);
-            command.action(logger, args, (err) => {
-                // restore the original command name
-                cli.currentCommandName = parentCommandName;
-                if (err) {
-                    return reject(err);
-                }
+            try {
+                yield command.action(logger, args);
                 if (args.options.debug || args.options.verbose) {
                     const chalk = require('chalk');
                     logger.logToStderr(chalk.green('DONE'));
                 }
-                resolve();
-            });
+            }
+            finally {
+                // restore the original command name
+                cli.currentCommandName = parentCommandName;
+            }
         });
     }
     static executeCommandWithOutput(command, args, listener) {
-        return new Promise((resolve, reject) => {
+        return __awaiter(this, void 0, void 0, function* () {
             const log = [];
             const logErr = [];
             const logger = {
@@ -257,26 +200,30 @@ class Cli {
             cli.currentCommandName = command.getCommandName();
             // store the current logger if any
             const currentLogger = request_1.default.logger;
-            command.action(logger, args, (err) => {
+            try {
+                yield command.action(logger, args);
+                return ({
+                    stdout: log.join(os.EOL),
+                    stderr: logErr.join(os.EOL)
+                });
+            }
+            catch (err) {
+                throw {
+                    error: err,
+                    stderr: logErr.join(os.EOL)
+                };
+            }
+            /* c8 ignore next */
+            finally {
                 // restore the original command name
                 cli.currentCommandName = parentCommandName;
                 // restore the original logger
                 request_1.default.logger = currentLogger;
-                if (err) {
-                    return reject({
-                        error: err,
-                        stderr: logErr.join(os.EOL)
-                    });
-                }
-                resolve({
-                    stdout: log.join(os.EOL),
-                    stderr: logErr.join(os.EOL)
-                });
-            });
+            }
         });
     }
     loadAllCommands() {
-        const files = utils_1.fsUtil.readdirR(this.commandsFolder);
+        const files = fsUtil_1.fsUtil.readdirR(this.commandsFolder);
         files.forEach(file => {
             if (file.indexOf(`${path.sep}commands${path.sep}`) > -1 &&
                 file.indexOf(`${path.sep}assets${path.sep}`) < 0 &&
@@ -348,18 +295,21 @@ class Cli {
             this.loadAllCommands();
         }
     }
-    loadCommand(command) {
-        this.commands.push({
+    static getCommandInfo(command) {
+        return {
             aliases: command.alias(),
             name: command.name,
             command: command,
             options: this.getCommandOptions(command),
             defaultProperties: command.defaultProperties()
-        });
+        };
     }
-    getCommandOptions(command) {
+    loadCommand(command) {
+        this.commands.push(Cli.getCommandInfo(command));
+    }
+    static getCommandOptions(command) {
         const options = [];
-        command.options().forEach(option => {
+        command.options.forEach(option => {
             const required = option.option.indexOf('<') > -1;
             const optionArgs = option.option.split(/[ ,|]+/);
             let short;
@@ -390,7 +340,7 @@ class Cli {
             alias: {}
         };
         if (commandInfo) {
-            const commandTypes = commandInfo.command.types();
+            const commandTypes = commandInfo.command.types;
             if (commandTypes) {
                 minimistOptions.string = commandTypes.string;
                 minimistOptions.boolean = commandTypes.boolean;
@@ -484,7 +434,7 @@ class Cli {
                         Array.isArray(logStatement[0].value)) {
                         logStatement = logStatement[0].value;
                     }
-                    logStatement = logStatement.map((s) => utils_1.formatting.filterObject(s, currentCommand.defaultProperties));
+                    logStatement = logStatement.map((s) => formatting_1.formatting.filterObject(s, currentCommand.defaultProperties));
                 }
             }
         }
@@ -544,11 +494,11 @@ class Cli {
         }
         return undefined;
     }
-    printHelp(exitCode = 0) {
+    printHelp(helpMode, exitCode = 0) {
         const properties = {};
         if (this.commandToExecute) {
             properties.command = this.commandToExecute.name;
-            this.printCommandHelp();
+            this.printCommandHelp(helpMode);
         }
         else {
             Cli.log();
@@ -565,7 +515,7 @@ class Cli {
         appInsights_1.default.flush();
         process.exit(exitCode);
     }
-    printCommandHelp() {
+    printCommandHelp(helpMode) {
         let helpFilePath = '';
         let commandNameWords = [];
         if (this.commandToExecute) {
@@ -585,10 +535,66 @@ class Cli {
         }
         helpFilePath = path.join(...pathChunks);
         if (fs.existsSync(helpFilePath)) {
+            let helpContents = fs.readFileSync(helpFilePath, 'utf8');
+            helpContents = this.getHelpSection(helpMode, helpContents);
+            helpContents = md_1.md.md2plain(helpContents, path.join(this.commandsFolder, '..', '..', 'docs'));
             Cli.log();
-            Cli.log(utils_1.md.md2plain(fs.readFileSync(helpFilePath, 'utf8'), path.join(this.commandsFolder, '..', '..', 'docs')));
+            Cli.log(helpContents);
         }
     }
+    getHelpMode(options) {
+        const h = options.h;
+        const help = options.help;
+        // user passed -h or --help, let's see if they passed a specific mode
+        // or requested the default
+        if (h || help) {
+            const helpMode = h !== null && h !== void 0 ? h : help;
+            if (typeof helpMode === 'boolean' || typeof helpMode !== 'string') {
+                // requested default mode or passed a number, let's use default
+                return this.getSettingWithDefaultValue(settingsNames_1.settingsNames.helpMode, Cli.defaultHelpMode);
+            }
+            else {
+                const lowerCaseHelpMode = helpMode.toLowerCase();
+                if (Cli.helpModes.indexOf(lowerCaseHelpMode) < 0) {
+                    Cli.getInstance().closeWithError(`Unknown help mode ${helpMode}. Allowed values are ${Cli.helpModes.join(', ')}`, { options }, false);
+                    return ''; // noop
+                }
+                else {
+                    return lowerCaseHelpMode;
+                }
+            }
+        }
+        else {
+            return this.getSettingWithDefaultValue(settingsNames_1.settingsNames.helpMode, Cli.defaultHelpMode);
+        }
+    }
+    getHelpSection(helpMode, helpContents) {
+        if (helpMode === 'full') {
+            return helpContents;
+        }
+        // options is the first section, so get help up to options
+        const titleAndUsage = helpContents.substring(0, helpContents.indexOf('## Options'));
+        // find the requested section
+        const sectionLines = [];
+        const sectionName = helpMode[0].toUpperCase() + helpMode.substring(1);
+        const lines = helpContents.split('\n');
+        for (let i = 0; i < lines.length; i++) {
+            const line = lines[i];
+            if (line.indexOf(`## ${sectionName}`) === 0) {
+                sectionLines.push(line);
+            }
+            else if (sectionLines.length > 0) {
+                if (line.indexOf('## ') === 0) {
+                    // we've reached the next section, stop
+                    break;
+                }
+                else {
+                    sectionLines.push(line);
+                }
+            }
+        }
+        return titleAndUsage + sectionLines.join('\n');
+    }
     printAvailableCommands() {
         // commands that match the current group
         const commandsToPrint = {};
@@ -692,7 +698,7 @@ class Cli {
         Cli.error(errorMessage);
         if (showHelpIfEnabled &&
             this.getSettingWithDefaultValue(settingsNames_1.settingsNames.showHelpOnFailure, showHelpIfEnabled)) {
-            this.printHelp(exitCode);
+            this.printHelp(this.getHelpMode(args.options), exitCode);
         }
         else {
             process.exit(exitCode);
@@ -719,11 +725,11 @@ class Cli {
             console.error(message, ...optionalParams);
         }
     }
-    static prompt(options, cb) {
-        const inquirer = require('inquirer');
-        inquirer
-            .prompt(options)
-            .then(result => cb(result));
+    static prompt(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const inquirer = require('inquirer');
+            return yield inquirer.prompt(options);
+        });
     }
     static removeShortOptions(args) {
         const filteredArgs = JSON.parse(JSON.stringify(args));
@@ -751,4 +757,6 @@ class Cli {
     }
 }
 exports.Cli = Cli;
+Cli.defaultHelpMode = 'full';
+Cli.helpModes = ['options', 'examples', 'remarks', 'response', 'full'];
 //# sourceMappingURL=Cli.js.map

package/dist/index.js

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs");
 const path = require("path");
 const appInsights_1 = require("./appInsights");
-const cli_1 = require("./cli");
+const Cli_1 = require("./cli/Cli");
 const packageJSON = require('../package.json');
 // required to make console.log() in combination with piped output synchronous
 // on Windows/in PowerShell so that the output is not trimmed by calling
@@ -19,7 +19,7 @@ if (!process.env.CLIMICROSOFT365_NOUPDATE) {
 }
 fs.realpath(__dirname, (err, resolvedPath) => {
     try {
-        const cli = cli_1.Cli.getInstance();
+        const cli = Cli_1.Cli.getInstance();
         cli.execute(path.join(resolvedPath, 'm365'), process.argv.slice(2));
     }
     catch (e) {