convert-csv-to-json 1.5.0 → 2.0.0

package/.github/workflows/nodejs.yml

@@ -9,7 +9,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [12.x, 14.x, 16.x, 18.x]
 
     steps:
     - uses: actions/checkout@v3

package/.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="PREFERRED_PROJECT_CODE_STYLE" value="Default" />
+  </state>
+</component>

package/.idea/csv-plugin.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="CsvFileAttributes">
+    <option name="attributeMap">
+      <map>
+        <entry key="/test/resource/input.csv">
+          <value>
+            <Attribute>
+              <option name="separator" value=";" />
+            </Attribute>
+          </value>
+        </entry>
+        <entry key="/test/resource/input_example.csv">
+          <value>
+            <Attribute>
+              <option name="separator" value=";" />
+            </Attribute>
+          </value>
+        </entry>
+        <entry key="/test/resource/input_example_sub_array.csv">
+          <value>
+            <Attribute>
+              <option name="separator" value=";" />
+            </Attribute>
+          </value>
+        </entry>
+        <entry key="/test/resource/input_quoted_fields.csv">
+          <value>
+            <Attribute>
+              <option name="separator" value="," />
+            </Attribute>
+          </value>
+        </entry>
+        <entry key="/test/resource/input_quoted_fields_with_subarray.csv">
+          <value>
+            <Attribute>
+              <option name="separator" value="," />
+            </Attribute>
+          </value>
+        </entry>
+        <entry key="/test/resource/input_tilde_delimiter.csv">
+          <value>
+            <Attribute>
+              <option name="separator" value="," />
+            </Attribute>
+          </value>
+        </entry>
+      </map>
+    </option>
+  </component>
+</project>

package/README.md

