Gruntfile.js

/*global module:false*/

var fs = module.require('fs');
var path = module.require('path');
var os = module.require('os');
var md = module.require('matchdep');

module.exports = function fxGruntConfig (grunt) {
	
	'use strict';
	
	// VAR
	var GRUNT_FILE = 'Gruntfile.js';
	
	var BUILD_FILE = './dist/build.json';
	
	var SRC_FILES = ['./src/*.js'];
	
	var JSCS_FILE = '.jscsrc';
	
	// TESTS
	var SERVER_PORT = 8081;
	var SERVER_URI = 'http://localhost:' + SERVER_PORT;
	var TEST_PATHS = [
		'/tests/framework.debug.js.test.html',
		'/tests/framework.callback.js.test.html',
		'/tests/framework.actions.js.test.html',
		'/tests/framework.fx.js.test.html',
		'/tests/framework.app.js.test.html',
		'/tests/framework.storage.js.test.html'
	];
	
	var TEST_URIS = [];
	var TEST_URIS_LT = [];
	var TEST_URIS_CI = [];
	var TEST_QS = '?noglobals=true';
	
	// for qunit
	var createTestUris = function () {
		for (var c = 0; c < TEST_PATHS.length; c++) {
			TEST_URIS.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + '3.4.1');
			TEST_URIS.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + '3.3.1');
			TEST_URIS.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + '3.2.1');
			TEST_URIS.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + '3.1.1');
			TEST_URIS.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + '3.0.0');
			TEST_URIS.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + '2.2.4');
			TEST_URIS.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + '2.1.4');
			TEST_URIS.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + '2.0.3');
			TEST_URIS.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + '1.12.2');
			TEST_URIS.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + '1.11.1');
			TEST_URIS.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + '1.10.2');
			TEST_URIS.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + '1.9.1');
		}
	};
	var createTestUrisLt = function () {
		for (var c = 0; c < TEST_PATHS.length; c++) {
			TEST_URIS_LT.push(SERVER_URI + TEST_PATHS[c] + TEST_QS);
		}
	};
	var createTestUrisCi = function () {
		for (var c = 0; c < TEST_PATHS.length; c++) {
			TEST_URIS_CI.push(SERVER_URI + TEST_PATHS[c] + TEST_QS + 'local');
		}
	};
	var VERBOSE = !!~grunt.option.flags().indexOf('--verbose');
	
	var config = {
		pkg: grunt.file.readJSON('package.json'),
		clean: {
			options: {
				force: true
			},
			doc: {
				src: [
					'docs/<%= pkg.name %>/<%= pkg.version %>/*'
				]
			}
		},
		buildnum: {
			options: {
				file: BUILD_FILE
			}
		},
		babel: {
			options: {
				sourceMap: false,
				presets: [[
					'@babel/preset-env',
					{
						modules: false,
						targets: {
							ie: 11
						}
					}
				]],
				minified: true,
				comments: false,
				plugins: []
			},
			dist: {
				files: {
					'dist/<%= pkg.name %>.min.js': 'dist/<%= pkg.name %>.js'
				}
			}
		},
		meta: {
			banner: '/*! <%= pkg.title || pkg.name %> - v<%= pkg.version %>' +
			' - <%= meta.revision %> - build <%= buildnum.num %> - ' +
			'<%= grunt.template.today("yyyy-mm-dd") %>\n' +
			'<%= pkg.homepage ? " * " + pkg.homepage + "\\n" : "" %>' +
			' * Copyright (c) <%= grunt.template.today("yyyy") %> ' +
			'<%= pkg.author.name %> (<%= pkg.author.url %>);\n' +
			' * <%= pkg.license %> */'
		},
		revision: {
			options: {
				property: 'meta.revision',
				ref: 'HEAD',
				short: true
			}
		},
		concat: {
			options: {
				process: true,
				banner: '<%= meta.banner %>'
			},
			dist: {
				src: SRC_FILES,
				dest: 'dist/<%= pkg.name %>.js'
			}
		},
		qunit: {
			options: {
				noGlobals: true,
				timeout: 6000,
				console: !!VERBOSE,
				puppeteer: {
					headless: !VERBOSE,
					args: ['--media-cache-size=1', '--disk-cache-size=1']
				}
			},
			all: {
				options: {
					urls: TEST_URIS
				}
			},
			ci: {
				options: {
					urls: TEST_URIS_CI
				}
			},
			latest: {
				options: {
					urls: TEST_URIS_LT
				}
			}
		},
		watch: {
			files: SRC_FILES.concat(GRUNT_FILE),
			tasks: ['jshint', 'complexity']
		},
		jshint: {
			files: SRC_FILES.concat(GRUNT_FILE),
			//force: true,
			options: {
				bitwise: false,
				camelcase: false,
				curly: true,
				eqeqeq: false, // allow ==
				forin: true,
				//freeze: true,
				immed: false, //
				latedef: true, // late definition
				newcap: true, // capitalize ctos
				noempty: true,
				nonew: true, // no new ..()
				noarg: true,
				plusplus: false,
				quotmark: 'single',
				undef: true,
				maxparams: 5,
				maxdepth: 5,
				maxstatements: 30,
				maxlen: 100,
				//maxcomplexity: 10,
				
				// relax options
				//boss: true,
				//eqnull: true,
				esnext: true,
				regexp: true,
				strict: true,
				trailing: false,
				sub: true, // [] notation
				smarttabs: true,
				lastsemic: false, // enforce semicolons
				white: true,
				
				// env
				browser: true,
				
				globals: {
					document: true,
					console: true,
					App: true,
					window: true
				}
			}
		},
		uglify: {
			prod: {
				files: {
					'dist/<%= pkg.name %>.min.js': '<%= concat.dist.dest %>'
				}
			},
			options: {
				banner: '<%= meta.banner %>',
				sourceMap: 'dist/<%= pkg.name %>.min.js.map',
				sourceMappingURL: '<%= pkg.name %>.min.js.map',
				report: 'gzip',
				mangle: true,
				compress: {
					global_defs: {
						DEBUG: false
					},
					dead_code: true,
					unused: true
				},
				preserveComments: false
			}
		},
		connect: {
			server: {
				options: {
					port: SERVER_PORT,
					base: '.'
				}
			}
		},
		complexity: {
			generic: {
				src: SRC_FILES.concat(GRUNT_FILE),
				options: {
					//jsLintXML: 'report.xml', // create XML JSLint-like report
					errorsOnly: false, // show only maintainability errors
					cyclomatic: 10,
					halstead: 25,
					maintainability: 89
				}
			}
		},
		jscs: {
			src: SRC_FILES.concat(GRUNT_FILE),
			options: {
				config: JSCS_FILE,
				fix: true
			}
		},
		jsdoc: {
			dist: {
				src: SRC_FILES.concat('README.md'),
				options: {
					destination: 'docs',
					private: false,
					package: './package.json',
					template: './node_modules/minami'
				}
			}
		}
	};
	
	var init = function (grunt) {
		// Overrides some values
		grunt.util.linefeed = '\n';
		grunt.file.preserveBOM = false;
		
		// Project configuration.
		grunt.initConfig(config);
		
		// fix source map url
		grunt.registerTask('fix-source-map',
			'Fixes the wrong file path in the source map', function () {
			var sourceMapPath = grunt.template.process('<%= uglify.options.sourceMap %>');
			var sourceMapUrl = grunt.template.process('<%= uglify.options.sourceMappingURL %>');
			var diff = sourceMapPath.replace(sourceMapUrl, '');
			var sourceMap = grunt.file.readJSON(sourceMapPath);
			sourceMap.file = sourceMap.file.replace(diff, '');
			var newSources = [];
			sourceMap.sources.forEach(function (elem) {
				newSources.push(elem.replace(diff, ''));
			});
			sourceMap.sources = newSources;
			grunt.file.write(sourceMapPath, JSON.stringify(sourceMap));
		});

		// generate build number
		grunt.registerTask('buildnum',
			'Generates and updates the current build number', function () {
			var options = this.options();
			var getBuildNumber = function () {
				var b = {};
				
				try {
					b = grunt.file.readJSON(options.file);
				} catch (e) {}
				
				b.lastBuild = b.lastBuild > 0 ? b.lastBuild + 1 : 1;
				
				grunt.file.write(options.file, JSON.stringify(b));
				
				return b.lastBuild;
			};

			var buildnum = getBuildNumber();
			grunt.config.set('buildnum.num', buildnum);
			grunt.log.writeln('New build num:', buildnum);
			grunt.log.writeln('For version:', config.pkg.version);
		});
		
		// Default task.
		grunt.registerTask('test', ['connect', 'qunit:all']);
		grunt.registerTask('test-latest', ['connect', 'qunit:latest']);
		grunt.registerTask('test-ci', ['connect', 'qunit:ci']);
		grunt.registerTask('dev', ['jshint', 'jscs', 'complexity']);
		grunt.registerTask('build', [
			'buildnum',
			'revision',
			'concat',
			'babel',
			'fix-source-map'
		]);
		grunt.registerTask('doc', ['clean:doc','jsdoc']);
		grunt.registerTask('ci', ['dev', 'test-ci', 'build', 'doc']);
		grunt.registerTask('default', ['dev', 'test', 'build', 'doc']);
	};
	
	var load = function (grunt) {
		md.filterDev('grunt-*').forEach(grunt.loadNpmTasks);
		
		createTestUris();
		createTestUrisCi();
		createTestUrisLt();
		
		init(grunt);
		
		console.log('Running grunt on ' + os.platform());
	};
	
	// load the set-up
	load(grunt);
};