include schema in dist

Author: alexcjohnson

package.json

@@ -119,6 +119,7 @@
     "gzip-size": "^3.0.0",
     "image-size": "^0.5.1",
     "jasmine-core": "^2.4.1",
+    "jsdom": "^9.5.0",
     "karma": "^1.5.0",
     "karma-browserify": "^5.1.1",
     "karma-chrome-launcher": "^2.0.0",

src/plot_api/plot_schema.js

@@ -64,7 +64,7 @@ exports.get = function() {
     return {
         defs: {
             valObjects: Lib.valObjectMeta,
-            metaKeys: UNDERSCORE_ATTRS.concat(['description', 'role']),
+            metaKeys: UNDERSCORE_ATTRS.concat(['description', 'role', 'editType', 'impliedEdits']),
             editType: {
                 traces: editTypes.traces,
                 layout: editTypes.layout

tasks/bundle.js

@@ -1,7 +1,7 @@
 var constants = require('./util/constants');
 var common = require('./util/common');
 var _bundle = require('./util/browserify_wrapper');
-
+var makeSchema = require('./util/make_schema');
 /*
  * This script takes one argument
  *
@@ -41,7 +41,8 @@ _bundle(constants.pathToPlotlyGeoAssetsSrc, constants.pathToPlotlyGeoAssetsDist,
 // Browserify the plotly.js with meta
 _bundle(constants.pathToPlotlyIndex, constants.pathToPlotlyDistWithMeta, {
     standalone: 'Plotly',
-    debug: DEV
+    debug: DEV,
+    then: makeSchema(constants.pathToPlotlyDistWithMeta, constants.pathToSchema)
 });
 
 // Browserify the plotly.js partial bundles

tasks/util/browserify_wrapper.js

@@ -50,6 +50,9 @@ module.exports = function _bundle(pathToIndex, pathToBundle, opts) {
 
     bundleWriteStream.on('finish', function() {
         logger(pathToBundle);
+        if(opts.then) {
+            opts.then();
+        }
     });
 
     b.bundle(function(err, buf) {

tasks/util/constants.js

@@ -41,6 +41,8 @@ module.exports = {
     pathToPlotlyDistMin: path.join(pathToDist, 'plotly.min.js'),
     pathToPlotlyDistWithMeta: path.join(pathToDist, 'plotly-with-meta.js'),
 
+    pathToSchema: path.join(pathToDist, 'plot-schema.json'),
+
     partialBundleNames: partialBundleNames,
     partialBundlePaths: partialBundlePaths,
 

tasks/util/make_schema.js

@@ -0,0 +1,25 @@
+var fs = require('fs');
+var path = require('path');
+var jsdom = require('jsdom');
+
+module.exports = function makeSchema(plotlyPath, schemaPath) {
+    return function() {
+        var plotlyjsCode = fs.readFileSync(plotlyPath, 'utf-8');
+        jsdom.env({
+            html: '<div></div>',
+            src: [plotlyjsCode],
+            done: function(err, window) {
+                if(err) {
+                    console.log(err);
+                    return;
+                }
+
+                var plotSchema = window.Plotly.PlotSchema.get();
+                var plotSchemaStr = JSON.stringify(plotSchema, null, 4);
+                fs.writeFileSync(schemaPath, plotSchemaStr);
+
+                console.log('ok ' + path.basename(schemaPath));
+            }
+        });
+    };
+};