@pnp/cli-microsoft365 6.0.0-beta.ff232be → 6.1.0-beta.17b053d

package/dist/cli/Cli.js

@@ -14,19 +14,17 @@ const fs = require("fs");
 const minimist = require("minimist");
 const os = require("os");
 const path = require("path");
-const appInsights_1 = require("../appInsights");
 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 validation_1 = require("../utils/validation");
+const telemetry_1 = require("../telemetry");
 const packageJSON = require('../../package.json');
 class Cli {
-    // eslint-disable-next-line @typescript-eslint/no-empty-function
-    constructor() {
-        this.commands = [];
-        this.commandsFolder = '';
-    }
     get config() {
         if (!this._config) {
             const configStore = require('configstore');
@@ -43,6 +41,11 @@ class Cli {
             return configuredValue;
         }
     }
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    constructor() {
+        this.commands = [];
+        this.commandsFolder = '';
+    }
     static getInstance() {
         if (!Cli.instance) {
             Cli.instance = new Cli();
@@ -81,9 +84,15 @@ class Cli {
                 // we have found a command to execute. Parse args again taking into
                 // account short and long options, option types and whether the command
                 // supports known and unknown options or not
-                this.optionsFromArgs = {
-                    options: this.getCommandOptionsFromArgs(rawArgs, this.commandToExecute)
-                };
+                try {
+                    this.optionsFromArgs = {
+                        options: this.getCommandOptionsFromArgs(rawArgs, this.commandToExecute)
+                    };
+                }
+                catch (e) {
+                    const optionsWithoutShorts = Cli.removeShortOptions({ options: parsedArgs });
+                    return this.closeWithError(e.message, optionsWithoutShorts, false);
+                }
             }
             else {
                 this.optionsFromArgs = {
@@ -96,54 +105,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 +125,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,10 +137,10 @@ 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);
+                    const output = Cli.formatOutput(command, message, args.options);
                     Cli.log(output);
                 },
                 logRaw: (message) => Cli.log(message),
@@ -203,34 +154,33 @@ 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 = {
                 log: (message) => {
-                    const formattedMessage = Cli.formatOutput(message, args.options);
+                    const formattedMessage = Cli.formatOutput(command, message, args.options);
                     if (listener && listener.stdout) {
                         listener.stdout(formattedMessage);
                     }
                     log.push(formattedMessage);
                 },
                 logRaw: (message) => {
-                    const formattedMessage = Cli.formatOutput(message, args.options);
+                    const formattedMessage = Cli.formatOutput(command, message, args.options);
                     if (listener && listener.stdout) {
                         listener.stdout(formattedMessage);
                     }
@@ -257,26 +207,35 @@ 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) {
+                // restoring the command and logger is done here instead of in a 'finally' because there were issues with the code coverage tool
                 // 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),
+                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;
+            }
         });
     }
     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 +307,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()
-        });
+        };
+    }
+    loadCommand(command) {
+        this.commands.push(Cli.getCommandInfo(command));
     }
-    getCommandOptions(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;
@@ -389,11 +351,15 @@ class Cli {
         const minimistOptions = {
             alias: {}
         };
+        let argsToParse = args;
         if (commandInfo) {
-            const commandTypes = commandInfo.command.types();
+            const commandTypes = commandInfo.command.types;
             if (commandTypes) {
                 minimistOptions.string = commandTypes.string;
-                minimistOptions.boolean = commandTypes.boolean;
+                // minimist will parse unused boolean options to 'false' (unused options => options that are not included in the args) 
+                // But in the CLI booleans are nullable. They can can be true, false or undefined.
+                // For this reason we only pass boolean types that are actually used as arg.
+                minimistOptions.boolean = commandTypes.boolean.filter(optionName => args.some(arg => `--${optionName}` === arg || `-${optionName}` === arg));
             }
             minimistOptions.alias = {};
             commandInfo.options.forEach(option => {
@@ -401,10 +367,37 @@ class Cli {
                     minimistOptions.alias[option.short] = option.long;
                 }
             });
+            argsToParse = this.getRewrittenArgs(args, commandTypes);
         }
-        return minimist(args, minimistOptions);
+        return minimist(argsToParse, minimistOptions);
     }
-    static formatOutput(logStatement, options) {
+    /**
+     * Rewrites arguments (if necessary) before passing them into minimist.
+     * Currently only boolean values are checked and fixed.
+     * Args are only checked and rewritten if the option has been added to the 'types.boolean' array.
+     */
+    getRewrittenArgs(args, commandTypes) {
+        const booleanTypes = commandTypes.boolean;
+        if (booleanTypes.length === 0) {
+            return args;
+        }
+        return args.map((arg, index, array) => {
+            if (arg.startsWith('-') || index === 0) {
+                return arg;
+            }
+            // This line checks if the current arg is a value that belongs to a boolean option.
+            if (booleanTypes.some(t => `--${t}` === array[index - 1] || `-${t}` === array[index - 1])) {
+                const rewrittenBoolean = formatting_1.formatting.rewriteBooleanValue(arg);
+                if (!validation_1.validation.isValidBoolean(rewrittenBoolean)) {
+                    const optionName = array[index - 1];
+                    throw new Error(`The value '${arg}' for option '${optionName}' is not a valid boolean`);
+                }
+                return rewrittenBoolean;
+            }
+            return arg;
+        });
+    }
+    static formatOutput(command, logStatement, options) {
         if (logStatement instanceof Date) {
             return logStatement.toString();
         }
@@ -434,10 +427,7 @@ class Cli {
             logStatementType = typeof logStatement;
         }
         if (!options.output || options.output === 'json') {
-            return JSON
-                .stringify(logStatement, null, 2)
-                // replace unescaped newlines with escaped newlines #2807
-                .replace(/([^\\])\\n/g, '$1\\\\\\n');
+            return command.getJsonOutput(logStatement);
         }
         if (logStatement instanceof Command_1.CommandError) {
             const chalk = require('chalk');
@@ -484,55 +474,17 @@ 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));
                 }
             }
         }
