grunt-springroll/libs/springroll-json.js

Tasks building SpringRoll projects

/**
*  Encapsulate the springroll.json format functionality
*  this converts the springroll.json file into useable file lists
*  for running tasks on.
*/
module.exports = function(grunt, options)
{	
	// Use underscore utilities
	var _ = require('lodash'),	
		path = require('path');

	// The name of the build file
	var filename = options.cwd + '/' + (options.buildFile || 'springroll.json');

	// Filter an array of files and only return the javascript files
	var isJS = function(file){ return /\.js$/.test(file); };

	// Filter an array of files and only return CSS and LESS files
	var isCSS = function(file){ return /\.(less|css)$/.test(file); };

	// The list of files to copy
	var librariesCopy = null;

	// Check for springroll file
	if (!grunt.file.exists(filename))
		grunt.fail.fatal('no ' + filename + ' file is found');

	// Load the springroll file which contains the list of 
	// library and project files to springroll
	var file = grunt.file.readJSON(filename);

	// Error checking for required fields and types
	if (!file.name || !_.isString(file.name)) 
		grunt.fail.fatal('"name" is a required field in ' + filename);

	if (!file.version || !_.isString(file.version)) 
		grunt.fail.fatal('"version" is a required field in ' + filename);

	if (!file.main || !_.isArray(file.main))
		grunt.fail.fatal('"main" is a required field in ' + filename);

	if (!file.libraries || !_.isArray(file.libraries))
		grunt.fail.fatal('"libraries" is a required field in ' + filename);

	if (!_.isUndefined(file.librariesDebug) && !_.isArray(file.librariesDebug))
		grunt.fail.fatal('"librariesDebug" must be an array of files in ' + filename);

	if (!_.isUndefined(file.mainDebug) && !_.isArray(file.mainDebug))
		grunt.fail.fatal('"mainDebug" must be an array of files in ' + filename);

	if (!file.config || !_.isString(file.config)) 
		grunt.fail.fatal('"config" must be a string, which is a path to configuration source JSON files');

	var assets = null;

	// Check for assets, this can either be an array of files which
	// outputs 
	if (!_.isUndefined(file.assets))
	{
		if (!_.isArray(file.assets) && !_.isObject(file.assets))
		{
			grunt.fail.fatal('"assets" must be an array or object of files in ' + filename);
		}
		else 
		{
			assets = {};

			// This was the old implementation where you had a single
			// asset file. Unclear if we'll keep this in the future
			if (_.isArray(file.assets))
			{
				assets.assets = _.filter(file.assets || "", isJS);
			}
			// More modern usage for multiple asset files
			else if (_.isObject(file.assets))
			{
				_.each(file.assets, function(files, key){
					assets[key] = _.filter(files || "", isJS);
				});
			}
		}
	}

	// Check for files to copy
	var hasCopy = !_.isUndefined(file.librariesCopy);
	grunt.config.set('hasCopy', hasCopy);

	// Format into format for grunt-contrib-copy
	if (hasCopy) {
		librariesCopy = {};
		var id = 0;
		_.each(file.librariesCopy, function (dest, src) {
			librariesCopy[id++] = {
				src: src,
				dest: dest,
				expand: true,
				flatten: true
			};
		});
	}


	return {

		// The name of the app
		name: file.name,

		// The semantic version of the app
		version: file.version,

		// The configuration source directory
		config: file.config,

		// The name of the springroll file
		file : filename,
		
		// Files to copy
		librariesCopy: librariesCopy,

		// The additional assets
		assets: assets,

		js : {
			// The collection of library files
			libraries : _.filter(file.libraries, isJS),

			// The collection of library files built in debug/unminified mode
			librariesDebug : _.filter(file.librariesDebug || file.libraries, isJS),

			// The collection of source files
			main : _.filter(file.main, isJS),

			// The collection of source files in debug mode
			mainDebug : _.filter(file.mainDebug || file.main, isJS),
		},

		css : {
			// The library css files
			libraries : _.filter(file.libraries, isCSS),

			// The library debug css files
			librariesDebug : _.filter(file.librariesDebug || file.libraries, isCSS),

			// The project css files
			main : _.filter(file.main, isCSS),

			// The project debug CSS
			mainDebug : _.filter(file.mainDebug || file.main, isCSS)
		}
	};
};