@pnp/cli-microsoft365 6.0.0-beta.5637b93 → 6.0.0-beta.5bdba89

package/dist/m365/spfx/commands/project/project-upgrade.js

@@ -18,8 +18,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs = require("fs");
 const os = require("os");
 const path = require("path");
+// uncomment to support upgrading to preview releases
+const semver_1 = require("semver");
 const Command_1 = require("../../../../Command");
-const utils_1 = require("../../../../utils");
+const fsUtil_1 = require("../../../../utils/fsUtil");
+const packageManager_1 = require("../../../../utils/packageManager");
 const commands_1 = require("../../commands");
 const base_project_command_1 = require("./base-project-command");
 const FN017001_MISC_npm_dedupe_1 = require("./project-upgrade/rules/FN017001_MISC_npm_dedupe");
@@ -62,7 +65,8 @@ class SpfxProjectUpgradeCommand extends base_project_command_1.BaseProjectComman
             '1.13.1',
             '1.14.0',
             '1.15.0',
-            '1.15.2'
+            '1.15.2',
+            '1.16.0-rc.0'
         ];
         __classPrivateFieldGet(this, _SpfxProjectUpgradeCommand_instances, "m", _SpfxProjectUpgradeCommand_initTelemetry).call(this);
         __classPrivateFieldGet(this, _SpfxProjectUpgradeCommand_instances, "m", _SpfxProjectUpgradeCommand_initOptions).call(this);
@@ -74,196 +78,193 @@ class SpfxProjectUpgradeCommand extends base_project_command_1.BaseProjectComman
     get description() {
         return 'Upgrades SharePoint Framework project to the specified version';
     }