-        if (options.output === 'csv') {
-            const { stringify } = require('csv-stringify/sync');
-            const cli = Cli.getInstance();
-            // https://csv.js.org/stringify/options/
-            return stringify(logStatement, {
-                header: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvHeader, true),
-                escape: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvEscape, '"'),
-                quote: cli.config.get(settingsNames_1.settingsNames.csvQuote),
-                quoted: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvQuoted, false),
-                quotedEmpty: cli.getSettingWithDefaultValue(settingsNames_1.settingsNames.csvQuotedEmpty, false)
-            });
-        }
-        // display object as a list of key-value pairs
-        if (logStatement.length === 1) {
-            const obj = logStatement[0];
-            const propertyNames = [];
-            Object.getOwnPropertyNames(obj).forEach(p => {
-                propertyNames.push(p);
-            });
-            let longestPropertyLength = 0;
-            propertyNames.forEach(p => {
-                if (p.length > longestPropertyLength) {
-                    longestPropertyLength = p.length;
-                }
-            });
-            const output = [];
-            propertyNames.sort().forEach(p => {
-                output.push(`${p.length < longestPropertyLength ? p + new Array(longestPropertyLength - p.length + 1).join(' ') : p}: ${Array.isArray(obj[p]) || typeof obj[p] === 'object' ? JSON.stringify(obj[p]) : obj[p]}`);
-            });
-            return output.join('\n') + '\n';
-        }
-        // display object as a table where each property is a column
-        else {
-            const Table = require('easy-table');
-            const t = new Table();
-            logStatement.forEach((r) => {
-                if (typeof r !== 'object') {
-                    return;
-                }
-                Object.getOwnPropertyNames(r).forEach(p => {
-                    t.cell(p, r[p]);
-                });
-                t.newRow();
-            });
-            return t.toString();
+        switch (options.output) {
+            case 'csv':
+                return command.getCsvOutput(logStatement);
+            case 'md':
+                return command.getMdOutput(logStatement, command, options);
+            default:
+                return command.getTextOutput(logStatement);
         }
     }
     static getFirstNonUndefinedArrayItem(arr) {
@@ -544,11 +496,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();
@@ -558,14 +510,10 @@ class Cli {
             properties.command = 'commandList';
             this.printAvailableCommands();
         }
-        appInsights_1.default.trackEvent({
-            name: 'help',
-            properties
-        });
-        appInsights_1.default.flush();
+        telemetry_1.telemetry.trackEvent('help', properties);
         process.exit(exitCode);
     }
-    printCommandHelp() {
+    printCommandHelp(helpMode) {
         let helpFilePath = '';
         let commandNameWords = [];
         if (this.commandToExecute) {
@@ -585,9 +533,65 @@ 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
@@ -692,7 +696,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 +723,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 +755,6 @@ class Cli {
     }
 }
 exports.Cli = Cli;
+Cli.defaultHelpMode = 'full';
+Cli.helpModes = ['options', 'examples', 'remarks', 'response', 'full'];
 //# sourceMappingURL=Cli.js.map

package/dist/index.js

@@ -3,8 +3,8 @@
 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 telemetry_1 = require("./telemetry");
 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,14 +19,11 @@ 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) {
-        appInsights_1.default.trackException({
-            exception: e
-        });
-        appInsights_1.default.flush();
+        telemetry_1.telemetry.trackException(e);
         process.exit(1);
     }
 });