Merge pull request #129 from FracturedShader/feature/skip-UTF-8-BOM

Added UTF-8 BOM skipping for partials and pages.
foundation · Jul 13, 2017 · 8edca3a · 8edca3a
2 parents 8375d4c + 2a1396c
commit 8edca3a
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 4 deletions.
diff --git a/lib/loadPartials.js b/lib/loadPartials.js
@@ -1,4 +1,3 @@
-var fs    = require('fs');
 var path  = require('path');
 var utils = require('./utils');
 
@@ -11,8 +10,9 @@ module.exports = function(dir) {
 
   for (var i in partials) {
     var ext = path.extname(partials[i]);
-    var file = fs.readFileSync(partials[i]);
+    var file = utils.readWithoutBOM(partials[i]);
     var name = path.basename(partials[i], ext);
+
     this.Handlebars.registerPartial(name, file.toString() + '\n');
   }
 }
diff --git a/lib/render.js b/lib/render.js
@@ -3,6 +3,7 @@ var fm = require('front-matter');
 var path = require('path');
 var through = require('through2');
 var processRoot = require('./processRoot');
+var utils = require('./utils');
 
 module.exports = function() {
   return through.obj(render.bind(this));
@@ -17,7 +18,7 @@ module.exports = function() {
 function render(file, enc, cb) {
   try {
     // Get the HTML for the current page and layout
-    var page = fm(file.contents.toString());
+    var page = fm(utils.readWithoutBOM(file.path).toString());
     var pageData;
 
     // Determine which layout to use

diff --git a/lib/utils.js b/lib/utils.js
@@ -2,6 +2,7 @@
 
 var glob = require('glob');
 var path = require('path');
+var fs = require('fs');
 
 /**
  * Load a set of files
@@ -19,4 +20,23 @@ exports.loadFiles = function(dir, pattern) {
   }
 
   return files;
-}
+}
+
+/**
+ * Skips over the UTF-8 BOM if it exists in the file
+ * @param  {string} path File to load
+ * @return {Buffer}      File contents without BOM
+ */
+exports.readWithoutBOM = function(path) {
+  var bomBytes = [0xEF, 0xBB, 0xBF];
+  var bomSize = bomBytes.length;
+  var fileData = fs.readFileSync(path);
+  var dataLength = fileData.length;
+  var hasBom = true;
+
+  for (var i = 0; (i < bomSize) && (i < dataLength) && hasBom; ++i) {
+    hasBom = fileData[i] === bomBytes[i];
+  }
+
+  return hasBom ? fileData.slice(bomSize) : fileData;
+}