test: add test for arrayIndexesAsKeys option for #207

mrodrig · Feb 25, 2024 · c3562d9 · c3562d9
1 parent b017dfb
commit c3562d9
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 0 deletions.
diff --git a/test/config/testCsvFilesList.ts b/test/config/testCsvFilesList.ts
@@ -52,6 +52,7 @@ const csvFileConfig = [
     {key: 'newlineWithWrapDelimiters', file: '../data/csv/newlineWithWrapDelimiters.csv'},
     {key: 'excludeKeyPattern', file: '../data/csv/excludeKeyPattern.csv'},
     {key: 'wildcardMatch', file: '../data/csv/wildcardMatch.csv'},
+    {key: 'arrayIndexesAsKeys', file: '../data/csv/arrayIndexesAsKeys.csv'},
 ];
 
 function readCsvFile(filePath: string) {

diff --git a/test/config/testJsonFilesList.ts b/test/config/testJsonFilesList.ts
@@ -45,4 +45,5 @@ export default {
     newlineWithWrapDelimiters: require('../data/json/newlineWithWrapDelimiters'),
     excludeKeyPattern: require('../data/json/excludeKeyPattern'),
     wildcardMatch: require('../data/json/wildcardMatch.json'),
+    arrayIndexesAsKeys: require('../data/json/arrayIndexesAsKeys.json'),
 };
diff --git a/test/data/csv/arrayIndexesAsKeys.csv b/test/data/csv/arrayIndexesAsKeys.csv
@@ -0,0 +1,3 @@
+test.list.0.a,test.list.0.optionA,test.list.1.a,test.list.1.optionB
+1,ac,2,radio
+3,cd,4,heat
diff --git a/test/data/json/arrayIndexesAsKeys.json b/test/data/json/arrayIndexesAsKeys.json
@@ -0,0 +1,30 @@
+[
+    {
+        "test": {
+            "list": [
+                {
+                    "a": 1,
+                    "optionA": "ac"
+                },
+                {
+                    "a": 2,
+                    "optionB": "radio"
+                }
+            ]
+        }
+    },
+    {
+        "test": {
+            "list": [
+                {
+                    "a": 3,
+                    "optionA": "cd"
+                },
+                {
+                    "a": 4,
+                    "optionB": "heat"
+                }
+            ]
+        }
+    }
+]
diff --git a/test/json2csv.ts b/test/json2csv.ts
@@ -578,6 +578,14 @@ export function runTests() {
                 assert.equal(csv, updatedCsv);
             });
 
+            // Test case for #207
+            it('should include the array indexes in CSV key headers if specified via the option', () => {
+                const csv = json2csv(jsonTestData.arrayIndexesAsKeys, {
+                    arrayIndexesAsKeys: true,
+                });
+                assert.equal(csv, csvTestData.arrayIndexesAsKeys);
+            });
+
             it('should use a custom value parser function when provided', () => {
                 const updatedCsv = csvTestData.trimmedFields.split('\n');
                 const textRow = 'Parsed Value,Parsed Value,Parsed Value,Parsed Value,Parsed Value';