@@ -23,6 +23,7 @@
     + [Generate Array of Object in JSON format](#generate-array-of-object-in-json-format)
     + [Generate Object with sub array](#generate-object-with-sub-array)
     + [Define field delimiter](#define-field-delimiter)
+    + [Support Quoted Fields](#support-quoted-fields)
     + [Index header](#index-header)
     + [Empty rows](#empty-rows)
     + [Format property value by type](#format-property-value-by-type)
@@ -150,6 +151,30 @@ E.g. if your field delimiter is the comma **,** then:
  csvToJson.fieldDelimiter(',').getJsonFromCsv(fileInputName);
 ```
 
+#### Support Quoted Fields
+To be able to parse correctly fields wrapped in quote, like the **last_name** in the first row in the following example:
+
+|first_name|         last_name          |email|
+|:----------:|:--------------------------:|:---:|
+|Constantin| "Langsdon,Nandson,Gangson" |clangsdon0@hc360.com|
+
+you need to activate the support quoted fields feature: 
+
+```js
+ csvToJson.supportQuotedField(true).getJsonFromCsv(fileInputName);
+```
+
+The result will be:
+```json
+[
+  {
+      "firstName": "Constantin",
+      "lastName": "Langsdon,Nandson,Gangson",
+      "email": "clangsdon0@hc360.com"
+    }
+]
+``` 
+
 #### Index header
 If the header is not on the first line you can define the header index like: 
 

package/index.js

@@ -20,6 +20,13 @@ exports.formatValueByType = function (active = true) {
   return this;
 };
 
+/**
+ *
+ */
+exports.supportQuotedField = function (active = false) {
+  csvToJson.supportQuotedField(active);
+  return this;
+};
 /**
  * Defines the field delimiter which will be used to split the fields
  */

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "convert-csv-to-json",
-  "version": "1.5.0",
+  "version": "2.0.0",
   "description": "Convert CSV to JSON",
   "main": "index.js",
   "scripts": {
-    "test": "./node_modules/.bin/mocha --reporter spec",
+    "test": "./node_modules/.bin/mocha --parallel --reporter spec",
     "test-watch": "./node_modules/.bin/mocha -w"
   },
   "repository": {

package/src/csvToJson.js

@@ -14,6 +14,11 @@ class CsvToJson {
     return this;
   }
 
+  supportQuotedField(active) {
+    this.isSupportQuotedField = active;
+    return this;
+  }
+
   fieldDelimiter(delimiter) {
     this.delimiter = delimiter;
     return this;
@@ -60,6 +65,7 @@ class CsvToJson {
   }
 
   csvToJson(parsedCsv) {
+  	this.validateInputConfig();
     let lines = parsedCsv.split(newLine);
     let fieldDelimiter = this.getFieldDelimiter();
     let index = this.getIndexHeader();
@@ -72,11 +78,17 @@ class CsvToJson {
 
     let jsonResult = [];
     for (let i = (index + 1); i < lines.length; i++) {
-      let currentLine = lines[i].split(fieldDelimiter);
-      if (stringUtils.hasContent(currentLine)) {
-        jsonResult.push(this.buildJsonResult(headers, currentLine));
-      }
-    }
+        let currentLine;
+        if(this.isSupportQuotedField){
+            currentLine = this.split(lines[i]);
+        }
+        else{
+            currentLine = lines[i].split(fieldDelimiter);
+        }
+        if (stringUtils.hasContent(currentLine)) {
+            jsonResult.push(this.buildJsonResult(headers, currentLine));
+        }
+       }
     return jsonResult;
   }
 
@@ -137,6 +149,76 @@ class CsvToJson {
     return false;
   }
 
+  validateInputConfig(){
+  	if(this.isSupportQuotedField) {
+  	 	if(this.getFieldDelimiter() === '"'){
+  	 		throw new Error('When SupportQuotedFields is enabled you cannot defined the field delimiter as quote -> ["]');
+  	 	}
+  	 	if(this.parseSubArraySeparator === '"'){
+  	 		throw new Error('When SupportQuotedFields is enabled you cannot defined the field parseSubArraySeparator as quote -> ["]');
+  	 	}
+  	 	if(this.parseSubArrayDelimiter === '"'){
+  	 		throw new Error('When SupportQuotedFields is enabled you cannot defined the field parseSubArrayDelimiter as quote -> ["]');
+  	 	}
+  	}
+  }
+
+  hasQuotes(line) {
+    return line.includes('"');
+  }
+
+  split(line) {
+    if(line.length == 0){
+      return [];
+    }
+    let delim = this.getFieldDelimiter();
+    let subSplits = [''];
+    if (this.hasQuotes(line)) {
+        let chars = line.split('');
+
+        let subIndex = 0;
+        let startQuote = false;
+        let isDouble = false;
+        chars.forEach((c, i, arr) => {
+            if (isDouble) { //when run into double just pop it into current and move on
+                subSplits[subIndex] += c;
+                isDouble = false;
+                return;
+            }
+
+            if (c != '"' && c != delim ) {
+                subSplits[subIndex] += c;
+            } else if(c == delim && startQuote){
+                subSplits[subIndex] += c;
+            } else if( c == delim ){
+                subIndex++
+                subSplits[subIndex] = '';
+                return;
+            } else {
+                if (arr[i + 1] === '"') {
+                    //Double quote
+                    isDouble = true;
+                    //subSplits[subIndex] += c; //Skip because this is escaped quote
+                } else {
+                    if (!startQuote) {
+                        startQuote = true;
+                        //subSplits[subIndex] += c; //Skip because we don't want quotes wrapping value
+                    } else {
+                        //end
+                        startQuote = false;
+                        //subSplits[subIndex] += c; //Skip because we don't want quotes wrapping value
+                    }
+                }
+            }
+        });
+        if(startQuote){
+            throw new Error('Row contains mismatched quotes!');
+        }
+        return subSplits;
+    } else {
+        return line.split(delim);
+    }
+  }
 }
 
 module.exports = new CsvToJson();