Merge pull request #586 from hannu/remove-from-inline-json

Do not expose all configuration params to index.html JSON
SC5 · Apr 20, 2015 · 92f8a6b · 92f8a6b
2 parents 99baadc + df91dde
commit 92f8a6b
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -395,7 +395,7 @@ If you modify you assets in gulp streams, you can add styleguide output director
 gulp.task('images', function() {
   gulp.src(['images/**'])
     // Do image sprites, optimizations etc.
-    .pipe(gulp.dest(buildPath + '/images'));
+    .pipe(gulp.dest(buildPath + '/images'))
     .pipe(gulp.dest(outputPath + '/images'));
 });
 

diff --git a/lib/styleguide.js b/lib/styleguide.js
@@ -94,6 +94,15 @@ function copyUsedOptionsToJsonConfig(opt, json) {
   return json;
 }
 
+function copyUsedOptionsToInlineJsonConfig(opt, json) {
+  var used = ['title', 'disableEncapsulation', 'disableHtml5Mode'];
+  json.config = {};
+  used.forEach(function(prop) {
+    json.config[prop] = _.cloneDeep(opt[prop]);
+  });
+  return json;
+}
+
 function addFileHashesAndReplaceAbsolutePaths(json) {
   if (!json) {
     return;
@@ -258,7 +267,7 @@ module.exports.generate = function(options) {
             .pipe(mustache({
               title: opt.title,
               extraHead: opt.extraHead,
-              styleguideConfig: JSON.stringify(copyUsedOptionsToJsonConfig(opt, {}).config),
+              styleguideConfig: JSON.stringify(copyUsedOptionsToInlineJsonConfig(opt, {}).config),
               appRoot: opt.appRoot,
               socketIo: opt.server,
               filesConfig: JSON.stringify(opt.filesConfig)

diff --git a/test/integration/structure.test.js b/test/integration/structure.test.js
@@ -62,7 +62,11 @@ describe('index.html', function() {
   });
 
   it('should contain serialized styleguide configuration', function() {
-    expect(indexHtml.contents.toString()).to.contain('var _styleguideConfig = {"appRoot":"/my-styleguide-book"');
+    expect(indexHtml.contents.toString()).to.contain('var _styleguideConfig = {"title":"Test Styleguide"');
+  });
+
+  it('should not add extraHead to serialized configuration', function() {
+    expect(indexHtml.contents.toString()).not.to.contain('"extreHead":');
   });
 });