Updates from feedback

Author: alvadb

CHANGELOG.md

@@ -1,4 +1,7 @@
 # Changelog
+## 0.1.12 Released on 2018-05-19.
+
+* Added support for readme tags.
 
 ## 0.1.11 Released on 2018-05-14
 

README.md

@@ -23,6 +23,10 @@ Options:
   -j, --inJson       A boolean flag indicating whether output format of the
                      messages is json.                 [boolean] [default: true]
   -h, --help         Show help                                         [boolean]
+  -o, --oldTagName   The tag name for the old specification file.  If include it 
+                     indicates that the old spec file is a readme file
+  -n, --newTagName   The tag name for the new specification file.  If include it 
+                     indicates that the new spec file is a readme file
 ```
 
 ## Build dependencies

cli.js

@@ -28,6 +28,16 @@ yargs
     describe: `Set the log file path. It must be an absolute filepath. ` +
     `By default the logs will stored in a timestamp based log file at "${defaultLogDir}".`
   })
+  .option('o', {
+    alias: 'oldTagName',
+    describe: `The tag name for the old specification file.  If include it ` +
+    `indicates that the old spec file is a readme file`
+  })
+  .option('n', {
+    alias: 'newTagName',
+    describe: `The tag name for the new specification file.  If include it ` +
+    `indicates that the new spec file is a readme file`
+  })
   .global(['h', 'l', 'f'])
   .help()
   .argv;

lib/commands/oad.js

@@ -17,12 +17,12 @@ exports.builder = {
     default: true
   },
   o: {
-    alias: 'old-tag-name',
-    describe: 'The tag name for the readme.  If include also indicates that the old spec file is a readme file',
+    alias: 'oldTagName',
+    describe: 'The tag name for the old specification file.  If include it indicates that the old spec file is a readme file',
   },
   n: {
-    alias: 'new-tag-name',
-    describe: 'The tag name for the readme.  If include also indicates that the old spec file is a readme file',
+    alias: 'newTagName',
+    describe: 'The tag name for the new specification file.  If include it indicates that the new spec file is a readme file',
   }
 };
 

lib/validate.js

@@ -21,6 +21,10 @@ exports = module.exports;
  * 
  * @param {boolean} [options.matchApiVersion] A boolean flag indicating whether to consider api-version while comparing.
  * 
+ * @param {string} [options.oldTagName] Tag name used for autorest with the old specification file.
+ *
+ * @param {string} [options.newTagName] Tag name used for autorest with the new specification file.
+ * 
  */
 exports.compare = function compare(oldSwagger, newSwagger, options) {
   if (!options) options = {};

lib/validators/openApiDiff.js

@@ -27,6 +27,10 @@ class OpenApiDiff {
    *
    * @param {boolean} [options.matchApiVersion] A boolean flag indicating whether to consider api-version while comparing.
    *
+   * @param {string} [options.oldTagName] Tag name used for autorest with the old specification file.
+   *
+   * @param {string} [options.newTagName] Tag name used for autorest with the new specification file.
+   *
    * @returns {object} OpenApiDiff Returns the configured OpenApiDiff object.
    */
   constructor(options) {
@@ -118,6 +122,8 @@ class OpenApiDiff {
    *
    * @param {string} outputFileName Name of the output file to which autorest outputs swagger-doc.
    *
+   * @param {string} tagName Name of the tag in the specification file.
+   *
    */
   processViaAutoRest(swaggerPath, outputFileName, tagName) {
     log.silly(`processViaAutoRest is being called`);
@@ -141,12 +147,9 @@ class OpenApiDiff {
 
       let outputFolder = os.tmpdir();
       let outputFilePath = path.join(outputFolder, `${outputFileName}.json`);
-      var autoRestCmd;
-      if(tagName) {
-        autoRestCmd = `${self.autoRestPath()} ${swaggerPath} --tag=${tagName} --output-artifact=swagger-document.json --output-file=${outputFileName} --output-folder=${outputFolder}`;
-      }else {
-        autoRestCmd = `${self.autoRestPath()} --input-file=${swaggerPath} --output-artifact=swagger-document.json --output-file=${outputFileName} --output-folder=${outputFolder}`;
-      }
+      var autoRestCmd = tagName 
+        ? `${self.autoRestPath()} ${swaggerPath} --tag=${tagName} --output-artifact=swagger-document.json --output-file=${outputFileName} --output-folder=${outputFolder}`
+        : `${self.autoRestPath()} --input-file=${swaggerPath} --output-artifact=swagger-document.json --output-file=${outputFileName} --output-folder=${outputFolder}`;
 
       log.debug(`Executing: "${autoRestCmd}"`);
 

openapi-diff/src/modeler/AutoRest.Swagger/Model/ServiceDefinition.cs

@@ -124,10 +124,8 @@ public override IEnumerable<ComparisonMessage> Compare(ComparisonContext context
             if (previousDefinition == null)
                 throw new ArgumentException("Comparing a service definition with something else.");
 
-            if (Info != null && 
-                previousDefinition.Info != null &&
-                Info.Version != null && 
-                previousDefinition.Info.Version != null)
+            if (Info?.Version != null && 
+                previousDefinition.Info?.Version != null)
             {
                 context.PushProperty("info");
                 context.PushProperty("version");