Fix parser as npm module. Add config tests

Author: irodger

Readme.md

@@ -14,6 +14,7 @@ xlsx to JSON parser. Also support i18next format. Relies on node-xlsx.
 ### Yep, it can append new files to exist now! *Cheers* 😎
 
 ### What's new
+* v.0.3.0 - Add config tests. Fix parser. Now it's work as NPM module correctly
 * v.0.2.5 - Codystyle fixes
 * v.0.2.4 - Remove async write file & some refactoring
 * v.0.2.3 - Add author's contacts

__tests__/test.json

@@ -1,9 +1,8 @@
-
-    {
-      "en": {
-        "translations": {
-          "three": "three",
-          "two": "two"
-        }
-      }
-    }
+{
+  "en": {
+    "translations": {
+      "three": "three",
+      "two": "two"
+    }
+  }
+}

__tests__/tests.js

@@ -1,14 +1,16 @@
 const getValuesFromArray = require('../utils/getValuesFromArray');
 const getValuesFromFile = require('../utils/getValuesFromFile');
 const recursiveSearchValues = require('../utils/recursiveSearchValues');
-const path = require('path');
+const getConfig = require('../utils/getConfig');
+const path = process.cwd() + '/';
+
 const mockArray = [
   ['one', 'two'],
   ['two', 4],
   ['three', true]
 ];
 
-const file = path.resolve(__dirname, 'test.json');
+const file = path + '__tests__/test.json';
 const mockObject = {
   "one":
     {
@@ -30,26 +32,50 @@ const emptyObj = {};
 
 describe('getValuesFromArray', () => {
   it('getValuesFromArray converting array to Object', () => {
-    expect(getValuesFromArray(mockArray, 2)).toEqual(mockObject)
+    expect(getValuesFromArray(mockArray, 2)).toEqual(mockObject);
   });
 
   it('getValuesFromFile get values from json and return Object', () => {
-    expect(getValuesFromFile(file)).toEqual(mockSecondObj)
+    expect(getValuesFromFile(file)).toEqual(mockSecondObj);
+  });
+
+  it('getValuesFromFile without correct file return false', () => {
+    expect(getValuesFromFile('/fake/' + file)).toEqual(false);
   });
 
   it('getValuesFromFile return error when file not found', () => {
-    expect(getValuesFromFile('test.json')).toEqual(false)
+    expect(getValuesFromFile('test.json')).toEqual(false);
   });
 
   it('recursiveSearchValues return Array or Object with only first deepest childs', () => {
-    expect(recursiveSearchValues(mockObject)).toEqual(mockSecondObj)
+    expect(recursiveSearchValues(mockObject)).toEqual(mockSecondObj);
   });
 
   it('recursiveSearchValues return deepest children value' , () => {
-    expect(recursiveSearchValues(mockSecondObj)).toEqual("three")
-  })
+    expect(recursiveSearchValues(mockSecondObj)).toEqual("three");
+  });
+
+  it('recursiveSearchValues with empty object return undefined' , () => {
+    expect(recursiveSearchValues(emptyObj)).toEqual(undefined);
+  });
+
+  it('is getConfig still object', () => {
+    expect(typeof getConfig === 'object').toEqual(true);
+  });
 
-  it('recursiveSearchValues return empty obj' , () => {
-    expect(recursiveSearchValues(emptyObj)).toEqual(undefined)
-  })
+  it('getConfig contains json dir', () => {
+    expect(getConfig.jsonDir).toEqual(path + 'json/');
+  });
+
+  it('getConfig contains xlsx dir', () => {
+    expect(getConfig.xlsxDir).toEqual(path + 'xlsx/');
+  });
+
+  it('getConfig contains withFilenames argument', () => {
+    expect(getConfig.withFilenames).toEqual(false);
+  });
+
+  it('getConfig contains listNumber argument', () => {
+    expect(getConfig.listNumber).toEqual(1);
+  });
 });

index.js

@@ -1,61 +1,45 @@
 const xlsx = require('node-xlsx');
 const fs = require('fs');
-const path = require('path');
 const getValuesFromFile = require('./utils/getValuesFromFile');
 const getValuesFromArray = require('./utils/getValuesFromArray');
-const config = fs.existsSync(path.resolve(__dirname, './../../xlsx-json-parser.config.js')) ? require('../../xlsx-json-parser.config.js') : require('./xlsx-json-parser.config.js');
-let listNumber = config.listNumber;
-let withFilenames = config.withFilenames;
-let xlsxDir = config.xlsxDir;
-let jsonDir = config.jsonDir;
-
-/**
- * Get arguments from command line
- * >node index listNumber xlsxDir jsonDir --wfn
- */
-process.argv.forEach(function (val) {
-  listNumber = val.includes('--ln=') ? parseInt(val.split('=')[1]) : config.listNumber;
-  withFilenames = val.includes('--wfn') ? val : config.withFilenames;
-  xlsxDir = val.includes('--xlsx=') ? val.split('=')[1] : config.xlsxDir;
-  jsonDir = val.includes('--json=') ? val.split('=')[1] : config.jsonDir;
-});
+const config = require('./utils/getConfig');
 
 /**
  * Close app when folder with xlsx not found
  */
