Merge pull request #15 from mrodrig/updates-for-5.5.2

Option parity with json2csv, various fixes

Author: mrodrig

bin/csv2json.js

@@ -9,14 +9,17 @@ const pkg = require('../package.json'),
 program
     .version(pkg.version)
     .usage('<csvFile> [options]')
+    .argument('<csvFile>', 'CSV file to convert')
     .option('-o, --output [output]', 'Path of output file. If not provided, then stdout will be used', utils.convertToAbsolutePath)
-    .option('-f, --field <delimiter>', 'Optional field delimiter')
-    .option('-w, --wrap <delimiter>', 'Optional wrap delimiter')
-    .option('-e, --eol <delimiter>', 'Optional end of line delimiter')
+    .option('-f, --field <delimiter>', 'Field delimiter')
+    .option('-w, --wrap <delimiter>', 'Wrap delimiter')
+    .option('-e, --eol <delimiter>', 'End of Line delimiter')
     .option('-b, --excel-bom', 'Excel Byte Order Mark character prepended to CSV')
-    .option('-H, --trim-header', 'Trim header fields')
+    .option('-p, --prevent-csv-injection', 'Prevent CSV Injection')
     .option('-F, --trim-fields', 'Trim field values')
-    .option('-k, --keys [keys]', 'Keys of documents to convert to CSV', utils.constructKeysList, undefined)
+    .option('-H, --trim-header', 'Trim header fields')
+    .option('-h, --header-fields', 'Specify the fields names in place a header line in the CSV itself', utils.constructKeysList)
+    .option('-k, --keys [keys]', 'Keys of documents to convert to CSV', utils.constructKeysList)
     .parse(process.argv);
 
 const options = program.opts();
@@ -31,6 +34,8 @@ Promise.resolve({
             eol: options.eol
         },
         excelBOM: Boolean(options.excelBom),
+        headerFields: options.headerFields,
+        preventCsvInjection: Boolean(options.preventCsvInjection),
         trimHeaderFields: Boolean(options.trimHeader),
         trimFieldValues: Boolean(options.trimFields),
         keys: options.keys

bin/json2csv.js

@@ -9,20 +9,29 @@ const pkg = require('../package.json'),
 program
     .version(pkg.version)
     .usage('<jsonFile> [options]')
+    .argument('<jsonFile>', 'JSON file to convert')
     .option('-o, --output [output]', 'Path of output file. If not provided, then stdout will be used', utils.convertToAbsolutePath)
-    .option('-f, --field <delimiter>', 'Optional field delimiter')
-    .option('-w, --wrap <delimiter>', 'Optional wrap delimiter')
-    .option('-e, --eol <delimiter>', 'Optional end of line delimiter')
+    .option('-a, --array-indexes-as-keys', 'Includes array indexes in the generated keys')
+    .option('-S, --check-schema', 'Check for schema differences')
+    .option('-f, --field <delimiter>', 'Field delimiter')
+    .option('-w, --wrap <delimiter>', 'Wrap delimiter')
+    .option('-e, --eol <delimiter>', 'End of Line delimiter')
+    .option('-E, --empty-field-value <value>', 'Empty field value')
+    .option('-n, --expand-nested-objects', 'Expand nested objects to be deep converted to CSV')
+    .option('-k, --keys [keys]', 'Keys of documents to convert to CSV', utils.constructKeysList)
+    .option('-d, --escape-header-nested-dots', 'Escape header nested dots')
     .option('-b, --excel-bom', 'Excel Byte Order Mark character prepended to CSV')
+    .option('-x, --exclude-keys [keys]', 'Comma separated list of keys to exclude', utils.constructKeysList)
+    .option('-A, --expand-array-objects', 'Expand array objects')
     .option('-W, --without-header', 'Withhold the prepended header')
+    .option('-p, --prevent-csv-injection', 'Prevent CSV Injection')
     .option('-s, --sort-header', 'Sort the header fields')
-    .option('-H, --trim-header', 'Trim header fields')
     .option('-F, --trim-fields', 'Trim field values')
-    .option('-S, --check-schema', 'Check for schema differences')
-    .option('-E, --empty-field-value <value>', 'Empty field value')
-    .option('-A, --expand-array-objects', 'Expand array objects')
+    .option('-H, --trim-header', 'Trim header fields')
     .option('-U, --unwind-arrays', 'Unwind array values to their own CSV line')
-    .option('-k, --keys [keys]', 'Keys of documents to convert to CSV', utils.constructKeysList, undefined)
+    .option('-I, --iso-date-format', 'Use ISO 8601 date format')
+    .option('-L, --locale-format', 'Use locale format for values')
+    .option('-B, --wrap-booleans', 'Wrap booleans')
     .parse(process.argv);
 
 const options = program.opts();
@@ -36,15 +45,23 @@ Promise.resolve({
             wrap: options.wrap,
             eol: options.eol
         },
+        arrayIndexesAsKeys: Boolean(options.arrayIndexesAsKeys),
+        emptyFieldValue: options.emptyFieldValue,
+        escapeHeaderNestedDots: Boolean(options.escapeHeaderNestedDots),
         excelBOM: Boolean(options.excelBom),
+        excludeKeys: options.excludeKeys,
+        expandNestedObjects: Boolean(options.expandNestedObjects),
         prependHeader: !options.withoutHeader,
+        preventCsvInjection: Boolean(options.preventCsvInjection),
         sortHeader: Boolean(options.sortHeader),
         trimHeaderFields: Boolean(options.trimHeader),
         trimFieldValues: Boolean(options.trimFields),
         checkSchemaDifferences: Boolean(options.checkSchema),
         expandArrayObjects: Boolean(options.expandArrayObjects),
         unwindArrays: Boolean(options.unwindArrays),
-        emptyFieldValue: options.emptyFieldValue,
+        useDateIso8601Format: Boolean(options.isoDateFormat),
+        useLocaleFormat: Boolean(options.localeFormat),
+        wrapBooleans: Boolean(options.wrapBooleans),
         keys: options.keys
     }
 })

bin/utils/utils.js

@@ -84,12 +84,6 @@ function processOutput(params) {
 
 }
 
-function constructKeysList(key, keys) {
-    // Initialize as empty array, if undefined at start
-    if (!keys) {
-        keys = [];
-    }
-
-    keys.push(key);
-    return keys;
+function constructKeysList(keys) {
+    return keys.split(',');
 }

package-lock.json

@@ -2,7 +2,7 @@
     "author": "mrodrig",
     "name": "@mrodrig/json-2-csv-cli",
     "description": "CLI for the json-2-csv package",
-    "version": "5.0.0",
+    "version": "5.5.4",
     "repository": {
         "type": "git",
         "url": "https://github.com/mrodrig/json-2-csv-cli.git"
@@ -29,8 +29,8 @@
         "cli"
     ],
     "dependencies": {
-        "commander": "11.1.0",
-        "json-2-csv": "5.0.0"
+        "commander": "12.1.0",
+        "json-2-csv": "5.5.4"
     },
     "engines": {
         "node": ">= 18"