touch up sync_packages.js

- factor up findModuleList from stats.js, to list which
  trace modules are included
- fixup cb when build/* exist
- add DRYRUN env var, to skip `npm publish`

Author: etpinard

tasks/stats.js

@@ -1,7 +1,6 @@
 var path = require('path');
 var fs = require('fs');
 
-var falafel = require('falafel');
 var gzipSize = require('gzip-size');
 var prettySize = require('prettysize');
 
@@ -11,7 +10,6 @@ var pkg = require('../package.json');
 
 var pathDistREADME = path.join(constants.pathToDist, 'README.md');
 var cdnRoot = 'https://cdn.plot.ly/plotly-';
-var coreModules = ['scatter'];
 
 var ENC = 'utf-8';
 var JS = '.js';
@@ -156,12 +154,12 @@ function makeBundleHeaderInfo(pathObj) {
 function makeBundleInfo(pathObj) {
     var name = pathObj.name;
     var sizes = findSizes(pathObj);
-    var moduleList = coreModules.concat(scrapeContent(pathObj));
+    var moduleList = common.findModuleList(pathObj.index);
 
     return [
         '### plotly.js ' + name,
         '',
-        formatBundleInfo(name, moduleList),
+        'The `' + name + '` partial bundle contains trace modules ' + common.formatEnumeration(moduleList) + '.',
         '',
         '| Way to import | Location |',
         '|---------------|----------|',
@@ -197,50 +195,3 @@ function findSizes(pathObj) {
 
     return sizes;
 }
-
-function scrapeContent(pathObj) {
-    var code = fs.readFileSync(pathObj.index, ENC);
-    var moduleList = [];
-
-    falafel(code, function(node) {
-        if(isModuleNode(node)) {
-            var moduleName = node.value.replace('./', '');
-            moduleList.push(moduleName);
-        }
-    });
-
-    return moduleList;
-}
-
-function isModuleNode(node) {
-    return (
-        node.type === 'Literal' &&
-        node.parent &&
-        node.parent.type === 'CallExpression' &&
-        node.parent.callee &&
-        node.parent.callee.type === 'Identifier' &&
-        node.parent.callee.name === 'require' &&
-        node.parent.parent &&
-        node.parent.parent.type === 'ArrayExpression'
-    );
-}
-
-function formatBundleInfo(bundleName, moduleList) {
-    var enumeration = moduleList.map(function(moduleName, i) {
-        var len = moduleList.length,
-            ending;
-
-        if(i === len - 2) ending = ' and';
-        else if(i < len - 1) ending = ',';
-        else ending = '';
-
-        return '`' + moduleName + '`' + ending;
-    });
-
-    return [
-        'The', '`' + bundleName + '`',
-        'partial bundle contains the',
-        enumeration.join(' '),
-        'trace modules.'
-    ].join(' ');
-}

tasks/sync_packages.js

@@ -11,23 +11,27 @@ var packagesSpecs = constants.partialBundlePaths
     .map(function(d) {
         return {
             name: 'plotly.js-' + d.name + '-dist',
+            index: d.index,
             main: 'plotly-' + d.name + '.js',
             dist: d.dist,
-            desc: 'Ready-to-use plotly.js ' + d.name + ' distributed bundle',
+            desc: 'Ready-to-use plotly.js ' + d.name + ' distributed bundle.',
         };
     })
     .concat([{
         name: 'plotly.js-dist',
+        index: path.join(constants.pathToLib, 'index.js'),
         main: 'plotly.js',
         dist: constants.pathToPlotlyDist,
-        desc: 'Ready-to-use plotly.js distributed bundle',
+        desc: 'Ready-to-use plotly.js distributed bundle.',
     }]);
 
 packagesSpecs.forEach(function(d) {
     var pkgPath = path.join(constants.pathToBuild, d.name);
 
     function initDirectory(cb) {
-        if(!common.doesDirExist(pkgPath)) {
+        if(common.doesDirExist(pkgPath)) {
+            cb();
+        } else {
             fs.mkdir(pkgPath, cb);
         }
     }
@@ -53,11 +57,15 @@ packagesSpecs.forEach(function(d) {
     }
 
     function writeREADME(cb) {
+        var moduleList = common.findModuleList(d.index);
+
         var cnt = [
             '# ' + d.name,
             '',
             d.desc,
             '',
+            'Contains trace modules ' + common.formatEnumeration(moduleList) + '.',
+            '',
             'For more info on plotly.js, go to https://github.com/plotly/plotly.js',
             '',
             '## Copyright and license',
@@ -82,14 +90,14 @@ packagesSpecs.forEach(function(d) {
     }
 
     function publishToNPM(cb) {
+        if(process.env.DRYRUN) {
+            console.log('dry run, did not publish ' + d.name);
+            cb();
+            return;
+        }
         exec('npm publish', {cwd: pkgPath}, cb).stdout.pipe(process.stdout);
     }
 
-    // TODO
-    // - add minified file?
-    // - what to do with dist/topojson/
-    // - what to do with mathjax/
-
     runSeries([
         initDirectory,
         writePackageJSON,

tasks/util/common.js

@@ -1,5 +1,6 @@
 var fs = require('fs');
 var exec = require('child_process').exec;
+var falafel = require('falafel');
 
 exports.execCmd = function(cmd, cb, errorCb) {
     cb = cb ? cb : function() {};
@@ -66,3 +67,41 @@ exports.touch = function(filePath) {
 exports.throwOnError = function(err) {
     if(err) throw err;
 };
+
+exports.findModuleList = function(pathToIndex) {
+    var code = fs.readFileSync(pathToIndex, 'utf-8');
+    // In v1.x, all partial bundles include the 'scatter' module
+    var moduleList = ['scatter'];
+
+    falafel(code, function(node) {
+        if(
+            node.type === 'Literal' &&
+            node.parent &&
+            node.parent.type === 'CallExpression' &&
+            node.parent.callee &&
+            node.parent.callee.type === 'Identifier' &&
+            node.parent.callee.name === 'require' &&
+            node.parent.parent &&
+            node.parent.parent.type === 'ArrayExpression'
+        ) {
+            var moduleName = node.value.replace('./', '');
+            moduleList.push(moduleName);
+        }
+    });
+
+    return moduleList;
+};
+
+exports.formatEnumeration = function(list) {
+    var len = list.length;
+
+    return list.map(function(l, i) {
+        var ending;
+
+        if(i === len - 2) ending = ' and';
+        else if(i < len - 1) ending = ',';
+        else ending = '';
+
+        return '`' + l + '`' + ending;
+    }).join(' ');
+};