convert-csv-to-json 1.5.0 → 2.1.0

package/.github/workflows/codeql-analysis.yml

@@ -35,11 +35,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -50,7 +50,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -64,4 +64,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3

package/.github/workflows/nodejs.yml

@@ -9,12 +9,12 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [12.x, 14.x, 16.x]
+        node-version: [14.x, 16.x, 18.x, 20.x, 21.x]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
     - name: npm install, build, and test

package/.vscode/launch.json

@@ -0,0 +1,24 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch Chrome",
+            "request": "launch",
+            "type": "chrome",
+            "url": "http://localhost:8080",
+            "webRoot": "${workspaceFolder}"
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/index.js"
+        }
+    ]
+}

package/README.md

@@ -4,7 +4,7 @@
 [![Known Vulnerabilities](https://snyk.io/test/github/iuccio/csvToJson/badge.svg)](https://snyk.io/test/github/iuccio/csvToJson)
 [![Code Climate](https://codeclimate.com/github/iuccio/csvToJson/badges/gpa.svg)](https://codeclimate.com/github/iuccio/csvToJson)
 [![NPM Version](https://img.shields.io/npm/v/convert-csv-to-json.svg)](https://npmjs.org/package/convert-csv-to-json)
-![NodeJS Version](https://img.shields.io/badge/nodeJS-%3E=12.x-brightgreen.svg)
+![NodeJS Version](https://img.shields.io/badge/nodeJS-%3E=14.x-brightgreen.svg)
 [![Downloads](https://img.shields.io/npm/dm/convert-csv-to-json.svg)](https://npmjs.org/package/convert-csv-to-json)
 
 **This project is not dependent on others packages or libraries.**
@@ -23,12 +23,14 @@
     + [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)
       - [Number](#number)
       - [Boolean](#boolean)
     + [Encoding](#encoding)
+  * [Chaining Pattern](#chaining-pattern)
 - [Development](#development)
 - [License](#license)
 - [Buy me a Coffee](#buy-me-a-coffee)
@@ -95,6 +97,7 @@ $ npm install -g convert-csv-to-json
 ```
 
 ### Usage
+
 #### Generate JSON file
 ```js
 let csvToJson = require('convert-csv-to-json');
@@ -123,7 +126,8 @@ Given the above CSV example, to generate a JSON Object with properties that cont
 with the values <b>*diego,marek,dries*</b> you have to call the function ```parseSubArray(delimiter, separator)``` .
 To generate the JSON Object with sub array from the above CSV example:
 ```js
-    csvToJson.parseSubArray('*',',').getJsonFromCsv('myInputFile.csv');
+    csvToJson.parseSubArray('*',',')
+                .getJsonFromCsv('myInputFile.csv');
 ``` 
 The result will be:
 ```json
@@ -147,14 +151,41 @@ In case your CSV file has defined another field delimiter you have to call the f
 E.g. if your field delimiter is the comma **,** then:
 
 ```js
- csvToJson.fieldDelimiter(',').getJsonFromCsv(fileInputName);
+ 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: 
 
 ```js
- csvToJson.indexHeader(3).getJsonFromCsv(fileInputName);
+ csvToJson.indexHeader(3)
+            .getJsonFromCsv(fileInputName);
 ```
 
 #### Empty rows
@@ -163,7 +194,8 @@ Empty rows are ignored and not parsed.
 #### Format property value by type
 If you want that a number will be printed as a Number type, and values *true* or *false* is printed as a boolean Type, use:
 ```js
- csvToJson.formatValueByType().getJsonFromCsv(fileInputName);
+ csvToJson.formatValueByType()
+            .getJsonFromCsv(fileInputName);
 ```
 For example: 
 
@@ -212,33 +244,56 @@ instead of
 You can read and decode files with the following encoding:
  * utf8: 
     ```js
-     csvToJson.utf8Encoding().getJsonFromCsv(fileInputName);
+     csvToJson.utf8Encoding()
+                .getJsonFromCsv(fileInputName);
     ```
  * ucs2:
     ```js
-      csvToJson.ucs2Encoding().getJsonFromCsv(fileInputName);
+      csvToJson.ucs2Encoding()
+                .getJsonFromCsv(fileInputName);
      ```
  * utf16le:
      ```js
-       csvToJson.utf16leEncoding().getJsonFromCsv(fileInputName);
+       csvToJson.utf16leEncoding()
+                  .getJsonFromCsv(fileInputName);
       ```
  * latin1:
      ```js
-       csvToJson.latin1Encoding().getJsonFromCsv(fileInputName);
+       csvToJson.latin1Encoding()
+                  .getJsonFromCsv(fileInputName);
       ```
  * ascii:
      ```js
-       csvToJson.asciiEncoding().getJsonFromCsv(fileInputName);
+       csvToJson.asciiEncoding()
+                  .getJsonFromCsv(fileInputName);
       ```
  * base64:
      ```js
-       csvToJson.base64Encoding().getJsonFromCsv(fileInputName);
+       csvToJson.base64Encoding()
+                  .getJsonFromCsv(fileInputName);
       ```
  * hex:
      ```js
-       csvToJson.hexEncoding().getJsonFromCsv(fileInputName);
+       csvToJson.hexEncoding()
+                  .getJsonFromCsv(fileInputName);
       ```
 
+### Chaining Pattern
+
+The exposed API is implemented with the [Method Chaining Pattern](https://en.wikipedia.org/wiki/Method_chaining), which means that multiple methods can be chained, e.g.:
+
+```js
+let csvToJson = require('convert-csv-to-json');
+
+csvToJson.fieldDelimiter(',')
+            .formatValueByType()
+            .parseSubArray("*",',')
+            .supportQuotedField(true)
+            .getJsonFromCsv('myInputFile.csv');
+
+```
+
+
 ## Development
 * Download all csvToJson dependencies:
     ~~~
@@ -248,9 +303,9 @@ You can read and decode files with the following encoding:
     ~~~
     npm test
     ~~~
-* Watch Tests
+* Debug Tests
     ~~~
-    npm run test-watch
+    npm run test-debug
     ~~~
 
 ## License
@@ -258,4 +313,5 @@ CSVtoJSON is licensed under the GNU General Public License v3.0 [License](LICENS
 
 ## Buy me a Coffee	
 Just if you want to support this repository:	
-   * **BTC** tip address: 3KCCK292a61AHrKuVCFZ8Agr3j31Zw8Mzg
+   * **BTC** tip address: 
+37vdjQhbaR7k7XzhMKWzMcnqUxfw1njBNk

package/SECURITY.md

@@ -14,6 +14,7 @@ A generated Github Depedabot PR is normally quickly merged and a new version is
 
 | Version | Supported          |
 | ------- | ------------------ |
+| 2.0.0   | :white_check_mark: |
 | 1.4.0   | :white_check_mark: |
 | 1.3.3   | :white_check_mark: |
 | 1.3.2   | :white_check_mark: |      
@@ -22,6 +23,7 @@ A generated Github Depedabot PR is normally quickly merged and a new version is
 
 | Version | Supported          |
 | ------- | ------------------ |
+| 2.0.0   | :white_check_mark: |
 | 1.4.0   | :white_check_mark: |
 | 1.3.3   | :warning: moderate dev dependencies vulnerability|
 | 1.3.2   | :warning: moderate dev dependencies vulnerability|  

package/coverage/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}

package/coverage/block-navigation.js

@@ -0,0 +1,87 @@
+/* eslint-disable */
+var jumpToCode = (function init() {
+    // Classes of code we would like to highlight in the file view
+    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
+
+    // Elements to highlight in the file listing view
+    var fileListingElements = ['td.pct.low'];
+
+    // We don't want to select elements that are direct descendants of another match
+    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
+
+    // Selecter that finds elements on the page to which we can jump
+    var selector =
+        fileListingElements.join(', ') +
+        ', ' +
+        notSelector +
+        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
+
+    // The NodeList of matching elements
+    var missingCoverageElements = document.querySelectorAll(selector);
+
+    var currentIndex;
+
+    function toggleClass(index) {
+        missingCoverageElements
+            .item(currentIndex)
+            .classList.remove('highlighted');
+        missingCoverageElements.item(index).classList.add('highlighted');
+    }
+
+    function makeCurrent(index) {
+        toggleClass(index);
+        currentIndex = index;
+        missingCoverageElements.item(index).scrollIntoView({
+            behavior: 'smooth',
+            block: 'center',
+            inline: 'center'
+        });
+    }
+
+    function goToPrevious() {
+        var nextIndex = 0;
+        if (typeof currentIndex !== 'number' || currentIndex === 0) {
+            nextIndex = missingCoverageElements.length - 1;
+        } else if (missingCoverageElements.length > 1) {
+            nextIndex = currentIndex - 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    function goToNext() {
+        var nextIndex = 0;
+
+        if (
+            typeof currentIndex === 'number' &&
+            currentIndex < missingCoverageElements.length - 1
+        ) {
+            nextIndex = currentIndex + 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    return function jump(event) {
+        if (
+            document.getElementById('fileSearch') === document.activeElement &&
+            document.activeElement != null
+        ) {
+            // if we're currently focused on the search input, we don't want to navigate
+            return;
+        }
+
+        switch (event.which) {
+            case 78: // n
+            case 74: // j
+                goToNext();
+                break;
+            case 66: // b
+            case 75: // k
+            case 80: // p
+                goToPrevious();
+                break;
+        }
+    };
+})();
+window.addEventListener('keydown', jumpToCode);