Release 3.0.0

* Improving logic flow of the module.
* RFC 4180 compliance.
* Refactored tests to remove replication and improve coverage.
* Release 3.0.0

Author: mrodrig

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,20 @@
+## Background Information
+- Module Version: 
+
+Issue is with:
+- [ ] json2csv
+- [ ] csv2json
+
+## Expected Behavior
+
+
+## Actual Behavior
+
+
+## Code Example
+```javascript
+// Please include a simple example to replicate the issue
+let converter = require('json-2-csv');
+
+
+```

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+## Background Information
+
+- Fixes issue(s): #
+- Proposed release version: ` `
+
+## Proposed Changes
+
+- 
+- 

.gitignore

@@ -1,34 +1,11 @@
-# Created by .gitignore support plugin (hsz.mobi)
-### Node template
-# Logs
-logs
-*.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
 # Coverage directory used by tools like istanbul
 coverage
 
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
 # Dependency directory
-# Commenting this out is preferred by some people, see
-# https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
 node_modules
 
-# Users Environment Variables
-.lock-wscript
-
+# Users Environment Configurations
 .idea
 
-test/CSV/*
+# Debug logs
+npm-debug.log

.travis.yml

@@ -3,5 +3,7 @@ language: node_js
 node_js:
   - "11"
   - "10"
+  - "9"
   - "8"
+  - "7"
   - "6"

README.md

@@ -5,6 +5,7 @@
 [![Build Status](https://travis-ci.org/mrodrig/json-2-csv.svg?branch=master)](https://travis-ci.org/mrodrig/json-2-csv)
 [![Downloads](http://img.shields.io/npm/dm/json-2-csv.svg)](https://www.npmjs.org/package/json-2-csv)
 [![NPM version](https://img.shields.io/npm/v/json-2-csv.svg)](https://www.npmjs.org/package/json-2-csv)
+[![Maintainability](https://api.codeclimate.com/v1/badges/8c0cc3699d054fb77abe/maintainability)](https://codeclimate.com/github/mrodrig/json-2-csv/maintainability)
 [![Known Vulnerabilities](https://snyk.io/test/npm/json-2-csv/badge.svg)](https://snyk.io/test/npm/json-2-csv)
 
 This node module will convert an array of JSON documents to a CSV string.
@@ -30,6 +31,10 @@ $ npm install json-2-csv
 let converter = require('json-2-csv');
 ```
 
+## Upgrading?
+
+Upgrading to v3 from v2? Check out the [upgrade guide](https://github.com/mrodrig/json-2-csv/blob/master/upgrade_guides/UPGRADE_2_to_3.md).
+
 ### API
 
 #### `converter.json2csv(array, callback, options)`
@@ -40,25 +45,22 @@ let converter = require('json-2-csv');
 * `options` - (Optional) A JSON document specifying any of the following key value pairs:
   * `delimiter` - Document - Specifies the different types of delimiters
     * `field` - String - Field Delimiter. 
-      * Default: `','`
-    * `array` - String - Array Value Delimiter. 
-      * Default: `';'`
+      * Default: `,`
     * `wrap` - String - Wrap values in the delimiter of choice (e.g. wrap values in quotes). 
-      * Default: `''`
+      * Default: `"`
     * `eol` - String - End of Line Delimiter. 
-      * Default: `'\n'`
+      * Default: `\n`
+  * `excelBOM` - Boolean - Should a unicode character be prepended to allow Excel to open a UTF-8 encoded file with non-ASCII characters present.
   * `prependHeader` - Boolean - Should the auto-generated header be prepended as the first line in the CSV?
     * Default: `true`
   * `sortHeader` - Boolean - Should the header keys be sorted in alphabetical order? 
     * Default: `false`
-  * `emptyFieldValue` - String - Value for fields without data _when not checking schemas_.
-    * Default: `'null'`
   * `trimHeaderFields` - Boolean - Should the header fields be trimmed? 
     * Default: `false`
   * `trimFieldValues` - Boolean - Should the field values be trimmed? (*in development*)
     * Default: `false`
   * `checkSchemaDifferences` - Boolean - Should all documents have the same schema?
-    * Default: `true`
+    * Default: `false`
     * Note: Change this to `false` if some documents are missing certain fields and you still want to convert the data.
   * `keys` - Array - Specify the keys (as strings) that should be converted. 
     * Default: `null`
@@ -69,7 +71,7 @@ let converter = require('json-2-csv');
 
 For examples, please refer to the [json2csv API Documentation (Link)](https://github.com/mrodrig/json-2-csv/wiki/json2csv-Documentation)
 
-#### Promisified Version: `converter.json2csvPromisified(array, options)`
+#### Promisified Version: `converter.json2csvAsync(array, options)`
 
 Available in version `2.2.0`, this functionality makes use of promises from the `bluebird` module.
 
@@ -80,13 +82,13 @@ Available in version `2.2.0`, this functionality makes use of promises from the
 * `options` - (Optional) A JSON document specifying any of the following key value pairs:
   * `delimiter` - Document - Specifies the different types of delimiters
     * `field` - String - Field Delimiter. 
-      * Default: `','`
-    * `array` - String - Array Value Delimiter. 
-      * Default: `';'`
+      * Default: `,`
     * `wrap` - String - The character that field values are wrapped in. 
-      * Default: `''`
+      * Default: `"`
     * `eol` - String - End of Line Delimiter. 
-      * Default: `'\n'`
+      * Default: `\n`
+  * `excelBOM` - Boolean - Does the CSV contain a unicode character prepended in order to allow Excel to open a UTF-8 encoded file with non-ASCII characters present?
+  	* Default: `false`
   * `trimHeaderFields` - Boolean - Should the header fields be trimmed? 
     * Default: `false`
   * `trimFieldValues` - Boolean - Should the field values be trimmed? 
@@ -98,7 +100,7 @@ Available in version `2.2.0`, this functionality makes use of promises from the
 
 For examples, please refer to the [csv2json API Documentation (Link)](https://github.com/mrodrig/json-2-csv/wiki/csv2json-Documentation)
 
-#### Promisified Version: `csv2jsonPromisified(csv, options)`
+#### Promisified Version: `csv2jsonAsync(csv, options)`
 
 Available in version `2.2.0`, this functionality makes use of promises from the `bluebird` module.
 
@@ -108,7 +110,7 @@ Available in version `2.2.0`, this functionality makes use of promises from the
 $ npm test
 ```
 
-_Note_: This requires `mocha`, `should`, `async`, and `underscore`.
+_Note_: This requires `mocha`, `should`, and `underscore`.
 
 To see test coverage, please run:
 ```bash
@@ -117,18 +119,18 @@ $ npm run coverage
 
 Current Coverage is:
 ```
-Statements   : 94.69% ( 196/207 )
-Branches     : 93.55% ( 145/155 )
-Functions    : 100% ( 34/34 )
-Lines        : 95.38% ( 186/195 )
+Statements   : 100% ( 245/245 )
+Branches     : 100% ( 122/122 )
+Functions    : 100% ( 48/48 )
+Lines        : 100% ( 243/243 )
 ```
 
 ## Frequently Asked Questions (FAQ)
 Please find the updated list (relocated to the Wiki) here: [Frequently Asked Questions (Link)](https://github.com/mrodrig/json-2-csv/wiki/FAQ)
 
 ## Features
 * Header Generation (per document keys)
-* Allows for conversion of specific keys in both json2csv and csv2json via the options.KEYS parameter (as of 1.1.2)
+* Allows for conversion of specific keys in both json2csv and csv2json via the options.keys parameter (as of 1.1.2)
 * Verifies all documents have same schema (schema field order does not matter as of 1.1.0)
 * Supports sub-documents natively
 * Supports arrays as document values for both json2csv and csv2json
@@ -138,5 +140,6 @@ Please find the updated list (relocated to the Wiki) here: [Frequently Asked Que
 * Promisifiable via bluebird's .promisify(<function>) and .promisifyAll(<object>) (as of 1.1.1)
 * Wrapped value support for json2csv and csv2json (as of 1.3.0)
 * Support for multiple different schemas (as of 1.4.0)
-* Promisified versions of the functions are now available by default: json2csvPromisified, csv2jsonPromisified (as of 2.2.0)
+* Promisified versions of the functions are now available by default: json2csvAsync, csv2jsonAsync (as of 2.2.0)
 * Nested quotes are escaped with an additional quote (per [RFC 4180](https://tools.ietf.org/html/rfc4180)) thanks to @eric-thelin (as of 2.3.0)
+* RFC 4180 Compliance (as of 3.0.0)

package.json

@@ -2,7 +2,7 @@
     "author": "mrodrig",
     "name": "json-2-csv",
     "description": "A JSON to CSV and CSV to JSON converter that natively supports sub-documents and auto-generates the CSV heading.",
-    "version": "2.4.0",
+    "version": "3.0.0",
     "repository": {
         "type": "git",
         "url": "http://github.com/mrodrig/json-2-csv.git"
@@ -32,8 +32,7 @@
     "devDependencies": {
         "mocha": "5.2.0",
         "istanbul": "0.4.5",
-        "should": "13.2.3",
-        "async": "2.6.1"
+        "should": "13.2.3"
     },
     "engines": {
         "node": ">= 6"

src/constants.json

@@ -1,38 +1,39 @@
 {
-  "Errors" : {
+  "errors" : {
 
-    "delimitersMustDiffer": "The field and array delimiters must differ.",
     "callbackRequired": "A callback is required!",
     "optionsRequired": "Options were not passed and are required.",
 
     "json2csv": {
-      "cannotCallJson2CsvOn": "Cannot call json2csv on ",
-      "dataNotArrayOfDocuments": "Data provided was not an array of documents.",
+      "cannotCallOn": "Cannot call json2csv on ",
+      "dataCheckFailure": "Data provided was not an array of documents.",
       "notSameSchema": "Not all documents have the same schema."
     },
 
     "csv2json": {
-      "cannotCallCsv2JsonOn": "Cannot call csv2json on ",
-      "csvNotString": "CSV is not a string.",
-      "noDataRetrieveHeading": "No data provided to retrieve heading."
+      "cannotCallOn": "Cannot call csv2json on ",
+      "dataCheckFailure": "CSV is not a string."
     }
 
   },
 
-  "DefaultOptions" : {
-    "DELIMITER" : {
-      "FIELD" : ",",
-      "ARRAY" : ";",
-      "WRAP"  : "",
-      "EOL"   : "\n"
+  "defaultOptions" : {
+    "delimiter" : {
+      "field" : ",",
+      "wrap"  : "\"",
+      "eol"   : "\n"
     },
-    "PREPEND_HEADER" : true,
-    "TRIM_HEADER_FIELDS": false,
-    "TRIM_FIELD_VALUES" : false,
-    "SORT_HEADER" : false,
-    "PARSE_CSV_NUMBERS" : false,
-    "KEYS" : null,
-    "CHECK_SCHEMA_DIFFERENCES": true,
-    "EMPTY_FIELD_VALUE": "null"
+    "excelBOM": false,
+    "prependHeader" : true,
+    "trimHeaderFields": false,
+    "trimFieldValues" : false,
+    "sortHeader" : false,
+    "parseCsvNumbers" : false,
+    "keys" : null,
+    "checkSchemaDifferences": false
+  },
+
+  "values" : {
+    "excelBOM": "\ufeff"
   }
 }