@qooxdoo/framework 7.5.0 → 7.6.0

package/source/class/qx/tool/cli/commands/Compile.js

@@ -27,6 +27,7 @@ require("app-module-path").addPath(process.cwd() + "/node_modules");
 
 /**
  * Handles compilation of the project
+ * @ignore(setImmediate)
  */
 qx.Class.define("qx.tool.cli.commands.Compile", {
   extend: qx.tool.cli.commands.Command,
@@ -111,6 +112,11 @@ qx.Class.define("qx.tool.cli.commands.Compile", {
         type: "string"
       },
 
+      "local-fonts": {
+        describe: "whether to prefer local font files over CDN",
+        type: "boolean"
+      },
+
       watch: {
         describe: "enables watching for changes and continuous compilation",
         type: "boolean",
@@ -531,6 +537,10 @@ Framework: v${await this.getQxVersion()} in ${await this.getQxPath()}`);
      * @return {Boolean} true if all makers succeeded
      */
     async _loadConfigAndStartMaking() {
+      if (!this.getCompilerApi().compileJsonExists() && !qx.tool.cli.Cli.getInstance().compileJsExists()) {
+        qx.tool.compiler.Console.error("Cannot find either compile.json nor compile.js");
+        process.exit(1);
+      }
       var config = this.getCompilerApi().getConfiguration();
       var makers = (this.__makers = await this.createMakersFromConfig(config));
       if (!makers || !makers.length) {
@@ -685,7 +695,7 @@ Framework: v${await this.getQxVersion()} in ${await this.getQxPath()}`);
           );
 
           watch.setConfigFilenames(arr);
-          return await watch.start();
+          return watch.start();
         })
       );
     },
@@ -998,6 +1008,18 @@ Framework: v${await this.getQxVersion()} in ${await this.getQxPath()}`);
         target.setUpdatePoFiles(this.argv.updatePoFiles);
         target.setLibraryPoPolicy(this.argv.libraryPo);
 
+        let fontsConfig = targetConfig.fonts || {};
+        let preferLocalFonts = true;
+
+        if (this.argv.localFonts !== undefined) {
+          preferLocalFonts = this.argv.localFonts;
+        } else if (fontsConfig.local !== undefined) {
+          preferLocalFonts = fontsConfig.local;
+        }
+        target.setPreferLocalFonts(preferLocalFonts);
+        if (fontsConfig.fontTypes !== undefined) {
+          target.setFontTypes(fontsConfig.fontTypes);
+        }
         // Take the command line for `minify` as most precedent only if provided
         var minify;
         if (process.argv.indexOf("--minify") > -1) {
@@ -1230,6 +1252,7 @@ Framework: v${await this.getQxVersion()} in ${await this.getQxPath()}`);
             data.localModules || {},
             false
           );
+
           if (!qx.lang.Object.isEmpty(appConfig.localModules)) {
             app.setLocalModules(appConfig.localModules);
           }

package/source/class/qx/tool/cli/commands/Config.js

@@ -13,13 +13,9 @@
 
    Authors:
      * John Spackman (john.spackman@zenesis.com, @johnspackman)
+     * Henner Kollmann (Henner.Kollmann@gmx.de, @hkollmann)
 
 ************************************************************************ */
-const process = require("process");
-const path = require("path");
-const columnify = require("columnify");
-const fs = qx.tool.utils.Promisify.fs;
-
 /**
  * Handles persistent configuration
  */
