Add excel string to cli and standardize

zemirco · Jan 23, 2018 · 8da9876 · 8da9876
1 parent e6a64ec
commit 8da9876
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -401,22 +401,26 @@ Usage: json2csv [options]
 
   Options:
 
-    -h, --help                   output usage information
-    -V, --version                output the version number
-    -i, --input <input>          Path and name of the incoming json file.
-    -o, --output [output]        Path and name of the resulting csv file. Defaults to console.
-    -f, --fields <fields>        Specify the fields to convert.
-    -l, --fieldList [list]       Specify a file with a list of fields to include. One field per line.
-    -d, --delimiter [delimiter]  Specify a delimiter other than the default comma to use.
-    -e, --eol [value]            Specify an End-of-Line value for separating rows.
-    -q, --quote [value]          Specify an alternate quote value.
-    -n, --no-header              Disable the column name header
-    -F, --flatten                Flatten nested objects
-    -u, --unwindPath <paths>     Creates multiple rows from a single JSON document similar to MongoDB unwind.
-    -L, --ldjson                 Treat the input as Line-Delimited JSON.
-    -p, --pretty                 Use only when printing to console. Logs output in pretty tables.
-    -a, --include-empty-rows     Includes empty rows in the resulting CSV output.
-    -b, --with-bom               Includes BOM character at the beginning of the CSV.
+    -h, --help                          output usage information
+    -V, --version                       output the version number
+    -i, --input <input>                 Path and name of the incoming json file. If not provided, will read from stdin.
+    -o, --output [output]               Path and name of the resulting csv file. Defaults to stdout.
+    -f, --fields <fields>               Specify the fields to convert.
+    -l, --fieldList [list]              Specify a file with a list of fields to include. One field per line.
+    -d, --delimiter [delimiter]         Specify a delimiter other than the default comma to use.
+    -v, --default-value [defaultValue]  Specify a default value other than empty string.
+    -e, --eol [value]                   Specify an End-of-Line value for separating rows.
+    -q, --quote [value]                 Specify an alternate quote value.
+    -dq, --double-quotes [value]        Specify a value to replace double quote in strings
+    -ex, --excel-strings                Converts string data into normalized Excel style data
+    -n, --no-header                     Disable the column name header
+    -F, --flatten                       Flatten nested objects
+    -u, --unwindPath <paths>            Creates multiple rows from a single JSON document similar to MongoDB unwind.
+    -L, --ldjson                        Treat the input as Line-Delimited JSON.
+    -p, --pretty                        Use only when printing to console. Logs output in pretty tables.
+    -a, --include-empty-rows            Includes empty rows in the resulting CSV output.
+    -b, --with-bom                      Includes BOM character at the beginning of the csv.
+    -h, --help                          output usage information
 ```
 
 An input file `-i` and fields `-f` are required. If no output `-o` is specified the result is logged to the console.

diff --git a/bin/json2csv.js b/bin/json2csv.js
@@ -17,10 +17,11 @@ program
   .option('-f, --fields <fields>', 'Specify the fields to convert.')
   .option('-l, --fieldList [list]', 'Specify a file with a list of fields to include. One field per line.')
   .option('-d, --delimiter [delimiter]', 'Specify a delimiter other than the default comma to use.')
-  .option('-v, --defaultValue [defaultValue]', 'Specify a default value other than empty string.')
+  .option('-v, --default-value [defaultValue]', 'Specify a default value other than empty string.')
   .option('-e, --eol [value]', 'Specify an End-of-Line value for separating rows.')
   .option('-q, --quote [value]', 'Specify an alternate quote value.')
-  .option('-dq, --doubleQuotes [value]', 'Specify a value to replace double quote in strings')
+  .option('-dq, --double-quotes [value]', 'Specify a value to replace double quote in strings')
+  .option('-ex, --excel-strings','Converts string data into normalized Excel style data')
   .option('-n, --no-header', 'Disable the column name header')
   .option('-F, --flatten', 'Flatten nested objects')
   .option('-u, --unwindPath <paths>', 'Creates multiple rows from a single JSON document similar to MongoDB unwind.')
@@ -123,6 +124,7 @@ getFields(function (err, fields) {
       quote: program.quote,
       doubleQuotes: program.doubleQuotes,
       defaultValue: program.defaultValue,
+      excelStrings: program.excelStrings,
       flatten: program.flatten,
       includeEmptyRows: program.includeEmptyRows,
       withBOM: program.withBom