@qooxdoo/framework 7.9.2 → 8.0.0-beta.1

package/source/class/qx/tool/{cli → compiler/cli}/commands/package/Publish.js

@@ -21,107 +21,106 @@ const process = require("process");
 const { Octokit } = require("@octokit/rest");
 const semver = require("semver");
 const inquirer = require("inquirer");
-const glob = require("glob");
+const { glob } = require("glob");
 
 /**
  * Publishes a release on GitHub
  */
-qx.Class.define("qx.tool.cli.commands.package.Publish", {
-  extend: qx.tool.cli.commands.Package,
+qx.Class.define("qx.tool.compiler.cli.commands.package.Publish", {
+  extend: qx.tool.compiler.cli.commands.Package,
 
   statics: {
-    getYargsCommand() {
-      return {
-        command: "publish",
-        describe:
-          "publishes a new release of the package on GitHub. Requires a GitHub access token. By default, makes a patch release.",
-        builder: {
-          type: {
-            alias: "t",
-            describe: "Set the release type",
-            nargs: 1,
-            choices:
-              "major,premajor,minor,preminor,patch,prepatch,prerelease".split(
-                /,/
-              ),
-
-            type: "string"
-          },
-
-          noninteractive: {
-            alias: "I",
-            type: "boolean",
-            describe: "Do not prompt user"
-          },
-
-          "use-version": {
-            alias: "V",
-            type: "string",
-            describe: "Use given version number"
-          },
-
-          prerelease: {
-            type: "boolean",
-            alias: "p",
-            describe: "Publish as a prerelease (as opposed to a stable release)"
-          },
-
-          quiet: {
-            type: "boolean",
-            alias: "q",
-            describe: "No output"
-          },
-
-          message: {
-            alias: "m",
-            type: "string",
-            describe: "Set commit/release message"
-          },
-
-          dryrun: {
-            type: "boolean",
-            describe: "Deprecated. Use --dry-run"
-          },
-
-          "dry-run": {
-            type: "boolean",
-            alias: "d",
-            describe: "Show result only, do not publish to GitHub"
-          },
-
-          force: {
-            type: "boolean",
-            alias: "f",
-            describe: "Ignore warnings (such as demo check)"
-          },
-
-          "create-index": {
-            type: "boolean",
-            alias: "i",
-            describe:
-              "Create an index file (qooxdoo.json) with paths to Manifest.json files"
-          },
-
-          "qx-version": {
-            type: "string",
-            check: argv => semver.valid(argv.qxVersion),
-            describe:
-              "A semver string. If given, the qooxdoo version for which to publish the package"
-          },
-
-          breaking: {
-            type: "boolean",
-            describe:
-              "Do not create a backwards-compatible release, i.e. allow compatibility with current version only"
-          },
-
-          "qx-version-range": {
-            type: "string",
-            describe:
-              "A semver range. If given, it overrides --qx-version and --breaking and sets this specific version range"
-          }
-        }
-      };
+    async createCliCommand(clazz = this) {
+      let cmd = await qx.tool.compiler.cli.Command.createCliCommand(clazz);
+      cmd.set({
+        name: "publish",
+        description: "publishes a new release of the package on GitHub. Requires a GitHub access token. By default, makes a patch release."
+      });
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("type").set({
+          shortCode: "t",
+          description: "Set the release type",
+          type: ["major", "premajor", "minor", "preminor", "patch", "prepatch", "prerelease"]
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("noninteractive").set({
+          shortCode: "I",
+          description: "Do not prompt user",
+          type: "boolean",
+          value: false
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("use-version").set({
+          shortCode: "V",
+          description: "Use given version number",
+          type: "string"
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("prerelease").set({
+          shortCode: "p",
+          description: "Publish as a prerelease (as opposed to a stable release)",
+          type: "boolean",
+          value: false
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("message").set({
+          shortCode: "m",
+          description: "Set commit/release message",
+          type: "string"
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("dry-run").set({
+          shortCode: "d",
+          description: "Show result only, do not publish to GitHub",
+          type: "boolean",
+          value: false
+        })
+      );
+
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("create-index").set({
+          shortCode: "i",
+          description: "Create an index file (qooxdoo.json) with paths to Manifest.json files",
+          type: "boolean",
+          value: false
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("qx-version").set({
+          description: "A semver string. If given, the qooxdoo version for which to publish the package",
+          type: "string"
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("breaking").set({
+          description: "Do not create a backwards-compatible release, i.e. allow compatibility with current version only",
+          type: "boolean",
+          value: false
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("qx-version-range").set({
+          description: "A semver range. If given, it overrides --qx-version and --breaking and sets this specific version range",
+          type: "string"
+        })
+      );
+
+      return cmd;
     }
   },
 
@@ -147,17 +146,9 @@ qx.Class.define("qx.tool.cli.commands.package.Publish", {
      *
      */
     async process() {
-      await super.process();
       // init
       const argv = this.argv;
 
-      if (argv.dryrun) {
-        qx.tool.compiler.Console.info(
-          'The "--dryrun" option is deprecated. Please use "--dry-run" instead.'
-        );
-        argv.dryRun = true
-      }
-
       // qooxdoo version
       let qxVersion = await this.getQxVersion();
       if (fs.existsSync("Manifest.json")) {
@@ -193,8 +184,20 @@ qx.Class.define("qx.tool.cli.commands.package.Publish", {
         );
       }
 
+      // get current branch
+      let currentBranch;
+      try {
+        currentBranch = (
+          await qx.tool.utils.Utils.exec("git branch --show-current")
+        ).trim();
+      } catch (e) {
+        throw new qx.tool.utils.Utils.UserError(
+          "Cannot determine current branch."
+        );
+      }
+
       // token
-      let cfg = await qx.tool.cli.ConfigDb.getInstance();
+      let cfg = await qx.tool.compiler.cli.ConfigDb.getInstance();
       let github = cfg.db("github", {});
       if (!github.token) {
         let response = await inquirer.prompt([
@@ -365,6 +368,25 @@ qx.Class.define("qx.tool.cli.commands.package.Publish", {
         }
       }
 
+      // prompt user to confirm branch if not master/main
+      if (
+        !argv.noninteractive &&
+        currentBranch !== "master" &&
+        currentBranch !== "main"
+      ) {
+        let branchQuestion = {
+          type: "confirm",
+          name: "useBranch",
+          message: `Warning: You are about to publish from branch '${currentBranch}' (not master/main). Continue?`,
+          default: false
+        };
+
+        let branchAnswer = await inquirer.prompt(branchQuestion);
+        if (!branchAnswer.useBranch) {
+          process.exit(0);
+        }
+      }
+
       // prompt user to confirm
       let doRelease = true;
       if (!argv.noninteractive) {
@@ -373,7 +395,7 @@ qx.Class.define("qx.tool.cli.commands.package.Publish", {
           name: "doRelease",
           message: `This will ${
             argv.version ? "set" : "increment"
-          } the version from ${old_version} to ${new_version}, having a dependency on qooxdoo ${semver_range}, and create a release of the current master on GitHub. Do you want to proceed?`,
+          } the version from ${old_version} to ${new_version}, having a dependency on qooxdoo ${semver_range}, and create a release on branch '${currentBranch}' on GitHub. Do you want to proceed?`,
           default: "y"
         };
 
@@ -468,11 +490,11 @@ qx.Class.define("qx.tool.cli.commands.package.Publish", {
           owner,
           repo,
           tag_name: tag,
-          target_commitish: "master",
+          target_commitish: currentBranch,
           name: tag,
           body: message,
           draft: false,
-          prerelease: argv.prerelease
+          prerelease: argv.prerelease || false
         };
 
         await octokit.repos.createRelease(release_data);
@@ -498,78 +520,72 @@ qx.Class.define("qx.tool.cli.commands.package.Publish", {
      * Creates a qooxdoo.json file with paths to Manifest.json files in this repository
      * @private
      */
-    __createIndexFile: async argv =>
-      new Promise((resolve, reject) => {
-        if (argv.verbose && !argv.quiet) {
-          qx.tool.compiler.Console.info("Creating index file...");
-        }
-        glob(
-          qx.tool.config.Manifest.config.fileName,
-          { matchBase: true },
-          async (err, files) => {
-            if (err) {
-              reject(err);
-            }
-            if (!files || !files.length) {
-              reject(
-                new qx.tool.utils.Utils.UserError(
-                  "No Manifest.json files could be found"
-                )
-              );
-            }
-            let mainpath;
-            if (files.length > 1) {
-              let choices = files.map(p => {
-                let m = qx.tool.utils.Json.parseJson(
-                  fs.readFileSync(path.join(process.cwd(), p), "utf-8")
-                );
-
-                return {
-                  name:
-                    m.info.name + (m.info.summary ? ": " + m.info.summary : ""),
-                  value: p
-                };
-              });
-              let answer = await inquirer.prompt({
-                name: "mainpath",
-                message: "Please choose the main library",
-                type: "list",
-                choices
-              });
-
-              mainpath = answer.mainpath;
-            }
-            let data = {
-              libraries: files.map(p =>
-                files.length > 1 && p === mainpath
-                  ? {
-                      path: path.dirname(p),
-                      main: true
-                    }
-                  : { path: path.dirname(p) }
-              )
-            };
-
-            // write index file
-            const registryModel = qx.tool.config.Registry.getInstance();
-            if (argv.dryRun) {
-              qx.tool.compiler.Console.info(
-                `Dry run: not creating index file ${registryModel.getRelativeDataPath()} with the following content:`
-              );
-
-              qx.tool.compiler.Console.info(data);
-            } else {
-              await registryModel.load(data);
-              await registryModel.save();
-              if (!argv.quiet) {
-                qx.tool.compiler.Console.info(
-                  `Created index file ${registryModel.getRelativeDataPath()}'.`
-                );
+    async __createIndexFile(argv) {
+      if (argv.verbose && !argv.quiet) {
+        qx.tool.compiler.Console.info("Creating index file...");
+      }
+
+      const files = await glob(
+        qx.tool.config.Manifest.config.fileName,
+        { matchBase: true }
+      );
+
+      if (!files || !files.length) {
+        throw new qx.tool.utils.Utils.UserError(
+          "No Manifest.json files could be found"
+        );
+      }
+
+      let mainpath;
+      if (files.length > 1) {
+        let choices = files.map(p => {
+          let m = qx.tool.utils.Json.parseJson(
+            fs.readFileSync(path.join(process.cwd(), p), "utf-8")
+          );
+
+          return {
+            name:
+              m.info.name + (m.info.summary ? ": " + m.info.summary : ""),
+            value: p
+          };
+        });
+        let answer = await inquirer.prompt({
+          name: "mainpath",
+          message: "Please choose the main library",
+          type: "list",
+          choices
+        });
+
+        mainpath = answer.mainpath;
+      }
+      let data = {
+        libraries: files.map(p =>
+          files.length > 1 && p === mainpath
+            ? {
+                path: path.dirname(p),
+                main: true
               }
-            }
-            resolve();
-          }
+            : { path: path.dirname(p) }
+        )
+      };
+
+      // write index file
+      const registryModel = qx.tool.config.Registry.getInstance();
+      if (argv.dryRun) {
+        qx.tool.compiler.Console.info(
+          `Dry run: not creating index file ${registryModel.getRelativeDataPath()} with the following content:`
         );
-      })
+
+        qx.tool.compiler.Console.info(data);
+      } else {
+        await registryModel.load(data);
+        await registryModel.save();
+        if (!argv.quiet) {
+          qx.tool.compiler.Console.info(
+            `Created index file ${registryModel.getRelativeDataPath()}'.`
+          );
+        }
+      }
+    }
   }
 });

package/source/class/qx/tool/{cli → compiler/cli}/commands/package/Remove.js

@@ -17,31 +17,29 @@
 ************************************************************************ */
 const fs = require("fs");
 const path = require("upath");
-const rimraf = require("rimraf");
 
 /**
  * Installs a package
  */
-qx.Class.define("qx.tool.cli.commands.package.Remove", {
-  extend: qx.tool.cli.commands.Package,
+qx.Class.define("qx.tool.compiler.cli.commands.package.Remove", {
+  extend: qx.tool.compiler.cli.commands.Package,
 
   statics: {
-    getYargsCommand() {
-      return {
-        command: "remove [uri]",
-        describe: "removes a package from the configuration.",
-        builder: {
-          verbose: {
-            alias: "v",
-            describe: "Verbose logging"
-          },
-
-          quiet: {
-            alias: "q",
-            describe: "No output"
-          }
-        }
-      };
+    async createCliCommand(clazz = this) {
+      let cmd = await qx.tool.compiler.cli.Command.createCliCommand(clazz);
+      cmd.set({
+        name: "remove",
+        description: "removes a package from the configuration."
+      });
+
+      cmd.addArgument(
+        new qx.tool.cli.Argument("uri").set({
+          description: "package URI to remove",
+          type: "string"
+        })
+      );
+
+      return cmd;
     }
   },
 
@@ -50,7 +48,6 @@ qx.Class.define("qx.tool.cli.commands.package.Remove", {
      * Removes packages
      */
     async process() {
-      await super.process();
       if (!this.argv.uri) {
         throw new qx.tool.utils.Utils.UserError("No repository name given.");
       }
@@ -80,7 +77,7 @@ qx.Class.define("qx.tool.cli.commands.package.Remove", {
       }
       if (found.length) {
         for (const p of found) {
-          rimraf.sync(p);
+          await qx.tool.utils.files.Utils.deleteRecursive(p);
         }
         if (!this.argv.quiet) {
           qx.tool.compiler.Console.info(