Added options support through cli args

Author: Vishal Shingala

README.md

@@ -89,9 +89,8 @@ function (err, result) {
 ```
 
 ### Options:
-* `'schemaFaker'(boolean)`:  whether to use json-schema-faker for schema conversion. Default: `true`
-* `'requestNameSource'(string)`: The strategy to use to generate request names. url: use the request's URL as the name, fallback: Use the summary/operationId/URL (in that order) Default: `fallback`
-* `'indentCharacter' (string)`: The character to use per level of indentation for JSON/XML data. Default: `' '(space)`
+
+Check out complete list of options and their usage at [OPTIONS.md](/OPTIONS.md)
 
 ### ConversionResult
 
@@ -169,9 +168,12 @@ The converter can be used as a CLI tool as well. The following [command line opt
 - `-p`, `--pretty`  
   Used to pretty print the collection object while writing to a file
 
-- `-c`, `--config`  
+- `-O`, `--options`
   Used to supply options to the converter, for complete options details see [here](/OPTIONS.md)
 
+- `-c`, `--options-config`  
+  Used to supply options to the converter through config file, for complete options details see [here](/OPTIONS.md)
+
 - `-h`, `--help`  
   Specifies all the options along with a few usage examples on the terminal
 
@@ -181,9 +183,9 @@ The converter can be used as a CLI tool as well. The following [command line opt
 **Sample usage examples of the converter CLI**
 
 
-- Takes a specification (spec.yaml) as an input and writes to a file (collection.json) with pretty printing
+- Takes a specification (spec.yaml) as an input and writes to a file (collection.json) with pretty printing and using  provided options
 ```terminal
-$ openapi2postmanv2 -s spec.yaml -o collection.json -p
+$ openapi2postmanv2 -s spec.yaml -o collection.json -p -O folderStrategy=Tags,includeAuthInfoInExample=false
 ```
 
 - Testing the converter

bin/openapi2postmanv2.js

@@ -1,24 +1,57 @@
 #!/usr/bin/env node
-var program = require('commander'),
+var _ = require('lodash'),
+  program = require('commander'),
   Converter = require('../index.js'),
   fs = require('fs'),
   path = require('path'),
+  availableOptions = require('../lib/options').getOptions('use', { usage: ['CONVERSION'] }),
   inputFile,
   outputFile,
   prettyPrintFlag,
   configFile,
+  definedOptions,
   testFlag,
   swaggerInput,
   swaggerData;
 
+/**
+ * Parses comma separated options mentioned in command args and generates JSON object
+ *
+ * @param {String} value - User defined options value
+ * @returns {Object} - Parsed option in format of JSON object
+ */
+function parseOptions (value) {
+  let definedOptions = value.split(','),
+    parsedOptions = {};
+
+  _.forEach(definedOptions, (definedOption) => {
+    let option = definedOption.split('=');
+
+    if (option.length === 2 && _.includes(_.keys(availableOptions), option[0])) {
+      try {
+        // parse parsable data types (e.g. boolean, integer etc)
+        parsedOptions[option[0]] = JSON.parse(option[1]);
+      }
+      catch (e) {
+        // treat value as string if can not be parsed
+        parsedOptions[option[0]] = option[1];
+      }
+    }
+    else {
+      console.warn('\x1b[33m%s\x1b[0m', 'Warning: Invalid defined option ', option[0]);
+    }
+  });
+  return parsedOptions;
+}
+
 program
   .version(require('../package.json').version, '-v, --version')
   .option('-s, --spec <spec>', 'Convert given OPENAPI 3.0.0 spec to Postman Collection v2.0')
   .option('-o, --output <output>', 'Write the collection to an output file')
   .option('-t, --test', 'Test the OPENAPI converter')
   .option('-p, --pretty', 'Pretty print the JSON file')
-  .option('-c, --config <config>', 'JSON file containing Converter options');
-
+  .option('-C, --options-config <optionsConfig>', 'JSON file containing Converter options')
+  .option('-O, --options <options>', 'comma separated list of options', parseOptions);
 
 program.on('--help', function() {
   /* eslint-disable */
@@ -44,6 +77,7 @@ outputFile = program.output || false;
 testFlag = program.test || false;
 prettyPrintFlag = program.pretty || false;
 configFile = program.config || false;
+definedOptions = program.options || {};
 swaggerInput;
 swaggerData;
 
@@ -58,14 +92,16 @@ swaggerData;
 function writetoFile(prettyPrintFlag, file, collection) {
   if (prettyPrintFlag) {
     fs.writeFile(file, JSON.stringify(collection, null, 4), (err) => {
-      if (err) { console.log('Could not write to file', err); }
-      console.log('Conversion successful', 'Collection written to file');
+      if (err) { console.log('Could not write to file', err); } // eslint-disable-line no-console
+      // eslint-disable-next-line no-console
+      console.log('\x1b[32m%s\x1b[0m', 'Conversion successful, collection written to file');
     });
   }
   else {
     fs.writeFile(file, JSON.stringify(collection), (err) => {
-      if (err) { console.log('Could not write to file', err); }
-      console.log('Conversion successful', 'Collection written to file');
+      if (err) { console.log('Could not write to file', err); } // eslint-disable-line no-console
+      // eslint-disable-next-line no-console
+      console.log('\x1b[32m%s\x1b[0m', 'Conversion successful, collection written to file');
     });
   }
 }
@@ -81,10 +117,15 @@ function convert(swaggerData) {
   // apply options from config file if present
   if (configFile) {
     configFile = path.resolve(configFile);
-    console.log('Config file: ', configFile);
+    console.log('Options Config file: ', configFile); // eslint-disable-line no-console
     options = JSON.parse(fs.readFileSync(configFile, 'utf8'));
   }
 
+  // override options provided via cli
+  if (definedOptions) {
+    options = definedOptions;
+  }
+
   Converter.convert({
     type: 'string',
     data: swaggerData