Deprecated

With the release of SpringRoll 2.0 this repository has been deprecated.

It has been replaced by the Springroll-seed project

Grunt SpringRoll

Grunt SpringRoll is a Node plugin which provides common project build tasks for creating SpringRoll projects. The plugin requires both Grunt and Bower to be installed on the local system in order to build.

Requirements

There are a couple of tools that you'll need to install before we can create our project. Please make sure the following items are available on your machine:

• Install Node JS
• Install Grunt npm install -g grunt-cli
• Install Bower npm install -g bower

Adding Dependencies

Grunt SpringRoll is designed to easily include external dependencies into your project.

Modify the bower.json file to include additional libraries into your project. For more information about using Bower please visit the website. For instance, if you wanted to include CreateJS, bower.json might look like this. Note that the version and name field is automatically updated from the springroll.json file.

{
    "name": "MyApp",
    "version":"0.0.1",
    "dependencies": {
        "jquery" : "~1",
        "normalize-css" : "*",
        "EaselJS" : "*",
        "TweenJS" : "*",
        "PreloadJS" : "*",
        "SoundJS" : "*"
    }
}

Then, update springroll.json to list the files you'd like to include from the libraries.

{
    "name" : "MyApp",
    "version" : "1.0.0",
    "main" : [
        "src/main.js",
        "src/main.less"
    ],
    "libraries" : [
        "components/normalize-css/normalize.css",
        "components/jquery/dist/jquery.min.js",
        "components/EaselJS/lib/easeljs-*.*.*.min.js",
        "components/EaselJS/lib/movieclip-*.*.*.min.js",
        "components/PreloadJS/lib/preloadjs-*.*.*.min.js",
        "components/SoundJS/lib/soundjs-*.*.*.min.js",
        "components/TweenJS/lib/tweenjs-*.*.*.min.js"
    ]
}

After adding these libraries, run grunt libs from the commandline to import new libraries into your project.

Grunt Tasks

These are the list of grunt tasks for building the project.

Task Hooks

These are the list of grunt tasks which are safe to be overridden using grunt.registerTask(). These task aliases are empty and contain no sub-tasks.

Build File

The springroll.json file contains the list of all required JavaScript and CSS files in order to build the project. Below describes the different fields of this file.

Conditional Compiling

The main JavaScript source building supports conditional compiling with global constants. These constants can be use to specify an inline block of code that should be use for development or release builds of the project. The booleans DEBUG and RELEASE are supported.

Example

if (DEBUG)
{
    // This code is only visible when built using the 'dev' task
    alert('Debug code here!');
}
 
if (RELEASE)
{
    // This code is only visible when built using the 'default' task
}

Project Structure

Plugin Settings

The Grunt SpringRoll plugin can accept additional options. Here's an example to add additional arguments:

module.exports = function(grunt)
{
    require('grunt-springroll')(grunt, {
        options: {
            jsFolder : "deploy/js",
            cssFolder : "deploy/css"
        }
    });
};

settings.options.autoInit

A boolean defaults to true. If grunt.initConfig() is automatically called.

settings.options.buildFile

A string defaults to "springroll.json". The name of the JSON file which contains the JavaScript, CSS files to build. See the Build File above for more information about what this does.

settings.options.distFolder

A string defaults to "deploy". The base output folder where to save the compiled project files.

settings.options.jsFolder

A string defaults to "deploy/assets/js". The base output folder for JavaScript files (libraries.js and main.js).

settings.options.cssFolder

A string defaults to "deploy/assets/css". The base output folder for CSS files (libraries.css and main.css).

settings.options.configFolder

A string defaults to "deploy/assets/config". The name of the output folder which will contain the configuration files.

settings.options.configFile

A string defaults to "deploy/assets/config/config.json". The name of the output file which will contain the concatenated configuration JSON file.

settings.*

Any additional arguments to be accessible by the Grunt cofnig. The data to set which can be accessible by all Grunt tasks, for instance { "name": "MyApp"} would allow a substitution <%= name %> which would resolve to MyApp.