@qooxdoo/framework 7.9.2 → 8.0.0-beta.2

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

@@ -26,17 +26,17 @@ const process = require("process");
  *
  * - adding a listener for the "runTests" event fired on the command
  * instance  in the `load()` method of the class extending {@link
- * qx.tool.cli.api.CompilerApi} or {@link qx.tool.cli.api.CompilerApi}.
+ * qx.tool.compiler.cli.api.CompilerApi} or {@link qx.tool.compiler.cli.api.CompilerApi}.
  *
  * - or by implementing a `beforeTests()` method in the class
- * extending {@link qx.tool.cli.api.CompilerApi}
+ * extending {@link qx.tool.compiler.cli.api.CompilerApi}
  *
  * The event and/or method is called with a {@link qx.event.type.Data}
  * containing the command instance.
  *
  */
-qx.Class.define("qx.tool.cli.commands.Test", {
-  extend: qx.tool.cli.commands.Serve,
+qx.Class.define("qx.tool.compiler.cli.commands.Test", {
+  extend: qx.tool.compiler.cli.commands.Serve,
 
   statics: {
     /**
@@ -45,40 +45,37 @@ qx.Class.define("qx.tool.cli.commands.Test", {
      */
     CONFIG_FILENAME: "compile-test.json",
 
-    YARGS_BUILDER: {
-      "fail-fast": {
-        describe: "Exit on first failing test",
-        default: false,
-        type: "boolean"
-      },
-
-      "disable-webserver": {
-        describe: "Disables the start of the webserver",
-        default: false,
-        type: "boolean"
-      }
-    },
+    async createCliCommand(clazz = this) {
+      let cmd = await qx.tool.compiler.cli.commands.Serve.createCliCommand(clazz);
+      cmd.set({
+        name: "test",
+        description: "run test for current project"
+      });
 
-    getYargsCommand() {
-      return {
-        command: "test",
-        describe: "run test for current project",
-        builder: (() => {
-          let res = Object.assign(
-            {},
-            qx.tool.cli.commands.Compile.YARGS_BUILDER,
-            qx.tool.cli.commands.Serve.YARGS_BUILDER,
-            qx.tool.cli.commands.Test.YARGS_BUILDER
-          );
+      // Remove flags that test doesn't use
+      cmd.removeFlag("machine-readable");
+      cmd.removeFlag("feedback");
+      cmd.removeFlag("show-startpage");
+      cmd.removeFlag("rebuild-startpage");
+
+      // Add test-specific flags
+      cmd.addFlag(
+        new qx.tool.cli.Flag("fail-fast").set({
+          description: "Exit on first failing test",
+          type: "boolean",
+          value: false
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("disable-webserver").set({
+          description: "Disables the start of the webserver",
+          type: "boolean",
+          value: false
+        })
+      );
 
-          delete res.watch;
-          delete res["machine-readable"];
-          delete res["feedback"];
-          delete res["show-startpage"];
-          delete res["rebuild-startpage"];
-          return res;
-        })()
-      };
+      return cmd;
     }
   },
 
@@ -87,21 +84,14 @@ qx.Class.define("qx.tool.cli.commands.Test", {
      * Fired to start tests.
      *
      * The event data is the command instance:
-     *  cmd: {qx.tool.cli.commands.Test}
+     *  cmd: {qx.tool.compiler.cli.commands.Test}
      */
     runTests: "qx.event.type.Data"
   },
 
-  construct(argv) {
-    super(argv);
+  construct() {
+    super();
     this.__tests = [];
-    this.addListener("changeExitCode", evt => {
-      let exitCode = evt.getData();
-      // overwrite error code only in case of errors
-      if (exitCode !== 0 && argv.failFast) {
-        process.exit(Math.min(255, exitCode));
-      }
-    });
   },
 
   properties: {
@@ -134,10 +124,10 @@ qx.Class.define("qx.tool.cli.commands.Test", {
 
     /**
      * add a test object and listens for the change of exitCode property
-     * @param {qx.tool.cli.api.Test} test
+     * @param {qx.tool.compiler.cli.api.Test} test
      */
     addTest(test) {
-      qx.core.Assert.assertInstance(test, qx.tool.cli.api.Test);
+      qx.core.Assert.assertInstance(test, qx.tool.compiler.cli.api.Test);
       test.addListenerOnce("changeExitCode", evt => {
         let exitCode = evt.getData();
         // handle result and inform user
@@ -154,7 +144,7 @@ qx.Class.define("qx.tool.cli.commands.Test", {
         if (exitCode !== 0) {
           if (test.getFailFast()) {
             this.argv.failFast = true;
-          }  
+          }
           this.setExitCode(exitCode);
         }
       });
@@ -174,11 +164,18 @@ qx.Class.define("qx.tool.cli.commands.Test", {
       if (
         !this.argv.configFile &&
         fs.existsSync(
-          path.join(process.cwd(), qx.tool.cli.commands.Test.CONFIG_FILENAME)
+          path.join(process.cwd(), qx.tool.compiler.cli.commands.Test.CONFIG_FILENAME)
         )
       ) {
-        this.argv.configFile = qx.tool.cli.commands.Test.CONFIG_FILENAME;
+        this.argv.configFile = qx.tool.compiler.cli.commands.Test.CONFIG_FILENAME;
       }
+      this.addListener("changeExitCode", evt => {
+        let exitCode = evt.getData();
+        // overwrite error code only in case of errors
+        if (exitCode !== 0 && this.argv.failFast) {
+          process.exit(Math.min(255, exitCode));
+        }
+      });
       this.addListener("making", () => {
         if (
           !this.hasListener("runTests") &&
@@ -221,7 +218,7 @@ qx.Class.define("qx.tool.cli.commands.Test", {
         await super.process();
       } else {
         // compile only
-        await qx.tool.cli.commands.Compile.prototype.process.call(this);
+        await qx.tool.compiler.cli.commands.Compile.prototype.process.call(this);
         // since the server is not started, manually fire the event necessary for firing the "runTests" event
         await this.fireDataEventAsync("afterStart");
       }

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

@@ -23,45 +23,56 @@ const ignore = require("ignore");
 /**
  * Migrates code to ES6 (partially)
  */
-qx.Class.define("qx.tool.cli.commands.Typescript", {
-  extend: qx.tool.cli.commands.Command,
+qx.Class.define("qx.tool.compiler.cli.commands.Typescript", {
+  extend: qx.tool.compiler.cli.Command,
   statics: {
-    getYargsCommand() {
-      let config = {
-        command: "typescript [files...]",
-        describe: "generate typescript definitions",
-        builder: {
-          outputFilename: {
-            describe: "Output filename",
-            type: "string",
-            default: "qooxdoo.d.ts"
-          },
-
-          verbose: {
-            alias: "v",
-            describe: "Verbose logging"
-          },
-
-          exclude: {
-            type: "array",
-            describe: "Paths to exclude"
-          }
-        }
-      };
+    async createCliCommand(clazz = this) {
+      let cmd = await qx.tool.compiler.cli.Command.createCliCommand(clazz);
+      cmd.set({
+        name: "typescript", 
+        description: "generate typescript definitions"
+      });
+
+      cmd.addArgument(
+        new qx.tool.cli.Argument("files").set({
+          description: "files to process",
+          array: true,
+          type: "string"
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("outputFilename").set({
+          description: "Output filename",
+          type: "string",
+          value: "qooxdoo.d.ts"
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("exclude").set({
+          description: "Paths to exclude",
+          array: true,
+          type: "string"
+        })
+      );
 
       if (qx.core.Environment.get("qx.debug")) {
-        config.builder["meta-debug"] = {
-          describe:
-            "Debug metadata output to console, implies --verbose and only one file"
-        };
+        cmd.addFlag(
+          new qx.tool.cli.Flag("meta-debug").set({
+            description: "Debug metadata output to console, implies --verbose and only one file",
+            type: "boolean",
+            value: false
+          })
+        );
       }
-      return config;
+
+      return cmd;
     }
   },
 
   members: {
     async process() {
-      await super.process();
       const IGNORE_FILENAME = ".typescriptignore";
       const ig = ignore();
       try {
@@ -80,25 +91,6 @@ qx.Class.define("qx.tool.cli.commands.Typescript", {
         ig.add(exclude);
       }
 
-      const classFiles = [];
-
-      const scanImpl = async filename => {
-        let basename = path.basename(filename);
-        let stat = await fs.promises.stat(filename);
-        if (stat.isFile() && basename.match(/\.js$/)) {
-          classFiles.push(filename);
-        } else if (
-          stat.isDirectory() &&
-          (basename == "." || basename[0] != ".")
-        ) {
-          let files = await fs.promises.readdir(filename);
-          for (let i = 0; i < files.length; i++) {
-            let subname = path.join(filename, files[i]);
-            await scanImpl(subname);
-          }
-        }
-      };
-
       let files = this.argv.files || [];
       if (files.length === 0) {
         if (fs.existsSync("Manifest.json")) {
@@ -119,18 +111,37 @@ qx.Class.define("qx.tool.cli.commands.Typescript", {
         qx.tool.compiler.Console.error("No files to process");
         process.exit(1);
       }
-      for (let file of files) {
-        await scanImpl(file);
-      }
 
       if (qx.core.Environment.get("qx.debug")) {
         if (this.argv.metaDebug) {
           this.argv.verbose = true;
-          if (classFiles.length > 1) {
-            console.log("Only one file can be processed in meta debug mode");
+          let target = files[0];
+          let stat = await fs.promises.stat(target);
+          if (stat.isDirectory()) {
+            const findFirst = async dir => {
+              for (let entry of await fs.promises.readdir(dir)) {
+                let full = path.join(dir, entry);
+                let s = await fs.promises.stat(full);
+                if (s.isFile() && entry.endsWith(".js")) {
+                  return full;
+                }
+                if (s.isDirectory() && entry[0] !== ".") {
+                  let found = await findFirst(full);
+                  if (found) {
+                    return found;
+                  }
+                }
+              }
+              return null;
+            };
+            target = await findFirst(target);
+            if (!target) {
+              qx.tool.compiler.Console.error("No .js file found for meta debug");
+              process.exit(1);
+            }
           }
           let meta = new qx.tool.compiler.MetaExtraction();
-          await meta.parse(classFiles[0]);
+          await meta.parse(target);
           meta.fixupJsDoc({ resolveType: type => type });
           console.log(JSON.stringify(meta.getMetaData(), null, 2));
           process.exit(0);
@@ -139,15 +150,12 @@ qx.Class.define("qx.tool.cli.commands.Typescript", {
 
       let metaDb = new qx.tool.compiler.MetaDatabase();
       await metaDb.load();
-      for (let filename of classFiles) {
-        if (this.argv.verbose) {
-          qx.tool.compiler.Console.info(`Processing ${filename} ...`);
-        }
-        await metaDb.addFile(filename);
-      }
-      await metaDb.reparseAll();
+      await metaDb.loadFromDirectories(files, { ignore: ig, verbose: this.argv.verbose });
 
       let tsWriter = new qx.tool.compiler.targets.TypeScriptWriter(metaDb);
+      if (this.argv.outputFilename) {
+        tsWriter.setOutputTo(this.argv.outputFilename);
+      }
       await tsWriter.process();
     }
   }

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

@@ -13,6 +13,7 @@
 
    Authors:
      * Christian Boulanger (info@bibliograph.org, @cboulanger)
+     * Henner Kollmann (Henner.Kollmann@gmx.de, @hkollmann)
 
 ************************************************************************ */
 const fs = require("fs");
@@ -39,37 +40,59 @@ const path = require("upath");
  * (Package support is not yet implemented)
  *
  */
-qx.Class.define("qx.tool.cli.commands.add.Class", {
-  extend: qx.tool.cli.commands.Command,
+qx.Class.define("qx.tool.compiler.cli.commands.add.Class", {
+  extend: qx.tool.compiler.cli.Command,
   statics: {
-    getYargsCommand() {
-      return {
-        command: "class <classname> [options]",
-        describe:
-          "adds a new class file to the current project, based on a template.",
-        builder: {
-          type: {
-            alias: "t",
-            describe: "the type of the class (optional).",
-            default: "default"
-          },
-
-          extend: {
-            alias: "e",
-            describe: "the base class of the new class"
-          },
-
-          import: {
-            describe:
-              "import the template to the `templates/class` folder of the current project, where it can be customized"
-          },
-
-          force: {
-            alias: "f",
-            describe: "overwrite an existing file"
-          }
-        }
-      };
+    async createCliCommand(clazz = this) {
+      let cmd = await qx.tool.compiler.cli.Command.createCliCommand(clazz);
+      cmd.set({
+        name: "class",
+        description:
+          "adds a new class file to the current project, based on a template."
+      });
+
+      cmd.addArgument(
+        new qx.tool.cli.Argument("classname").set({
+          description: "the name of the class to create",
+          required: true,
+          type: "string"
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("type").set({
+          shortCode: "t",
+          description: "the type of the class (optional).",
+          value: "default"
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("extend").set({
+          shortCode: "e",
+          description: "the base class of the new class"
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("import").set({
+          description:
+            "import the template to the `templates/class` folder of the current project, where it can be customized",
+          type: "boolean",
+          value: false
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("overwrite").set({
+          shortCode: "o",
+          description: "overwrite an existing file",
+          type: "boolean",
+          value: false
+        })
+      );
+
+      return cmd;
     }
   },
 
@@ -169,7 +192,7 @@ qx.Class.define("qx.tool.cli.commands.add.Class", {
       let absolute_path = path.join(process.cwd(), relative_path);
       let file_exists = false;
       try {
-        fs.accessSync(absolute_path);
+        fs.accessSync(absolute_path, fs.constants.F_OK);
         file_exists = true;
       } catch (e) {}
       if (file_exists && !argv.force) {

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

@@ -13,52 +13,75 @@
 
    Authors:
      * Christian Boulanger (info@bibliograph.org, @cboulanger)
+     * Henner Kollmann (Henner.Kollmann@gmx.de, @hkollmann)
 
 ************************************************************************ */
 
 const fs = require("fs");
 const process = require("process");
 const path = require("upath");
-const inquirer = require("inquirer");
 /**
  * Add a new script file to the current project, to be loaded by the qooxdoo boot loader
  *
  * Syntax: `qx add script path/to/script.js`
  *
  */
-qx.Class.define("qx.tool.cli.commands.add.Script", {
-  extend: qx.tool.cli.commands.Command,
+qx.Class.define("qx.tool.compiler.cli.commands.add.Script", {
+  extend: qx.tool.compiler.cli.Command,
   statics: {
-    getYargsCommand() {
-      return {
-        command: "script <scriptpath> [options]",
-        describe:
-          "adds a new script file to the current project, to be loaded before application startup.",
-        builder: {
-          resourcedir: {
-            describe:
-              "The subdirectory of the resource folder in which to place the file",
-            alias: "d",
-            default: "js"
-          },
-
-          rename: {
-            describe: "Rename the file to the given name",
-            alias: "r"
-          },
-
-          undo: {
-            describe:
-              "Removes the file that would normally be added with the given arguments",
-            alias: "z"
-          },
-
-          noninteractive: {
-            alias: "I",
-            describe: "Do not prompt user"
-          }
-        }
-      };
+    async createCliCommand(clazz = this) {
+      let cmd = await qx.tool.compiler.cli.Command.createCliCommand(clazz);
+      cmd.set({
+        name: "script",
+        description:
+          "adds a new script file to the current project, to be loaded before application startup."
+      });
+
+      cmd.addArgument(
+        new qx.tool.cli.Argument("scriptpath").set({
+          description: "path to the script file to add",
+          required: true,
+          type: "string"
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("resourcedir").set({
+          description:
+            "The subdirectory of the resource folder in which to place the file",
+          shortCode: "d",
+          value: "js"
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("rename").set({
+          description: "Rename the file to the given name",
+          shortCode: "r",
+          type: "string"
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("undo").set({
+          description:
+            "Removes the file that would normally be added with the given arguments",
+          shortCode: "z",
+          type: "boolean",
+          value: false
+        })
+      );
+
+      cmd.addFlag(
+        new qx.tool.cli.Flag("noninteractive").set({
+          shortCode: "I",
+          description: "Do not prompt user",
+          type: "boolean",
+          value: false
+        })
+      );
+
+      return cmd;
     }
   },
 
@@ -101,6 +124,7 @@ qx.Class.define("qx.tool.cli.commands.add.Script", {
       }
       if ((await fs.existsAsync(resource_file_path)) && !this.argv.undo) {
         if (!this.argv.noninteractive) {
+          const { default: inquirer } = await import("inquirer");
           let question = {
             type: "confirm",
             name: "doOverwrite",

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

@@ -16,26 +16,32 @@
    * Henner Kollmann (Henner.Kollmann@gmx.de, @hkollmann)
 
 ************************************************************************ */
-qx.Class.define("qx.tool.cli.commands.config.Delete", {
-  extend: qx.tool.cli.commands.Config,
+qx.Class.define("qx.tool.compiler.cli.commands.config.Delete", {
+  extend: qx.tool.compiler.cli.commands.Config,
   statics: {
-    /**
-     * Returns the yargs command data
-     * @return {Object}
-     */
-    getYargsCommand() {
-      return {
-        command: "delete <key>",
-        describe: "Deletes a configuration value"
-      };
+    async createCliCommand(clazz = this) {
+      let cmd = await qx.tool.compiler.cli.Command.createCliCommand(clazz);
+      cmd.set({
+        name: "delete",
+        description: "Deletes a configuration value"
+      });
+
+      cmd.addArgument(
+        new qx.tool.cli.Argument("key").set({
+          description: "Configuration key to delete",
+          required: true,
+          type: "string"
+        })
+      );
+
+      return cmd;
     }
   },
 
   members: {
     async process() {
-      await super.process();
       this._checkKey(this.argv);
-      let cfg = await qx.tool.cli.ConfigDb.getInstance();
+      let cfg = await qx.tool.compiler.cli.ConfigDb.getInstance();
       let keyInfo = this._breakout(this.argv.key);
       let parent = cfg.db(keyInfo.parentKey);
       if (parent) {

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

@@ -16,18 +16,25 @@
    * Henner Kollmann (Henner.Kollmann@gmx.de, @hkollmann)
 
 ************************************************************************ */
-qx.Class.define("qx.tool.cli.commands.config.Get", {
-  extend: qx.tool.cli.commands.Config,
+qx.Class.define("qx.tool.compiler.cli.commands.config.Get", {
+  extend: qx.tool.compiler.cli.commands.Config,
   statics: {
-    /**
-     * Returns the yargs command data
-     * @return {Object}
-     */
-    getYargsCommand() {
-      return {
-        command: "get <key> [options]",
-        describe: "Gets a configuration value"
-      };
+    async createCliCommand(clazz = this) {
+      let cmd = await qx.tool.compiler.cli.Command.createCliCommand(clazz);
+      cmd.set({
+        name: "get",
+        description: "Gets a configuration value"
+      });
+
+      cmd.addArgument(
+        new qx.tool.cli.Argument("key").set({
+          description: "Configuration key to get",
+          required: true,
+          type: "string"
+        })
+      );
+
+      return cmd;
     }
   },
 
@@ -36,9 +43,8 @@ qx.Class.define("qx.tool.cli.commands.config.Get", {
      * Lists library packages compatible with the current project
      */
     async process() {
-      await super.process();
       this._checkKey(this.argv);
-      let cfg = await qx.tool.cli.ConfigDb.getInstance();
+      let cfg = await qx.tool.compiler.cli.ConfigDb.getInstance();
       let value = cfg.db(this.argv.key);
       if (this.argv.bare) {
         qx.tool.compiler.Console.info(value || "");