Merge pull request #5508 from plotly/improve-mk-bundles

Revise process of making bundles and  simplify making partial bundles

Author: archmoj

README.md

@@ -96,13 +96,9 @@ Then elsewhere in your code:
 var Plotly = require('./path/to/custom-plotly');
 ```
 
-#### Non-ascii characters
+Alternatively you could browserify a custom bundle of desired trace modules e.g. `pie` and `choropleth` using
+`npm run partial-bundle pie choropleth --name=custom`
 
-Important: the plotly.js code base contains some non-ascii characters. Therefore, please make sure to set the `charset` attribute to `"utf-8"` in the script tag that imports your plotly.js bundle. For example:
-
-```html
-<script src="my-plotly-bundle.js" charset="utf-8"></script>
-```
 
 ## Building plotly.js
 

lib/index-basic.js

@@ -3,8 +3,18 @@
 var Plotly = require('./core');
 
 Plotly.register([
+    // traces
     require('./bar'),
-    require('./pie')
+    require('./pie'),
+
+    // transforms
+    require('./aggregate'),
+    require('./filter'),
+    require('./groupby'),
+    require('./sort'),
+
+    // components
+    require('./calendars')
 ]);
 
-module.exports = require('./register_extra')(Plotly);
+module.exports = Plotly;

lib/index-cartesian.js

@@ -3,17 +3,27 @@
 var Plotly = require('./core');
 
 Plotly.register([
+    // traces
     require('./bar'),
     require('./box'),
     require('./heatmap'),
     require('./histogram'),
     require('./histogram2d'),
     require('./histogram2dcontour'),
-    require('./image'),
-    require('./pie'),
     require('./contour'),
     require('./scatterternary'),
-    require('./violin')
+    require('./violin'),
+    require('./image'),
+    require('./pie'),
+
+    // transforms
+    require('./aggregate'),
+    require('./filter'),
+    require('./groupby'),
+    require('./sort'),
+
+    // components
+    require('./calendars')
 ]);
 
-module.exports = require('./register_extra')(Plotly);
+module.exports = Plotly;

lib/index-finance.js

@@ -3,15 +3,25 @@
 var Plotly = require('./core');
 
 Plotly.register([
+    // traces
     require('./bar'),
     require('./histogram'),
+    require('./funnel'),
+    require('./waterfall'),
     require('./pie'),
     require('./funnelarea'),
+    require('./indicator'),
     require('./ohlc'),
     require('./candlestick'),
-    require('./funnel'),
-    require('./waterfall'),
-    require('./indicator')
+
+    // transforms
+    require('./aggregate'),
+    require('./filter'),
+    require('./groupby'),
+    require('./sort'),
+
+    // components
+    require('./calendars')
 ]);
 
-module.exports = require('./register_extra')(Plotly);
+module.exports = Plotly;

lib/index-geo.js

@@ -3,8 +3,18 @@
 var Plotly = require('./core');
 
 Plotly.register([
+    // traces
     require('./scattergeo'),
-    require('./choropleth')
+    require('./choropleth'),
+
+    // transforms
+    require('./aggregate'),
+    require('./filter'),
+    require('./groupby'),
+    require('./sort'),
+
+    // components
+    require('./calendars')
 ]);
 
-module.exports = require('./register_extra')(Plotly);
+module.exports = Plotly;

lib/index-gl2d.js

@@ -3,11 +3,21 @@
 var Plotly = require('./core');
 
 Plotly.register([
+    // traces
     require('./scattergl'),
     require('./splom'),
     require('./pointcloud'),
     require('./heatmapgl'),
-    require('./parcoords')
+    require('./parcoords'),
+
+    // transforms
+    require('./aggregate'),
+    require('./filter'),
+    require('./groupby'),
+    require('./sort'),
+
+    // components
+    require('./calendars')
 ]);
 
-module.exports = require('./register_extra')(Plotly);
+module.exports = Plotly;

lib/index-gl3d.js

@@ -3,13 +3,23 @@
 var Plotly = require('./core');
 
 Plotly.register([
+    // traces
     require('./scatter3d'),
     require('./surface'),
-    require('./mesh3d'),
     require('./isosurface'),
     require('./volume'),
+    require('./mesh3d'),
     require('./cone'),
-    require('./streamtube')
+    require('./streamtube'),
+
+    // transforms
+    require('./aggregate'),
+    require('./filter'),
+    require('./groupby'),
+    require('./sort'),
+
+    // components
+    require('./calendars')
 ]);
 
-module.exports = require('./register_extra')(Plotly);
+module.exports = Plotly;

lib/index-mapbox.js

@@ -3,9 +3,19 @@
 var Plotly = require('./core');
 
 Plotly.register([
+    // traces
     require('./scattermapbox'),
     require('./choroplethmapbox'),
-    require('./densitymapbox')
+    require('./densitymapbox'),
+
+    // transforms
+    require('./aggregate'),
+    require('./filter'),
+    require('./groupby'),
+    require('./sort'),
+
+    // components
+    require('./calendars')
 ]);
 
-module.exports = require('./register_extra')(Plotly);
+module.exports = Plotly;

lib/index-strict.js

@@ -2,8 +2,8 @@
 
 var Plotly = require('./core');
 
-// traces
 Plotly.register([
+    // traces
     require('./bar'),
     require('./box'),
     require('./heatmap'),
@@ -16,40 +16,39 @@ Plotly.register([
     require('./funnel'),
     require('./waterfall'),
     require('./image'),
-
     require('./pie'),
     require('./sunburst'),
     require('./treemap'),
     require('./funnelarea'),
-
     require('./scattergeo'),
     require('./choropleth'),
-
     require('./scattergl'),
     require('./splom'),
-
     require('./parcoords'),
     require('./parcats'),
-
     require('./scattermapbox'),
     require('./choroplethmapbox'),
     require('./densitymapbox'),
-
     require('./sankey'),
     require('./indicator'),
-
     require('./table'),
-
     require('./carpet'),
     require('./scattercarpet'),
     require('./contourcarpet'),
-
     require('./ohlc'),
     require('./candlestick'),
-
     require('./scatterpolar'),
     require('./scatterpolargl'),
-    require('./barpolar')
+    require('./barpolar'),
+
+    // transforms
+    require('./aggregate'),
+    require('./filter'),
+    require('./groupby'),
+    require('./sort'),
+
+    // components
+    require('./calendars')
 ]);
 
-module.exports = require('./register_extra')(Plotly);
+module.exports = Plotly;

lib/index.js

@@ -2,8 +2,8 @@
 
 var Plotly = require('./core');
 
-// traces
 Plotly.register([
+    // traces
     require('./bar'),
     require('./box'),
     require('./heatmap'),
@@ -16,52 +16,48 @@ Plotly.register([
     require('./funnel'),
     require('./waterfall'),
     require('./image'),
-
     require('./pie'),
     require('./sunburst'),
     require('./treemap'),
     require('./funnelarea'),
-
     require('./scatter3d'),
     require('./surface'),
     require('./isosurface'),
     require('./volume'),
     require('./mesh3d'),
     require('./cone'),
     require('./streamtube'),
-
     require('./scattergeo'),
     require('./choropleth'),
-
     require('./scattergl'),
     require('./splom'),
-
     require('./pointcloud'),
     require('./heatmapgl'),
-
     require('./parcoords'),
-
     require('./parcats'),
-
     require('./scattermapbox'),
     require('./choroplethmapbox'),
     require('./densitymapbox'),
-
     require('./sankey'),
     require('./indicator'),
-
     require('./table'),
-
     require('./carpet'),
     require('./scattercarpet'),
     require('./contourcarpet'),
-
     require('./ohlc'),
     require('./candlestick'),
-
     require('./scatterpolar'),
     require('./scatterpolargl'),
-    require('./barpolar')
+    require('./barpolar'),
+
+    // transforms
+    require('./aggregate'),
+    require('./filter'),
+    require('./groupby'),
+    require('./sort'),
+
+    // components
+    require('./calendars')
 ]);
 
-module.exports = require('./register_extra')(Plotly);
+module.exports = Plotly;

lib/register_extra.js

@@ -21,12 +21,13 @@
     "plotly"
   ],
   "scripts": {
+    "partial-bundle": "node tasks/partial_bundle.js",
     "bundle": "node tasks/bundle.js",
-    "header-dist": "node tasks/header_dist.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 header-dist && 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 .",
@@ -51,7 +52,7 @@
     "baseline": "node tasks/baseline.js",
     "noci-baseline": "npm run cibuild && ./tasks/noci_test.sh image && git checkout dist && echo 'Please do not commit unless the change was expected!'",
     "preversion": "check-node-version --node 12 --npm 6.14 && npm-link-check && npm ls --prod",
-    "version": "npm run build && npm run no-bad-char && git add -A dist build src/version.js",
+    "version": "npm run build && npm run no-bad-char && git add -A lib dist build src/version.js",
     "postversion": "node -e \"console.log('Version bumped and committed. If ok, run: git push && git push --tags')\"",
     "postpublish": "node tasks/sync_packages.js",
     "postshrinkwrap": "chttps ."