task to collect translation keys and verify syntax

Author: alexcjohnson

dist/translationKeys.txt

@@ -0,0 +1,60 @@
+Autoscale
+Box Select
+Click to enter Colorscale title
+Click to enter Component A title
+Click to enter Component B title
+Click to enter Component C title
+Click to enter Plot title
+Click to enter X axis title
+Click to enter Y axis title
+Close
+Compare data on hover
+Double click on legend to isolate individual trace
+Double-click to<br>zoom back out
+Download plot as a png
+High
+IE only supports svg.  Changing format to svg.
+Incoming flow count
+Lasso Select
+Low
+Open
+Orbital rotation
+Outgoing flow count
+Pan
+Produced with Plotly
+Reset
+Reset axes
+Reset camera to default
+Reset camera to last save
+Reset view
+Reset views
+Save and edit plot in cloud
+Show closest data on hover
+Snapshot succeeded
+Sorry there was a problem downloading your snapshot!
+Source
+Taking snapshot - this may take a few seconds
+Target
+Toggle Spike Lines
+Toggle show closest data on hover
+Turntable rotation
+Zoom
+Zoom in
+Zoom out
+cannot use zsmooth: "fast"
+kde
+lat
+log axis found
+lon
+lower fence
+max
+mean
+mean ± σ
+median
+min
+q1
+q3
+trace
+upper fence
+x scale is not linear
+y scale is not linear

package.json

@@ -25,7 +25,8 @@
     "bundle": "node tasks/bundle.js",
     "header": "node tasks/header.js",
     "stats": "node tasks/stats.js",
-    "build": "npm run preprocess && npm run bundle && npm run header && npm run stats",
+    "find-strings": "node tasks/find_locale_strings.js",
+    "build": "npm run preprocess && npm run find-strings && npm run bundle && npm run header && npm run stats",
     "cibuild": "npm run preprocess && node tasks/cibundle.js",
     "watch": "node tasks/watch.js",
     "lint": "eslint --version && eslint .",
@@ -36,7 +37,7 @@
     "test-image": "node tasks/test_image.js",
     "test-image-gl2d": "node tasks/test_image.js gl2d_* --queue",
     "test-export": "node tasks/test_export.js",
-    "test-syntax": "node tasks/test_syntax.js",
+    "test-syntax": "node tasks/test_syntax.js && npm run find-strings",
     "test-bundle": "node tasks/test_bundle.js",
     "test": "npm run test-jasmine && npm run test-bundle && npm run test-image && npm run test-image-gl2d && npm run test-syntax && npm run lint",
     "start-test_dashboard": "node devtools/test_dashboard/server.js",

tasks/find_locale_strings.js

@@ -0,0 +1,85 @@
+var path = require('path');
+var fs = require('fs');
+
+var falafel = require('falafel');
+var glob = require('glob');
+
+var constants = require('./util/constants');
+var srcGlob = path.join(constants.pathToSrc, '**/*.js');
+
+var common = require('./util/common');
+
+var EXIT_CODE = 0;
+
+var localizeRE = /(^|[\.])(_|localize)$/;
+
+// main
+findLocaleStrings();
+
+function findLocaleStrings() {
+    glob(srcGlob, function(err, files) {
+        if(err) {
+            EXIT_CODE = 1;
+            console.log(err);
+            return;
+        }
+
+        var dict = {};
+        var hasTranslation = false;
+
+        files.forEach(function(file) {
+            var code = fs.readFileSync(file, 'utf-8');
+
+            falafel(code, {locations: true}, function(node) {
+                // parse through code string looking for translated strings
+                // You may either assign `Lib.localize` to `_` and use that, or
+                // call `Lib.localize` directly.
+                if(node.type === 'CallExpression' &&
+                    (node.callee.name === '_' || node.callee.source() === 'Lib._')
+                ) {
+                    var strNode = node.arguments[1];
+                    if(node.arguments.length !== 2) {
+                        logError(file, node, 'Localize takes 2 args');
+                    }
+                    if(strNode.type !== 'Literal') {
+                        logError(file, node, 'Translated string must be a literal');
+                    }
+                    dict[strNode.value] = 1;
+                    hasTranslation = true;
+                }
+
+                // make sure localize is the only thing we assign to a variable `_`
+                // NB: this does not preclude using `_` for an unused function arg
+                else if(node.type === 'VariableDeclarator' && node.id.name === '_') {
+                    var src = node.init.source();
+                    if(!localizeRE.test(src)) {
+                        logError(file, node, 'Use `_` only to mean localization');
+                    }
+                }
+            });
+        });
+
+        if(!hasTranslation) {
+            console.error('Found no translations.');
+            EXIT_CODE = 1;
+        }
+
+        if(!EXIT_CODE) {
+            var strings = Object.keys(dict).sort().join('\n');
+            common.writeFile(constants.pathToTranslationKeys, strings);
+            console.log('ok find_locale_strings');
+        }
+    });
+}
+
+function logError(file, node, msg) {
+    console.error(file + ' [line ' + node.loc.start.line + '] ' + msg +
+        '\n   ' + node.source());
+    EXIT_CODE = 1;
+}
+
+process.on('exit', function() {
+    if(EXIT_CODE) {
+        throw new Error('find_locale_strings failed.');
+    }
+});

tasks/util/constants.js

@@ -42,6 +42,7 @@ module.exports = {
     pathToPlotlyDistWithMeta: path.join(pathToDist, 'plotly-with-meta.js'),
 
     pathToSchema: path.join(pathToDist, 'plot-schema.json'),
+    pathToTranslationKeys: path.join(pathToDist, 'translationKeys.txt'),
 
     partialBundleNames: partialBundleNames,
     partialBundlePaths: partialBundlePaths,