README

Grunt-Haxe

Compile Haxe to JavaScript

Haxe is an open-source, multi-platform programming language with many advanced features. Visit the [Haxe website] haxe_www to learn more. A list of advanced features can be found here.

Getting Started

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-haxe --save-dev

(Note: install v0.1.7 of this plugin if you are still using Grunt v0.3)

Then add this line to your project's grunt.js gruntfile:

grunt.loadNpmTasks('grunt-haxe');

Documentation

Overview

Inside your grunt.js file, add a section named haxe. Use this section to define the arguments that will be passed to the Haxe compiler

Config Examples

Minimal Example

A project requires at least the following three properties in order to successfully compile:

haxe: {
    minimal_example: {
        main: 'Main', /*name of the startup class*/
        classpath:['app'],/*specify folder/s where source code is located*/
        output:'dist/output.js' /*compile to this file*/
    }
}

The Haxe project called 'minimal_example' can then be compiled using the following command:

$ grunt haxe:minimal_example

Complete Example

This example shows all available options for configuring your project;

haxe: {
    complete_example: {
        main: 'Main',
        classpath:['app'],
        libs:['casalib'], /*specify haxelib libraries */
        flags:['something', 'createjs'], /* define conditional compilation flags */
        macros:['Mymacro.doSomethingCool()'], /*call the given macro*/
        resources:['activity/xml/map-layout.json@map_layout'], /*define named resource files*/
        misc:['-debug', "--dead-code-elimination", "--js-modern"],/* add any other arguments*/
        output:'app/scripts/output.js',
        onError: function (e) {
            /*custom error message */
            console.log( 'There was a problem...\n' + e );
        },
        force:true /*continue processing task (like --force)*/
    }
}

Composite Example

The value of the option property is typically a string that defines the name and location of a file to compile to but it can also be an object literal that in turn contains an output property.

The following example shows how to configure debug and release builds for a project by defining common properties for both in a single place. Unique settings for each build are then nested;

haxe: {
    multi_target_example: {
        main: 'Main',
        classpath:['app'],
        output:{
            debug:{
                misc:['-debug'],/*-debug results in a js source map*/
                output: 'dist/output.js'
            },
            release: {
                misc:["--dead-code-elimination", "--js-modern"],
                output: 'app/scripts/output.js'
            }
        }
    }
}

HXML Example

The standard Haxe build file is a .hxml file. This can be used as an alternative to defining all the properties directly in the grunt file.

haxe: {
    hxml_example: {
        hxml: 'build.hxml'
    }
}

grunt-haxe

Usage no npm install needed!