feature(writejson) add support of writeFile options

Author: coderaiser

.travis.yml

@@ -1,8 +1,7 @@
 language: node_js
 node_js:
-    - 4
-    - 6
     - 8
+    - 10
 
 script:
   - npm run lint
@@ -14,3 +13,4 @@ notifications:
         on_failure: change
 
 sudo: false
+

README.md

@@ -24,9 +24,12 @@ writejson('data.json', {hello: 'world'}, (error) => {
 });
 
 const options = {
-    replacer: ['hello'],// properties to put in json
-    space: 4            // default space count
-    eof: true           // default new line at end of file
+    replacer: ['hello'],    // properties to put in json
+    space: 4,               // default space count
+    eof: true,              // default new line at end of file
+    encoding: 'utf8',       // default
+    mode: '0o666',          // default
+    flag: 'w',              // default
 };
 
 writejson('data.json', {hello: 'world'}, options, (error) => {

lib/writejson.js

@@ -3,6 +3,12 @@
 const fs = require('fs');
 const tryCatch = require('try-catch');
 
+const getWriteOptions = (options) => ({
+    encoding: options.encoding,
+    mode: options.mode,
+    flag: options.flag,
+});
+
 module.exports = (name, json, options, callback) => {
     if (!callback) {
         callback = options;
@@ -13,16 +19,19 @@ module.exports = (name, json, options, callback) => {
     checkCB(callback);
 
     const str = stringify(json, options);
-    fs.writeFile(name, str, callback);
+    const writeOptions = getWriteOptions(options);
+    
+    fs.writeFile(name, str, writeOptions, callback);
 };
 
 module.exports.sync = sync;
 
 function sync(name, data, options) {
-    options = options || {};
-    
+    options = options || {}; 
     check(name, data, options);
-    fs.writeFileSync(name, stringify(data, options));
+    
+    const writeOptions = getWriteOptions(options);
+    fs.writeFileSync(name, stringify(data, options), writeOptions);
 }
 
 module.exports.sync.try = (name, data, options) => {

package.json

@@ -30,11 +30,13 @@
   },
   "devDependencies": {
     "coveralls": "^3.0.0",
+    "es6-promisify": "^6.0.0",
     "eslint": "^4.19.1",
     "eslint-plugin-node": "^6.0.1",
     "nyc": "^12.0.2",
     "redrun": "^6.0.0",
-    "tape": "^4.2.2"
+    "tape": "^4.2.2",
+    "try-to-catch": "^1.0.2"
   },
   "engines": {
     "node": ">=4.0.0"

test/writejson.js

@@ -4,7 +4,11 @@ const os = require('os');
 const path = require('path');
 const fs = require('fs');
 const test = require('tape');
+const {promisify} = require('es6-promisify');
+const tryToCatch = require('try-to-catch');
+
 const writejson = require('..');
+const _writejson = promisify(writejson);
 
 const tmp = os.tmpdir();
 const NAME = path.join(tmp, String(Math.random()));
@@ -21,7 +25,7 @@ test('writejson: should write json data to file', (t) => {
             t.notOk(error, 'no read error');
             t.deepEqual(json, JSON.parse(data), 'data should be equal');
 
-            fs.unlink(NAME, error => {
+            fs.unlink(NAME, (error) => {
                 t.notOk(error, 'no remove error');
                 t.end();
             });
@@ -51,7 +55,7 @@ test('writejson: should write json data to file with options', (t) => {
             t.equal(resultStr, data, 'data should be equal');
             t.deepEqual(JSON.parse(data), result, 'objects should be equal');
 
-            fs.unlink(NAME, error => {
+            fs.unlink(NAME, (error) => {
                 t.notOk(error, 'no remove error');
                 t.end();
             });
@@ -60,7 +64,7 @@ test('writejson: should write json data to file with options', (t) => {
 });
 
 test('writejson: should write json data to file with default options', (t) => {
-    const resultStr = JSON.stringify(json, null, 4) + '\n'
+    const resultStr = JSON.stringify(json, null, 4) + '\n';
 
     writejson(NAME, json, error => {
         t.notOk(error, 'no write error');
@@ -71,7 +75,7 @@ test('writejson: should write json data to file with default options', (t) => {
             t.equal(resultStr, data, 'data should be equal');
             t.deepEqual(JSON.parse(data), json, 'objects should be equal');
 
-            fs.unlink(NAME, error => {
+            fs.unlink(NAME, (error) => {
                 t.notOk(error, 'no remove error');
                 t.end();
             });
@@ -80,12 +84,32 @@ test('writejson: should write json data to file with default options', (t) => {
 });
 
 test('writejson: write error', (t) => {
-    writejson('/hello.json', json, error => {
+    writejson('/hello.json', json, (error) => {
         t.ok(error, 'should return error: ' + error.message);
         t.end();
     });
 });
 
+test('writejson: write options', async (t) => {
+    const json = {
+        hello: 'world',
+    };
+    
+    const options = {
+        mode: 0o600
+    };
+    
+    await tryToCatch(_writejson, NAME, json, options);
+    
+    const {mode} = fs.statSync(NAME);
+    const expected = Number(mode).toString(8).slice(3);
+    
+    fs.unlinkSync(NAME);
+    
+    t.equal(expected, '600', 'should equal');
+    t.end();
+});
+
 test('writejson.sync.try: write error', (t) => {
     const error = writejson.sync.try('/hello.json', json);
 
@@ -100,14 +124,14 @@ test('writejson: no args', (t) => {
 
 test('writejson: no json', (t) => {
     const fn = () => writejson('hello');
-
+    
     t.throws(fn, /json should be object!/, 'json check');
     t.end();
 });
 
 test('writejson: options not object', (t) => {
     const fn = () => writejson('hello', {}, 'options', () => {});
-
+    
     t.throws(fn, /options should be object!/, 'options check');
     t.end();
 });