add extra_bundles - handle options in partial_bundle

Author: archmoj

package.json

@@ -21,12 +21,13 @@
     "plotly"
   ],
   "scripts": {
-    "bundle": "node tasks/bundle.js",
     "partial-bundle": "node tasks/partial_bundle.js",
+    "bundle": "node tasks/bundle.js",
+    "extra-bundles": "node tasks/extra_bundles.js",
     "stats": "node tasks/stats.js",
     "find-strings": "node tasks/find_locale_strings.js",
     "preprocess": "node tasks/preprocess.js",
-    "build": "node tasks/empty_dist.js && npm run preprocess && npm run find-strings && npm run bundle && npm run partial-bundle && npm run stats",
+    "build": "node tasks/empty_dist.js && npm run preprocess && npm run find-strings && npm run bundle && npm run extra-bundles && npm run stats",
     "cibuild": "node tasks/empty_dist.js && npm run preprocess && node tasks/cibundle.js",
     "watch": "node tasks/watch.js",
     "lint": "eslint --version && eslint .",

tasks/extra_bundles.js

@@ -0,0 +1,24 @@
+var runSeries = require('run-series');
+
+var partialBundle = require('./partial_bundle');
+var constants = require('./util/constants');
+var partialBundlePaths = constants.partialBundleNames.map(constants.makePartialBundleOpts);
+
+var tasks = [];
+
+// Browserify the plotly.js partial bundles
+for(var i = 0; i < partialBundlePaths.length; i++) {
+    var opts = partialBundlePaths[i];
+
+    partialBundle(tasks, {
+        name: opts.name,
+        index: opts.index,
+        dist: opts.dist,
+        distMin: opts.distMin,
+        traceList: opts.traceList
+    });
+}
+
+runSeries(tasks, function(err) {
+    if(err) throw err;
+});

tasks/no_es6_dist.js

@@ -2,6 +2,8 @@ var eslint = require('eslint');
 var constants = require('./util/constants');
 var EXIT_CODE = 0;
 
+var partialBundlePaths = constants.partialBundleNames.map(constants.makePartialBundleOpts);
+
 assertES5();
 
 // Ensure no ES6 has snuck through into the build:
@@ -17,7 +19,7 @@ function assertES5() {
         }
     });
 
-    var files = constants.partialBundlePaths.map(function(f) { return f.dist; });
+    var files = partialBundlePaths.map(function(f) { return f.dist; });
     files.unshift(constants.pathToPlotlyDist);
 
     var report = cli.executeOnFiles(files);

tasks/partial_bundle.js

@@ -8,16 +8,59 @@ var common = require('./util/common');
 var _bundle = require('./util/browserify_wrapper');
 
 var header = constants.licenseDist + '\n';
-
-var tasks = [];
 var allTraces = fs.readdirSync(path.join(constants.pathToSrc, 'traces'));
 var fullIndex = fs.readFileSync(constants.pathToPlotlyIndex, 'utf-8');
 
+var argv = process.argv;
+
+if(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];
+
+        if(
+            allTraces.indexOf(a) !== -1 && // requested
+            traceList.indexOf(a) === -1    // not added before
+        ) {
+            traceList.push(a);
+        }
+        if(a.indexOf('name=') !== -1) name = a.replace('name=', '');
+    }
+    if(!name) name = 'custom';
+    traceList = traceList.sort();
+
+    var opts = {
+        traceList: traceList,
+        name: name,
+
+        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')
+    };
+
+    console.log(opts);
+
+    var tasks = [];
+
+    partialBundle(tasks, opts);
+
+    runSeries(tasks, function(err) {
+        if(err) throw err;
+    });
+}
+
 // Browserify the plotly.js partial bundles
