Merge remote-tracking branch 'boilerplate/master' into t/12721

Reinmar · Reinmar · commit cfae14429609 · 2014-12-17T13:22:41.000+01:00
Conflicts:
	.gitattributes
	.gitignore
	CHANGES.md
	README.md
	gruntfile.js
	package.json
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,12 @@
+# Configurations to normalize the IDE behavior.
+# http://editorconfig.org/
+
+root = true
+
+[*]
+indent_style = tab
+tab_width = 4
+charset = utf-8
+end_of_line = lf
+trim_trailing_whitespace = true
+insert_final_newline = true
diff --git a/.gitattributes b/.gitattributes
@@ -1,14 +1,17 @@
 *			text=auto
 
+*.htaccess	eol=lf
 *.cgi		eol=lf
+*.sh		eol=lf
+
 *.css		text
-*.htaccess	eol=lf
 *.htm		text
 *.html		text
 *.js		text
+*.json		text
 *.php		text
-*.sh		eol=lf
 *.txt		text
+*.md		text
 
 *.png		-text
 *.gif		-text
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,18 @@
-node_modules
-.bender/*
-bender-*.log
+# These files will be ignored by Git and by our linting tools:
+#	grunt jshint
+#	grunt jscs
+#
+# Be sure to append /** to folders to have everything inside them ignored.
+
+# All "dot directoties".
+.*/**
+
+node_modules/**
+build/**
+
+dev/builder/release/**
+dev/builder/ckbuilder/**
+dev/langtool/po/**
+dev/langtool/cklangtool/**
+
+bender-*.log
diff --git a/.jshintignore b/.jshintignore
diff --git a/dev/builder/.gitignore b/dev/builder/.gitignore
diff --git a/dev/langtool/.gitignore b/dev/langtool/.gitignore
diff --git a/dev/tasks/githooks.js b/dev/tasks/githooks.js
@@ -0,0 +1,15 @@
+/* jshint node: true */
+
+'use strict';
+
+module.exports = function( grunt ) {
+	grunt.config.merge( {
+		githooks: {
+			all: {
+				'pre-commit': 'default'
+			}
+		}
+	} );
+
+	grunt.loadNpmTasks( 'grunt-githooks' );
+};
diff --git a/dev/tasks/jscs-config.json b/dev/tasks/jscs-config.json
@@ -1,18 +1,4 @@
 {
-	"excludeFiles": [
-		".bender/*",
-		"dev/builder/release/*",
-		"lang/*",
-		"node_modules/*",
-		"plugins/*/lib/*",
-		"plugins/**/lang/*",
-		"plugins/uicolor/yui/*",
-		"plugins/htmlwriter/samples/assets/outputforflash/*",
-		"tests/adapters/jquery/_assets/*",
-		"tests/core/dom/_assets/*",
-		"tests/core/selection/_helpers/rangy.js",
-		"tests/plugins/mathjax/_assets/truncated-mathjax/*"
-	],
 	"requireCurlyBraces": [
 		"switch", "try", "catch"
 	],
@@ -64,4 +50,4 @@
 		"escape": true
 	},
 	"validateIndentation": "\t"
