Merge pull request #7254 from plotly/remove-transforms-bundle-option

Remove transforms from bundles

Author: archmoj

CUSTOM_BUNDLE.md

@@ -1,5 +1,5 @@
 # Custom bundle
-You can simply make custom bundles yourself, if none of the [distributed packages](https://github.com/plotly/plotly.js/blob/master/dist/README.md) meet your needs, or you want to make a more optimized bundle file with/without specific traces and transforms.
+You can simply make custom bundles yourself, if none of the [distributed packages](https://github.com/plotly/plotly.js/blob/master/dist/README.md) meet your needs, or you want to make a more optimized bundle file with/without specific traces.
 
 Make sure you have the versions of node/npm that's recommended:
 - plotly.js before 2.5: Node 12/npm 6
@@ -27,7 +27,7 @@ cd plotly.js
 npm i
 ```
 
-By default all traces and transforms are included in the bundle if you simply run:
+By default all traces are included in the bundle if you simply run:
 ```sh
 npm run custom-bundle
 ```
@@ -39,16 +39,6 @@ npm run custom-bundle -- --traces scatter,scattergl,scatter3d
 Please note that the `scatter` trace is currently included in all bundles and cannot be removed.
 [This behaviour may change in the future](https://github.com/plotly/plotly.js/pull/5535), so we recommend that you explicitly include `scatter` anyway if you need it in your bundle.
 
-Use the `transforms` option to specify which should be included.
-```sh
-npm run custom-bundle -- --transforms sort,filter
-```
-
-Or use `transforms none` to exclude them all.
-```sh
-npm run custom-bundle -- --transforms none
-```
-
 Use the `strict` option to use strict trace types where possible.
 ```sh
 npm run custom-bundle -- --traces scatter,scattergl --strict
@@ -66,15 +56,14 @@ npm run custom-bundle -- --unminified
 ```
 
 # Example illustrating use of different options together
-To create an unminified custom bundle named `myScatters` including `scatter`, `scattergl` and `scatter3d` traces without any transforms:
+To create an unminified custom bundle named `myScatters` including `scatter`, `scattergl` and `scatter3d` traces:
 ```sh
 npm run custom-bundle -- \
     --unminified \
     --out myScatters \
     --traces scatter,scattergl,scatter3d \
-    --transforms none
 ```
 Or simply on one line:
 ```sh
-npm run custom-bundle -- --unminified --out myScatters --traces scatter,scattergl,scatter3d --transforms none
+npm run custom-bundle -- --unminified --out myScatters --traces scatter,scattergl,scatter3d
 ```

draftlogs/7240_remove.md

@@ -1 +1 @@
- - Drop transforms from the API [[#7240](https://github.com/plotly/plotly.js/pull/7240)]
+ - Drop transforms from the API [[#7240](https://github.com/plotly/plotly.js/pull/7240), [#7254](https://github.com/plotly/plotly.js/pull/7254)]

lib/aggregate.js

@@ -7,12 +7,6 @@ Plotly.register([
     require('./bar'),
     require('./pie'),
 
-    // transforms
-    require('./aggregate'),
-    require('./filter'),
-    require('./groupby'),
-    require('./sort'),
-
     // components
     require('./calendars'),
 ]);

lib/filter.js

@@ -16,12 +16,6 @@ Plotly.register([
     require('./image'),
     require('./pie'),
 
-    // transforms
-    require('./aggregate'),
-    require('./filter'),
-    require('./groupby'),
-    require('./sort'),
-
     // components
     require('./calendars'),
 ]);

lib/groupby.js

@@ -14,12 +14,6 @@ Plotly.register([
     require('./ohlc'),
     require('./candlestick'),
 
-    // transforms
-    require('./aggregate'),
-    require('./filter'),
-    require('./groupby'),
-    require('./sort'),
-
     // components
     require('./calendars'),
 ]);

lib/index-basic.js

@@ -7,12 +7,6 @@ Plotly.register([
     require('./scattergeo'),
     require('./choropleth'),
 
-    // transforms
-    require('./aggregate'),
-    require('./filter'),
-    require('./groupby'),
-    require('./sort'),
-
     // components
     require('./calendars'),
 ]);

lib/index-cartesian.js

@@ -8,12 +8,6 @@ Plotly.register([
     require('./splom'),
     require('./parcoords'),
 
-    // transforms
-    require('./aggregate'),
-    require('./filter'),
-    require('./groupby'),
-    require('./sort'),
-
     // components
     require('./calendars'),
 ]);

lib/index-finance.js

@@ -12,12 +12,6 @@ Plotly.register([
     require('./cone'),
     require('./streamtube'),
 
-    // transforms
-    require('./aggregate'),
-    require('./filter'),
-    require('./groupby'),
-    require('./sort'),
-
     // components
     require('./calendars'),
 ]);

lib/index-geo.js

@@ -8,12 +8,6 @@ Plotly.register([
     require('./choroplethmap'),
     require('./densitymap'),
 
-    // transforms
-    require('./aggregate'),
-    require('./filter'),
-    require('./groupby'),
-    require('./sort'),
-
     // components
     require('./calendars'),
 ]);

lib/index-gl2d.js

@@ -8,12 +8,6 @@ Plotly.register([
     require('./choroplethmapbox'),
     require('./densitymapbox'),
 
-    // transforms
-    require('./aggregate'),
-    require('./filter'),
-    require('./groupby'),
-    require('./sort'),
-
     // components
     require('./calendars'),
 ]);

lib/index-gl3d.js

@@ -53,12 +53,6 @@ Plotly.register([
     require('./barpolar'),
     require('./scattersmith'),
 
-    // transforms
-    require('./aggregate'),
-    require('./filter'),
-    require('./groupby'),
-    require('./sort'),
-
     // components
     require('./calendars'),
 ]);

lib/index-map.js

@@ -53,12 +53,6 @@ Plotly.register([
     require('./barpolar'),
     require('./scattersmith'),
 
-    // transforms
-    require('./aggregate'),
-    require('./filter'),
-    require('./groupby'),
-    require('./sort'),
-
     // components
     require('./calendars'),
 ]);

lib/index-mapbox.js

@@ -5,7 +5,6 @@ import runSeries from 'run-series';
 import partialBundle from './partial_bundle.mjs';
 import constants from './util/constants.js';
 
-var allTransforms = constants.allTransforms;
 var allTraces = constants.allTraces;
 
 function createList(outList, inList, allList, type) {
@@ -55,12 +54,10 @@ if(process.argv.length > 2) {
     var unminified = inputBoolean(args.unminified, false);
     var out = args.out ? args.out : 'custom';
     var traces = inputArray(args.traces, allTraces);
-    var transforms = inputArray(args.transforms, allTransforms);
     var strict = inputBoolean(args.strict, false);
 
     var opts = {
         traceList: createList(['scatter'], traces, allTraces, 'trace'),
-        transformList: createList([], transforms, allTransforms, 'transform'),
 
         name: out,
         index: path.join(constants.pathToLib, 'index-' + (strict ? 'strict-' : '') + out + '.js'),

lib/index-strict.js

@@ -39,7 +39,6 @@ for(var i = 0; i < list.length; i++) {
         dist: opts.dist,
         distMin: opts.distMin,
         traceList: opts.traceList,
-        transformList: opts.transformList,
         calendars: opts.calendars
     });
 }

lib/index.js

@@ -5,7 +5,6 @@ import common from './util/common.js';
 import _bundle from './util/bundle_wrapper.mjs';
 
 var header = constants.licenseDist + '\n';
-var allTransforms = constants.allTransforms;
 var allTraces = constants.allTraces;
 var mainIndex = constants.mainIndex;
 var strictIndex = constants.strictIndex;
@@ -18,7 +17,6 @@ export default 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 strict = opts.strict;
 
@@ -27,8 +25,8 @@ export default function partialBundle(tasks, opts) {
         tasks.push(function(done) {
             var partialIndex = (strict) ? strictIndex : mainIndex;
 
-            var all = ['calendars'].concat(allTransforms).concat(allTraces);
-            var includes = (calendars ? ['calendars'] : []).concat(transformList).concat(traceList);
+            var all = ['calendars'].concat(allTraces);
+            var includes = (calendars ? ['calendars'] : []).concat(traceList);
             var excludes = all.filter(function(e) { return includes.indexOf(e) === -1; });
 
             excludes.forEach(function(t) {

lib/sort.js

@@ -52,15 +52,6 @@ function exposePartsInLib() {
 
     insert('calendars', 'src/components');
 
-    [
-        'aggregate',
-        'filter',
-        'groupby',
-        'sort'
-    ].forEach(function(k) {
-        insert(k, 'src/transforms');
-    });
-
     constants.allTraces.forEach(function(k) {
         insert(k, 'src/traces');
     });

tasks/custom_bundle.mjs

@@ -24,12 +24,6 @@ var strictIndex = fs.readFileSync(pathToPlotlyStrict, 'utf-8');
 var allTraces = fs.readdirSync(path.join(pathToSrc, 'traces'))
     .filter(startsWithLowerCase);
 
-var allTransforms = fs.readdirSync(path.join(pathToSrc, 'transforms'))
-    .filter(function(v) {
-        return startsWithLowerCase(v) && v !== 'helpers.js';
-    })
-    .map(function(e) { return e.replace('.js', ''); });
-
 var pathToTopojsonSrc;
 try {
     pathToTopojsonSrc = path.join(path.dirname(require.resolve('sane-topojson')), 'dist/');
@@ -162,7 +156,6 @@ 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'),
@@ -185,7 +178,6 @@ module.exports = {
 
     partialBundleTraces: partialBundleTraces,
 
-    allTransforms: allTransforms,
     allTraces: allTraces,
     mainIndex: mainIndex,
     strictIndex: strictIndex,

tasks/extra_bundles.mjs

@@ -1,15 +1,14 @@
 var Plotly = require('../../../lib/core');
 var Bar = require('../../../lib/bar');
 var Scatter3d = require('../../../lib/scatter3d');
-var Filter = require('../../../lib/filter');
 var Calendars = require('../../../lib/calendars');
 
 var checkComponent = require('../assets/check_component');
 
 describe('Bundle with a component loaded before traces', function() {
     'use strict';
 
-    Plotly.register([Calendars, Filter, Scatter3d, Bar]);
+    Plotly.register([Calendars, Scatter3d, Bar]);
 
     checkComponent(Plotly);
 });

tasks/partial_bundle.mjs

@@ -1,15 +1,14 @@
 var Plotly = require('../../../lib/core');
 var Bar = require('../../../lib/bar');
 var Scatter3d = require('../../../lib/scatter3d');
-var Filter = require('../../../lib/filter');
 var Calendars = require('../../../lib/calendars');
 
 var checkComponent = require('../assets/check_component');
 
 describe('Bundle with a component loaded after traces', function() {
     'use strict';
 
-    Plotly.register([Bar, Scatter3d, Filter, Calendars]);
+    Plotly.register([Bar, Scatter3d, Calendars]);
 
     checkComponent(Plotly);
 });