jsonfile: added options.spaces

Author: jprichardson

README.md

@@ -56,7 +56,7 @@ console.dir(jf.readFileSync(file))
 
 ### writeFile(filename, [options], callback)
 
-`options`: Pass in any `fs.writeFile` options or set `replacer` for a [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify).
+`options`: Pass in any `fs.writeFile` options or set `replacer` for a [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify). Can also pass in `spaces`.
 
 
 ```js
@@ -70,10 +70,23 @@ jf.writeFile(file, obj, function(err) {
 })
 ```
 
+**formatting with spaces:**
+
+```js
+var jf = require('jsonfile')
+
+var file = '/tmp/data.json'
+var obj = {name: 'JP'}
+
+jf.writeFile(file, obj, {spaces: 2}, function(err) {
+  console.log(err)
+})
+```
+
 
 ### writeFileSync(filename, [options])
 
-`options`: Pass in any `fs.writeFileSync` options or set `replacer` for a [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify).
+`options`: Pass in any `fs.writeFileSync` options or set `replacer` for a [JSON replacer](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify). Can also pass in `spaces`.
 
 ```js
 var jf = require('jsonfile')
@@ -84,10 +97,22 @@ var obj = {name: 'JP'}
 jf.writeFileSync(file, obj)
 ```
 
+**formatting with spaces:**
+
+```js
+var jf = require('jsonfile')
+
+var file = '/tmp/data.json'
+var obj = {name: 'JP'}
+
+jf.writeFileSync(file, obj, {spaces: 2})
+```
+
+
 
 ### spaces
 
-Number of spaces to indent JSON files.
+Global configuration to set spaces to indent JSON files.
 
 **default:** `null`
 
@@ -104,6 +129,28 @@ jf.writeFile(file, obj, function(err) { //json file has four space indenting now
 })
 ```
 
+Note, it's bound to `this.spaces`. So, if you do this:
+
+```js
+var myObj = {}
+myObj.writeJsonSync = jf.writeFileSync
+// => this.spaces = null
+```
+
+Could do the following:
+
+```js
+var jf = require('jsonfile')
+jf.spaces = 4
+jf.writeFileSync(file, obj) // will have 4 spaces indentation
+
+var myCrazyObj = {spaces: 32}
+myCrazyObj.writeJsonSync = jf.writeFileSync
+myCrazyObj.writeJsonSync(file, obj) // will have 32 space indentation
+myCrazyObj.writeJsonSync(file, obj, {spaces: 2}) // will have only 2
+```
+
+
 
 Contributions
 -------------

index.js

@@ -42,12 +42,17 @@ function readFileSync (file, options) {
 function writeFile (file, obj, options, callback) {
   if (callback == null) {
     callback = options
-    options = {}
+    options = options || {}
   }
 
+  var spaces = options
+    ? 'spaces' in options
+    ? options.spaces : this.spaces
+    : this.spaces
+
   var str = ''
   try {
-    str = JSON.stringify(obj, options ? options.replacer : null, this.spaces) + '\n'
+    str = JSON.stringify(obj, options ? options.replacer : null, spaces) + '\n'
   } catch (err) {
     if (callback) return callback(err, null)
   }
@@ -57,7 +62,8 @@ function writeFile (file, obj, options, callback) {
 
 function writeFileSync (file, obj, options) {
   options = options || {}
-  var str = JSON.stringify(obj, options.replacer, this.spaces) + '\n'
+  var spaces = 'spaces' in options ? options.spaces : this.spaces
+  var str = JSON.stringify(obj, options.replacer, spaces) + '\n'
   // not sure if fs.writeFileSync returns anything, but just in case
   return fs.writeFileSync(file, str, options)
 }

test.js

@@ -238,6 +238,19 @@ describe('jsonfile', function () {
         })
       })
     })
+
+    describe('> when spaces passed as an option', function () {
+      it('should write file with spaces', function (done) {
+        var file = path.join(TEST_DIR, 'somefile.json')
+        var obj = { name: 'jp' }
+        jf.writeFile(file, obj, {spaces: 8}, function (err) {
+          assert.ifError(err)
+          var data = fs.readFileSync(file, 'utf8')
+          assert.strictEqual(data, JSON.stringify(obj, null, 8) + '\n')
+          done()
+        })
+      })
+    })
   })
 
   describe('+ writeFileSync()', function () {
@@ -289,6 +302,16 @@ describe('jsonfile', function () {
         assert.strictEqual(data.reg, 'regex:/hello/g')
       })
     })
+
+    describe('> when spaces passed as an option', function () {
+      it('should write file with spaces', function () {
+        var file = path.join(TEST_DIR, 'somefile.json')
+        var obj = { name: 'JP' }
+        jf.writeFileSync(file, obj, {spaces: 8})
+        var data = fs.readFileSync(file, 'utf8')
+        assert.strictEqual(data, JSON.stringify(obj, null, 8) + '\n')
+      })
+    })
   })
 
   describe('spaces', function () {