-}
+}
diff --git a/dev/tasks/jscs.js b/dev/tasks/jscs.js
@@ -0,0 +1,26 @@
+/* jshint node: true */
+
+'use strict';
+
+var tools = require( './utils/tools' );
+
+module.exports = function( grunt ) {
+	tools.setupMultitaskConfig( grunt, {
+		task: 'jscs',
+		defaultOptions: grunt.file.readJSON( 'dev/tasks/jscs-config.json' ),
+		addGitIgnore: 'excludeFiles',
+		targets: {
+			all: function() {
+				return [ '**/*.js' ];
+			},
+
+			git: function() {
+				return tools.getGitDirtyFiles().filter( function( file ) {
+					return ( /\.js$/ ).test( file );
+				} );
+			}
+		}
+	} );
+
+	grunt.loadNpmTasks( 'grunt-jscs' );
+};
diff --git a/dev/tasks/jshint-config.json b/dev/tasks/jshint-config.json
diff --git a/dev/tasks/jshint.js b/dev/tasks/jshint.js
@@ -0,0 +1,26 @@
+/* jshint node: true */
+
+'use strict';
+
+var tools = require( './utils/tools' );
+
+module.exports = function( grunt ) {
+	tools.setupMultitaskConfig( grunt, {
+		task: 'jshint',
+		defaultOptions: grunt.file.readJSON( 'dev/tasks/jshint-config.json' ),
+		addGitIgnore: 'ignores',
+		targets: {
+			all: function() {
+				return [ '**/*.js' ];
+			},
+
+			git: function() {
+				return tools.getGitDirtyFiles().filter( function( file ) {
+					return ( /\.js$/ ).test( file );
+				} );
+			}
+		}
+	} );
+
+	grunt.loadNpmTasks( 'grunt-contrib-jshint' );
+};
diff --git a/dev/tasks/utils/tools.js b/dev/tasks/utils/tools.js
@@ -0,0 +1,142 @@
+/* jshint node: true, es3: false */
+
+'use strict';
+
+var dirtyFiles,
+	ignoreList;
+
+module.exports = {
+	/**
+	 * Check if a task (including its optional target) is in the queue of tasks to be executed by Grunt.
+	 *
+	 * @param grunt {Object} The Grunt object.
+	 * @param task {String} The task name. May optionally include the target (e.g. 'task:target').
+	 * @returns {Boolean} "true" if the task is in the queue.
+	 */
+	checkTaskInQueue: function( grunt, task ) {
+		var cliTasks = grunt.cli.tasks;
+
+		// Check if the task has been called directly.
+		var isDirectCall = ( cliTasks.indexOf( task ) > -1 );
+		// Check if this is a "default" call and that the task is inside "default".
+		var isDefaultTask = ( cliTasks.indexOf( 'default' ) > -1 ) || !cliTasks.length;
+		// Hacking Grunt hard.
+		var isTaskInDefault = isDefaultTask && ( grunt.task._tasks.default.info.indexOf( '"' + task + '"' ) > -1 );
+
+		return isDirectCall || isTaskInDefault;
+	},
+
+	/**
+	 * Configures a multi-task and defines targets that are queued to be run by Grunt.
+	 *
+	 * @param grunt {Object} The Grunt object.
+	 * @param options {Object} A list of options for the method. See the jscs and jshint tasks for example.
+	 */
+	setupMultitaskConfig: function( grunt, options ) {
+		var task = options.task;
+		var taskConfig = {};
+		var config = taskConfig[ task ] = {
+			options: options.defaultOptions
+		};
+
+		// "all" is the default target to be used if others are not to be run.
+		var all = options.targets.all;
+		var isAll = true;
+
+		delete options.targets.all;
+
+		Object.getOwnPropertyNames( options.targets ).forEach( function( target ) {
+			if ( this.checkTaskInQueue( grunt, task + ':' + target ) ) {
+				config[ target ] = options.targets[ target ]();
+				isAll = false;
+			}
+		}, this );
+
+		if ( isAll ) {
+			config.all = all();
+		}
+
+		// Append .gitignore entries to the ignore list.
+		if ( options.addGitIgnore ) {
+			var ignoreProp = task + '.options.' + options.addGitIgnore;
+			var ignores = grunt.config.get( ignoreProp ) || [];
+
+			ignores = ignores.concat( this.getGitIgnore( grunt ) );
+			grunt.config.set( ignoreProp, ignores );
+		}
+
+		// Merge over configurations set in gruntfile.js.
+		grunt.config.merge( taskConfig );
+	},
+
+	/**
+	 * Gets the list of ignores from `.gitignore`.
+	 *
+	 * @param grunt {Object} The Grunt object.
+	 * @returns {String[]} The list of ignores.
+	 */
+	getGitIgnore: function( grunt ) {
+		if ( !ignoreList ) {
+			ignoreList = grunt.file.read( '.gitignore' );
+
+			ignoreList = ignoreList
+				// Remove comment lines.
+				.replace( /^#.*$/gm, '' )
+				// Transform into array.
+				.split( /\n+/ )
+				// Remove empty entries.
+				.filter( function( path ) {
+					return !!path;
+				} );
+		}
+
+		return ignoreList;
+	},
+
+	/**
+	 * Gets the list of files that are supposed to be included in the next Git commit.
+	 *
+	 * @returns {String[]} A list of file paths.
+	 */
+	getGitDirtyFiles: function() {
+		// Cache it, so it is executed only once when running multiple tasks.
+		if ( !dirtyFiles ) {
+			dirtyFiles = this
+				// Compare the state of index with HEAD.
+				.shExec( 'git diff-index --name-only HEAD' )
+				// Remove trailing /n to avoid an empty entry.
+				.replace( /\s*$/, '' )
+				// Transform into array.
+				.split( '\n' );
+
+			// If nothing is returned, the array will one one empty string only.
+			if ( dirtyFiles.length == 1 && !dirtyFiles[ 0 ] ) {
+				dirtyFiles = [];
+			}
+		}
+
+		return dirtyFiles;
+	},
+
+	/**
+	 * Executes a shell command.
+	 *
+	 * @param command {String} The command to be executed.
+	 * @returns {String} The command output.
+	 */
+	shExec: function( command ) {
+		var sh = require( 'shelljs' );
+		sh.config.silent = true;
+
+		var ret = sh.exec( command );
+
+		if ( ret.code ) {
+			throw new Error(
+				'Error while executing `' + command + '`:\n\n' +
+				ret.output
+			);
+		}
+
+		return ret.output;
+	}
+};
diff --git a/gruntfile.js b/gruntfile.js
@@ -3,9 +3,40 @@
 'use strict';
 
 module.exports = function( grunt ) {
+	// First register the "default" task, so it can be analyzed by other tasks.
+	grunt.registerTask( 'default', [ 'jshint:git', 'jscs:git' ] );
+
+	// Files that will be ignored by the "jscs" and "jshint" tasks.
+	var ignoreFiles = [
+		// Automatically loaded from .gitignore. Add more if necessary.
+
+		'lang/**',
+		'plugins/*/lib/**',
+		'plugins/**/lang/**',
+		'plugins/uicolor/yui/**',
+		'plugins/htmlwriter/samples/assets/outputforflash/**',
+		'tests/adapters/jquery/_assets/**',
+		'tests/core/dom/_assets/**',
+		'tests/core/selection/_helpers/rangy.js',
+		'tests/plugins/mathjax/_assets/truncated-mathjax/**'
+	];
+
+	// Basic configuration which will be overloaded by the tasks.
 	grunt.initConfig( {
 		pkg: grunt.file.readJSON( 'package.json' ),
 
+		jshint: {
+			options: {
+				ignores: ignoreFiles
+			}
+		},
+
+		jscs: {
+			options: {
+				excludeFiles: ignoreFiles
+			}
+		},
+
 		plugin: {
 			externalDir: '../ckeditor-plugins/',
 			installationDir: 'plugins/'
@@ -45,7 +76,9 @@ module.exports = function( grunt ) {
 		}
 	} );
 
-	grunt.loadNpmTasks( 'grunt-contrib-imagemin' );
+	// Finally load the tasks.
 	grunt.loadTasks( 'dev/tasks' );
+
+	grunt.loadNpmTasks( 'grunt-contrib-imagemin' );
 	grunt.registerTask( 'images', 'Optimizes images which are not processed later by the CKBuilder (i.e. icons).', [ 'imagemin' ] );
 };
diff --git a/package.json b/package.json
@@ -6,9 +6,12 @@
 		"benderjs-jquery": "~0.2.0",
 		"benderjs-sinon": "~0.1.0",
 		"benderjs-yui": "~0.2.0",
-		"grunt": "^0.4.5",
+		"grunt": "~0",
 		"grunt-contrib-imagemin": "^0.8.1",
-		"shelljs": "^0.3.0"
+		"grunt-jscs": "~1",
+		"grunt-contrib-jshint": "~0",
+		"grunt-githooks": "~0",
+		"shelljs": "~0"
 	},
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1"
