(Closes #45) jsonfile: strip BOM

Author: jprichardson

index.js

@@ -24,6 +24,8 @@ function readFile (file, options, callback) {
   fs.readFile(file, options, function (err, data) {
     if (err) return callback(err)
 
+    data = stripBom(data)
+
     var obj
     try {
       obj = JSON.parse(data, options ? options.reviver : null)
@@ -57,6 +59,7 @@ function readFileSync (file, options) {
   }
 
   var content = fs.readFileSync(file, options)
+  content = stripBom(content)
 
   try {
     return JSON.parse(content, options.reviver)
@@ -107,6 +110,13 @@ function writeFileSync (file, obj, options) {
   return fs.writeFileSync(file, str, options)
 }
 
+function stripBom (content) {
+  // we do this because JSON.parse would convert it to a utf8 string if encoding wasn't specified
+  if (Buffer.isBuffer(content)) content = content.toString('utf8')
+  content = content.replace(/^\uFEFF/, '')
+  return content
+}
+
 var jsonfile = {
   spaces: null,
   readFile: readFile,

test/read-file-sync.test.js

@@ -162,4 +162,14 @@ describe('+ readFileSync()', function () {
       assert.deepEqual(dataOut, dataIn)
     })
   })
+
+  describe('> w/ BOM', function () {
+    it('should properly parse', function () {
+      var file = path.join(TEST_DIR, 'file-bom.json')
+      var obj = { name: 'JP' }
+      fs.writeFileSync(file, '\uFEFF' + JSON.stringify(obj))
+      var data = jf.readFileSync(file)
+      assert.deepEqual(obj, data)
+    })
+  })
 })

test/read-file.test.js

@@ -231,4 +231,17 @@ describe('+ readFile()', function () {
       })
     })
   })
+
+  describe('> w/ BOM', function () {
+    it('should properly parse', function (done) {
+      var file = path.join(TEST_DIR, 'file-bom.json')
+      var obj = { name: 'JP' }
+      fs.writeFileSync(file, '\uFEFF' + JSON.stringify(obj))
+      jf.readFile(file, function (err, data) {
+        assert.ifError(err)
+        assert.deepEqual(obj, data)
+        done()
+      })
+    })
+  })
 })