Make docs data serialization stable so that diffs are viable

nivoc · Feb 12, 2015 · e622686 · e622686
1 parent d117ba2
commit e622686
Show file tree

Hide file tree

Showing 4 changed files with 5,763 additions and 5 deletions.
diff --git a/docs/client/.gitattributes b/docs/client/.gitattributes
diff --git a/docs/client/data.js b/docs/client/data.js
diff --git a/scripts/admin/jsdoc/docdata-jsdoc-template/publish.js b/scripts/admin/jsdoc/docdata-jsdoc-template/publish.js
@@ -6,6 +6,7 @@
   var helper = require('jsdoc/util/templateHelper');
 
   var _ = require("underscore");
+  var stringify = require("canonical-json");
 
   var names = [];
   var dataContents = {};
@@ -107,14 +108,14 @@
     });
 
     // write full docs JSON
-    var jsonString = JSON.stringify(dataContents);
+    var jsonString = stringify(dataContents, null, 2);
     var jsString = "DocsData = " + jsonString + ";";
     jsString = "// This file is automatically generated by JSDoc; regenerate it with scripts/admin/jsdoc/jsdoc.sh\n" + jsString;
     var docsDataFilename = "docs/client/data.js";
     fs.writeFileSync(docsDataFilename, jsString);
 
     // write name tree JSON
-    jsonString = JSON.stringify(names.sort(), null, 2);
+    jsonString = stringify(names.sort(), null, 2);
     var nameTreeFilename= "docs/client/names.json";
     fs.writeFileSync(nameTreeFilename, jsonString);
   };

diff --git a/scripts/admin/jsdoc/package.json b/scripts/admin/jsdoc/package.json
@@ -5,6 +5,7 @@
   "readme": "no warn",
   "repository": "no warn",
   "dependencies": {
-    "jsdoc": "3.3.0-alpha9"
+    "jsdoc": "3.3.0-alpha9",
+    "canonical-json": "0.0.4"
   }
 }