convert-csv-to-json 1.3.3 → 1.5.0

package/.devcontainer/devcontainer.json

@@ -0,0 +1,19 @@
+{
+	"name": "Node.js",
+	"image": "mcr.microsoft.com/devcontainers/javascript-node:16-bullseye"
+
+	// Features to add to the dev container. More info: https://containers.dev/implementors/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "yarn install",
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: ''
+assignees: ''
+
+---
+
+## Expected Behavior
+
+
+## Actual Behavior
+
+
+## Steps to Reproduce the Problem
+
+  1.
+  1.
+  1.
+
+## Specifications
+
+  - Version:

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+Fixes #
+
+## Proposed Changes
+
+  -
+  -
+  -

package/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"

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

@@ -35,11 +35,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v1
+      uses: github/codeql-action/init@v2
       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@v1
+      uses: github/codeql-action/autobuild@v2
 
     # ℹ️ 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@v1
+      uses: github/codeql-action/analyze@v2

package/.github/workflows/nodejs.yml

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

package/README.md

@@ -1,29 +1,39 @@
 # CSVtoJSON 
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/iuccio/csvToJson/Node%20CI?label=Build)](https://github.com/iuccio/csvToJson/actions?query=workflow%3A%22Node+CI%22)
-[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/iuccio/csvToJson/CodeQL/master?label=CodeQL)](https://github.com/iuccio/csvToJson/actions?query=workflow%3ACodeQL)
+![Build](https://github.com/iuccio/csvToJson/actions/workflows/nodejs.yml/badge.svg)
+![CodeQL](https://github.com/iuccio/csvToJson/actions/workflows/codeql-analysis.yml/badge.svg)
+[![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)
 [![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.**
 
+
 ## Table of Contents
-1. [Description](#description)
-1. [Prerequisites](#prerequisites)
-1. [Install npm *convert-csv-to-json package*](#install-npm-convert-csv-to-json-package)
-1. [Usage](#usage)
-    * [Generate JSON file](#generate-json-file)
-    * [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)
-    * [Format property value by type](#format-property-value-by-type)
-        * [Number](#number)
-        * [Boolean](#boolean)
-    * [Encoding](#encoding)
-1. [Development](#development)
-1. [License](#license)
-1. [Buy me a Coffee](#buy-me-a-coffee)
 
+<!-- toc -->
+
+- [Description](#description)
+- [Prerequisites](#prerequisites)
+- [Install npm *convert-csv-to-json package*](#install-npm-convert-csv-to-json-package)
+  * [Install](#install)
+  * [Usage](#usage)
+    + [Generate JSON file](#generate-json-file)
+    + [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)
+    + [Index header](#index-header)
+    + [Empty rows](#empty-rows)
+    + [Format property value by type](#format-property-value-by-type)
+      - [Number](#number)
+      - [Boolean](#boolean)
+    + [Encoding](#encoding)
+- [Development](#development)
+- [License](#license)
+- [Buy me a Coffee](#buy-me-a-coffee)
+
+<!-- tocstop -->
 
 ## Description
 Converts *csv* files to *JSON* files with Node.js. 
@@ -140,6 +150,16 @@ E.g. if your field delimiter is the comma **,** then:
  csvToJson.fieldDelimiter(',').getJsonFromCsv(fileInputName);
 ```
 
+#### Index header
+If the header is not on the first line you can define the header index like: 
+
+```js
+ csvToJson.indexHeader(3).getJsonFromCsv(fileInputName);
+```
+
+#### Empty rows
+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

package/SECURITY.md

@@ -0,0 +1,31 @@
+# Security Policy
+
+[csvToJson](https://github.com/iuccio/csvToJson) is not dependent on others packages or libraries. The only dependencies that [csvToJson](https://github.com/iuccio/csvToJson) uses 
+are **devDependencies**.
+This means that the prduced [npm package](https://www.npmjs.com/package/convert-csv-to-json) is never affected by dependency vulnerabilities.
+
+For the **devDependencies** Github Dependabot is enabled and inform us when a security vulnerability affects [csvToJson](https://github.com/iuccio/csvToJson). 
+A generated Github Depedabot PR is normally quickly merged and a new version is released.
+
+## Vulnerabities 
+[![Known Vulnerabilities](https://snyk.io/test/github/iuccio/csvToJson/badge.svg)](https://snyk.io/test/github/iuccio/csvToJson)
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.4.0   | :white_check_mark: |
+| 1.3.3   | :white_check_mark: |
+| 1.3.2   | :white_check_mark: |      
+
+### Dev Dependencies
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 1.4.0   | :white_check_mark: |
+| 1.3.3   | :warning: moderate dev dependencies vulnerability|
+| 1.3.2   | :warning: moderate dev dependencies vulnerability|  
+
+## Reporting a Vulnerability
+
+To report a Security Vulnerability please add an [Vulnerabilty Issue](https://github.com/iuccio/csvToJson/labels/vulnerabilty).  

package/index.js

@@ -28,6 +28,14 @@ exports.fieldDelimiter = function (delimiter) {
   return this;
 };
 
+/**
+ * Defines the index where the header is defined
+ */
+exports.indexHeader = function (index) {
+  csvToJson.indexHeader(index);
+  return this;
+};
+
 /**
  * Defines how to match and parse a sub array
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "convert-csv-to-json",
-  "version": "1.3.3",
+  "version": "1.5.0",
   "description": "Convert CSV to JSON",
   "main": "index.js",
   "scripts": {
@@ -35,8 +35,8 @@
   },
   "homepage": "https://github.com/iuccio/CSVtoJSON#readme",
   "devDependencies": {
-    "chai": "^4.3.6",
+    "chai": "^4.3.7",
     "chai-fs": "^2.0.0",
-    "mocha": "^9.2.0"
+    "mocha": "^10.2.0"
   }
 }

package/src/csvToJson.js

@@ -14,11 +14,20 @@ class CsvToJson {
     return this;
   }
 
-  fieldDelimiter(delimieter) {
-    this.delimiter = delimieter;
+  fieldDelimiter(delimiter) {
+    this.delimiter = delimiter;
     return this;
   }
 
+  indexHeader(indexHeader) {
+    if(isNaN(indexHeader)){
+        throw new Error('The index Header must be a Number!');
+    }
+    this.indexHeader = indexHeader;
+    return this;
+  }
+
+
   parseSubArray(delimiter = '*',separator = ',') {
     this.parseSubArrayDelimiter = delimiter;
     this.parseSubArraySeparator = separator;
@@ -53,10 +62,16 @@ class CsvToJson {
   csvToJson(parsedCsv) {
     let lines = parsedCsv.split(newLine);
     let fieldDelimiter = this.getFieldDelimiter();
-    let headers = lines[0].split(fieldDelimiter);
+    let index = this.getIndexHeader();
+    let headers = lines[index].split(fieldDelimiter);
+
+    while(!stringUtils.hasContent(headers) && index <= lines.length){
+        index = index + 1;
+        headers = lines[index].split(fieldDelimiter);
+    }
 
     let jsonResult = [];
-    for (let i = 1; i < lines.length; i++) {
+    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));
@@ -72,6 +87,13 @@ class CsvToJson {
     return defaultFieldDelimiter;
   }
 
+  getIndexHeader(){
+    if(this.indexHeader !== null && !isNaN(this.indexHeader)){
+        return this.indexHeader;
+    }
+    return 0;
+  }
+
   buildJsonResult(headers, currentLine) {
     let jsonObject = {};
     for (let j = 0; j < headers.length; j++) {