Add 'useLocaleFormat' option. (#147)

* Add 'useLocaleFormat' option.

Fixes #146, #64

* Force test timezone to EST.

Author: mrodrig

README.md

@@ -84,36 +84,6 @@ Looking for examples? Check out the Wiki: [json-2-csv Wiki](https://github.com/m
   	* `false` uses the following keys:
   		* `['specifications']`
     * Note: This may result in CSV output that does not map back exactly to the original JSON. See #102 for more information.
-  * `unwindArrays` - Boolean - Should array values be "unwound" such that there is one line per value in the array?
-    * Default: `false`
-    * Example:
-    ```json
-    [
-        {
-            "_id": {"$oid": "5cf7ca3616c91100018844af"},
-            "data": {"category": "Computers", "options": [{"name": "MacBook Pro 15"}, {"name": "MacBook Air 13"}]}
-        },
-        {
-            "_id": {"$oid": "5cf7ca3616c91100018844bf"},
-            "data": {"category": "Cars", "options": [{"name": "Supercharger"}, {"name": "Turbocharger"}]}
-        }
-    ]
-    ```
-    * `true` will unwind the JSON to four objects, and therefore four lines of CSV values:
-    ```csv
-    _id.$oid,data.category,data.options.name
-    5cf7ca3616c91100018844af,Computers,MacBook Pro 15
-    5cf7ca3616c91100018844af,Computers,MacBook Air 13
-    5cf7ca3616c91100018844bf,Cars,Supercharger
-    5cf7ca3616c91100018844bf,Cars,Turbocharger
-    ```
-    * `false` will leave the values unwound and will convert the array as-is (when this option is used without expandArrayObjects):
-    ```csv
-    _id.$oid,data.category,data.options
-    5cf7ca3616c91100018844af,Computers,"[{""name"":""MacBook Pro 15""},{""name"":""MacBook Air 13""}]"
-    5cf7ca3616c91100018844bf,Cars,"[{""name"":""Supercharger""},{""name"":""Turbocharger""}]"
-    ```
-	* Note: This may result in CSV output that does not map back exactly to the original JSON.
   * `keys` - Array - Specify the keys (as strings) that should be converted. 
     * Default: `null`
     * If you have a nested object (ie. {info : {name: 'Mike'}}), then set this to ['info.name']
@@ -122,10 +92,43 @@ Looking for examples? Check out the Wiki: [json-2-csv Wiki](https://github.com/m
     * Default: `true`
   * `sortHeader` - Boolean - Should the header keys be sorted in alphabetical order? 
     * Default: `false`
+  * `trimFieldValues` - Boolean - Should the field values be trimmed?
+    * Default: `false`
   * `trimHeaderFields` - Boolean - Should the header fields be trimmed? 
     * Default: `false`
-  * `trimFieldValues` - Boolean - Should the field values be trimmed? (*in development*)
+  * `unwindArrays` - Boolean - Should array values be "unwound" such that there is one line per value in the array?
+      * Default: `false`
+      * Example:
+      ```json
+      [
+          {
+              "_id": {"$oid": "5cf7ca3616c91100018844af"},
+              "data": {"category": "Computers", "options": [{"name": "MacBook Pro 15"}, {"name": "MacBook Air 13"}]}
+          },
+          {
+              "_id": {"$oid": "5cf7ca3616c91100018844bf"},
+              "data": {"category": "Cars", "options": [{"name": "Supercharger"}, {"name": "Turbocharger"}]}
+          }
+      ]
+      ```
+      * `true` will unwind the JSON to four objects, and therefore four lines of CSV values:
+      ```csv
+      _id.$oid,data.category,data.options.name
+      5cf7ca3616c91100018844af,Computers,MacBook Pro 15
+      5cf7ca3616c91100018844af,Computers,MacBook Air 13
+      5cf7ca3616c91100018844bf,Cars,Supercharger
+      5cf7ca3616c91100018844bf,Cars,Turbocharger
+      ```
+      * `false` will leave the values unwound and will convert the array as-is (when this option is used without expandArrayObjects):
+      ```csv
+      _id.$oid,data.category,data.options
+      5cf7ca3616c91100018844af,Computers,"[{""name"":""MacBook Pro 15""},{""name"":""MacBook Air 13""}]"
+      5cf7ca3616c91100018844bf,Cars,"[{""name"":""Supercharger""},{""name"":""Turbocharger""}]"
+      ```
+  	* Note: This may result in CSV output that does not map back exactly to the original JSON.
+  * `useLocaleFormat` - Boolean - Should values be converted to a locale specific string?
     * Default: `false`
+    * Note: If selected, values will be converted using `toLocaleString()` rather than `toString()`
 
 
 For examples, please refer to the [json2csv API Documentation (Link)](https://github.com/mrodrig/json-2-csv/wiki/json2csv-Documentation)

src/constants.json

@@ -32,7 +32,8 @@
     "keys" : null,
     "checkSchemaDifferences": false,
     "expandArrayObjects": false,
-    "unwindArrays": false
+    "unwindArrays": false,
+    "useLocaleFormat": false
   },
 
   "values" : {

src/json2csv.js

@@ -279,7 +279,7 @@ const Json2Csv = function(options) {
         } else if (utils.isNull(fieldValue)) {
             return 'null';
         } else {
-            return fieldValue.toString();
+            return !options.useLocaleFormat ? fieldValue.toString() : fieldValue.toLocaleString();
         }
     }
 

test/config/testCsvFilesList.js

@@ -30,7 +30,8 @@ const fs = require('fs'),
         {key: 'quotedEmptyFieldValue', file: '../data/csv/quotedEmptyFieldValue.csv'},
         {key: 'csvEmptyLastValue', file: '../data/csv/csvEmptyLastValue.csv'},
         {key: 'unwind', file: '../data/csv/unwind.csv'},
-        {key: 'unwindWithSpecifiedKeys', file: '../data/csv/unwindWithSpecifiedKeys.csv'}
+        {key: 'unwindWithSpecifiedKeys', file: '../data/csv/unwindWithSpecifiedKeys.csv'},
+        {key: 'localeFormat', file: '../data/csv/localeFormat.csv'}
     ];
 
 function readCsvFile(filePath) {

test/config/testJsonFilesList.js

@@ -22,5 +22,6 @@ module.exports = {
     emptyFieldValues: require('../data/json/emptyFieldValues'),
     quotedEmptyFieldValue: require('../data/json/quotedEmptyFieldValue'),
     csvEmptyLastValue: require('../data/json/csvEmptyLastValue'),
-    unwind: require('../data/json/unwind')
+    unwind: require('../data/json/unwind'),
+    localeFormat: require('../data/json/localeFormat')
 };

test/data/csv/localeFormat.csv

@@ -0,0 +1,4 @@
+name,features.name,price,createdAt,features.pros
+test1,modules,"12,345",2021-01-01T04:59:00.000Z,undefined
+test1,undefined,"12,345",2021-01-01T04:59:00.000Z,efficiency
+test2,testing,"35,000",2000-01-01T05:00:00.000Z,undefined

test/data/json/localeFormat.js

@@ -0,0 +1,25 @@
+module.exports = [
+    {
+        name: 'test1',
+        features: [
+            {
+                name: 'modules'
+            },
+            {
+                pros: 'efficiency'
+            }
+        ],
+        price: 12345,
+        createdAt: new Date('2021-01-01T04:59:00.000Z')
+    },
+    {
+        name: 'test2',
+        features: [
+            {
+                name: 'testing'
+            }
+        ],
+        price: 35000,
+        createdAt: new Date('2000-01-01T05:00:00.000Z')
+    }
+];

test/json2csv.js

@@ -435,6 +435,14 @@ function runTests(jsonTestData, csvTestData) {
                     keys: ['data.category', 'data.options.name']
                 });
             });
+
+            it('should use the locale format when specified', (done) => {
+                converter.json2csv(jsonTestData.localeFormat, (err, csv) => {
+                    if (err) done(err);
+                    csv.should.equal(csvTestData.localeFormat);
+                    done();
+                }, { useLocaleFormat: true, unwindArrays: true });
+            });
         });
     });
 

test/tests.js

@@ -4,6 +4,7 @@ let json2csvTests = require('./json2csv'),
     csvTestData = require('./config/testCsvFilesList');
 
 describe('json-2-csv Node Module', function() {
+    process.env.TZ = 'America/New_York';
     // Run JSON to CSV tests
     json2csvTests.runTests(jsonTestData, csvTestData);