Remove undocumented passParsingErrors option

Author: RyanZim

CHANGELOG.md

@@ -1,4 +1,5 @@
 - **BREAKING:** Remove global `spaces` option.
+- Remove undocumented `passParsingErrors` option.
 - Added `EOL` override option to `writeFile` when using `spaces`. [#89]
 
 3.0.1 / 2017-07-05

index.js

@@ -19,10 +19,7 @@ function readFile (file, options, callback) {
   var fs = options.fs || _fs
 
   var shouldThrow = true
-  // DO NOT USE 'passParsingErrors' THE NAME WILL CHANGE!!!, use 'throws' instead
-  if ('passParsingErrors' in options) {
-    shouldThrow = options.passParsingErrors
-  } else if ('throws' in options) {
+  if ('throws' in options) {
     shouldThrow = options.throws
   }
 
@@ -56,10 +53,7 @@ function readFileSync (file, options) {
   var fs = options.fs || _fs
 
   var shouldThrow = true
-  // DO NOT USE 'passParsingErrors' THE NAME WILL CHANGE!!!, use 'throws' instead
-  if ('passParsingErrors' in options) {
-    shouldThrow = options.passParsingErrors
-  } else if ('throws' in options) {
+  if ('throws' in options) {
     shouldThrow = options.throws
   }
 

test/read-file-sync.test.js

@@ -50,21 +50,6 @@ describe('+ readFileSync()', function () {
     })
   })
 
-  describe('> when invalid JSON and passParsingErrors set to false', function () {
-    it('should return null', function () {
-      var file = path.join(TEST_DIR, 'somefile4-invalid.json')
-      var data = '{not valid JSON'
-      fs.writeFileSync(file, data)
-
-      assert.throws(function () {
-        jf.readFileSync(file)
-      })
-
-      var obj = jf.readFileSync(file, {passParsingErrors: false})
-      assert.strictEqual(obj, null)
-    })
-  })
-
   describe('> when invalid JSON and throws set to false', function () {
     it('should return null', function () {
       var file = path.join(TEST_DIR, 'somefile4-invalid.json')
@@ -80,22 +65,6 @@ describe('+ readFileSync()', function () {
     })
   })
 
-  describe('> when invalid JSON and passParsingErrors set to true', function () {
-    it('should return null', function () {
-      var file = path.join(TEST_DIR, 'somefile4-invalid.json')
-      var data = '{not valid JSON'
-      fs.writeFileSync(file, data)
-
-      assert.throws(function () {
-        jf.readFileSync(file)
-      })
-
-      assert.throws(function () {
-        jf.readFileSync(file, {throws: true})
-      })
-    })
-  })
-
   describe('> when invalid JSON and throws set to true', function () {
     it('should throw an exception', function () {
       var file = path.join(TEST_DIR, 'somefile4-invalid.json')

test/read-file.test.js

@@ -75,62 +75,6 @@ describe('+ readFile()', function () {
     })
   })
 
-  describe('> when invalid JSON and throws set to false', function () {
-    it('should return null and no error', function (done) {
-      var fn = 'somefile4-invalid.json'
-      var file = path.join(TEST_DIR, fn)
-      var data = '{not valid JSON'
-      var bothDone = false
-      fs.writeFileSync(file, data)
-
-      jf.readFile(file, function (err, obj2) {
-        assert(err instanceof Error)
-        assert(err.message.match(fn))
-        if (bothDone) {
-          done()
-        }
-        bothDone = true
-      })
-
-      jf.readFile(file, {throws: false}, function (err, obj2) {
-        assert.ifError(err)
-        assert.strictEqual(obj2, null)
-        if (bothDone) {
-          done()
-        }
-        bothDone = true
-      })
-    })
-  })
-
-  describe('> when invalid JSON and throws set to true', function () {
-    it('should return an error', function (done) {
-      var fn = 'somefile4-invalid.json'
-      var file = path.join(TEST_DIR, fn)
-      var data = '{not valid JSON'
-      var bothDone = false
-      fs.writeFileSync(file, data)
-
-      jf.readFile(file, function (err, obj2) {
-        assert(err instanceof Error)
-        assert(err.message.match(fn))
-        if (bothDone) {
-          done()
-        }
-        bothDone = true
-      })
-
-      jf.readFile(file, {throws: true}, function (err, obj2) {
-        assert(err instanceof Error)
-        assert(err.message.match(fn))
-        if (bothDone) {
-          done()
-        }
-        bothDone = true
-      })
-    })
-  })
-
   describe('> when invalid JSON and throws set to true', function () {
     it('should return an error', function (done) {
       var fn = 'somefile4-invalid.json'