A grunt plugin which builds your Qooxdoo app.
Last updated 4 years ago by pcdummy .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install grunt-qxcompiler 
SYNC missed versions from official npm registry.


This plugin allows you to compile your Qooxdoo app with qxcompiler, it adds ES6 compatiblity, multi app compilation and allows you to include contribs easily.

This project is a WIP / Alpha release. Expect things to be broken or getting changed.

For a minimal example see the authors tweets app.

Getting Started

This plugin requires Grunt ~1.0.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-qxcompiler --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:


The "qxcompiler" task


In your project's Gruntfile, add a section named qxcompiler to the data object passed into grunt.initConfig().

var qxpath = '../vendor/qooxdoo';
if ('QOOXDOO_PATH' in process.env) {
  qxpath = process.env.QOOXDOO_PATH;

  // Configuration to be run
  qxcompiler: {
    options: {
      appClass: 'qxpromiserest_demo.Application',
      appName: 'qxpromiserest_demo',
      appTitle: 'QxPromiserestRest Demo',
      theme: 'qxpromiserest_demo.theme.Theme',
      locales: ['en'],
      addScript: [
      addCss: [],
      libraryDirs: [
        qxpath + '/framework',

    source: {
      options: {
        target: 'source',
        outDir: 'build/source/',
        copyResources: true

    build: {
      options: {
        target: 'build',
        outDir: 'build/build/',
        // Only available within the 'build' target.
        minify: true

    hybrid: {
      options: {
        target: 'hybrid',
        outDir: 'build/hybrid/'



Type: String

Your applications class name.


Type: String

Name of your application, will be used for "<appname>.html" and "<appname>/boot.js" in the output directory.


Type: String

Title of your application - i'm not yet sure what is it for.


Type: String

The theme of your application.


Type: Array

Array of locales to integrate.


Type: Array

Array of scripts to load before Qooxdoo init, each entry can have a sprintf style variable %(<NAMESPACE>) this will be replaced with the actual path of the libraries source folder on a source/hybrid target, when using the build target it will use '.' as replacement.


Type: Array

Same replacement as with addScript can happen here.


Type: Array

Relative or absolute paths to the libraries to include, each MUST have a "Manifest.json", make sure to add Qooxdoo itself here.


Type: Boolean Default: true

Minify the result in build targets?


Type: Boolean Default: false

Copy resources into the output directory on source targets?


In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)

Current Tags

  • 0.1.2                                ...           latest (4 years ago)

3 Versions

  • 0.1.2                                ...           4 years ago
  • 0.1.1                                ...           4 years ago
  • 0.1.0                                ...           4 years ago
Maintainers (1)
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 1
Last Month 1
Dependencies (16)
Dev Dependencies (6)
Dependents (0)

Copyright 2014 - 2017 © |