@angular/cli 14.0.0-next.5 → 14.0.0-next.6

package/src/commands/update/cli.js

@@ -6,25 +6,81 @@
  * Use of this source code is governed by an MIT-style license that can be
  * found in the LICENSE file at https://angular.io/license
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UpdateCommandModule = void 0;
+const schematics_1 = require("@angular-devkit/schematics");
+const tools_1 = require("@angular-devkit/schematics/tools");
+const child_process_1 = require("child_process");
+const fs_1 = require("fs");
+const npm_package_arg_1 = __importDefault(require("npm-package-arg"));
+const npm_pick_manifest_1 = __importDefault(require("npm-pick-manifest"));
+const path = __importStar(require("path"));
+const path_1 = require("path");
+const semver = __importStar(require("semver"));
+const workspace_schema_1 = require("../../../lib/config/workspace-schema");
 const command_module_1 = require("../../command-builder/command-module");
-const update_impl_1 = require("./update-impl");
+const schematic_engine_host_1 = require("../../command-builder/utilities/schematic-engine-host");
+const schematic_workflow_1 = require("../../command-builder/utilities/schematic-workflow");
+const color_1 = require("../../utilities/color");
+const install_package_1 = require("../../utilities/install-package");
+const log_file_1 = require("../../utilities/log-file");
+const package_manager_1 = require("../../utilities/package-manager");
+const package_metadata_1 = require("../../utilities/package-metadata");
+const package_tree_1 = require("../../utilities/package-tree");
+const version_1 = require("../../utilities/version");
+/**
+ * Disable CLI version mismatch checks and forces usage of the invoked CLI
+ * instead of invoking the local installed version.
+ */
+const disableVersionCheckEnv = process.env['NG_DISABLE_VERSION_CHECK'];
+const disableVersionCheck = disableVersionCheckEnv !== undefined &&
+    disableVersionCheckEnv !== '0' &&
+    disableVersionCheckEnv.toLowerCase() !== 'false';
+const ANGULAR_PACKAGES_REGEXP = /^@(?:angular|nguniversal)\//;
+const UPDATE_SCHEMATIC_COLLECTION = path.join(__dirname, 'schematic/collection.json');
 class UpdateCommandModule extends command_module_1.CommandModule {
     constructor() {
         super(...arguments);
+        this.shouldReportAnalytics = false;
         this.command = 'update [packages..]';
         this.describe = 'Updates your workspace and its dependencies. See https://update.angular.io/.';
+        this.longDescriptionPath = (0, path_1.join)(__dirname, 'long-description.md');
     }
     builder(localYargs) {
         return localYargs
             .positional('packages', {
             description: 'The names of package(s) to update.',
-            type: 'string',
+            coerce: (value) => (typeof value === 'string' ? [value] : value),
         })
             .option('force', {
             description: 'Ignore peer dependency version mismatches. ' +
-                'Passes the `--force` flag to the package manager when installing packages.',
+                `Passes the '--force' flag to the package manager when installing packages.`,
             type: 'boolean',
             default: false,
         })
@@ -38,20 +94,22 @@ class UpdateCommandModule extends command_module_1.CommandModule {
             type: 'boolean',
         })
             .option('name', {
-            description: 'The name of the migration to run.',
+            description: 'The name of the migration to run. ' +
+                `Only available with a single package being updated, and only with 'migrate-only' option.`,
             type: 'string',
             implies: ['migrate-only'],
             conflicts: ['to', 'from'],
         })
             .option('from', {
-            description: 'Version from which to migrate from. Only available with a single package being updated, and only on migration only.',
+            description: 'Version from which to migrate from. ' +
+                `Only available with a single package being updated, and only with 'migrate-only'.`,
             type: 'string',
             implies: ['to', 'migrate-only'],
             conflicts: ['name'],
         })
             .option('to', {
             describe: 'Version up to which to apply migrations. Only available with a single package being updated, ' +
-                'and only on migrations only. Requires from to be specified. Default to the installed version detected.',
+                `and only with 'migrate-only' option. Requires 'from' to be specified. Default to the installed version detected.`,
             type: 'string',
             implies: ['from', 'migrate-only'],
             conflicts: ['name'],
@@ -71,13 +129,626 @@ class UpdateCommandModule extends command_module_1.CommandModule {
             type: 'boolean',
             alias: ['C'],
             default: false,
+        })
+            .check(({ packages, next, 'allow-dirty': allowDirty, 'migrate-only': migrateOnly }) => {
+            const { logger } = this.context;
+            // This allows the user to easily reset any changes from the update.
+            if ((packages === null || packages === void 0 ? void 0 : packages.length) && !this.checkCleanGit()) {
+                if (allowDirty) {
+                    logger.warn('Repository is not clean. Update changes will be mixed with pre-existing changes.');
+                }
+                else {
+                    throw new command_module_1.CommandModuleError('Repository is not clean. Please commit or stash any changes before updating.');
+                }
+            }
+            if (migrateOnly) {
+                if ((packages === null || packages === void 0 ? void 0 : packages.length) !== 1) {
+                    throw new command_module_1.CommandModuleError(`A single package must be specified when using the 'migrate-only' option.`);
+                }
+                if (next) {
+                    logger.warn(`'next' option has no effect when using 'migrate-only' option.`);
+                }
+            }
+            return true;
         })
             .strict();
     }
-    run(options) {
-        const command = new update_impl_1.UpdateCommand(this.context, 'update');
-        return command.validateAndRun(options);
+    async run(options) {
+        var _a, _b;
+        const { logger, packageManager } = this.context;
+        await (0, package_manager_1.ensureCompatibleNpm)(this.context.root);
+        // Check if the current installed CLI version is older than the latest compatible version.
+        if (!disableVersionCheck) {
+            const cliVersionToInstall = await this.checkCLIVersion(options.packages, options.verbose, options.next);
+            if (cliVersionToInstall) {
+                logger.warn('The installed Angular CLI version is outdated.\n' +
+                    `Installing a temporary Angular CLI versioned ${cliVersionToInstall} to perform the update.`);
+                return (0, install_package_1.runTempPackageBin)(`@angular/cli@${cliVersionToInstall}`, packageManager, process.argv.slice(2));
+            }
+        }
+        const packages = [];
+        for (const request of (_a = options.packages) !== null && _a !== void 0 ? _a : []) {
+            try {
+                const packageIdentifier = (0, npm_package_arg_1.default)(request);
+                // only registry identifiers are supported
+                if (!packageIdentifier.registry) {
+                    logger.error(`Package '${request}' is not a registry package identifer.`);
+                    return 1;
+                }
+                if (packages.some((v) => v.name === packageIdentifier.name)) {
+                    logger.error(`Duplicate package '${packageIdentifier.name}' specified.`);
+                    return 1;
+                }
+                if (options.migrateOnly && packageIdentifier.rawSpec) {
+                    logger.warn('Package specifier has no effect when using "migrate-only" option.');
+                }
+                // If next option is used and no specifier supplied, use next tag
+                if (options.next && !packageIdentifier.rawSpec) {
+                    packageIdentifier.fetchSpec = 'next';
+                }
+                packages.push(packageIdentifier);
+            }
+            catch (e) {
+                logger.error(e.message);
+                return 1;
+            }
+        }
+        logger.info(`Using package manager: '${packageManager}'`);
+        logger.info('Collecting installed dependencies...');
+        const rootDependencies = await (0, package_tree_1.getProjectDependencies)(this.context.root);
+        logger.info(`Found ${rootDependencies.size} dependencies.`);
+        const workflow = new tools_1.NodeWorkflow(this.context.root, {
+            packageManager: this.context.packageManager,
+            packageManagerForce: options.force,
+            // __dirname -> favor @schematics/update from this package
+            // Otherwise, use packages from the active workspace (migrations)
+            resolvePaths: [__dirname, this.context.root],
+            schemaValidation: true,
+            engineHostCreator: (options) => new schematic_engine_host_1.SchematicEngineHost(options.resolvePaths),
+        });
+        if (packages.length === 0) {
+            // Show status
+            const { success } = await this.executeSchematic(workflow, UPDATE_SCHEMATIC_COLLECTION, 'update', {
+                force: options.force,
+                next: options.next,
+                verbose: options.verbose,
+                packageManager,
+                packages: [],
+            });
+            return success ? 0 : 1;
+        }
+        return options.migrateOnly
+            ? this.migrateOnly(workflow, ((_b = options.packages) !== null && _b !== void 0 ? _b : [])[0], rootDependencies, options)
+            : this.updatePackagesAndMigrate(workflow, rootDependencies, options, packages);
+    }
+    async executeSchematic(workflow, collection, schematic, options = {}) {
+        const { logger } = this.context;
+        const workflowSubscription = (0, schematic_workflow_1.subscribeToWorkflow)(workflow, logger);
+        // TODO: Allow passing a schematic instance directly
+        try {
+            await workflow
+                .execute({
+                collection,
+                schematic,
+                options,
+                logger,
+            })
+                .toPromise();
+            return { success: !workflowSubscription.error, files: workflowSubscription.files };
+        }
+        catch (e) {
+            if (e instanceof schematics_1.UnsuccessfulWorkflowExecution) {
+                logger.error(`${color_1.colors.symbols.cross} Migration failed. See above for further details.\n`);
+            }
+            else {
+                const logPath = (0, log_file_1.writeErrorToLogFile)(e);
+                logger.fatal(`${color_1.colors.symbols.cross} Migration failed: ${e.message}\n` +
+                    `  See "${logPath}" for further details.\n`);
+            }
+            return { success: false, files: workflowSubscription.files };
+        }
+        finally {
+            workflowSubscription.unsubscribe();
+        }
+    }
+    /**
+     * @return Whether or not the migration was performed successfully.
+     */
+    async executeMigration(workflow, packageName, collectionPath, migrationName, commit) {
+        const { logger } = this.context;
+        const collection = workflow.engine.createCollection(collectionPath);
+        const name = collection.listSchematicNames().find((name) => name === migrationName);
+        if (!name) {
+            logger.error(`Cannot find migration '${migrationName}' in '${packageName}'.`);
+            return 1;
+        }
+        logger.info(color_1.colors.cyan(`** Executing '${migrationName}' of package '${packageName}' **\n`));
+        const schematic = workflow.engine.createSchematic(name, collection);
+        return this.executePackageMigrations(workflow, [schematic.description], packageName, commit);
+    }
+    /**
+     * @return Whether or not the migrations were performed successfully.
+     */
+    async executeMigrations(workflow, packageName, collectionPath, from, to, commit) {
+        const collection = workflow.engine.createCollection(collectionPath);
+        const migrationRange = new semver.Range('>' + (semver.prerelease(from) ? from.split('-')[0] + '-0' : from) + ' <=' + to.split('-')[0]);
+        const migrations = [];
+        for (const name of collection.listSchematicNames()) {
+            const schematic = workflow.engine.createSchematic(name, collection);
+            const description = schematic.description;
+            description.version = coerceVersionNumber(description.version);
+            if (!description.version) {
+                continue;
+            }
+            if (semver.satisfies(description.version, migrationRange, { includePrerelease: true })) {
+                migrations.push(description);
+            }
+        }
+        if (migrations.length === 0) {
+            return 0;
+        }
+        migrations.sort((a, b) => semver.compare(a.version, b.version) || a.name.localeCompare(b.name));
+        this.context.logger.info(color_1.colors.cyan(`** Executing migrations of package '${packageName}' **\n`));
+        return this.executePackageMigrations(workflow, migrations, packageName, commit);
+    }
+    async executePackageMigrations(workflow, migrations, packageName, commit = false) {
+        const { logger } = this.context;
+        for (const migration of migrations) {
+            const [title, ...description] = migration.description.split('. ');
+            logger.info(color_1.colors.cyan(color_1.colors.symbols.pointer) +
+                ' ' +
+                color_1.colors.bold(title.endsWith('.') ? title : title + '.'));
+            if (description.length) {
+                logger.info('  ' + description.join('.\n  '));
+            }
+            const result = await this.executeSchematic(workflow, migration.collection.name, migration.name);
+            if (!result.success) {
+                return 1;
+            }
+            logger.info('  Migration completed.');
+            // Commit migration
+            if (commit) {
+                const commitPrefix = `${packageName} migration - ${migration.name}`;
+                const commitMessage = migration.description
+                    ? `${commitPrefix}\n\n${migration.description}`
+                    : commitPrefix;
+                const committed = this.commit(commitMessage);
+                if (!committed) {
+                    // Failed to commit, something went wrong. Abort the update.
+                    return 1;
+                }
+            }
+            logger.info(''); // Extra trailing newline.
+        }
+        return 0;
+    }
+    async migrateOnly(workflow, packageName, rootDependencies, options) {
+        const { logger } = this.context;
+        const packageDependency = rootDependencies.get(packageName);
+        let packagePath = packageDependency === null || packageDependency === void 0 ? void 0 : packageDependency.path;
+        let packageNode = packageDependency === null || packageDependency === void 0 ? void 0 : packageDependency.package;
+        if (packageDependency && !packageNode) {
+            logger.error('Package found in package.json but is not installed.');
+            return 1;
+        }
+        else if (!packageDependency) {
+            // Allow running migrations on transitively installed dependencies
+            // There can technically be nested multiple versions
+            // TODO: If multiple, this should find all versions and ask which one to use
+            const packageJson = (0, package_tree_1.findPackageJson)(this.context.root, packageName);
+            if (packageJson) {
+                packagePath = path.dirname(packageJson);
+                packageNode = await (0, package_tree_1.readPackageJson)(packageJson);
+            }
+        }
+        if (!packageNode || !packagePath) {
+            logger.error('Package is not installed.');
+            return 1;
+        }
+        const updateMetadata = packageNode['ng-update'];
+        let migrations = updateMetadata === null || updateMetadata === void 0 ? void 0 : updateMetadata.migrations;
+        if (migrations === undefined) {
+            logger.error('Package does not provide migrations.');
+            return 1;
+        }
+        else if (typeof migrations !== 'string') {
+            logger.error('Package contains a malformed migrations field.');
+            return 1;
+        }
+        else if (path.posix.isAbsolute(migrations) || path.win32.isAbsolute(migrations)) {
+            logger.error('Package contains an invalid migrations field. Absolute paths are not permitted.');
+            return 1;
+        }
+        // Normalize slashes
+        migrations = migrations.replace(/\\/g, '/');
+        if (migrations.startsWith('../')) {
+            logger.error('Package contains an invalid migrations field. Paths outside the package root are not permitted.');
+            return 1;
+        }
+        // Check if it is a package-local location
+        const localMigrations = path.join(packagePath, migrations);
+        if ((0, fs_1.existsSync)(localMigrations)) {
+            migrations = localMigrations;
+        }
+        else {
+            // Try to resolve from package location.
+            // This avoids issues with package hoisting.
+            try {
+                migrations = require.resolve(migrations, { paths: [packagePath] });
+            }
+            catch (e) {
+                if (e.code === 'MODULE_NOT_FOUND') {
+                    logger.error('Migrations for package were not found.');
+                }
+                else {
+                    logger.error(`Unable to resolve migrations for package.  [${e.message}]`);
+                }
+                return 1;
+            }
+        }
+        if (options.name) {
+            return this.executeMigration(workflow, packageName, migrations, options.name, options.createCommits);
+        }
+        const from = coerceVersionNumber(options.from);
+        if (!from) {
+            logger.error(`"from" value [${options.from}] is not a valid version.`);
+            return 1;
+        }
+        return this.executeMigrations(workflow, packageName, migrations, from, options.to || packageNode.version, options.createCommits);
+    }
+    // eslint-disable-next-line max-lines-per-function
+    async updatePackagesAndMigrate(workflow, rootDependencies, options, packages) {
+        var _a;
+        const { logger } = this.context;
+        const logVerbose = (message) => {
+            if (options.verbose) {
+                logger.info(message);
+            }
+        };
+        const requests = [];
+        // Validate packages actually are part of the workspace
+        for (const pkg of packages) {
+            const node = rootDependencies.get(pkg.name);
+            if (!(node === null || node === void 0 ? void 0 : node.package)) {
+                logger.error(`Package '${pkg.name}' is not a dependency.`);
+                return 1;
+            }
+            // If a specific version is requested and matches the installed version, skip.
+            if (pkg.type === 'version' && node.package.version === pkg.fetchSpec) {
+                logger.info(`Package '${pkg.name}' is already at '${pkg.fetchSpec}'.`);
+                continue;
+            }
+            requests.push({ identifier: pkg, node });
+        }
+        if (requests.length === 0) {
+            return 0;
+        }
+        logger.info('Fetching dependency metadata from registry...');
+        const packagesToUpdate = [];
+        for (const { identifier: requestIdentifier, node } of requests) {
+            const packageName = requestIdentifier.name;
+            let metadata;
+            try {
+                // Metadata requests are internally cached; multiple requests for same name
+                // does not result in additional network traffic
+                metadata = await (0, package_metadata_1.fetchPackageMetadata)(packageName, logger, {
+                    verbose: options.verbose,
+                });
+            }
+            catch (e) {
+                logger.error(`Error fetching metadata for '${packageName}': ` + e.message);
+                return 1;
+            }
+            // Try to find a package version based on the user requested package specifier
+            // registry specifier types are either version, range, or tag
+            let manifest;
+            if (requestIdentifier.type === 'version' ||
+                requestIdentifier.type === 'range' ||
+                requestIdentifier.type === 'tag') {
+                try {
+                    manifest = (0, npm_pick_manifest_1.default)(metadata, requestIdentifier.fetchSpec);
+                }
+                catch (e) {
+                    if (e.code === 'ETARGET') {
+                        // If not found and next was used and user did not provide a specifier, try latest.
+                        // Package may not have a next tag.
+                        if (requestIdentifier.type === 'tag' &&
+                            requestIdentifier.fetchSpec === 'next' &&
+                            !requestIdentifier.rawSpec) {
+                            try {
+                                manifest = (0, npm_pick_manifest_1.default)(metadata, 'latest');
+                            }
+                            catch (e) {
+                                if (e.code !== 'ETARGET' && e.code !== 'ENOVERSIONS') {
+                                    throw e;
+                                }
+                            }
+                        }
+                    }
+                    else if (e.code !== 'ENOVERSIONS') {
+                        throw e;
+                    }
+                }
+            }
+            if (!manifest) {
+                logger.error(`Package specified by '${requestIdentifier.raw}' does not exist within the registry.`);
+                return 1;
+            }
+            if (manifest.version === ((_a = node.package) === null || _a === void 0 ? void 0 : _a.version)) {
+                logger.info(`Package '${packageName}' is already up to date.`);
+                continue;
+            }
+            if (node.package && ANGULAR_PACKAGES_REGEXP.test(node.package.name)) {
+                const { name, version } = node.package;
+                const toBeInstalledMajorVersion = +manifest.version.split('.')[0];
+                const currentMajorVersion = +version.split('.')[0];
+                if (toBeInstalledMajorVersion - currentMajorVersion > 1) {
+                    // Only allow updating a single version at a time.
+                    if (currentMajorVersion < 6) {
+                        // Before version 6, the major versions were not always sequential.
+                        // Example @angular/core skipped version 3, @angular/cli skipped versions 2-5.
+                        logger.error(`Updating multiple major versions of '${name}' at once is not supported. Please migrate each major version individually.\n` +
+                            `For more information about the update process, see https://update.angular.io/.`);
+                    }
+                    else {
+                        const nextMajorVersionFromCurrent = currentMajorVersion + 1;
+                        logger.error(`Updating multiple major versions of '${name}' at once is not supported. Please migrate each major version individually.\n` +
+                            `Run 'ng update ${name}@${nextMajorVersionFromCurrent}' in your workspace directory ` +
+                            `to update to latest '${nextMajorVersionFromCurrent}.x' version of '${name}'.\n\n` +
+                            `For more information about the update process, see https://update.angular.io/?v=${currentMajorVersion}.0-${nextMajorVersionFromCurrent}.0`);
+                    }
+                    return 1;
+                }
+            }
+            packagesToUpdate.push(requestIdentifier.toString());
+        }
+        if (packagesToUpdate.length === 0) {
+            return 0;
+        }
+        const { success } = await this.executeSchematic(workflow, UPDATE_SCHEMATIC_COLLECTION, 'update', {
+            verbose: options.verbose,
+            force: options.force,
+            next: options.next,
+            packageManager: this.context.packageManager,
+            packages: packagesToUpdate,
+        });
+        if (success) {
+            try {
+                await fs_1.promises.rm(path.join(this.context.root, 'node_modules'), {
+                    force: true,
+                    recursive: true,
+                    maxRetries: 3,
+                });
+            }
+            catch { }
+            const result = await (0, install_package_1.installAllPackages)(this.context.packageManager, options.force ? ['--force'] : [], this.context.root);
+            if (result !== 0) {
+                return result;
+            }
+        }
+        if (success && options.createCommits) {
+            if (!this.commit(`Angular CLI update for packages - ${packagesToUpdate.join(', ')}`)) {
+                return 1;
+            }
+        }
+        // This is a temporary workaround to allow data to be passed back from the update schematic
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const migrations = global.externalMigrations;
+        if (success && migrations) {
+            for (const migration of migrations) {
+                // Resolve the package from the workspace root, as otherwise it will be resolved from the temp
+                // installed CLI version.
+                let packagePath;
+                logVerbose(`Resolving migration package '${migration.package}' from '${this.context.root}'...`);
+                try {
+                    try {
+                        packagePath = path.dirname(
+                        // This may fail if the `package.json` is not exported as an entry point
+                        require.resolve(path.join(migration.package, 'package.json'), {
+                            paths: [this.context.root],
+                        }));
+                    }
+                    catch (e) {
+                        if (e.code === 'MODULE_NOT_FOUND') {
+                            // Fallback to trying to resolve the package's main entry point
+                            packagePath = require.resolve(migration.package, { paths: [this.context.root] });
+                        }
+                        else {
+                            throw e;
+                        }
+                    }
+                }
+                catch (e) {
+                    if (e.code === 'MODULE_NOT_FOUND') {
+                        logVerbose(e.toString());
+                        logger.error(`Migrations for package (${migration.package}) were not found.` +
+                            ' The package could not be found in the workspace.');
+                    }
+                    else {
+                        logger.error(`Unable to resolve migrations for package (${migration.package}).  [${e.message}]`);
+                    }
+                    return 1;
+                }
+                let migrations;
+                // Check if it is a package-local location
+                const localMigrations = path.join(packagePath, migration.collection);
+                if ((0, fs_1.existsSync)(localMigrations)) {
+                    migrations = localMigrations;
+                }
+                else {
+                    // Try to resolve from package location.
+                    // This avoids issues with package hoisting.
+                    try {
+                        migrations = require.resolve(migration.collection, { paths: [packagePath] });
+                    }
+                    catch (e) {
+                        if (e.code === 'MODULE_NOT_FOUND') {
+                            logger.error(`Migrations for package (${migration.package}) were not found.`);
+                        }
+                        else {
+                            logger.error(`Unable to resolve migrations for package (${migration.package}).  [${e.message}]`);
+                        }
+                        return 1;
+                    }
+                }
+                const result = await this.executeMigrations(workflow, migration.package, migrations, migration.from, migration.to, options.createCommits);
+                if (!result) {
+                    return 0;
+                }
+            }
+        }
+        return success ? 0 : 1;
+    }
+    /**
+     * @return Whether or not the commit was successful.
+     */
+    commit(message) {
+        const { logger } = this.context;
+        // Check if a commit is needed.
+        let commitNeeded;
+        try {
+            commitNeeded = hasChangesToCommit();
+        }
+        catch (err) {
+            logger.error(`  Failed to read Git tree:\n${err.stderr}`);
+            return false;
+        }
+        if (!commitNeeded) {
+            logger.info('  No changes to commit after migration.');
+            return true;
+        }
+        // Commit changes and abort on error.
+        try {
+            createCommit(message);
+        }
+        catch (err) {
+            logger.error(`Failed to commit update (${message}):\n${err.stderr}`);
+            return false;
+        }
+        // Notify user of the commit.
+        const hash = findCurrentGitSha();
+        const shortMessage = message.split('\n')[0];
+        if (hash) {
+            logger.info(`  Committed migration step (${getShortHash(hash)}): ${shortMessage}.`);
+        }
+        else {
+            // Commit was successful, but reading the hash was not. Something weird happened,
+            // but nothing that would stop the update. Just log the weirdness and continue.
+            logger.info(`  Committed migration step: ${shortMessage}.`);
+            logger.warn('  Failed to look up hash of most recent commit, continuing anyways.');
+        }
+        return true;
+    }
+    checkCleanGit() {
+        try {
+            const topLevel = (0, child_process_1.execSync)('git rev-parse --show-toplevel', {
+                encoding: 'utf8',
+                stdio: 'pipe',
+            });
+            const result = (0, child_process_1.execSync)('git status --porcelain', { encoding: 'utf8', stdio: 'pipe' });
+            if (result.trim().length === 0) {
+                return true;
+            }
+            // Only files inside the workspace root are relevant
+            for (const entry of result.split('\n')) {
+                const relativeEntry = path.relative(path.resolve(this.context.root), path.resolve(topLevel.trim(), entry.slice(3).trim()));
+                if (!relativeEntry.startsWith('..') && !path.isAbsolute(relativeEntry)) {
+                    return false;
+                }
+            }
+        }
+        catch { }
+        return true;
+    }
+    /**
+     * Checks if the current installed CLI version is older or newer than a compatible version.
+     * @returns the version to install or null when there is no update to install.
+     */
+    async checkCLIVersion(packagesToUpdate, verbose = false, next = false) {
+        const { version } = await (0, package_metadata_1.fetchPackageManifest)(`@angular/cli@${this.getCLIUpdateRunnerVersion(typeof packagesToUpdate === 'string' ? [packagesToUpdate] : packagesToUpdate, next)}`, this.context.logger, {
+            verbose,
+            usingYarn: this.context.packageManager === workspace_schema_1.PackageManager.Yarn,
+        });
+        return version_1.VERSION.full === version ? null : version;
+    }
+    getCLIUpdateRunnerVersion(packagesToUpdate, next) {
+        var _a, _b;
+        if (next) {
+            return 'next';
+        }
+        const updatingAngularPackage = packagesToUpdate === null || packagesToUpdate === void 0 ? void 0 : packagesToUpdate.find((r) => ANGULAR_PACKAGES_REGEXP.test(r));
+        if (updatingAngularPackage) {
+            // If we are updating any Angular package we can update the CLI to the target version because
+            // migrations for @angular/core@13 can be executed using Angular/cli@13.
+            // This is same behaviour as `npx @angular/cli@13 update @angular/core@13`.
+            // `@angular/cli@13` -> ['', 'angular/cli', '13']
+            // `@angular/cli` -> ['', 'angular/cli']
+            const tempVersion = coerceVersionNumber(updatingAngularPackage.split('@')[2]);
+            return (_b = (_a = semver.parse(tempVersion)) === null || _a === void 0 ? void 0 : _a.major) !== null && _b !== void 0 ? _b : 'latest';
+        }
+        // When not updating an Angular package we cannot determine which schematic runtime the migration should to be executed in.
+        // Typically, we can assume that the `@angular/cli` was updated previously.
+        // Example: Angular official packages are typically updated prior to NGRX etc...
+        // Therefore, we only update to the latest patch version of the installed major version of the Angular CLI.
+        // This is important because we might end up in a scenario where locally Angular v12 is installed, updating NGRX from 11 to 12.
+        // We end up using Angular ClI v13 to run the migrations if we run the migrations using the CLI installed major version + 1 logic.
+        return version_1.VERSION.major;
     }
 }
 exports.UpdateCommandModule = UpdateCommandModule;
 UpdateCommandModule.scope = command_module_1.CommandScope.In;
+/**
+ * @return Whether or not the working directory has Git changes to commit.
+ */
+function hasChangesToCommit() {
+    // List all modified files not covered by .gitignore.
+    // If any files are returned, then there must be something to commit.
+    return (0, child_process_1.execSync)('git ls-files -m -d -o --exclude-standard').toString() !== '';
+}
+/**
+ * Precondition: Must have pending changes to commit, they do not need to be staged.
+ * Postcondition: The Git working tree is committed and the repo is clean.
+ * @param message The commit message to use.
+ */
+function createCommit(message) {
+    // Stage entire working tree for commit.
+    (0, child_process_1.execSync)('git add -A', { encoding: 'utf8', stdio: 'pipe' });
+    // Commit with the message passed via stdin to avoid bash escaping issues.
+    (0, child_process_1.execSync)('git commit --no-verify -F -', { encoding: 'utf8', stdio: 'pipe', input: message });
+}
+/**
+ * @return The Git SHA hash of the HEAD commit. Returns null if unable to retrieve the hash.
+ */
+function findCurrentGitSha() {
+    try {
+        return (0, child_process_1.execSync)('git rev-parse HEAD', { encoding: 'utf8', stdio: 'pipe' }).trim();
+    }
+    catch {
+        return null;
+    }
+}
+function getShortHash(commitHash) {
+    return commitHash.slice(0, 9);
+}
+function coerceVersionNumber(version) {
+    var _a;
+    if (!version) {
+        return undefined;
+    }
+    if (!/^\d{1,30}\.\d{1,30}\.\d{1,30}/.test(version)) {
+        const match = version.match(/^\d{1,30}(\.\d{1,30})*/);
+        if (!match) {
+            return undefined;
+        }
+        if (!match[1]) {
+            version = version.substring(0, match[0].length) + '.0.0' + version.substring(match[0].length);
+        }
+        else if (!match[2]) {
+            version = version.substring(0, match[0].length) + '.0' + version.substring(match[0].length);
+        }
+        else {
+            return undefined;
+        }
+    }
+    return (_a = semver.valid(version)) !== null && _a !== void 0 ? _a : undefined;
+}