Titanium SDK

# Build Configuration File (alloy.jmk)

Alloy provides hooks to customize the compilation process using a special JavaScript file called a JS Makefile (JMK). The file needs to be named alloy.jmk and located in the project's app directory. This file can be used for common administration tasks or to fine tune the build process. It will be loaded automatically by the Alloy command line during compilation.

Example of a JMK file:

alloy.jmk

task('pre:compile', function(event, logger) {
    logger.showTimestamp = true;
    logger.info('building project at '+ event.dir.project);
});

task('post:compile', function(event, logger) {
    logger.info('compile finished!');
});

To customize the build process, call the task function with the event name and provide a function callback, which will be called when the event is triggered by the compiler.

These are the event names (or compiler tasks):

  • pre:load: called after the project is cleaned and before copying any assets to the Resources folder.

  • pre:compile: called before the compiler starts.

  • post:compile: called after the compiler finishes but before it exits.

  • compile:app.js: called just after the compilation of the main app.js file but before the code is written to disk.

The function callback provides two arguments: event and logger.

The event object provides a set of objects and values which may be useful for building tasks:

Object/Value Description
adapters
(Array)		 List of adapters.
alloyConfig
(Object)		 Contains Alloy compiler configuration information.

* platform : either android or ios.

* file: file to target for selective compilation.

* deploytype : compilation environment type: either development, test or production.

* beautify : if set to true, the output from UglifyJS will be beautified.
autoStyle
(Boolean)		 If set to true, autostyle is enabled for the entire project.
dependencies
(Object)		 Value of the dependencies key in the config.json file.
dir
(Object)		 Contains directory paths to various resources.

* home : absolute path to the Alloy project's app directory.

* project : absolute path to the Alloy project's root directory.

* resources : absolute path to the Alloy project's Resource directory.

* resourcesAlloy : absolute path to the Alloy project's Resource/alloy directory.

* assets : absolute path to the Alloy project's assets.

* config : absolute path to the Alloy project's config.

* controllers : absolute path to the Alloy project's controllers.

* migrations : absolute path to the Alloy project's migrations.

* models : absolute path to the Alloy project's models.

* styles : absolute path to the Alloy project's styles.

* themes : absolute path to the Alloy project's themes.

* views : absolute path to the Alloy project's views.

* widgets : absolute path to the Alloy project's widgets.

* builtins : absolute path to the Alloy tool builtins.

* template : absolute path to the Alloy tool templates.
sourcemap
(Boolean)		 If true, generates the source mapping files for use with the Studio debugger and other functions.
These files maps the generated Titanium files in the Resources directory to the ones in the app directory.
theme
(String)		 Name of the theme being used.
code
(String)		 Only present for the compile:app.js task. Contains the contents of the app.js file.
appJSFile
(String)		 Only present for the compile:app.js task. Contains the the absolute path to the app.js file.

The logger object provides a reference to the logger, which defines the following methods and properties:

# Properties

DEBUG: Number READONLY Output all log messages.

INFO: Number READONLY Output all log messages except debug messages.

WARN: Number READONLY Output only warning and error log messages.

ERROR: Number READONLY Output only error log messages.

NONE: Number READONLY Disable log messages.

logLevel: Number Sets which log messages to output.

showTimestamp: Boolean If true, outputs timestamp with the log messages.

stripColors: Boolean If true, suppresses color output.

# Methods

debug (String msg) Outputs a debug log message.

Parameters:

  • msg : String Message to output.

Returns:

  • void

info (String msg) Outputs an info log message.

Parameters:

  • msg : String Message to output.

Returns:

  • void

warn (String msg) Outputs a warning log message.

Parameters:

  • msg : String Message to output.

Returns:

  • void

error (String msg) Outputs an error log message.

Parameters:

  • msg : String Message to output.

Returns:

  • void

← Project Configuration File (config.json) →

Contents