Remove global spaces option

Author: RyanZim

CHANGELOG.md

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

README.md

@@ -160,48 +160,6 @@ var obj = {name: 'JP'}
 jsonfile.writeFileSync(file, obj, {flag: 'a'})
 ```
 
-### spaces
-
-Global configuration to set spaces to indent JSON files.
-
-**default:** `null`
-
-```js
-var jsonfile = require('jsonfile')
-
-jsonfile.spaces = 4
-
-var file = '/tmp/data.json'
-var obj = {name: 'JP'}
-
-// json file has four space indenting now
-jsonfile.writeFile(file, obj, function (err) {
-  console.error(err)
-})
-```
-
-Note, it's bound to `this.spaces`. So, if you do this:
-
-```js
-var myObj = {}
-myObj.writeJsonSync = jsonfile.writeFileSync
-// => this.spaces = null
-```
-
-Could do the following:
-
-```js
-var jsonfile = require('jsonfile')
-jsonfile.spaces = 4
-jsonfile.writeFileSync(file, obj) // will have 4 spaces indentation
-
-var myCrazyObj = {spaces: 32}
-myCrazyObj.writeJsonSync = jsonfile.writeFileSync
-myCrazyObj.writeJsonSync(file, obj) // will have 32 space indentation
-myCrazyObj.writeJsonSync(file, obj, {spaces: 2}) // will have only 2
-```
-
-
 License
 -------
 

index.js

@@ -78,10 +78,7 @@ function readFileSync (file, options) {
 }
 
 function stringify (obj, options) {
-  // `jsonfile` and not `this` because people might destructure
-  // and use `writeFile` instead of `fs.writeFile`, in which case
-  // `this` would be `undefined`
-  var spaces = jsonfile.spaces
+  var spaces
   var EOL = '\n'
   if (typeof options === 'object' && options !== null) {
     if (options.spaces) {
@@ -134,7 +131,6 @@ function stripBom (content) {
 }
 
 var jsonfile = {
-  spaces: null,
   readFile: readFile,
   readFileSync: readFileSync,
   writeFile: writeFile,

test/test.js

@@ -34,35 +34,6 @@ describe('+ writeFileSync()', function () {
     assert.equal(data, '{"name":"JP"}\n')
   })
 
-  describe('> when global spaces is set', function () {
-    it('should write JSON with spacing', function () {
-      var file = path.join(TEST_DIR, 'somefile.json')
-      var obj = {name: 'JP'}
-      jf.spaces = 2
-      jf.writeFileSync(file, obj)
-
-      var data = fs.readFileSync(file, 'utf8')
-      assert.equal(data, '{\n  "name": "JP"\n}\n')
-
-      // restore default
-      jf.spaces = null
-    })
-
-    it('still uses global when context lost', function () {
-      var file = path.join(TEST_DIR, 'somefile.json')
-      var obj = {name: 'JP'}
-      jf.spaces = 2
-      var writeFileSync = jf.writeFileSync
-      writeFileSync(file, obj)
-
-      var data = fs.readFileSync(file, 'utf8')
-      assert.equal(data, '{\n  "name": "JP"\n}\n')
-
-      // restore default
-      jf.spaces = null
-    })
-  })
-
   describe('> when JSON replacer is set', function () {
     it('should replace JSON', function () {
       var file = path.join(TEST_DIR, 'somefile.json')

test/write-file-sync.test.js

@@ -39,41 +39,6 @@ describe('+ writeFile()', function () {
     })
   })
 
-  describe('> when global spaces is set', function () {
-    it('should write JSON with spacing', function (done) {
-      var file = path.join(TEST_DIR, 'somefile.json')
-      var obj = {name: 'JP'}
-      jf.spaces = 2
-      jf.writeFile(file, obj, function (err) {
-        assert.ifError(err)
-
-        var data = fs.readFileSync(file, 'utf8')
-        assert.equal(data, '{\n  "name": "JP"\n}\n')
-
-        // restore default
-        jf.spaces = null
-        done()
-      })
-    })
-
-    it('still uses global when context lost', function (done) {
-      var file = path.join(TEST_DIR, 'somefile.json')
-      var obj = {name: 'JP'}
-      jf.spaces = 2
-      var writeFile = jf.writeFile
-      writeFile(file, obj, function (err) {
-        assert.ifError(err)
-
-        var data = fs.readFileSync(file, 'utf8')
-        assert.equal(data, '{\n  "name": "JP"\n}\n')
-
-        // restore default
-        jf.spaces = null
-        done()
-      })
-    })
-  })
-
   describe('> when JSON replacer is set', function () {
     it('should replace JSON', function (done) {
       var file = path.join(TEST_DIR, 'somefile.json')