-if (!fs.existsSync(xlsxDir)) {
-  console.log(`Folder ${xlsxDir} with xlsx files doesn't exist. Checking your config file or directory.`);
+if (!fs.existsSync(config.xlsxDir)) {
+  console.log(`Folder ${config.xlsxDir} with Excel files doesn't exist. Checking your config file or directory.`);
   process.exit();
 }
 
 /**
  * Creating json directory if doesn't exist
  */
 try {
-  fs.mkdirSync(jsonDir);
+  fs.mkdirSync(config.jsonDir);
 } catch(err) {
-  console.log(`Directory ${jsonDir} already exist. And it's okay.`);
+  // No need to do something
 }
 
-fs.readdir(xlsxDir, (err, files) => {
+fs.readdir(config.xlsxDir, (err, files) => {
   files.forEach(file => {
     if (file.toString().includes('.xls')) {
       const filename = file.replace(/((.xlsx)|(.xls))/g, '');
-      const excelArray = xlsx.parse(`./${xlsxDir}/${file}`);
+      const excelArray = xlsx.parse(`${config.xlsxDir + file}`);
 
       const list = (listNumber) => {
         return typeof excelArray[listNumber - 1] !== 'undefined' ? excelArray[listNumber - 1] : console.log('List empty');
       };
 
-      const currentList = list(listNumber);
+      const currentList = list(config.listNumber);
 
       if (typeof currentList !== 'undefined' && currentList.data.length > 0) {
         const langs = currentList.data[0];
         const langsCount = langs.length;
         const tt = getValuesFromArray(currentList.data, langsCount);
 
         for (let i = 0; i < langs.length; i++) {
-          const file = `${jsonDir}/${langs[i]}${withFilenames ? `_${filename}` : ''}.json`;
+          const file = `${config.jsonDir + langs[i]}${config.withFilenames ? `_${filename}` : ''}.json`;
           let valuesArr = tt[`${langs[i]}`];
           let valuesToWrite, status;
 
@@ -66,13 +50,13 @@ fs.readdir(xlsxDir, (err, files) => {
           try {
             fs.writeFileSync(file, valuesToWrite);
 
-            console.log(`${langs[i]}${withFilenames ? `_${filename}` : ''}.json was ${status} in ${jsonDir}`);
+            console.log(`${langs[i]}${config.withFilenames ? `_${filename}` : ''}.json was ${status} in ${config.jsonDir}`);
           } catch(err) {
             return console.log('Error: ' + err);
           }
         }
       } else {
-        return console.log('File ' + file + ' has no list ' + listNumber + '.\nTry another file or list.');
+        return console.log('File ' + file + ' has no list ' + config.listNumber + '.\nTry another file or list.');
       }
     }
   });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "xlsx-json-parser",
-  "version": "0.2.5",
+  "version": "0.3.0",
   "description": "Parse xls/xlsx to json. i18next format",
   "main": "index.js",
   "author": "Roman iRodger Dvoryanov <[email protected]> (http://irodger.ru)",

utils/getConfig.js

@@ -0,0 +1,32 @@
+let configFile;
+const selfConfig = require('../xlsx-json-parser.config.js');
+const path = process.cwd() + '/';
+
+try {
+  configFile = require(path + 'xlsx-json-parser.config.js');
+} catch(err) {
+  configFile = require('../xlsx-json-parser.config.js');
+}
+
+const config = {
+  listNumber: configFile.listNumber || selfConfig.listNumber,
+  withFilenames: configFile.withFilenames || selfConfig.withFilenames,
+  xlsxDir: path + (configFile.xlsxDir || selfConfig.xlsxDir) + '/',
+  jsonDir: path + (configFile.jsonDir || selfConfig.jsonDir) + '/',
+  fileTemplate(lang, template) {
+    return configFile.fileTemplate ? configFile.fileTemplate(lang, template) : selfConfig.fileTemplate(lang, template)
+  }
+};
+
+/**
+ * Get arguments from command line
+ * >node index listNumber xlsxDir jsonDir --wfn
+ */
+process.argv.forEach(function (val) {
+  config.listNumber = val.includes('--ln=') ? parseInt(val.split('=')[1]) : config.listNumber;
+  config.withFilenames = val.includes('--wfn') ? val : config.withFilenames;
+  config.xlsxDir = val.includes('--xlsx=') ? val.split('=')[1] : config.xlsxDir;
+  config.jsonDir = val.includes('--json=') ? val.split('=')[1] : config.jsonDir;
+});
+
+module.exports = config;

utils/getValuesFromFile.js

@@ -1,13 +1,11 @@
 const fs = require('fs');
-const path = require('path');
 const recursiveSearchValues = require('./recursiveSearchValues');
 
 /**
  * Get values from file
  * @param file
  */
 function getValuesFromFile(file) {
-  file = path.resolve(__dirname + '/..', file);
   let contents;
 
   try {

xlsx-json-parser.config.js

@@ -1,15 +1,14 @@
 const config = {
-  xlsxDir: './xlsx/',
-  jsonDir: './json/',
+  xlsxDir: 'xlsx',
+  jsonDir: 'json',
   listNumber: 1,
   withFilenames: false,
   fileTemplate(lang, array) {
-    return `
-    {
-      "${lang}": {
-        "translations": ${JSON.stringify(array)}
-      }
-    }`;
+    return `{
+  "${lang}": {
+    "translations": ${JSON.stringify(array)}
+  }
+}`;
   },
 };