Gruntfile.js

/**
 * @description The Gruntfile.js - build file. Tragets are:
 *              - grunt test
 *              - grunt package // package for production
 *                - options --concat, --minify, --no-concat, --no-minify
 *              - grunt // test, package
 *
 * @author Fahim Farook
 *
 */
module.exports = function (grunt) {

	"use strict";

	// display the elapsed execution time of grunt tasks
	require("time-grunt")(grunt);

	// load grunt plugins automatically by looking at task names
	// so no need explicit loading. i.e. grunt.loadNpmTasks('grunt-contrib-clean');
	// task -- plugin matching rules
	//    - <task> -> <task>
	//    - <task> -> grunt-<task>
	//    - <task> -> grunt-contrib-<task>
	require("jit-grunt")(grunt, {
		// for tasks whose name doesn't match the plugin name, load it explicitly.
		useminPrepare: "grunt-usemin",
		replace: "grunt-text-replace"
	});


	// build properties
	var config = (function () {
		var build = grunt.file.readJSON(".fsm4jsrc");
		if (!build) {
			grunt.fail.fatal([".fsm4js doesn't exists"]);
		}

		// optimize
		var defaults = {
			js: {
				minify: true,
				concat: true
			}
		};
		if (!build.optimize) {
			grunt.log.error([".fsm4jsrc doesn't define optimize. Command line options or defaults will be used."]);
			build.optimize = defaults;
		} else {
			for (var prop in defaults) {
				if (!build.optimize[prop]) {
					build.optimize[prop] = {};
				}
			}
		}

		// dirs
		if (!(build.src && build.test && build.dist && build.temp)) {
			grunt.fail.fatal([".fsm4js doesn't define mandatory directories: src, test, dist, temp"]);
		}

		// .bowerrc
		var bower = grunt.file.readJSON(".bowerrc");
		if (bower) {
			build.bower = bower;
		} else {
			build.bower = {
				directory: "bower_components"
			};
		}
		// verify bower.json
		bower = grunt.file.readJSON("bower.json");
		if (!bower || !bower.main) {
			grunt.fail.fatal(["bower.json or main section in bower.json is missing. bower.json=" + bower]);
		}

		// verify package.json
		var pkg = grunt.file.readJSON("package.json");
		if (!pkg || !pkg.name) {
			grunt.fail.fatal(["package.json or name in package.json is missing. package.json=" + pkg]);
		}

		// routes
		var routes = {};
		routes["/" + build.bower.directory] = "./" + build.bower.directory;
		build.routes = routes;

		return build;
	}());

	// configuring grunt...
	grunt.initConfig({

		// settings
		config: config,

		// replace name and versions on package.json and bower.json
		replace: {
			version: {
				src: ["package.json", "bower.json", "<%= config.temp %>/**/*.js"],
				overwrite: true,
				replacements: [{
					from: "@@VERSION",
					to: "<%= config.version %>"
				}, {
					from: /"version"(\s+)?:[^,]+/g,
					to: "\"version\": \"<%= config.version %>\""
				}]
			}
		},

		// delete files/ directories
		clean: {
			dist: {
				files: [{
					dot: true, // .tmp
					src: [
						"<%= config.dist %>",
						"<%= config.temp %>"
					]
				}]
			},
			temp: ["<%= config.temp %>"]
		},

		// copy resources to dist or tmp
		copy: {
			// copy js files
			// from: src, to: temp
			// to allow minification (without requirejs)
			js_src_temp: {
				expand: true,
				dot: true,
				cwd: "<%= config.src %>",
				src: "**/*.js",
				dest: "<%= config.temp %>"
			},
			// copy js files
			// from: temp, to: dist
			js_temp_dist: {
				expand: true,
				dot: true,
				cwd: "<%= config.temp %>",
				src: "**/*.js",
				dest: "<%= config.dist %>"
			}
		},

		concat: {
			target: {
				// to concat files in order, put them in the required order.
				// last file must be excluded first.
				src: ["<%= config.concatOrder %>"],
				dest: "<%= config.temp %>/<%= config.name %>.min.js"
			}
		},

		// minify js files
		uglify: {
			target: {
				options: {
					mangle: false
				},
				files: [{
					expand: true,
					cwd: "<%= config.temp %>",
					src: ["**/*.js"],
					dest: "<%= config.dist %>"
				}]
			}
		},

		// validate javascript
		eslint: {
			options: {
				configFile: ".eslintrc" // where to find eslint configurations
			},
			target: [
				"Gruntfile.js",
				"<%= config.src %>/**/*.js",
				"<%= config.test %>/**/*.js",
				"!<%= config.bower.directory %>/**/*.js"
			]
		},

		// test unit tests in browser
		karma: {
			unit: {
				configFile: "karma.conf.js",
				files: [
					{src: ["<%= config.bower.directory %>/**/*.js"]},
					{src: ["<%= config.src %>/fsm4js-core/fsm4js-core.js"]},
					{src: ["<%= config.src %>/**/*.js"]},
					{src: ["<%= config.test %>/**/*.js"]}
				]
			}
		}
	});

	// usage: grunt test
	grunt.registerTask("test", function () {
		if (grunt.option("coverage")) {
			grunt.config("karma.unit.preprocessors", {
				"<%= config.src %>/**/*.js": "coverage"
			});
			grunt.config("karma.unit.singleRun", true);
		}
		grunt.task.run(["karma"]);
	});

	// usage
	// grunt package                 - package for production. Concat and minify based on settings provided in .zahrawirc
	// grunt package --concat-js     - Overrides settings provided in .zahrawirc
	// grunt package --minify-js     - Overrides settings provided in .zahrawirc
	// grunt package --no-concat-js  - Overrides settings provided in .zahrawirc
	// grunt package --no-minify-js  - Overrides settings provided in .zahrawirc
	grunt.registerTask("package", function () {
		// do configs
		var options = [
			"concat-js",
			"minify-js",
			"no-concat-js",
			"no-minify-js"
		];

		for (var i = 0, len = options.length; i < len; i++) {
			if (grunt.option(options[i])) {
				var opts = options[i].split("-");

				var val = opts[0] === "no" ? false : true;
				var type = opts[opts.length - 1]; // js or css
				var action = opts[opts.length - 2]; // concat or minify
				config.optimize[type][action] = val;
			}
		}

		var tasks = ["clean"]; // both .tmp and dist

		if (config.optimize.js.concat) {
			tasks.push("concat");
		} else {
			tasks.push("copy:js_src_temp"); // 2.a
		}

		tasks.push("replace");

		if (config.optimize.js.minify) { // minify
			tasks.push("uglify");
		} else {
			tasks.push("copy:js_temp_dist");
		}

		grunt.task.run(tasks);
	});

	// usage: grunt
	grunt.registerTask("default", [
		"newer:eslint",
		"test",
		"package"
	]);
};