-    commandAction(logger, args, cb) {
-        this.projectRootPath = this.getProjectRoot(process.cwd());
-        if (this.projectRootPath === null) {
-            cb(new Command_1.CommandError(`Couldn't find project root folder`, SpfxProjectUpgradeCommand.ERROR_NO_PROJECT_ROOT_FOLDER));
-            return;
-        }
-        this.toVersion = args.options.toVersion ? args.options.toVersion : this.supportedVersions[this.supportedVersions.length - 1];
-        // uncomment to support upgrading to preview releases
-        // if (!args.options.toVersion &&
-        //   !args.options.preview &&
-        //   prerelease(this.toVersion)) {
-        //   // no version and no preview specified while the current version to
-        //   // upgrade to is a prerelease so let's grab the first non-preview version
-        //   // since we're supporting only one preview version, it's sufficient for
-        //   // us to take second to last version
-        //   this.toVersion = this.supportedVersions[this.supportedVersions.length - 2];
-        // }
-        this.packageManager = args.options.packageManager || 'npm';
-        this.shell = args.options.shell || 'bash';
-        if (this.supportedVersions.indexOf(this.toVersion) < 0) {
-            cb(new Command_1.CommandError(`CLI for Microsoft 365 doesn't support upgrading SharePoint Framework projects to version ${this.toVersion}. Supported versions are ${this.supportedVersions.join(', ')}`, SpfxProjectUpgradeCommand.ERROR_UNSUPPORTED_TO_VERSION));
-            return;
-        }
-        this.projectVersion = this.getProjectVersion();
-        if (!this.projectVersion) {
-            cb(new Command_1.CommandError(`Unable to determine the version of the current SharePoint Framework project`, SpfxProjectUpgradeCommand.ERROR_NO_VERSION));
-            return;
-        }
-        const pos = this.supportedVersions.indexOf(this.projectVersion);
-        if (pos < 0) {
-            cb(new Command_1.CommandError(`CLI for Microsoft 365 doesn't support upgrading projects built using SharePoint Framework v${this.projectVersion}`, SpfxProjectUpgradeCommand.ERROR_UNSUPPORTED_FROM_VERSION));
-            return;
-        }
-        const posTo = this.supportedVersions.indexOf(this.toVersion);
-        if (pos > posTo) {
-            cb(new Command_1.CommandError('You cannot downgrade a project', SpfxProjectUpgradeCommand.ERROR_NO_DOWNGRADE));
-            return;
-        }
-        if (pos === posTo) {
-            logger.log(`Project doesn't need to be upgraded`);
-            cb();
-            return;
-        }
-        if (this.verbose) {
-            logger.logToStderr('Collecting project...');
-        }
-        const project = this.getProject(this.projectRootPath);
-        if (this.debug) {
-            logger.logToStderr('Collected project');
-            logger.logToStderr(project);
-        }
-        // reverse the list of versions to upgrade to, so that most recent findings
-        // will end up on top already. Saves us reversing a larger array later
-        const versionsToUpgradeTo = this.supportedVersions.slice(pos + 1, posTo + 1).reverse();
-        try {
-            versionsToUpgradeTo.forEach(v => {
-                const rules = require(`./project-upgrade/upgrade-${v}`);
-                rules.forEach(r => {
-                    r.visit(project, this.allFindings);
-                });
-            });
-        }
-        catch (e) {
-            cb(new Command_1.CommandError(e.message));
-            return;
-        }
-        if (this.packageManager === 'npm') {
-            const npmDedupeRule = new FN017001_MISC_npm_dedupe_1.FN017001_MISC_npm_dedupe();
-            npmDedupeRule.visit(project, this.allFindings);
-        }
-        // dedupe
-        const findings = this.allFindings.filter((f, i) => {
-            const firstFindingPos = this.allFindings.findIndex(f1 => f1.id === f.id);
-            return i === firstFindingPos;
-        });
-        // remove superseded findings
-        findings
-            // get findings that supersede other findings
-            .filter(f => f.supersedes.length > 0)
-            .forEach(f => {
-            f.supersedes.forEach(s => {
-                // find the superseded finding
-                const i = findings.findIndex(f1 => f1.id === s);
-                if (i > -1) {
-                    // ...and remove it from findings
-                    findings.splice(i, 1);
-                }
-            });
-        });
-        // remove findings without title
-        findings
-            .forEach(f => {
-            if (!f.title) {
-                // find the finding
-                const i = findings.findIndex(f1 => f1.id === f.id);
-                if (i > -1) {
-                    // ...and remove it from findings
-                    findings.splice(i, 1);
-                }
+    get allowedOutputs() {
+        return ['json', 'text', 'md', 'tour'];
+    }
+    commandAction(logger, args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this.projectRootPath = this.getProjectRoot(process.cwd());
+            if (this.projectRootPath === null) {
+                throw new Command_1.CommandError(`Couldn't find project root folder`, SpfxProjectUpgradeCommand.ERROR_NO_PROJECT_ROOT_FOLDER);
             }
-        });
-        // flatten
-        const findingsToReport = [].concat.apply([], findings.map(f => {
-            return f.occurrences.map(o => {
-                return {
-                    description: f.description,
-                    id: f.id,
-                    file: o.file,
-                    position: o.position,
-                    resolution: o.resolution,
-                    resolutionType: f.resolutionType,
-                    severity: f.severity,
-                    title: f.title
-                };
-            });
-        }));
-        // replace package operation tokens with command for the specific package manager
-        findingsToReport.forEach(f => {
-            // matches must be in this particular order to avoid false matches, eg.
-            // uninstallDev contains install
-            if (f.resolution.startsWith('uninstallDev')) {
-                f.resolution = f.resolution.replace('uninstallDev', utils_1.packageManager.getPackageManagerCommand('uninstallDev', this.packageManager));
-                return;
+            this.toVersion = args.options.toVersion ? args.options.toVersion : this.supportedVersions[this.supportedVersions.length - 1];
+            // uncomment to support upgrading to preview releases
+            if (!args.options.toVersion &&
+                !args.options.preview &&
+                (0, semver_1.prerelease)(this.toVersion)) {
+                // no version and no preview specified while the current version to
+                // upgrade to is a prerelease so let's grab the first non-preview version
+                // since we're supporting only one preview version, it's sufficient for
+                // us to take second to last version
+                this.toVersion = this.supportedVersions[this.supportedVersions.length - 2];
             }
-            if (f.resolution.startsWith('installDev')) {
-                f.resolution = f.resolution.replace('installDev', utils_1.packageManager.getPackageManagerCommand('installDev', this.packageManager));
-                return;
+            this.packageManager = args.options.packageManager || 'npm';
+            this.shell = args.options.shell || 'bash';
+            if (this.supportedVersions.indexOf(this.toVersion) < 0) {
+                throw new Command_1.CommandError(`CLI for Microsoft 365 doesn't support upgrading SharePoint Framework projects to version ${this.toVersion}. Supported versions are ${this.supportedVersions.join(', ')}`, SpfxProjectUpgradeCommand.ERROR_UNSUPPORTED_TO_VERSION);
             }
-            if (f.resolution.startsWith('uninstall')) {
-                f.resolution = f.resolution.replace('uninstall', utils_1.packageManager.getPackageManagerCommand('uninstall', this.packageManager));
-                return;
+            this.projectVersion = this.getProjectVersion();
+            if (!this.projectVersion) {
+                throw new Command_1.CommandError(`Unable to determine the version of the current SharePoint Framework project`, SpfxProjectUpgradeCommand.ERROR_NO_VERSION);
             }
-            if (f.resolution.startsWith('install')) {
-                f.resolution = f.resolution.replace('install', utils_1.packageManager.getPackageManagerCommand('install', this.packageManager));
-                return;
+            const pos = this.supportedVersions.indexOf(this.projectVersion);
+            if (pos < 0) {
+                throw new Command_1.CommandError(`CLI for Microsoft 365 doesn't support upgrading projects built using SharePoint Framework v${this.projectVersion}`, SpfxProjectUpgradeCommand.ERROR_UNSUPPORTED_FROM_VERSION);
             }
-            // copy support for multiple shells
-            if (f.resolution.startsWith('copy_cmd')) {
-                f.resolution = f.resolution.replace('copy_cmd', utils_1.fsUtil.getCopyCommand('copyCommand', this.shell));
-                f.resolution = f.resolution.replace('DestinationParam', utils_1.fsUtil.getCopyCommand('copyDestinationParam', this.shell));
-                return;
+            const posTo = this.supportedVersions.indexOf(this.toVersion);
+            if (pos > posTo) {
+                throw new Command_1.CommandError('You cannot downgrade a project', SpfxProjectUpgradeCommand.ERROR_NO_DOWNGRADE);
             }
-            // createdir support for multiple shells
-            if (f.resolution.startsWith('create_dir_cmd')) {
-                f.resolution = f.resolution.replace('create_dir_cmd', utils_1.fsUtil.getDirectoryCommand('createDirectoryCommand', this.shell));
-                f.resolution = f.resolution.replace('NameParam', utils_1.fsUtil.getDirectoryCommand('createDirectoryNameParam', this.shell));
-                f.resolution = f.resolution.replace('PathParam', utils_1.fsUtil.getDirectoryCommand('createDirectoryPathParam', this.shell));
-                f.resolution = f.resolution.replace('ItemTypeParam', utils_1.fsUtil.getDirectoryCommand('createDirectoryItemTypeParam', this.shell));
+            if (pos === posTo) {
+                logger.log(`Project doesn't need to be upgraded`);
                 return;
             }
-            // 'Add' support for multiple shells
-            if (f.resolution.startsWith('add_cmd')) {
-                const pathStart = f.resolution.indexOf('[BEFOREPATH]') + '[BEFOREPATH]'.length;
-                const pathEnd = f.resolution.indexOf('[AFTERPATH]');
-                const filePath = f.resolution.substring(pathStart, pathEnd);
-                const contentStart = f.resolution.indexOf('[BEFORECONTENT]') + '[BEFORECONTENT]'.length;
-                const contentEnd = f.resolution.indexOf('[AFTERCONTENT]');
-                const fileContent = f.resolution.substring(contentStart, contentEnd);
-                f.resolution = utils_1.fsUtil.getAddCommand('addFileCommand', this.shell);
-                f.resolution = f.resolution.replace('[FILECONTENT]', fileContent);
-                f.resolution = f.resolution.replace('[FILEPATH]', filePath);
-                f.resolution = f.resolution.replace('[BEFOREPATH]', ' ');
-                f.resolution = f.resolution.replace('[AFTERPATH]', ' ');
-                f.resolution = f.resolution.replace('[BEFORECONTENT]', ' ');
-                f.resolution = f.resolution.replace('[AFTERCONTENT]', ' ');
-                return;
+            if (this.verbose) {
+                logger.logToStderr('Collecting project...');
             }
-            // 'Remove' support for multiple shells
-            if (f.resolution.startsWith('remove_cmd')) {
-                f.resolution = f.resolution.replace('remove_cmd', utils_1.fsUtil.getRemoveCommand('removeFileCommand', this.shell));
-                return;
+            const project = this.getProject(this.projectRootPath);
+            if (this.debug) {
+                logger.logToStderr('Collected project');
+                logger.logToStderr(project);
+            }
+            // reverse the list of versions to upgrade to, so that most recent findings
+            // will end up on top already. Saves us reversing a larger array later
+            const versionsToUpgradeTo = this.supportedVersions.slice(pos + 1, posTo + 1).reverse();
+            try {
+                versionsToUpgradeTo.forEach(v => {
+                    const rules = require(`./project-upgrade/upgrade-${v}`);
+                    rules.forEach(r => {
+                        r.visit(project, this.allFindings);
+                    });
+                });
+            }
+            catch (e) {
+                throw new Command_1.CommandError(e.message);
+            }
+            if (this.packageManager === 'npm') {
+                const npmDedupeRule = new FN017001_MISC_npm_dedupe_1.FN017001_MISC_npm_dedupe();
+                npmDedupeRule.visit(project, this.allFindings);
+            }
+            // dedupe
+            const findings = this.allFindings.filter((f, i) => {
+                const firstFindingPos = this.allFindings.findIndex(f1 => f1.id === f.id);
+                return i === firstFindingPos;
+            });
+            // remove superseded findings
+            findings
+                // get findings that supersede other findings
+                .filter(f => f.supersedes.length > 0)
+                .forEach(f => {
+                f.supersedes.forEach(s => {
+                    // find the superseded finding
+                    const i = findings.findIndex(f1 => f1.id === s);
+                    if (i > -1) {
+                        // ...and remove it from findings
+                        findings.splice(i, 1);
+                    }
+                });
+            });
+            // remove findings without title
+            findings
+                .forEach(f => {
+                if (!f.title) {
+                    // find the finding
+                    const i = findings.findIndex(f1 => f1.id === f.id);
+                    if (i > -1) {
+                        // ...and remove it from findings
+                        findings.splice(i, 1);
+                    }
+                }
+            });
+            // flatten
+            const findingsToReport = [].concat.apply([], findings.map(f => {
+                return f.occurrences.map(o => {
+                    return {
+                        description: f.description,
+                        id: f.id,
+                        file: o.file,
+                        position: o.position,
+                        resolution: o.resolution,
+                        resolutionType: f.resolutionType,
+                        severity: f.severity,
+                        title: f.title
+                    };
+                });
+            }));
+            // replace package operation tokens with command for the specific package manager
+            findingsToReport.forEach(f => {
+                // matches must be in this particular order to avoid false matches, eg.
+                // uninstallDev contains install
+                if (f.resolution.startsWith('uninstallDev')) {
+                    f.resolution = f.resolution.replace('uninstallDev', packageManager_1.packageManager.getPackageManagerCommand('uninstallDev', this.packageManager));
+                    return;
+                }
+                if (f.resolution.startsWith('installDev')) {
+                    f.resolution = f.resolution.replace('installDev', packageManager_1.packageManager.getPackageManagerCommand('installDev', this.packageManager));
+                    return;
+                }
+                if (f.resolution.startsWith('uninstall')) {
+                    f.resolution = f.resolution.replace('uninstall', packageManager_1.packageManager.getPackageManagerCommand('uninstall', this.packageManager));
+                    return;
+                }
+                if (f.resolution.startsWith('install')) {
+                    f.resolution = f.resolution.replace('install', packageManager_1.packageManager.getPackageManagerCommand('install', this.packageManager));
+                    return;
+                }
+                // copy support for multiple shells
+                if (f.resolution.startsWith('copy_cmd')) {
+                    f.resolution = f.resolution.replace('copy_cmd', fsUtil_1.fsUtil.getCopyCommand('copyCommand', this.shell));
+                    f.resolution = f.resolution.replace('DestinationParam', fsUtil_1.fsUtil.getCopyCommand('copyDestinationParam', this.shell));
+                    return;
+                }
+                // createdir support for multiple shells
+                if (f.resolution.startsWith('create_dir_cmd')) {
+                    f.resolution = f.resolution.replace('create_dir_cmd', fsUtil_1.fsUtil.getDirectoryCommand('createDirectoryCommand', this.shell));
+                    f.resolution = f.resolution.replace('NameParam', fsUtil_1.fsUtil.getDirectoryCommand('createDirectoryNameParam', this.shell));
+                    f.resolution = f.resolution.replace('PathParam', fsUtil_1.fsUtil.getDirectoryCommand('createDirectoryPathParam', this.shell));
+                    f.resolution = f.resolution.replace('ItemTypeParam', fsUtil_1.fsUtil.getDirectoryCommand('createDirectoryItemTypeParam', this.shell));
+                    return;
+                }
+                // 'Add' support for multiple shells
+                if (f.resolution.startsWith('add_cmd')) {
+                    const pathStart = f.resolution.indexOf('[BEFOREPATH]') + '[BEFOREPATH]'.length;
+                    const pathEnd = f.resolution.indexOf('[AFTERPATH]');
+                    const filePath = f.resolution.substring(pathStart, pathEnd);
+                    const contentStart = f.resolution.indexOf('[BEFORECONTENT]') + '[BEFORECONTENT]'.length;
+                    const contentEnd = f.resolution.indexOf('[AFTERCONTENT]');
+                    const fileContent = f.resolution.substring(contentStart, contentEnd);
+                    f.resolution = fsUtil_1.fsUtil.getAddCommand('addFileCommand', this.shell);
+                    f.resolution = f.resolution.replace('[FILECONTENT]', fileContent);
+                    f.resolution = f.resolution.replace('[FILEPATH]', filePath);
+                    f.resolution = f.resolution.replace('[BEFOREPATH]', ' ');
+                    f.resolution = f.resolution.replace('[AFTERPATH]', ' ');
+                    f.resolution = f.resolution.replace('[BEFORECONTENT]', ' ');
+                    f.resolution = f.resolution.replace('[AFTERCONTENT]', ' ');
+                    return;
+                }
+                // 'Remove' support for multiple shells
+                if (f.resolution.startsWith('remove_cmd')) {
+                    f.resolution = f.resolution.replace('remove_cmd', fsUtil_1.fsUtil.getRemoveCommand('removeFileCommand', this.shell));
+                    return;
+                }
+            });
+            switch (args.options.output) {
+                case 'text':
+                    logger.log(this.getTextReport(findingsToReport));
+                    break;
+                case 'json':
+                    logger.log(findingsToReport);
+                    break;
+                case 'tour':
+                    this.writeReportTourFolder(this.getTourReport(findingsToReport, project));
+                    break;
+                case 'md':
+                    logger.log(this.getMdReport(findingsToReport));
+                    break;
+                default:
+                    logger.log(findingsToReport);
             }
         });
-        switch (args.options.output) {
-            case 'text':
-                logger.log(this.getTextReport(findingsToReport));
-                break;
-            case 'json':
-                logger.log(findingsToReport);
-                break;
-            case 'tour':
-                this.writeReportTourFolder(this.getTourReport(findingsToReport, project));
-                break;
-            case 'md':
-                logger.log(this.getMdReport(findingsToReport));
-                break;
-            default:
-                logger.log(findingsToReport);
-        }
-        cb();
     }
     writeReportTourFolder(findingsToReport) {
         const toursFolder = path.join(this.projectRootPath, '.tours');
@@ -280,10 +281,10 @@ class SpfxProjectUpgradeCommand extends base_project_command_1.BaseProjectComman
             '-----------------------', os.EOL,
             (reportData.packageManagerCommands
                 .concat(reportData.commandsToExecute
-                .filter((command) => command.indexOf(utils_1.packageManager.getPackageManagerCommand('install', this.packageManager)) === -1 &&
-                command.indexOf(utils_1.packageManager.getPackageManagerCommand('installDev', this.packageManager)) === -1 &&
-                command.indexOf(utils_1.packageManager.getPackageManagerCommand('uninstall', this.packageManager)) === -1 &&
-                command.indexOf(utils_1.packageManager.getPackageManagerCommand('uninstallDev', this.packageManager)) === -1))).join(os.EOL), os.EOL,
+                .filter((command) => command.indexOf(packageManager_1.packageManager.getPackageManagerCommand('install', this.packageManager)) === -1 &&
+                command.indexOf(packageManager_1.packageManager.getPackageManagerCommand('installDev', this.packageManager)) === -1 &&
+                command.indexOf(packageManager_1.packageManager.getPackageManagerCommand('uninstall', this.packageManager)) === -1 &&
+                command.indexOf(packageManager_1.packageManager.getPackageManagerCommand('uninstallDev', this.packageManager)) === -1))).join(os.EOL), os.EOL,
             os.EOL,
             Object.keys(reportData.modificationPerFile).map(file => {
                 return [
@@ -339,10 +340,10 @@ ${f.resolution}
             '```sh', os.EOL,
             (reportData.packageManagerCommands
                 .concat(reportData.commandsToExecute
-                .filter((command) => command.indexOf(utils_1.packageManager.getPackageManagerCommand('install', this.packageManager)) === -1 &&
-                command.indexOf(utils_1.packageManager.getPackageManagerCommand('installDev', this.packageManager)) === -1 &&
-                command.indexOf(utils_1.packageManager.getPackageManagerCommand('uninstall', this.packageManager)) === -1 &&
-                command.indexOf(utils_1.packageManager.getPackageManagerCommand('uninstallDev', this.packageManager)) === -1))).join(os.EOL), os.EOL,
+                .filter((command) => command.indexOf(packageManager_1.packageManager.getPackageManagerCommand('install', this.packageManager)) === -1 &&
+                command.indexOf(packageManager_1.packageManager.getPackageManagerCommand('installDev', this.packageManager)) === -1 &&
+                command.indexOf(packageManager_1.packageManager.getPackageManagerCommand('uninstall', this.packageManager)) === -1 &&
+                command.indexOf(packageManager_1.packageManager.getPackageManagerCommand('uninstallDev', this.packageManager)) === -1))).join(os.EOL), os.EOL,
             '```', os.EOL,
             os.EOL,
             '### Modify files', os.EOL,
@@ -422,7 +423,7 @@ ${f.resolution}
             if (f.resolutionType === 'cmd') {
                 if (f.resolution.indexOf('npm') > -1 ||
                     f.resolution.indexOf('yarn') > -1) {
-                    utils_1.packageManager.mapPackageManagerCommand({
+                    packageManager_1.packageManager.mapPackageManagerCommand({
                         command: f.resolution,
                         packagesDevExact,
                         packagesDepExact,
@@ -448,7 +449,7 @@ ${f.resolution}
                 });
             }
         });
-        const packageManagerCommands = utils_1.packageManager.reducePackageManagerCommand({
+        const packageManagerCommands = packageManager_1.packageManager.reducePackageManagerCommand({
             packagesDepExact,
             packagesDevExact,
             packagesDepUn,
@@ -478,9 +479,9 @@ _SpfxProjectUpgradeCommand_instances = new WeakSet(), _SpfxProjectUpgradeCommand
             preview: args.options.preview
         });
         // uncomment to support upgrading to preview releases
-        // if (prerelease(this.telemetryProperties.toVersion) && !args.options.preview) {
-        //   this.telemetryProperties.toVersion = this.supportedVersions[this.supportedVersions.length - 2];
-        // }
+        if ((0, semver_1.prerelease)(this.telemetryProperties.toVersion) && !args.options.preview) {
+            this.telemetryProperties.toVersion = this.supportedVersions[this.supportedVersions.length - 2];
+        }
     });
 }, _SpfxProjectUpgradeCommand_initOptions = function _SpfxProjectUpgradeCommand_initOptions() {
     this.options.unshift({
@@ -496,7 +497,7 @@ _SpfxProjectUpgradeCommand_instances = new WeakSet(), _SpfxProjectUpgradeCommand
     });
     this.options.forEach(o => {
         if (o.option.indexOf('--output') > -1) {
-            o.autocomplete = ['json', 'text', 'md', 'tour'];
+            o.autocomplete = this.allowedOutputs;
         }
     });
 }, _SpfxProjectUpgradeCommand_initValidators = function _SpfxProjectUpgradeCommand_initValidators() {