@@ -29,64 +25,20 @@ qx.Class.define("qx.tool.cli.commands.Config", {
 
   statics: {
     getYargsCommand() {
-      function run(argv, name) {
-        var cmd = new qx.tool.cli.commands.Config(argv);
-        return cmd[name](argv).catch(e => {
-          qx.tool.compiler.Console.error(e.stack || e.message);
-          process.exit(1);
-        });
-      }
       return {
-        command: "config <key> [value]",
-        describe: "gets/sets persistent configuration",
+        command: "config <command> [options]",
+        desc: "handles persistent configuration",
         builder(yargs) {
-          yargs
-            .option("quiet", {
-              alias: "q",
-              describe:
-                "Suppresses warnings (eg about unknown configuration keys)",
-              type: "boolean"
-            })
-            .command(
-              "set <key> <value>",
-              "Sets a configuration value",
-              () => {},
-              argv => run(argv, "cmdSet")
-            )
-            .command(
-              "get <key> [options]",
-              "Gets a configuration value",
-              {
-                bare: {
-                  type: "boolean",
-                  describe: "Restricts output to just the value"
-                }
-              },
-
-              argv => run(argv, "cmdGet")
-            )
-            .command(
-              "delete <key>",
-              "Deletes a configuration value",
-              () => {},
-              argv => run(argv, "cmdDelete")
-            )
-            .command(
-              "list",
-              "Lists all known configuration values",
-              {
-                all: {
-                  type: "boolean",
-                  describe: "Shows all keys, including unset"
-                }
-              },
-
-              argv => run(argv, "cmdList")
-            );
+          qx.tool.cli.Cli.addYargsCommands(
+            yargs,
+            ["List", "Set", "Get", "Delete"],
+
+            "qx.tool.cli.commands.config"
+          );
+
+          return yargs.demandCommand().showHelpOnFail().help();
         },
-        handler(argv) {
-          // Nothing
-        }
+        handler() {}
       };
     },
 
@@ -124,14 +76,14 @@ qx.Class.define("qx.tool.cli.commands.Config", {
   },
 
   members: {
-    __describe(key) {
+    _describe(key) {
       var data = qx.tool.cli.commands.Config.KNOWN_VALUES[key];
       return data && data.desc;
     },
 
-    __checkKey(argv) {
+    _checkKey(argv) {
       if (!argv.quiet) {
-        let desc = this.__describe(argv.key);
+        let desc = this._describe(argv.key);
         if (!desc) {
           qx.tool.compiler.Console.warn(
             "Warning: Unrecognised configuration key " + argv.key
@@ -140,7 +92,7 @@ qx.Class.define("qx.tool.cli.commands.Config", {
       }
     },
 
-    __breakout(key) {
+    _breakout(key) {
       let pos = key.lastIndexOf(".");
       let parentKey = pos > -1 ? key.substring(0, pos) : "";
       let childKey = key.substring(pos + 1);
@@ -150,83 +102,6 @@ qx.Class.define("qx.tool.cli.commands.Config", {
         parentKey: parentKey,
         childKey: childKey
       };
-    },
-
-    async cmdSet(argv) {
-      this.__checkKey(argv);
-      let cfg = await qx.tool.cli.ConfigDb.getInstance();
-      let setting = qx.tool.cli.commands.Config.KNOWN_VALUES[argv.key];
-      let value = argv.value;
-      if (setting && typeof setting.set == "function") {
-        value = await setting.set(value);
-      }
-
-      let keyInfo = this.__breakout(argv.key);
-      let parent = cfg.db(keyInfo.parentKey, {});
-      if (value === undefined) {
-        delete parent[keyInfo.childKey];
-      } else {
-        parent[keyInfo.childKey] = value;
-      }
-      await cfg.save();
-    },
-
-    async cmdDelete(argv) {
-      this.__checkKey(argv);
-      let cfg = await qx.tool.cli.ConfigDb.getInstance();
-      let keyInfo = this.__breakout(argv.key);
-      let parent = cfg.db(keyInfo.parentKey);
-      if (parent) {
-        delete parent[keyInfo.childKey];
-      }
-      await cfg.save();
-    },
-
-    async cmdGet(argv) {
-      this.__checkKey(argv);
-      let cfg = await qx.tool.cli.ConfigDb.getInstance();
-      let value = cfg.db(argv.key);
-      if (argv.bare) {
-        qx.tool.compiler.Console.info(value || "");
-      } else if (value !== undefined) {
-        qx.tool.compiler.Console.info(argv.key + "=" + value);
-      } else {
-        qx.tool.compiler.Console.info(argv.key + " is not set");
-      }
-    },
-
-    async cmdList(argv) {
-      let cfg = await qx.tool.cli.ConfigDb.getInstance();
-
-      let keys = {};
-      function scan(obj, parentKey) {
-        for (let [key, value] of Object.entries(obj)) {
-          let fullKey = parentKey + (parentKey.length ? "." : "") + key;
-          if (qx.tool.utils.Utils.isPlainObject(value)) {
-            scan(value, fullKey);
-            continue;
-          }
-          keys[fullKey] = true;
-        }
-      }
-      if (argv.all) {
-        for (let key in qx.tool.cli.commands.Config.KNOWN_VALUES) {
-          keys[key] = true;
-        }
-      }
-
-      // Recursively get a list of all known keys
-      scan(cfg.db(), "");
-      keys = Object.keys(keys);
-      keys.sort();
-      keys = keys.map(key => ({
-        key: key,
-        value: cfg.db(key),
-        description: this.__describe(key) || "Unrecognised key"
-      }));
-
-      // Display each value
-      qx.tool.compiler.Console.info(columnify(keys));
     }
   }
 });

package/source/class/qx/tool/cli/commands/ExportGlyphs.js

@@ -0,0 +1,134 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (@johnspackman)
+
+************************************************************************ */
+
+const fs = require("fs");
+const path = require("upath");
+const fontkit = require("@foliojs-fork/fontkit");
+const tmp = require("tmp");
+
+/**
+ * Exports font ligatures as a map
+ */
+qx.Class.define("qx.tool.cli.commands.ExportGlyphs", {
+  extend: qx.tool.cli.commands.Command,
+
+  statics: {
+    getYargsCommand() {
+      return {
+        command: "export-glyphs font-file glyph-file",
+        describe: "export font glyphs & ligatures"
+      };
+    }
+  },
+
+  members: {
+    /**
+     * @override
+     */
+    async process() {
+      let filename = this.argv.fontFile;
+      if (filename.match(/^https?:\/\//)) {
+        filename = await qx.tool.utils.Http.downloadToTempFile(
+          filename,
+          /^font\/(ttf|svg|eot|woff|woff2)$/
+        );
+      }
+      let font = await qx.tool.utils.Promisify.call(cb =>
+        fontkit.open(filename, null, cb)
+      );
+
+      if (!font.GSUB) {
+        qx.tool.compiler.Console.error(
+          `The webfont in ${filename} does not have any ligatures`
+        );
+
+        return;
+      }
+
+      let glyphs = {};
+
+      // some IconFonts (MaterialIcons for example) use ligatures
+      // to name their icons. This code extracts the ligatures
+      // hat tip to Jossef Harush https://stackoverflow.com/questions/54721774/extracting-ttf-font-ligature-mappings/54728584
+      let ligatureName = {};
+      let lookupList = font.GSUB.lookupList.toArray();
+      let lookupListIndexes =
+        font.GSUB.featureList[0].feature.lookupListIndexes;
+      lookupListIndexes.forEach(index => {
+        let subTable = lookupList[index].subTables[0];
+        let leadingCharacters = [];
+        if (subTable.coverage.rangeRecords) {
+          subTable.coverage.rangeRecords.forEach(coverage => {
+            for (let i = coverage.start; i <= coverage.end; i++) {
+              let character = font.stringsForGlyph(i)[0];
+              leadingCharacters.push(character);
+            }
+          });
+        }
+        let ligatureSets = subTable.ligatureSets.toArray();
+        ligatureSets.forEach((ligatureSet, ligatureSetIndex) => {
+          let leadingCharacter = leadingCharacters[ligatureSetIndex];
+          ligatureSet.forEach(ligature => {
+            let character = font.stringsForGlyph(ligature.glyph)[0];
+            if (!character) {
+              // qx.tool.compiler.Console.log(`WARN: ${this.getName()} no character ${ligature}`);
+              return;
+            }
+            let ligatureText =
+              leadingCharacter +
+              ligature.components.map(x => font.stringsForGlyph(x)[0]).join("");
+            var hexId = character.charCodeAt(0).toString(16);
+            if (ligatureName[hexId] == undefined) {
+              ligatureName[hexId] = [ligatureText];
+            } else {
+              ligatureName[hexId].push(ligatureText);
+            }
+          });
+        });
+      });
+
+      font.characterSet.forEach(codePoint => {
+        let glyph = font.glyphForCodePoint(codePoint);
+        if (glyph.path.commands.length < 1 && !glyph.layers) {
+          return;
+        }
+
+        const found = gName => {
+          glyphs[gName] = {
+            advanceWidth: glyph.advanceWidth,
+            advanceHeight: glyph.advanceHeight,
+            codePoint
+          };
+        };
+        if (glyph.name) {
+          found(glyph.name);
+        }
+        var names = ligatureName[codePoint.toString(16)];
+        if (names) {
+          names.forEach(found);
+        }
+      });
+
+      await fs.promises.writeFile(
+        this.argv.glyphFile,
+        JSON.stringify(glyphs, null, 2),
+        "utf8"
+      );
+    }
+  }
+});

package/source/class/qx/tool/cli/commands/Lint.js

@@ -113,7 +113,7 @@ qx.Class.define("qx.tool.cli.commands.Lint", {
         helperFilePath = path.dirname(helperFilePath);
       }
 
-      let config = await qx.tool.cli.Cli.getInstance().getParsedArgs();
+      let config = qx.tool.cli.Cli.getInstance().getParsedArgs();
       let lintOptions = config.eslintConfig || {};
       lintOptions.extends = lintOptions.extends || ["@qooxdoo/qx/browser"];
       lintOptions.globals = Object.assign(

package/source/class/qx/tool/cli/commands/Package.js

@@ -75,6 +75,9 @@ qx.Class.define("qx.tool.cli.commands.Package", {
           );
 
           return yargs.showHelpOnFail().help();
+        },
+        handler() {
+          // Nothing
         }
       };
     }

package/source/class/qx/tool/cli/commands/Pkg.js

@@ -47,7 +47,7 @@ qx.Class.define("qx.tool.cli.commands.Pkg", {
 
           return yargs.demandCommand().showHelpOnFail().help();
         },
-        handler(argv) {
+        handler() {
           // Nothing
         }
       };

package/source/class/qx/tool/cli/commands/Run.js

@@ -68,12 +68,12 @@ qx.Class.define("qx.tool.cli.commands.Run", {
       let config = this.getCompilerApi().getConfiguration();
       if (!config.run) {
         qx.tool.compiler.Console.print("qx.tool.cli.run.noRunConfig");
-        process.exit(-1);
+        process.exit(1);
       }
 
       if (!config.run.application) {
         qx.tool.compiler.Console.print("qx.tool.cli.run.noAppName");
-        process.exit(-1);
+        process.exit(1);
       }
 
       let maker = null;
@@ -85,14 +85,14 @@ qx.Class.define("qx.tool.cli.commands.Run", {
         if (apps.length) {
           if (maker) {
             qx.tool.compiler.Console.print("qx.tool.cli.run.tooManyMakers");
-            process.exit(-1);
+            process.exit(1);
           }
           if (apps.length != 1) {
             qx.tool.compiler.Console.print(
               "qx.tool.cli.run.tooManyApplications"
             );
 
-            process.exit(-1);
+            process.exit(1);
           }
           maker = tmp;
           app = apps[0];
@@ -100,11 +100,11 @@ qx.Class.define("qx.tool.cli.commands.Run", {
       });
       if (!app) {
         qx.tool.compiler.Console.print("qx.tool.cli.run.noAppName");
-        process.exit(-1);
+        process.exit(1);
       }
       if (app.getType() != "node") {
         qx.tool.compiler.Console.print("qx.tool.cli.run.mustBeNode");
-        process.exit(-1);
+        process.exit(1);
       }
 
       let target = maker.getTarget();
@@ -150,7 +150,6 @@ qx.Class.define("qx.tool.cli.commands.Run", {
         child.stdout.on("data", function (data) {
           console.log(data);
         });
-
         child.stderr.setEncoding("utf8");
         child.stderr.on("data", function (data) {
           console.error(data);

package/source/class/qx/tool/cli/commands/Serve.js

@@ -90,9 +90,6 @@ qx.Class.define("qx.tool.cli.commands.Serve", {
   },
 
   members: {
-    /** @type {qx.tool.utils.Website} the Website instance */
-    _website: null,
-
     /*
      * @Override
      */
@@ -100,18 +97,19 @@ qx.Class.define("qx.tool.cli.commands.Serve", {
       this.argv.watch = true;
       this.argv["machine-readable"] = false;
       this.argv["feedback"] = false;
-      await super.process();
 
       // build website if it hasn't been built yet.
-      const website = (this._website = new qx.tool.utils.Website());
+      const website = new qx.tool.utils.Website();
       if (!(await fs.existsAsync(website.getTargetDir()))) {
         qx.tool.compiler.Console.info(">>> Building startpage...");
-        await this._website.rebuildAll();
+        await website.rebuildAll();
       } else if (this.argv.rebuildStartpage) {
-        this._website.startWatcher();
+        website.startWatcher();
       }
-
-      await this.runWebServer();
+      this.addListenerOnce("made", () => {
+        this.runWebServer();
+      });
+      return super.process();
     },
 
     /**
@@ -210,36 +208,31 @@ qx.Class.define("qx.tool.cli.commands.Serve", {
           res.send(JSON.stringify(appsData, null, 2));
         });
       }
-      this.addListenerOnce("made", e => {
-        let server = http.createServer(app);
-        this.fireDataEvent("beforeStart", {
-          server: server,
-          application: app,
-          outputdir: defaultMaker.getTarget().getOutputDir()
-        });
-
-        server.on("error", e => {
-          if (e.code === "EADDRINUSE") {
-            qx.tool.compiler.Console.print(
-              "qx.tool.cli.serve.webAddrInUse",
-              config.serve.listenPort
-            );
-
-            process.exit(-1);
-          } else {
-            qx.tool.compiler.Console.log(
-              "Error when starting web server: " + e
-            );
-          }
-        });
-        server.listen(config.serve.listenPort, () => {
+      let server = http.createServer(app);
+      this.fireDataEvent("beforeStart", {
+        server: server,
+        application: app,
+        outputdir: defaultMaker.getTarget().getOutputDir()
+      });
+      server.on("error", e => {
+        if (e.code === "EADDRINUSE") {
           qx.tool.compiler.Console.print(
-            "qx.tool.cli.serve.webStarted",
-            "http://localhost:" + config.serve.listenPort
+            "qx.tool.cli.serve.webAddrInUse",
+            config.serve.listenPort
           );
 
-          this.fireEvent("afterStart");
-        });
+          process.exit(1);
+        } else {
+          qx.tool.compiler.Console.log("Error when starting web server: " + e);
+        }
+      });
+      server.listen(config.serve.listenPort, () => {
+        qx.tool.compiler.Console.print(
+          "qx.tool.cli.serve.webStarted",
+          "http://localhost:" + config.serve.listenPort
+        );
+
+        this.fireEvent("afterStart");
       });
     },
 

package/source/class/qx/tool/cli/commands/Test.js

@@ -188,7 +188,7 @@ qx.Class.define("qx.tool.cli.commands.Test", {
              See documentation at https://qooxdoo.org/docs/#/development/testing/`
           );
 
-          process.exit(-1);
+          process.exit(1);
         }
       });
 
@@ -206,6 +206,7 @@ qx.Class.define("qx.tool.cli.commands.Test", {
           await test.execute();
         }
         // for bash exitcode is not allowed to be more then 255!
+        // We must exit the process here because serve runs infinite!
         process.exit(Math.min(255, this.getExitCode()));
       });
 
@@ -216,7 +217,7 @@ qx.Class.define("qx.tool.cli.commands.Test", {
         // compile only
         await qx.tool.cli.commands.Compile.prototype.process.call(this);
         // since the server is not started, manually fire the event necessary for firing the "runTests" event
-        this.fireEvent("afterStart");
+        await this.fireDataEventAsync("afterStart");
       }
     },
 

package/source/class/qx/tool/cli/commands/add/Script.js

@@ -140,7 +140,9 @@ qx.Class.define("qx.tool.cli.commands.add.Script", {
       }
       // save
       this.debug(script_list);
-      manifestModel.setValue("externalResources.script", script_list).save();
+      await manifestModel
+        .setValue("externalResources.script", script_list)
+        .save();
     }
   }
 });

package/source/class/qx/tool/cli/commands/config/Delete.js

@@ -0,0 +1,47 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+   2017 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)
+   * Henner Kollmann (Henner.Kollmann@gmx.de, @hkollmann)
+
+************************************************************************ */
+qx.Class.define("qx.tool.cli.commands.config.Delete", {
+  extend: qx.tool.cli.commands.Config,
+  statics: {
+    /**
+     * Returns the yargs command data
+     * @return {Object}
+     */
+    getYargsCommand() {
+      return {
+        command: "delete <key>",
+        describe: "Deletes a configuration value"
+      };
+    }
+  },
+
+  members: {
+    async process() {
+      await super.process();
+      this._checkKey(this.argv);
+      let cfg = await qx.tool.cli.ConfigDb.getInstance();
+      let keyInfo = this._breakout(this.argv.key);
+      let parent = cfg.db(keyInfo.parentKey);
+      if (parent) {
+        delete parent[keyInfo.childKey];
+      }
+      await cfg.save();
+    }
+  }
+});