add append version util, use it to add version in bundles

Author: etpinard

tasks/bundle.js

@@ -4,6 +4,7 @@ var browserify = require('browserify');
 var UglifyJS = require('uglify-js');
 
 var compressAttributes = require('./util/compress_attributes');
+var appendVersion = require('./util/append_version');
 var constants = require('./util/constants');
 
 /*
@@ -24,7 +25,10 @@ try {
     fs.statSync(constants.pathToFontSVGBuild).isFile();
 }
 catch(e) {
-    throw new Error('Please run `npm run preprocess` first');
+    throw new Error([
+        'build/ is missing a or more files',
+        'Please run `npm run preprocess` first'
+    ].join('\n'));
 }
 
 
@@ -41,30 +45,43 @@ browserify(constants.pathToPlotlySrc, {
     if(!DEV) {
         fs.writeFile(
             constants.pathToPlotlyDistMin,
-            UglifyJS.minify(buf.toString(), constants.uglifyOptions).code
+            UglifyJS.minify(buf.toString(), constants.uglifyOptions).code,
+            function() {
+                appendVersion(
+                    constants.pathToPlotlyDistMin, {object: 'Plotly'}
+                );
+            }
         );
     }
 })
-.pipe(fs.createWriteStream(constants.pathToPlotlyDist));
+.pipe(fs.createWriteStream(constants.pathToPlotlyDist))
+.on('finish', function() {
+    appendVersion(constants.pathToPlotlyDist, {object: 'Plotly', DEV: DEV});
+});
 
 
 // Browserify the geo assets
 browserify(constants.pathToPlotlyGeoAssetsSrc, {
     standalone: 'PlotlyGeoAssets'
 })
-.bundle(function(err, buf) {
+.bundle(function(err) {
     if(err) throw err;
 })
-.pipe(fs.createWriteStream(constants.pathToPlotlyGeoAssetsDist));
-
+.pipe(fs.createWriteStream(constants.pathToPlotlyGeoAssetsDist))
+.on('finish', function() {
+    appendVersion(constants.pathToPlotlyGeoAssetsDist, {object: 'PlotlyGeoAssets'});
+});
 
 
 // Browserify the plotly.js with meta
 browserify(constants.pathToPlotlySrc, {
     debug: DEV,
     standalone: 'Plotly'
 })
-.bundle(function(err, buf) {
+.bundle(function(err) {
     if(err) throw err;
 })
-.pipe(fs.createWriteStream(constants.pathToPlotlyDistWithMeta));
+.pipe(fs.createWriteStream(constants.pathToPlotlyDistWithMeta))
+.on('finish', function() {
+    appendVersion(constants.pathToPlotlyDistWithMeta, {object: 'Plotly', DEV: DEV});
+});

tasks/util/append_version.js

@@ -0,0 +1,24 @@
+var fs = require('fs');
+
+var pkg = require('../../package.json');
+
+/**
+ * Append package version to bundle
+ *
+ * @param {string} path path to bundle
+ * @param {object} opts
+ *   - object {string} the standalone object in the bundle
+ *   - DEV {boolean} is this a DEV build?
+ */
+module.exports = function appendVersion(path, opts) {
+    var txt = [
+        opts.object,
+        '.version=', '\'',
+        pkg.version, opts.DEV ? '-dev' : '',
+        '\'', ';'
+    ].join('');
+
+    fs.appendFile(path, txt, function(err) {
+        if(err) throw err;
+    }) ;
+};

tasks/util/make_watchified_bundle.js

@@ -4,6 +4,7 @@ var browserify = require('browserify');
 var watchify = require('watchify');
 
 var compressAttributes = require('./compress_attributes');
+var appendVersion = require('./append_version');
 var formatBundleMsg = require('./format_bundle_msg');
 var constants = require('./constants');
 
@@ -47,7 +48,10 @@ module.exports = function makeWatchifiedBundle(onFirstBundleCallback) {
         })
         .pipe(
             fs.createWriteStream(constants.pathToPlotlyDist)
-        );
+        )
+        .on('finish', function() {
+            appendVersion(constants.pathToPlotlyDist, {object: 'Plotly', DEV: true});
+        });
     }
 
     return bundle;