@qooxdoo/framework/source/class/qx/tool/cli/commands/Migrate.js

The JS Framework for Coders

/* ************************************************************************

   qooxdoo - the new era of web development

   http://qooxdoo.org

   Copyright:
     2017-2021 Christian Boulanger

   License:
     MIT: https://opensource.org/licenses/MIT
     See the LICENSE file in the project's top-level directory for details.

   Authors:
     * Christian Boulanger (info@bibliograph.org, @cboulanger)

************************************************************************ */

const process = require("process");
const semver = require("semver");

/**
 * Migrates an application to a higher version
 */
qx.Class.define("qx.tool.cli.commands.Migrate", {
  extend: qx.tool.cli.commands.Package,

  statics: {
    /**
     * Flag to prevent recursive call to process()
     */
    migrationInProcess: false,
    /**
     * Return the Yargs configuration object
     * @return {{}}
     */
    getYargsCommand() {
      return {
        command: "migrate",
        describe: "migrate a library/application to a newer qooxdoo version",
        builder: {
          "dry-run": {
            describe: "Do not apply migrations"
          },

          "qx-version": {
            check: argv => semver.valid(argv.qxVersion),
            describe:
              "A semver string. If given, the maximum qooxdoo version for which to run migrations"
          }
        }
      };
    }
  },

  members: {
    /**
     * Announces or applies a migration
     */
    async process() {
      let runner = new qx.tool.migration.Runner().set({
        dryRun: Boolean(this.argv.dryRun),
        verbose: Boolean(this.argv.verbose),
        qxVersion: this.argv.qxVersion || null
      });

      let { applied, pending } = await runner.runMigrations();
      qx.tool.compiler.Console.info(
        `Finished ${
          this.argv.dryRun ? "checking" : "running"
        } migrations: ${applied} migrations applied, ${pending} migrations pending.`
      );
    },

    /**
     * @override
     */
    async checkMigrations() {}
  }
});