Merge pull request #740 from plotly/partial-bundles

Introducing partial dist bundles

Author: etpinard

.npmignore

@@ -1,12 +1,11 @@
 build/*
-
 !build/plotcss.js
 !build/ploticon.js
 !build/README.md
 
 devtools
 test
-dist/extras/mathjax
+dist/extras
 
 circle.yml
 docker-compose.yml

lib/index-basic.js

@@ -0,0 +1,18 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var Plotly = require('./core');
+
+Plotly.register([
+    require('./bar'),
+    require('./pie')
+]);
+
+module.exports = Plotly;

lib/index-cartesian.js

@@ -0,0 +1,25 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var Plotly = require('./core');
+
+Plotly.register([
+    require('./bar'),
+    require('./box'),
+    require('./heatmap'),
+    require('./histogram'),
+    require('./histogram2d'),
+    require('./histogram2dcontour'),
+    require('./pie'),
+    require('./contour'),
+    require('./scatterternary')
+]);
+
+module.exports = Plotly;

lib/index-geo.js

@@ -0,0 +1,18 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var Plotly = require('./core');
+
+Plotly.register([
+    require('./scattergeo'),
+    require('./choropleth')
+]);
+
+module.exports = Plotly;

lib/index-gl2d.js

@@ -0,0 +1,19 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var Plotly = require('./core');
+
+Plotly.register([
+    require('./scattergl'),
+    require('./heatmapgl'),
+    require('./contourgl')
+]);
+
+module.exports = Plotly;

lib/index-gl3d.js

@@ -0,0 +1,19 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var Plotly = require('./core');
+
+Plotly.register([
+    require('./scatter3d'),
+    require('./surface'),
+    require('./mesh3d')
+]);
+
+module.exports = Plotly;

lib/index-mapbox.js

@@ -0,0 +1,17 @@
+/**
+* Copyright 2012-2016, Plotly, Inc.
+* All rights reserved.
+*
+* This source code is licensed under the MIT license found in the
+* LICENSE file in the root directory of this source tree.
+*/
+
+'use strict';
+
+var Plotly = require('./core');
+
+Plotly.register([
+    require('./scattermapbox')
+]);
+
+module.exports = Plotly;

lib/index.js

@@ -8,14 +8,9 @@
 
 'use strict';
 
-/*
- * This file is browserify'ed into a standalone 'Plotly' object.
- */
+var Plotly = require('./core');
 
-var Core = require('./core');
-
-// Load all trace modules
-Core.register([
+Plotly.register([
     require('./bar'),
     require('./box'),
     require('./heatmap'),
@@ -33,4 +28,4 @@ Core.register([
     require('./scatterternary')
 ]);
 
-module.exports = Core;
+module.exports = Plotly;

package.json

@@ -24,7 +24,8 @@
     "preprocess": "node tasks/preprocess.js",
     "bundle": "node tasks/bundle.js",
     "header": "node tasks/header.js",
-    "build": "npm run preprocess && npm run bundle && npm run header",
+    "stats": "node tasks/stats.js",
+    "build": "npm run preprocess && npm run bundle && npm run header && npm run stats",
     "cibuild": "npm run preprocess && node tasks/cibundle.js",
     "watch": "node tasks/watch_plotly.js",
     "lint": "eslint . || true",
@@ -95,6 +96,7 @@
     "fs-extra": "^0.30.0",
     "fuse.js": "^2.2.0",
     "glob": "^7.0.0",
+    "gzip-size": "^3.0.0",
     "jasmine-core": "^2.4.1",
     "karma": "^1.1.0",
     "karma-browserify": "^5.0.1",

tasks/bundle.js

@@ -1,4 +1,5 @@
 var fs = require('fs');
+var path = require('path');
 
 var browserify = require('browserify');
 var UglifyJS = require('uglify-js');
@@ -28,48 +29,76 @@ try {
 }
 catch(e) {
     throw new Error([
-        'build/ is missing a or more files',
+        'build/ is missing one or more files',
         'Please run `npm run preprocess` first'
     ].join('\n'));
 }
 
 
 // Browserify plotly.js
-browserify(constants.pathToPlotlyIndex, {
-    debug: DEV,
+_bundle(constants.pathToPlotlyIndex, constants.pathToPlotlyDist, {
     standalone: 'Plotly',
-    transform: [compressAttributes]
-})
-.bundle(function(err, buf) {
-    if(err) throw err;
-
-    // generate plotly.min.js
-    if(!DEV) {
-        fs.writeFile(
-            constants.pathToPlotlyDistMin,
-            UglifyJS.minify(buf.toString(), constants.uglifyOptions).code
-        );
-    }
-})
-.pipe(fs.createWriteStream(constants.pathToPlotlyDist));
-
+    debug: DEV,
+    pathToMinBundle: constants.pathToPlotlyDistMin
+});
 
 // Browserify the geo assets
-browserify(constants.pathToPlotlyGeoAssetsSrc, {
+_bundle(constants.pathToPlotlyGeoAssetsSrc, constants.pathToPlotlyGeoAssetsDist, {
     standalone: 'PlotlyGeoAssets'
-})
-.bundle(function(err) {
-    if(err) throw err;
-})
-.pipe(fs.createWriteStream(constants.pathToPlotlyGeoAssetsDist));
-
+});
 
 // Browserify the plotly.js with meta
-browserify(constants.pathToPlotlyIndex, {
-    debug: DEV,
-    standalone: 'Plotly'
-})
-.bundle(function(err) {
-    if(err) throw err;
-})
-.pipe(fs.createWriteStream(constants.pathToPlotlyDistWithMeta));
+_bundle(constants.pathToPlotlyIndex, constants.pathToPlotlyDistWithMeta, {
+    standalone: 'Plotly',
+    debug: DEV
+});
+
+// Browserify the plotly.js partial bundles
+constants.partialBundlePaths.forEach(function(pathObj) {
+    _bundle(pathObj.index, pathObj.dist, {
+        standalone: 'Plotly',
+        debug: DEV,
+        pathToMinBundle: pathObj.distMin
+    });
+});
+
+function _bundle(pathToIndex, pathToBundle, opts) {
+    opts = opts || {};
+
+    // do we output a minified file?
+    var pathToMinBundle = opts.pathToMinBundle,
+        outputMinified = !!pathToMinBundle && !opts.debug;
+
+    var browserifyOpts = {};
+    browserifyOpts.standalone = opts.standalone;
+    browserifyOpts.debug = opts.debug;
+    browserifyOpts.transform = outputMinified ? [compressAttributes] : [];
+
+    var b = browserify(pathToIndex, browserifyOpts),
+        bundleWriteStream = fs.createWriteStream(pathToBundle);
+
+    bundleWriteStream.on('finish', function() {
+        logger(pathToBundle);
+    });
+
+    b.bundle(function(err, buf) {
+        if(err) throw err;
+
+        if(outputMinified) {
+            var minifiedCode = UglifyJS.minify(buf.toString(), constants.uglifyOptions).code;
+
+            fs.writeFile(pathToMinBundle, minifiedCode, function(err) {
+                if(err) throw err;
+
+                logger(pathToMinBundle);
+            });
+        }
+    })
+    .pipe(bundleWriteStream);
+}
+
+function logger(pathToOutput) {
+    var log = 'ok ' + path.basename(pathToOutput);
+
+    console.log(log);
+}