Build: Migrate to grunt 0.4. Rename to Gruntfile, upgrade to newer grunt-css and grunt-html, update custom tasks. Drop qunit-junit plugin, not worth the trouble. Update release script to run grunt-prepare after npm-install.

jzaefferer · jzaefferer · commit 7821c3f2c620 · 2012-12-24T18:10:44.000+01:00
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -46,16 +46,42 @@ var
 
 	// minified files
 	minify = {
-		"dist/jquery-ui.min.js": [ "<banner:meta.bannerAll>", "dist/jquery-ui.js" ],
-		"dist/i18n/jquery-ui-i18n.min.js": [ "<banner:meta.bannerI18n>", "dist/i18n/jquery-ui-i18n.js" ]
+		options: {
+			preserveComments: false
+		},
+		main: {
+			options: {
+				banner: createBanner( uiFiles )
+			},
+			files: {
+				"dist/jquery-ui.min.js": "dist/jquery-ui.js"
+			}
+		},
+		i18n: {
+			options: {
+				banner: createBanner( allI18nFiles )
+			},
+			files: {
+				"dist/i18n/jquery-ui-i18n.min.js": "dist/i18n/jquery-ui-i18n.js"
+			}
+		}
 	},
 
 	minifyCSS = {
-		"dist/jquery-ui.min.css": "dist/jquery-ui.css"
+		options: {
+			keepSpecialComments: 0
+		},
+		main: {
+			options: {
+				keepSpecialComments: '*'
+			},
+			src: "dist/jquery-ui.css",
+			dest: "dist/jquery-ui.min.css"
+		}
 	},
 
 	compareFiles = {
-		all: [
+		files: [
 			"dist/jquery-ui.js",
 			"dist/jquery-ui.min.js"
 		]
@@ -66,84 +92,95 @@ function mapMinFile( file ) {
 }
 
 uiFiles.concat( allI18nFiles ).forEach(function( file ) {
-	minify[ mapMinFile( file ) ] = [ "<banner>", file ];
+	minify[ file ] = {
+		options: {
+			banner: createBanner()
+		},
+		files: {}
+	};
+	minify[ file ].files[ mapMinFile( file ) ] = file;
 });
 
 cssFiles.forEach(function( file ) {
-	minifyCSS[ "dist/" + file.replace( /\.css$/, ".min.css" ).replace( /themes\/base\//, "themes/base/minified/" ) ] = [ "<banner>", "<strip_all_banners:" + file + ">" ];
+	minifyCSS[ file ] = {
+		options: {
+			banner: createBanner()
+		},
+		src: file,
+		dest: "dist/" + file.replace( /\.css$/, ".min.css" ).replace( /themes\/base\//, "themes/base/minified/" )
+	};
 });
 
 uiFiles.forEach(function( file ) {
+	// TODO this doesn't do anything until https://github.com/rwldrn/grunt-compare-size/issues/13
 	compareFiles[ file ] = [ file,  mapMinFile( file ) ];
 });
 
 // grunt plugins
+grunt.loadNpmTasks( "grunt-contrib-jshint" );
+grunt.loadNpmTasks( "grunt-contrib-uglify" );
+grunt.loadNpmTasks( "grunt-contrib-concat" );
+grunt.loadNpmTasks( "grunt-contrib-qunit" );
 grunt.loadNpmTasks( "grunt-css" );
 grunt.loadNpmTasks( "grunt-html" );
 grunt.loadNpmTasks( "grunt-compare-size" );
-grunt.loadNpmTasks( "grunt-junit" );
 grunt.loadNpmTasks( "grunt-git-authors" );
 // local testswarm and build tasks
 grunt.loadTasks( "build/tasks" );
 
-grunt.registerHelper( "strip_all_banners", function( filepath ) {
-	return grunt.file.read( filepath ).replace( /^\s*\/\*[\s\S]*?\*\/\s*/g, "" );
-});
-
-function stripBanner( files ) {
-	return files.map(function( file ) {
-		return "<strip_all_banners:" + file + ">";
-	});
-}
-
 function stripDirectory( file ) {
-	// TODO: we're receiving the directive, so we need to strip the trailing >
-	// we should be receving a clean path without the directive
 	return file.replace( /.+\/(.+?)>?$/, "$1" );
 }
-// allow access from banner template
-global.stripDirectory = stripDirectory;
 
 function createBanner( files ) {
 	// strip folders
 	var fileNames = files && files.map( stripDirectory );
 	return "/*! <%= pkg.title || pkg.name %> - v<%= pkg.version %> - " +
 		"<%= grunt.template.today('isoDate') %>\n" +
-		"<%= pkg.homepage ? '* ' + pkg.homepage + '\n' : '' %>" +
-		"* Includes: " + (files ? fileNames.join(", ") : "<%= stripDirectory(grunt.task.current.file.src[1]) %>") + "\n" +
+		"<%= pkg.homepage ? '* ' + pkg.homepage + '\\n' : '' %>" +
+		(files ? "* Includes: " + fileNames.join(", ") + "\n" : "")+
 		"* Copyright <%= grunt.template.today('yyyy') %> <%= pkg.author.name %>;" +
-		" Licensed <%= _.pluck(pkg.licenses, 'type').join(', ') %> */";
+		" Licensed <%= _.pluck(pkg.licenses, 'type').join(', ') %> */\n";
 }
 
 grunt.initConfig({
-	pkg: "<json:package.json>",
+	pkg: grunt.file.readJSON("package.json"),
 	files: {
 		dist: "<%= pkg.name %>-<%= pkg.version %>",
 		cdn: "<%= pkg.name %>-<%= pkg.version %>-cdn",
 		themes: "<%= pkg.name %>-themes-<%= pkg.version %>"
 	},
-	meta: {
-		banner: createBanner(),
-		bannerAll: createBanner( uiFiles ),
-		bannerI18n: createBanner( allI18nFiles ),
-		bannerCSS: createBanner( cssFiles )
-	},
 	compare_size: compareFiles,
 	concat: {
 		ui: {
-			src: [ "<banner:meta.bannerAll>", stripBanner( uiFiles ) ],
+			options: {
+				banner: createBanner( uiFiles ),
+				stripBanners: {
+					block: true
+				}
+			},
+			src: uiFiles,
 			dest: "dist/jquery-ui.js"
 		},
 		i18n: {
-			src: [ "<banner:meta.bannerI18n>", allI18nFiles ],
+			options: {
+				banner: createBanner( allI18nFiles )
+			},
+			src: allI18nFiles,
 			dest: "dist/i18n/jquery-ui-i18n.js"
 		},
 		css: {
-			src: [ "<banner:meta.bannerCSS>", stripBanner( cssFiles ) ],
+			options: {
+				banner: createBanner( cssFiles ),
+				stripBanners: {
+					block: true
+				}
+			},
+			src: cssFiles,
 			dest: "dist/jquery-ui.css"
 		}
 	},
-	min: minify,
+	uglify: minify,
 	cssmin: minifyCSS,
 	htmllint: {
 		// ignore files that contain invalid html, used only for ajax content testing
@@ -158,7 +195,7 @@ grunt.initConfig({
 				"jquery-*.js",
 				"MIT-LICENSE.txt",
 				"README.md",
-				"grunt.js",
+				"Gruntfile.js",
 				"package.json",
 				"*.jquery.json",
 				"ui/**/*",
@@ -284,10 +321,31 @@ grunt.initConfig({
 			return !( /(all|index|test|dialog|dialog_deprecated|tabs|tooltip)\.html$/ ).test( file );
 		})
 	},
-	lint: {
-		ui: "ui/*.js",
-		grunt: [ "grunt.js", "build/**/*.js" ],
-		tests: "tests/unit/**/*.js"
+	jshint: {
+		ui: {
+			options: {
+				jshintrc: "ui/.jshintrc"
+			},
+			files: {
+				src: "ui/*.js"
+			}
+		},
+		grunt: {
+			options: {
+				jshintrc: ".jshintrc"
+			},
+			files: {
+				src: [ "Gruntfile.js", "build/**/*.js" ]
+			}
+		},
+		tests: {
+			options: {
+				jshintrc: "tests/.jshintrc"
+			},
+			files: {
+				src: "tests/unit/**/*.js"
+			}
+		}
 	},
 	csslint: {
 		// nothing: []
@@ -307,39 +365,15 @@ grunt.initConfig({
 				"compatible-vendor-prefixes": false
 			}
 		}
-	},
-	jshint: (function() {
-		function parserc( path ) {
-			var rc = grunt.file.readJSON( (path || "") + ".jshintrc" ),
-				settings = {
-					options: rc,
-					globals: {}
-				};
-
-			(rc.predef || []).forEach(function( prop ) {
-				settings.globals[ prop ] = true;
-			});
-			delete rc.predef;
-
-			return settings;
-		}
-
-		return {
-			grunt: parserc(),
-			ui: parserc( "ui/" ),
-			// TODO: `evil: true` is only for document.write() https://github.com/jshint/jshint/issues/519
-			// TODO: don't create so many globals in tests
-			tests: parserc( "tests/" )
-		};
-	})()
+	}
 });
 
-grunt.registerTask( "default", "lint csslint htmllint qunit" );
-grunt.registerTask( "sizer", "concat:ui min:dist/jquery-ui.min.js compare_size:all" );
-grunt.registerTask( "sizer_all", "concat:ui min compare_size" );
-grunt.registerTask( "build", "concat min cssmin copy:dist_units_images" );
-grunt.registerTask( "release", "clean build copy:dist copy:dist_min copy:dist_min_images copy:dist_css_min md5:dist zip:dist" );
-grunt.registerTask( "release_themes", "release generate_themes copy:themes md5:themes zip:themes" );
-grunt.registerTask( "release_cdn", "release_themes copy:cdn copy:cdn_min copy:cdn_i18n copy:cdn_i18n_min copy:cdn_min_images copy:cdn_themes md5:cdn zip:cdn" );
+grunt.registerTask( "default", [ "jshint", "csslint", "htmllint", "qunit" ] );
+grunt.registerTask( "sizer", [ "concat:ui", "uglify:main", "compare_size:all" ] );
+grunt.registerTask( "sizer_all", [ "concat:ui", "uglify", "compare_size" ] );
+grunt.registerTask( "build", [ "concat", "uglify", "cssmin", "copy:dist_units_images" ] );
+grunt.registerTask( "release", "clean build copy:dist copy:dist_min copy:dist_min_images copy:dist_css_min md5:dist zip:dist".split( " " ) );
+grunt.registerTask( "release_themes", "release generate_themes copy:themes md5:themes zip:themes".split( " " ) );
+grunt.registerTask( "release_cdn", "release_themes copy:cdn copy:cdn_min copy:cdn_i18n copy:cdn_i18n_min copy:cdn_min_images copy:cdn_themes md5:cdn zip:cdn".split( " " ) );
 
 };
diff --git a/build/release/release.js b/build/release/release.js
@@ -77,6 +77,9 @@ function cloneRepo() {
 		if ( exec( "npm install download.jqueryui.com" ).code !== 0 ) {
 			abort( "Error installing dependencies." );
 		}
+		if ( exec( "cd node_modules/download.jqueryui.com && grunt prepare" ).code !== 0 ) {
+			abort( "Error installing dependencies." );
+		}
 	}
 	echo();
 }
diff --git a/build/tasks/build.js b/build/tasks/build.js
@@ -3,7 +3,9 @@ module.exports = function( grunt ) {
 "use strict";
 
 var path = require( "path" ),
-	fs = require( "fs" );
+	fs = require( "fs" ),
+	// support: node <0.8
+	existsSync = fs.existsSync || path.existsSync;
 
 grunt.registerTask( "manifest", "Generate jquery.json manifest files", function() {
 	var pkg = grunt.config( "pkg" ),
@@ -121,28 +123,11 @@ grunt.registerMultiTask( "copy", "Copy files to destination folder and replace @
 
 
 grunt.registerMultiTask( "zip", "Create a zip file for release", function() {
-	// TODO switch back to adm-zip for better cross-platform compability once it actually works
-	// 0.1.3 works, but result can't be unzipped
-	// its also a lot slower then zip program, probably due to how its used...
-	// var files = grunt.file.expandFiles( "dist/" + this.file.src + "/**/*" );
-	// grunt.log.writeln( "Creating zip file " + this.file.dest );
-
-	//var AdmZip = require( "adm-zip" );
-	//var zip = new AdmZip();
-	//files.forEach(function( file ) {
-	//	grunt.verbose.writeln( "Zipping " + file );
-	//	// rewrite file names from dist folder (created by build), drop the /dist part
-	//	zip.addFile(file.replace(/^dist/, "" ), fs.readFileSync( file ) );
-	//});
-	//zip.writeZip( "dist/" + this.file.dest );
-	//grunt.log.writeln( "Wrote " + files.length + " files to " + this.file.dest );
-
 	var done = this.async(),
-		dest = this.file.dest,
-		src = grunt.template.process( this.file.src, grunt.config() );
-	grunt.utils.spawn({
+		dest = this.data.dest;
+	grunt.util.spawn({
 		cmd: "zip",
-		args: [ "-r", dest, src ],
+		args: [ "-r", dest, this.data.src ],
 		opts: {
 			cwd: 'dist'
 		}
@@ -159,7 +144,7 @@ grunt.registerMultiTask( "zip", "Create a zip file for release", function() {
 
 grunt.registerMultiTask( "md5", "Create list of md5 hashes for CDN uploads", function() {
 	// remove dest file before creating it, to make sure itself is not included
-	if ( path.existsSync( this.file.dest ) ) {
+	if ( existsSync( this.file.dest ) ) {
 		fs.unlinkSync( this.file.dest );
 	}
 	var crypto = require( "crypto" ),
@@ -197,23 +182,23 @@ grunt.registerTask( "generate_themes", function() {
 	});
 
 	done = this.async();
-	grunt.utils.async.forEach( download.themeroller.gallery(), function( theme, done ) {
+	grunt.util.async.forEach( download.themeroller.gallery(), function( theme, done ) {
 		var folderName = theme.folderName(),
 			concatTarget = "css-" + folderName,
 			cssContent = theme.css(),
 			cssFolderName = target + "themes/" + folderName + "/",
 			cssFileName = cssFolderName + "jquery.ui.theme.css",
-			cssFiles = grunt.config.get( "concat.css.src" )[ 1 ].slice();
+			cssFiles = grunt.config.get( "concat.css.src" ).slice();
 
 		grunt.file.write( cssFileName, cssContent );
 
 		// get css components, replace the last file with the current theme
 		cssFiles.splice(-1);
-		cssFiles.push( "<strip_all_banners:" + cssFileName + ">" );
-		grunt.config.get( "concat" )[ concatTarget ] = {
-			src: [ "<banner:meta.bannerCSS>", cssFiles ],
+		cssFiles.push( cssFileName );
+		grunt.config.set( "concat." + concatTarget, {
+			src: cssFiles,
 			dest: cssFolderName + "jquery-ui.css"
-		};
+		});
 		grunt.task.run( "concat:" + concatTarget );
 
 		theme.fetchImages(function( err, files ) {
diff --git a/package.json b/package.json
@@ -43,12 +43,15 @@
 	],
 	"dependencies": {},
 	"devDependencies": {
-		"grunt": "~0.3.17",
-		"grunt-css": "0.2.0",
-		"grunt-compare-size": "0.1.4",
-		"grunt-html": "0.1.1",
-		"grunt-junit": "0.1.5",
-		"grunt-git-authors": "1.0.0",
+		"grunt": "0.4.x",
+		"grunt-contrib-jshint": "0.1.0",
+		"grunt-contrib-uglify": "0.1.0",
+		"grunt-contrib-concat": "0.1.1",
+		"grunt-contrib-qunit": "0.1.0",
+		"grunt-css": "0.5.1",
+		"grunt-compare-size": "0.3.1",
+		"grunt-html": "0.3.0",
+		"grunt-git-authors": "1.1.0-beta.1",
 		"rimraf": "2.0.1",
 		"testswarm": "0.3.0"
 	},

Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,9 @@ function cloneRepo() {`
`77`	`77`	`if ( exec( "npm install download.jqueryui.com" ).code !== 0 ) {`
`78`	`78`	`abort( "Error installing dependencies." );`
`79`	`79`	`}`
	`80`	`+ if ( exec( "cd node_modules/download.jqueryui.com && grunt prepare" ).code !== 0 ) {`
	`81`	`+ abort( "Error installing dependencies." );`
	`82`	`+ }`
`80`	`83`	`}`
`81`	`84`	`echo();`
`82`	`85`	`}`