-constants.partialBundlePaths.forEach(function(pathObj) {
-    tasks.push(function(done) {
-        var traceList = constants.partialBundleTraces[pathObj.name];
+function partialBundle(tasks, opts) {
+    var name = opts.name;
+    var index = opts.index;
+    var dist = opts.dist;
+    var distMin = opts.distMin;
+    var traceList = opts.traceList;
 
+    tasks.push(function(done) {
         var partialIndex = fullIndex;
         allTraces.forEach(function(trace) {
             if(traceList.indexOf(trace) === -1) {
@@ -37,25 +80,23 @@ constants.partialBundlePaths.forEach(function(pathObj) {
             }
         });
 
-        common.writeFile(pathObj.index, partialIndex, done);
+        common.writeFile(index, partialIndex, done);
     });
 
     tasks.push(function(done) {
-        _bundle(pathObj.index, pathObj.dist, {
+        _bundle(index, dist, {
             standalone: 'Plotly',
-            pathToMinBundle: pathObj.distMin
+            pathToMinBundle: distMin
         }, function() {
-            var headerDist = header.replace('plotly.js', 'plotly.js (' + pathObj.name + ')');
-            var headerDistMin = header.replace('plotly.js', 'plotly.js (' + pathObj.name + ' - minified)');
+            var headerDist = header.replace('plotly.js', 'plotly.js (' + name + ')');
+            var headerDistMin = header.replace('plotly.js', 'plotly.js (' + name + ' - minified)');
 
-            prependFile(pathObj.dist, headerDist, common.throwOnError);
-            prependFile(pathObj.distMin, headerDistMin, common.throwOnError);
+            prependFile(dist, headerDist, common.throwOnError);
+            prependFile(distMin, headerDistMin, common.throwOnError);
 
             done();
         });
     });
-});
+}
 
-runSeries(tasks, function(err) {
-    if(err) throw err;
-});
+module.exports = partialBundle;

tasks/stats.js

@@ -19,6 +19,8 @@ var ENC = 'utf-8';
 var JS = '.js';
 var MINJS = '.min.js';
 
+var partialBundlePaths = constants.partialBundleNames.map(constants.makePartialBundleOpts);
+
 // main
 common.writeFile(pathDistREADME, getReadMeContent());
 
@@ -136,7 +138,7 @@ function getMainBundleInfo() {
         '',
         'Starting in `v1.15.0`, plotly.js also ships with several _partial_ bundles:',
         '',
-        constants.partialBundlePaths.map(makeBundleHeaderInfo).join('\n'),
+        partialBundlePaths.map(makeBundleHeaderInfo).join('\n'),
         '',
         'Starting in `v1.39.0`, each plotly.js partial bundle has a corresponding npm package with no dependencies.',
         '',
@@ -151,7 +153,7 @@ function getMainBundleInfo() {
 
 // info about partial bundles
 function getPartialBundleInfo() {
-    return constants.partialBundlePaths.map(makeBundleInfo);
+    return partialBundlePaths.map(makeBundleInfo);
 }
 
 // footer info
@@ -172,7 +174,7 @@ function makeBundleHeaderInfo(pathObj) {
 function makeBundleInfo(pathObj) {
     var name = pathObj.name;
     var sizes = findSizes(pathObj);
-    var traceList = constants.partialBundleTraces[pathObj.name];
+    var traceList = pathObj.traceList;
     var pkgName = 'plotly.js-' + name + '-dist';
 
     return [

tasks/sync_packages.js

@@ -23,8 +23,10 @@ var copyrightAndLicense = [
     ''
 ].join('\n');
 
+var partialBundlePaths = constants.partialBundleNames.map(constants.makePartialBundleOpts);
+
 // sync "partial bundle" packages
-constants.partialBundlePaths
+partialBundlePaths
     .map(function(d) {
         return {
             name: 'plotly.js-' + d.name + '-dist',
@@ -44,7 +46,7 @@ constants.partialBundlePaths
     .forEach(syncPartialBundlePkg);
 
 // sync "minified partial bundle" packages
-constants.partialBundlePaths
+partialBundlePaths
     .map(function(d) {
         return {
             name: 'plotly.js-' + d.name + '-dist-min',
@@ -103,7 +105,7 @@ function syncPartialBundlePkg(d) {
 
 
     function writeREADME(cb) {
-        var traceList = constants.partialBundleTraces[d.name];
+        var traceList = d.traceList;
 
         var cnt = [
             '# ' + d.name,

tasks/util/constants.js

@@ -131,18 +131,21 @@ var partialBundleTraces = {
     ]
 };
 
-var partialBundlePaths = partialBundleNames.map(function(name) {
+function makePartialBundleOpts(name) {
     return {
         name: name,
+        traceList: partialBundleTraces[name],
         index: path.join(pathToBuild, 'index-' + name + '.js'),
         dist: path.join(pathToDist, 'plotly-' + name + '.js'),
         distMin: path.join(pathToDist, 'plotly-' + name + '.min.js')
     };
-});
+}
 
 var year = (new Date()).getFullYear();
 
 module.exports = {
+    makePartialBundleOpts: makePartialBundleOpts,
+
     pathToRoot: pathToRoot,
     pathToSrc: pathToSrc,
     pathToLib: pathToLib,
@@ -162,9 +165,7 @@ module.exports = {
     pathToSchema: path.join(pathToDist, 'plot-schema.json'),
     pathToTranslationKeys: path.join(pathToDist, 'translation-keys.txt'),
 
-    partialBundleTraces: partialBundleTraces,
     partialBundleNames: partialBundleNames,
-    partialBundlePaths: partialBundlePaths,
 
     pathToTopojsonSrc: pathToTopojsonSrc,
     pathToTopojsonDist: path.join(pathToDist, 'topojson/'),