Merge pull request Leaflet#4455 from Leaflet/build-version

perliedman · perliedman · commit f3586fdbfc1b · 2016-04-19T12:48:07.000+02:00
Build scripts: stop using magic-string and use git rev as semver metadata
diff --git a/Jakefile.js b/Jakefile.js
@@ -14,7 +14,7 @@ For a custom build, open build/build.html in the browser and follow the instruct
 
 var build = require('./build/build.js'),
     buildDocs = require('./build/docs'),
-    version = require('./src/Leaflet.js').version;
+    git = require('git-rev');
 
 function hint(msg, args) {
 	return function () {
@@ -27,23 +27,31 @@ function hint(msg, args) {
 	};
 }
 
+// Returns the version string in package.json, plus a semver build metadata if
+// this is not an official release
+function calculateVersion(officialRelease, callback) {
+
+	var version = require('./package.json').version;
+
+	if (officialRelease) {
+		callback(version);
+	} else {
+		git.short(function(str) {
+			callback (version + '+' + str);
+		});
+	}
+}
+
 desc('Check Leaflet source for errors with ESLint');
 task('lint', {async: true}, hint('Checking for JS errors...', 'src --config .eslintrc'));
 
 desc('Check Leaflet specs source for errors with ESLint');
 task('lintspec', {async: true}, hint('Checking for specs JS errors...', 'spec/suites --config spec/.eslintrc'));
 
 desc('Combine and compress Leaflet source files');
-task('build', {async: true}, function (compsBase32, buildName) {
-	var v;
-
-	jake.exec('git log -1 --pretty=format:"%h"', {breakOnError: false}, function () {
+task('build', {async: true}, function (compsBase32, buildName, officialRelease) {
+	calculateVersion(officialRelease, function(v){
 		build.build(complete, v, compsBase32, buildName);
-
-	}).on('stdout', function (data) {
-		v = version + ' (' + data.toString() + ')';
-	}).on('error', function () {
-		v = version;
 	});
 });
 
diff --git a/build/build.js b/build/build.js
@@ -1,7 +1,7 @@
 var fs = require('fs'),
     UglifyJS = require('uglify-js'),
     zlib = require('zlib'),
-    MagicString = require('magic-string'),
+    SourceNode = require( 'source-map' ).SourceNode;
 
     deps = require('./deps.js').deps;
 
@@ -70,21 +70,44 @@ function loadSilently(path) {
 	}
 }
 
-function bundleFiles(files, copy) {
-	var bundle = new MagicString.Bundle();
+// Concatenate the files while building up a sourcemap for the concatenation,
+// and replace the line defining L.version with the string prepared in the jakefile
+function bundleFiles(files, copy, version) {
+	var node = new SourceNode(null, null, null, '');
+
+	node.add(new SourceNode(null, null, null, copy + '(function (window, document, undefined) {'));
 
 	for (var i = 0, len = files.length; i < len; i++) {
-		bundle.addSource({
-			filename: files[i],
-			content: new MagicString( fs.readFileSync(files[i], 'utf8') + '\n\n' )
-		});
+		var contents = fs.readFileSync(files[i], 'utf8');
+
+		if (files[i] === 'src/Leaflet.js') {
+			contents = contents.replace(
+				new RegExp('version: \'.*\''),
+				'version: ' + JSON.stringify(version)
+			);
+		}
+
+		var lines = contents.split('\n');
+		var lineCount = lines.length;
+		var fileNode = new SourceNode(null, null, null, '');
+
+		fileNode.setSourceContent(files[i], contents);
+
+		for (var j=0; j<lineCount; j++) {
+			fileNode.add(new SourceNode(j+1, 0, files[i], lines[j] + '\n'));
+		}
+		node.add(fileNode);
+
+		node.add(new SourceNode(null, null, null, '\n\n'));
 	}
 
-	bundle.prepend(
-		copy + '(function (window, document, undefined) {'
-	).append('}(window, document));');
+	node.add(new SourceNode(null, null, null, '}(window, document));'));
 
-	return bundle;
+	var bundle = node.toStringWithSourceMap();
+	return {
+		src: bundle.code,
+		srcmap: bundle.map.toString()
+	};
 }
 
 function bytesToKB(bytes) {
@@ -106,8 +129,8 @@ exports.build = function (callback, version, compsBase32, buildName) {
 	    srcFilename = filenamePart + '-src.js',
 	    mapFilename = filenamePart + '-src.map',
 
-	    bundle = bundleFiles(files, copy),
-	    newSrc = bundle.toString() + '\n//# sourceMappingURL=' + mapFilename,
+	    bundle = bundleFiles(files, copy, version),
+	    newSrc = bundle.src + '\n//# sourceMappingURL=' + mapFilename,
 
 	    oldSrc = loadSilently(srcPath),
 	    srcDelta = getSizeDelta(newSrc, oldSrc, true);
@@ -116,11 +139,7 @@ exports.build = function (callback, version, compsBase32, buildName) {
 
 	if (newSrc !== oldSrc) {
 		fs.writeFileSync(srcPath, newSrc);
-		fs.writeFileSync(mapPath, bundle.generateMap({
-			file: srcFilename,
-			includeContent: true,
-			hires: false
-		}));
+		fs.writeFileSync(mapPath, bundle.srcmap);
 		console.log('\tSaved to ' + srcPath);
 	}
 
diff --git a/build/publish.sh b/build/publish.sh
@@ -8,7 +8,7 @@ npm test || exit 1
 
 git checkout -b build
 
-npm run build
+jake build[,,true]
 git add dist/leaflet-src.js dist/leaflet.js dist/leaflet-src.map -f
 
 git commit -m "v$VERSION"
diff --git a/package.json b/package.json
@@ -5,6 +5,7 @@
   "devDependencies": {
     "eslint": "^2.8.0",
     "eslint-config-mourner": "^2.0.1",
+    "git-rev": "^0.2.1",
     "happen": "~0.3.1",
     "jake": "~8.0.12",
     "karma": "~0.13.22",
@@ -15,10 +16,10 @@
     "karma-phantomjs-launcher": "^1.0.0",
     "karma-safari-launcher": "~0.1.1",
     "leafdoc": "^1.2.1",
-    "magic-string": "^0.11.4",
     "mocha": "~2.4.5",
     "phantomjs-prebuilt": "^2.1.7",
     "prosthetic-hand": "^1.3.0",
+    "source-map": "^0.5.3",
     "uglify-js": "~2.6.2"
   },
   "main": "dist/leaflet-src.js",
diff --git a/src/Leaflet.js b/src/Leaflet.js
@@ -1,6 +1,6 @@
 
 var L = {
-	version: '1.0.0-rc.1'
+	version: 'dev'
 };
 
 function expose() {
