feature(writejson) add options

Author: coderaiser

README.md

@@ -8,6 +8,12 @@ Write stringified object to file.
 npm i writejson --save
 ```
 ## How to use?
+To handle formating optional argument `options` could be used accroding to [JSON.stringify][StringifyURL].
+
+### API
+
+#### writejson(name, object, [ options, ] callback)
+Asynchonouse write stringified object.
 
 ```js
 var writejson = require('writejson');
@@ -17,19 +23,41 @@ writejson('data.json', {hello: 'world'}, function(error) {
         console.error(error.message);
 });
 
+var options = {
+    replacer: ['hello'],// properties to put in json
+    space: 4            // default space count
+    eof: true           // default new line at end of file
+};
+
+writejson('data.json', {hello: 'world'}, options, function(error) {
+    if (error)
+        console.error(error.message);
+});
+
+```
+#### writejson.sync(name, object [, options])
+Synchonouse write stringified object.
+
+```js
 try {
     writejson.sync('data.json', {hello: 'world'});
 } catch(error) {
     console.log(error.message);
 }
+```
+
+#### writejson.sync.try(name, object [, options])
+Synchonouse try to write stringified object.
 
+```js
 writejson.sync.try('data.json', {hello: 'world'});
 ```
 
 ## License
 
 MIT
 
+[StringifyURL]:           https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
 [NPMIMGURL]:                https://img.shields.io/npm/v/writejson.svg?style=flat
 [BuildStatusIMGURL]:        https://img.shields.io/travis/coderaiser/node-writejson/master.svg?style=flat
 [DependencyStatusIMGURL]:   https://img.shields.io/gemnasium/coderaiser/node-writejson.svg?style=flat

lib/writejson.js

@@ -3,13 +3,18 @@
 var fs          = require('fs'),
     tryCatch    = require('try-catch');
 
-module.exports = function(name, json, callback) {
-    check(name, json);
+module.exports = function(name, json, options, callback) {
+    if (!callback) {
+        callback = options;
+        options = {};
+    }
+    
+    check(name, json, options);
     checkCB(callback);
 
     var str,
         error = tryCatch(function() {
-            str = JSON.stringify(json);
+            str = stringify(json, options);
         });
 
     if (error)
@@ -20,27 +25,56 @@ module.exports = function(name, json, callback) {
 
 module.exports.sync = sync;
 
-function sync(name, data) {
-    check(name, data);
-    fs.writeFileSync(name, JSON.stringify(data));
+function sync(name, data, options) {
+    options = options || {};
+    
+    check(name, data, options);
+    fs.writeFileSync(name, stringify(data, options));
 }
 
-module.exports.sync.try = function(name, data) {
-    check(name, data);
+module.exports.sync.try = function(name, data, options) {
+    options = options || {};
+    check(name, data, options);
 
     var error = tryCatch(function() {
-        sync(name, data);
+        sync(name, data, options);
     });
 
     return error;
 };
 
-function check(name, json) {
+function defaultOptions(options) {
+    if (typeof options.space === 'undefined')
+        options.space = 4;
+    
+    if (typeof options.eof === 'undefined')
+        options.eof = true;
+    
+    return options;
+}
+
+function stringify(data, options) {
+    var result;
+    
+    defaultOptions(options);
+    
+    result = JSON.stringify(data, options.replacer, options.space);
+    
+    if (options.eof)
+        result += '\n';
+    
+    return result;
+}
+
+function check(name, json, options) {
     if (typeof name !== 'string')
         throw Error('name should be string!');
 
     if (typeof json !== 'object')
         throw Error('json should be object!');
+
+    if (typeof options !== 'object')
+        throw Error('options should be object!');
 }
 
 function checkCB(callback) {

test/writejson.js

@@ -9,7 +9,8 @@ let writejson   = require('..');
 const tmp = os.tmpdir();
 const NAME = path.join(tmp, String(Math.random()));
 const json = {
-    hello: 'world'
+    hello: 'world',
+    bye: 'sword'
 };
 
 test('writejson: should write json data to file', t => {
@@ -28,6 +29,57 @@ test('writejson: should write json data to file', t => {
     });
 });
 
+test('writejson: should write json data to file with options', t => {
+    let result = {
+        hello: 'world'
+    };
+    
+    let options = {
+        replacer: ['hello'],
+        space: 2,
+        eof: false
+    };
+    
+    let resultStr = JSON.stringify(json, options.replacer, options.space);
+    
+    writejson(NAME, json, options, error => {
+        t.notOk(error, 'no write error');
+         
+        fs.readFile(NAME, 'utf8', (error, data) => {
+            t.notOk(error, 'no read error');
+            
+            t.equal(resultStr, data, 'data should be equal');
+            t.deepEqual(JSON.parse(data), result, 'objects should be equal');
+            
+            fs.unlink(NAME, error => {
+                t.notOk(error, 'no remove error');
+                t.end();
+            });
+        });
+    });
+});
+
+test('writejson: should write json data to file with default options', t => {
+    let resultStr = JSON.stringify(json, null, 4);
+    resultStr += '\n';
+    
+    writejson(NAME, json, error => {
+        t.notOk(error, 'no write error');
+         
+        fs.readFile(NAME, 'utf8', (error, data) => {
+            t.notOk(error, 'no read error');
+            
+            t.equal(resultStr, data, 'data should be equal');
+            t.deepEqual(JSON.parse(data), json, 'objects should be equal');
+            
+            fs.unlink(NAME, error => {
+                t.notOk(error, 'no remove error');
+                t.end();
+            });
+        });
+    });
+});
+
 test('writejson: no args', t => {
     t.throws(writejson, /name should be string!/, 'NAME check');
     t.end();
@@ -40,6 +92,13 @@ test('writejson: no json', t => {
     t.end();
 });
 
+test('writejson: options not object', t => {
+    let fn = () => writejson('hello', {}, 'options', () => {});
+
+    t.throws(fn, /options should be object!/, 'options check');
+    t.end();
+});
+
 test('writejson: no callback', t => {
     let fn = () => writejson('hello', [1,2,3]);