Custom bundle script details

tasks/partial_bundle.js

@@ -1,4 +1,5 @@
 var path = require('path');
+var minimist = require('minimist');
 var runSeries = require('run-series');
 var prependFile = require('prepend-file');
 
@@ -7,39 +8,97 @@ var common = require('./util/common');
 var _bundle = require('./util/browserify_wrapper');
 
 var header = constants.licenseDist + '\n';
+var allTransforms = constants.allTransforms;
 var allTraces = constants.allTraces;
 var mainIndex = constants.mainIndex;
 
-var argv = process.argv;
+function isFalse(a) {
+    return (
+        a === 'none' ||
+        a === 'false'
+    );
+}
+
+function inputBoolean(a, dflt) {
+    return !a ? dflt : !isFalse(a);
+}
+
+function inputArray(a, dflt) {
+    dflt = dflt.slice();
+
+    return (
+        isFalse(a) ? [] :
+            !a || a === 'all' ? dflt :
+                a.split(',')
+    );
+}
 
-if(argv.length > 2) {
+if(process.argv.length > 2) {
     // command line
 
-    var traceList = ['scatter']; // added by default
-    var name;
-    for(var i = 2; i < argv.length; i++) {
-        var a = argv[i];
+    var args = minimist(process.argv.slice(2), {});
+
+    // parse arguments
+    var out = args.out ? args.out : 'custom';
+    var traces = inputArray(args.traces, allTraces);
+    var transforms = inputArray(args.transforms, allTransforms);
+    var calendars = inputBoolean(args.calendars, true);
+    var keepindex = inputBoolean(args.keepindex, false);
+    var sourcemaps = inputBoolean(args.sourcemaps, false);
+    var unminified = inputBoolean(args.unminified, false);
+
+    var i, t;
 
+    var traceList = ['scatter']; // added by default
+    for(i = 0; i < traces.length; i++) {
+        t = traces[i];
         if(
-            allTraces.indexOf(a) !== -1 && // requested
-            traceList.indexOf(a) === -1    // not added before
+            traceList.indexOf(t) === -1 // not added before
         ) {
-            traceList.push(a);
+            if(allTraces.indexOf(t) === -1) {
+                console.error(t, 'is not a valid trace!', 'Valid traces are:', allTraces);
+            } else {
+                traceList.push(t);
+            }
         }
-        if(a.indexOf('--name=') === 0) name = a.replace('--name=', '');
     }
-    if(!name) name = 'custom';
     traceList = traceList.sort();
 
+    var transformList = [];
+    for(i = 0; i < transforms.length; i++) {
+        t = transforms[i];
+        if(
+            transformList.indexOf(t) === -1 // not added before
+        ) {
+            if(allTransforms.indexOf(t) === -1) {
+                console.error(t, 'is not a valid transform!', 'Valid transforms are:', allTransforms);
+            } else {
+                transformList.push(t);
+            }
+        }
+    }
+    transformList = transformList.sort();
+
     var opts = {
         traceList: traceList,
-        name: name,
+        transformList: transformList,
+        calendars: calendars,
+        sourcemaps: sourcemaps,
 
-        index: path.join(constants.pathToBuild, 'index-' + name + '.js'),
-        dist: path.join(constants.pathToDist, 'plotly-' + name + '.js'),
-        distMin: path.join(constants.pathToDist, 'plotly-' + name + '.min.js')
+        name: out,
+        index: path.join(constants.pathToLib, 'index-' + out + '.js')
     };
 
+    if(unminified) {
+        opts.dist = path.join(constants.pathToDist, 'plotly-' + out + '.js');
+    } else {
+        opts.distMin = path.join(constants.pathToDist, 'plotly-' + out + '.min.js');
+    }
+
+    if(!keepindex) {
+        opts.deleteIndex = true;
+    }
+
     console.log(opts);
 
     var tasks = [];
@@ -58,40 +117,55 @@ function partialBundle(tasks, opts) {
     var dist = opts.dist;
     var distMin = opts.distMin;
     var traceList = opts.traceList;
+    var transformList = opts.transformList;
+    var calendars = opts.calendars;
+    var sourcemaps = opts.sourcemaps;
+    var deleteIndex = opts.deleteIndex;
 
     tasks.push(function(done) {
         var partialIndex = mainIndex;
-        allTraces.forEach(function(trace) {
-            if(traceList.indexOf(trace) === -1) {
-                var WHITESPACE_BEFORE = '\\s*';
-                // remove require
-                var newCode = partialIndex.replace(
-                    new RegExp(
-                        WHITESPACE_BEFORE +
-                        'require\\(\'\\./' + trace + '\'\\),',
-                    'g'), ''
-                );
-
-                // test removal
-                if(newCode === partialIndex) throw 'Unable to find and drop require for trace: "' + trace + '"';
-
-                partialIndex = newCode;
+
+        var all = ['calendars'].concat(allTransforms).concat(allTraces);
+        var includes = (calendars ? ['calendars'] : []).concat(transformList).concat(traceList);
+        var excludes = all.filter(function(e) { return includes.indexOf(e) === -1; });
+
+        excludes.forEach(function(t) {
+            var WHITESPACE_BEFORE = '\\s*';
+            // remove require
+            var newCode = partialIndex.replace(
+                new RegExp(
+                    WHITESPACE_BEFORE +
+                    'require\\(\'\\./' + t + '\'\\)' +
+                    (t === 'calendars' ? '' : ','), // there is no comma after calendars require
+                'g'), ''
+            );
+
+            // test removal
+            if(newCode === partialIndex) {
+                console.error('Unable to find and drop require for ' + t);
+                throw 'Error generating index for partial bundle!';
             }
+
+            partialIndex = newCode;
         });
 
         common.writeFile(index, partialIndex, done);
     });
 
     tasks.push(function(done) {
-        _bundle(index, dist, {
+        var bundleOpts = {
+            debug: sourcemaps,
+            deleteIndex: deleteIndex,
             standalone: 'Plotly',
             pathToMinBundle: distMin
-        }, function() {
+        };
+
+        _bundle(index, dist, bundleOpts, function() {
             var headerDist = header.replace('plotly.js', 'plotly.js (' + name + ')');
             var headerDistMin = header.replace('plotly.js', 'plotly.js (' + name + ' - minified)');
 
-            prependFile(dist, headerDist, common.throwOnError);
-            prependFile(distMin, headerDistMin, common.throwOnError);
+            if(dist) prependFile(dist, headerDist, common.throwOnError);
+            if(distMin) prependFile(distMin, headerDistMin, common.throwOnError);
 
             done();
         });

tasks/util/browserify_wrapper.js

@@ -47,10 +47,17 @@ module.exports = function _bundle(pathToIndex, pathToBundle, opts, cb) {
     }
 
     var b = browserify(pathToIndex, browserifyOpts);
-    var pending = pathToMinBundle ? 2 : 1;
+    var pending = (pathToMinBundle && pathToBundle) ? 2 : 1;
 
     function done() {
-        if(cb && --pending === 0) cb(null);
+        if(cb && --pending === 0) {
+            if(opts.deleteIndex) {
+                console.log('delete', pathToIndex);
+                fs.unlinkSync(pathToIndex, {});
+            }
+
+            cb(null);
+        }
     }
 
     var bundleStream = b.bundle(function(err) {
@@ -71,13 +78,15 @@ module.exports = function _bundle(pathToIndex, pathToBundle, opts, cb) {
             });
     }
 
-    bundleStream
-        .pipe(applyDerequire())
-        .pipe(fs.createWriteStream(pathToBundle))
-        .on('finish', function() {
-            logger(pathToBundle);
-            done();
-        });
+    if(pathToBundle) {
+        bundleStream
+            .pipe(applyDerequire())
+            .pipe(fs.createWriteStream(pathToBundle))
+            .on('finish', function() {
+                logger(pathToBundle);
+                done();
+            });
+    }
 };
 
 function logger(pathToOutput) {

tasks/util/constants.js

@@ -12,8 +12,10 @@ var pathToBuild = path.join(pathToRoot, 'build/');
 
 var pathToPlotlyIndex = path.join(pathToLib, 'index.js');
 var mainIndex = fs.readFileSync(pathToPlotlyIndex, 'utf-8');
-var pathToPlotlyTraces = path.join(pathToSrc, 'traces');
-var allTraces = fs.readdirSync(pathToPlotlyTraces);
+var allTraces = fs.readdirSync(path.join(pathToSrc, 'traces'));
+var allTransforms = fs.readdirSync(path.join(pathToSrc, 'transforms'))
+    .map(function(e) { return e.replace('.js', ''); });
+allTransforms.splice(allTransforms.indexOf('helpers'), 1);
 
 var pathToTopojsonSrc;
 try {
@@ -140,6 +142,8 @@ function makePartialBundleOpts(name) {
     return {
         name: name,
         traceList: partialBundleTraces[name],
+        transformList: allTransforms,
+        calendars: true,
         index: path.join(pathToLib, 'index-' + name + '.js'),
         dist: path.join(pathToDist, 'plotly-' + name + '.js'),
         distMin: path.join(pathToDist, 'plotly-' + name + '.min.js')
@@ -157,10 +161,10 @@ module.exports = {
     pathToBuild: pathToBuild,
     pathToDist: pathToDist,
 
+    allTransforms: allTransforms,
     allTraces: allTraces,
     mainIndex: mainIndex,
     pathToPlotlyIndex: pathToPlotlyIndex,
-    pathToPlotlyTraces: pathToPlotlyTraces,
     pathToPlotlyCore: path.join(pathToSrc, 'core.js'),
     pathToPlotlyVersion: path.join(pathToSrc, 'version.js'),
     pathToPlotlyBuild: path.join(pathToBuild, 'plotly.js'),