Make some CLI options mandatory

zemirco · Oct 19, 2019 · 1379565 · 1379565
1 parent 916e448
commit 1379565
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -56,29 +56,29 @@ By default, the above script will get the latest release of json2csv. You can al
 Usage: json2csv [options]
 
 Options:
-  -V, --version                        output the version number
-  -i, --input <input>                  Path and name of the incoming json file. Defaults to stdin.
-  -o, --output [output]                Path and name of the resulting csv file. Defaults to stdout.
-  -c, --config <path>                  Specify a file with a valid JSON configuration.
-  -n, --ndjson                         Treat the input as NewLine-Delimited JSON.
-  -s, --no-streaming                   Process the whole JSON array in memory instead of doing it line by line.
-  -f, --fields <fields>                List of fields to process. Defaults to field auto-detection.
-  -v, --default-value [defaultValue]   Default value to use for missing fields.
-  -q, --quote [quote]                  Character(s) to use as quote mark. Defaults to '"'.
-  -Q, --escaped-quote [escapedQuote]   Character(s) to use as a escaped quote. Defaults to a double `quote`, '""'.
-  -d, --delimiter [delimiter]          Character(s) to use as delimiter. Defaults to ','. (default: ",")
-  -e, --eol [eol]                      Character(s) to use as End-of-Line for separating rows. Defaults to '\n'. (default: "\n")
-  -E, --excel-strings                  Wraps string data to force Excel to interpret it as string even if it contains a number.
-  -H, --no-header                      Disable the column name header.
-  -a, --include-empty-rows             Includes empty rows in the resulting CSV output.
-  -b, --with-bom                       Includes BOM character at the beginning of the CSV.
-  -p, --pretty                         Print output as a pretty table. Use only when printing to console.
-  -u, --unwind <paths>                 Creates multiple rows from a single JSON document similar to MongoDB unwind.
-  -B, --unwind-blank                   When unwinding, blank out instead of repeating data. Defaults to false.
-  -F, --flatten-objects                Flatten nested objects. Defaults to false.
-  -F, --flatten-arrays                 Flatten nested arrays. Defaults to false.
-  -S, --flatten-separator <separator>  Flattened keys separator. Defaults to '.'. (default: ".")
-  -h, --help                           output usage information
+  -V, --version                       output the version number
+  -i, --input <input>                 Path and name of the incoming json file. Defaults to stdin.
+  -o, --output <output>               Path and name of the resulting csv file. Defaults to stdout.
+  -c, --config <path>                 Specify a file with a valid JSON configuration.
+  -n, --ndjson                        Treat the input as NewLine-Delimited JSON.
+  -s, --no-streaming                  Process the whole JSON array in memory instead of doing it line by line.
+  -f, --fields <fields>               List of fields to process. Defaults to field auto-detection.
+  -v, --default-value <defaultValue>  Default value to use for missing fields.
+  -q, --quote <quote>                 Character(s) to use as quote mark. Defaults to '"'.
+  -Q, --escaped-quote <escapedQuote>  Character(s) to use as a escaped quote. Defaults to a double `quote`, '""'.
+  -d, --delimiter <delimiter>         Character(s) to use as delimiter. Defaults to ','. (default: ",")
+  -e, --eol <eol>                     Character(s) to use as End-of-Line for separating rows. Defaults to '\n'. (default: "\n")
+  -E, --excel-strings                 Wraps string data to force Excel to interpret it as string even if it contains a number.
+  -H, --no-header                     Disable the column name header.
+  -a, --include-empty-rows            Includes empty rows in the resulting CSV output.
+  -b, --with-bom                      Includes BOM character at the beginning of the CSV.
+  -p, --pretty                        Print output as a pretty table. Use only when printing to console.
+  --unwind <paths>                    Creates multiple rows from a single JSON document similar to MongoDB unwind.
+  --unwind-blank                      When unwinding, blank out instead of repeating data. Defaults to false. (default: false)
+  --flatten-objects                   Flatten nested objects. Defaults to false. (default: false)
+  --flatten-arrays                    Flatten nested arrays. Defaults to false. (default: false)
+  --flatten-separator <separator>     Flattened keys separator. Defaults to '.'. (default: ".")
+  -h, --help                          output usage information
 ```
 
 If no input `-i` is specified the result is expected from to the console standard input.

diff --git a/bin/json2csv.js b/bin/json2csv.js
@@ -24,16 +24,16 @@ const Json2csvTransform = json2csv.Transform;
 program
   .version(pkg.version)
   .option('-i, --input <input>', 'Path and name of the incoming json file. Defaults to stdin.')
-  .option('-o, --output [output]', 'Path and name of the resulting csv file. Defaults to stdout.')
+  .option('-o, --output <output>', 'Path and name of the resulting csv file. Defaults to stdout.')
   .option('-c, --config <path>', 'Specify a file with a valid JSON configuration.')
   .option('-n, --ndjson', 'Treat the input as NewLine-Delimited JSON.')
   .option('-s, --no-streaming', 'Process the whole JSON array in memory instead of doing it line by line.')
   .option('-f, --fields <fields>', 'List of fields to process. Defaults to field auto-detection.')
-  .option('-v, --default-value [defaultValue]', 'Default value to use for missing fields.')
-  .option('-q, --quote [quote]', 'Character(s) to use as quote mark. Defaults to \'"\'.')
-  .option('-Q, --escaped-quote [escapedQuote]', 'Character(s) to use as a escaped quote. Defaults to a double `quote`, \'""\'.')
-  .option('-d, --delimiter [delimiter]', 'Character(s) to use as delimiter. Defaults to \',\'.', ',')
-  .option('-e, --eol [eol]', 'Character(s) to use as End-of-Line for separating rows. Defaults to \'\\n\'.', os.EOL)
+  .option('-v, --default-value <defaultValue>', 'Default value to use for missing fields.')
+  .option('-q, --quote <quote>', 'Character(s) to use as quote mark. Defaults to \'"\'.')
+  .option('-Q, --escaped-quote <escapedQuote>', 'Character(s) to use as a escaped quote. Defaults to a double `quote`, \'""\'.')
+  .option('-d, --delimiter <delimiter>', 'Character(s) to use as delimiter. Defaults to \',\'.', ',')
+  .option('-e, --eol <eol>', 'Character(s) to use as End-of-Line for separating rows. Defaults to \'\\n\'.', os.EOL)
   .option('-E, --excel-strings','Wraps string data to force Excel to interpret it as string even if it contains a number.')
   .option('-H, --no-header', 'Disable the column name header.')
   .option('-a, --include-empty-rows', 'Includes empty rows in the resulting CSV output.')