@asyncapi/cli 0.48.7 → 0.49.0

package/lib/commands/diff.d.ts

@@ -9,6 +9,7 @@ export default class Diff extends Command {
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         format: import("@oclif/core/lib/interfaces").OptionFlag<string>;
         type: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        markdownSubtype: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
         overrides: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
         'no-error': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
@@ -21,4 +22,5 @@ export default class Diff extends Command {
     run(): Promise<void>;
     outputJSON(diffOutput: AsyncAPIDiff, outputType: string): void;
     outputYAML(diffOutput: AsyncAPIDiff, outputType: string): void;
+    outputMarkdown(diffOutput: AsyncAPIDiff, outputType: string): void;
 }

package/lib/commands/diff.js

@@ -5,6 +5,7 @@ const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const diff = tslib_1.__importStar(require("@asyncapi/diff"));
 const fs_1 = require("fs");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const SpecificationFile_1 = require("../models/SpecificationFile");
 const base_1 = tslib_1.__importDefault(require("../base"));
 const validation_error_1 = require("../errors/validation-error");
@@ -24,9 +25,12 @@ class Diff extends base_1.default {
             const outputFormat = flags['format'];
             const outputType = flags['type'];
             const overrideFilePath = flags['overrides'];
+            let markdownSubtype = flags['markdownSubtype'];
             const watchMode = flags['watch'];
             const noError = flags['no-error'];
             let firstDocument, secondDocument;
+            checkAndWarnFalseFlag(outputFormat, markdownSubtype);
+            markdownSubtype = setDefaultMarkdownSubtype(outputFormat, markdownSubtype);
             try {
                 firstDocument = yield (0, SpecificationFile_1.load)(firstDocumentPath);
                 enableWatch(watchMode, {
@@ -81,7 +85,8 @@ class Diff extends base_1.default {
                 }
                 const diffOutput = diff.diff(parsed.firstDocumentParsed.json(), parsed.secondDocumentParsed.json(), {
                     override: overrides,
-                    outputType: outputFormat, // NOSONAR
+                    outputType: outputFormat,
+                    markdownSubtype: markdownSubtype
                 });
                 if (outputFormat === 'json') {
                     this.outputJSON(diffOutput, outputType);
@@ -89,6 +94,9 @@ class Diff extends base_1.default {
                 else if (outputFormat === 'yaml' || outputFormat === 'yml') {
                     this.outputYAML(diffOutput, outputType);
                 }
+                else if (outputFormat === 'md') {
+                    this.outputMarkdown(diffOutput, outputType);
+                }
                 else {
                     this.log(`The output format ${outputFormat} is not supported at the moment.`);
                 }
@@ -125,21 +133,10 @@ class Diff extends base_1.default {
         }
     }
     outputYAML(diffOutput, outputType) {
-        if (outputType === 'breaking') {
-            this.log(diffOutput.breaking());
-        }
-        else if (outputType === 'non-breaking') {
-            this.log(diffOutput.nonBreaking());
-        }
-        else if (outputType === 'unclassified') {
-            this.log(diffOutput.unclassified());
-        }
-        else if (outputType === 'all') {
-            this.log(diffOutput.getOutput());
-        }
-        else {
-            this.log(`The output type ${outputType} is not supported at the moment.`);
-        }
+        this.log(genericOutput(diffOutput, outputType));
+    }
+    outputMarkdown(diffOutput, outputType) {
+        this.log(genericOutput(diffOutput, outputType));
     }
 }
 exports.default = Diff;
@@ -148,12 +145,16 @@ Diff.flags = Object.assign({ help: core_1.Flags.help({ char: 'h' }), format: cor
         char: 'f',
         description: 'format of the output',
         default: 'yaml',
-        options: ['json', 'yaml', 'yml'],
+        options: ['json', 'yaml', 'yml', 'md'],
     }), type: core_1.Flags.string({
         char: 't',
         description: 'type of the output',
         default: 'all',
         options: ['breaking', 'non-breaking', 'unclassified', 'all'],
+    }), markdownSubtype: core_1.Flags.string({
+        description: 'the format of changes made to AsyncAPI document. It works only when diff is generated using md type. For example, when you specify subtype as json, then diff information in markdown is dumped as json structure.',
+        default: undefined,
+        options: ['json', 'yaml', 'yml']
     }), overrides: core_1.Flags.string({
         char: 'o',
         description: 'path to JSON file containing the override properties',
@@ -172,6 +173,21 @@ Diff.args = [
         required: true,
     },
 ];
+/**
+ * A generic output function for diff output
+ * @param diffOutput The diff output data
+ * @param outputType The output format requested by the user
+ * @returns The output(if the format exists) or a message indicating the format doesn't exist
+ */
+function genericOutput(diffOutput, outputType) {
+    switch (outputType) {
+        case 'breaking': return diffOutput.breaking();
+        case 'non-breaking': return diffOutput.nonBreaking();
+        case 'unclassified': return diffOutput.unclassified();
+        case 'all': return diffOutput.getOutput();
+        default: return `The output type ${outputType} is not supported at the moment.`;
+    }
+}
 function parseDocuments(command, firstDocument, secondDocument, flags) {
     return tslib_1.__awaiter(this, void 0, void 0, function* () {
         const { document: newFirstDocumentParsed, status: firstDocumentStatus } = yield (0, parser_1.parse)(command, firstDocument, flags);
@@ -221,7 +237,26 @@ const enableWatch = (status, watcher) => {
 function throwOnBreakingChange(diffOutput, outputFormat) {
     const breakingChanges = diffOutput.breaking();
     if ((outputFormat === 'json' && breakingChanges.length !== 0) ||
-        ((outputFormat === 'yaml' || outputFormat === 'yml') && breakingChanges !== '[]\n')) {
+        ((outputFormat === 'yaml' || outputFormat === 'yml') && breakingChanges !== '[]\n') ||
+        (outputFormat === 'md' && breakingChanges.length !== 0)) {
         throw new diff_error_1.DiffBreakingChangeError();
     }
 }
+/**
+ * Checks and warns user about providing unnecessary markdownSubtype option.
+ */
+function checkAndWarnFalseFlag(format, markdownSubtype) {
+    if (format !== 'md' && typeof (markdownSubtype) !== 'undefined') {
+        const warningMessage = chalk_1.default.yellowBright(`Warning: The given markdownSubtype flag will not work with the given format.\nProvided flag markdownSubtype: ${markdownSubtype}`);
+        console.log(warningMessage);
+    }
+}
+/**
+ * Sets the default markdownSubtype option in case user doesn't provide one.
+ */
+function setDefaultMarkdownSubtype(format, markdownSubtype) {
+    if (format === 'md' && typeof (markdownSubtype) === 'undefined') {
+        return 'yaml';
+    }
+    return markdownSubtype;
+}

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.48.7",
+  "version": "0.49.0",
   "commands": {
     "bundle": {
       "id": "bundle",
@@ -112,7 +112,8 @@
           "options": [
             "json",
             "yaml",
-            "yml"
+            "yml",
+            "md"
           ],
           "default": "yaml"
         },
@@ -130,6 +131,17 @@
           ],
           "default": "all"
         },
+        "markdownSubtype": {
+          "name": "markdownSubtype",
+          "type": "option",
+          "description": "the format of changes made to AsyncAPI document. It works only when diff is generated using md type. For example, when you specify subtype as json, then diff information in markdown is dumped as json structure.",
+          "multiple": false,
+          "options": [
+            "json",
+            "yaml",
+            "yml"
+          ]
+        },
         "overrides": {
           "name": "overrides",
           "type": "option",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "0.48.7",
+  "version": "0.49.0",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run"
@@ -10,7 +10,7 @@
   "dependencies": {
     "@asyncapi/avro-schema-parser": "^3.0.2",
     "@asyncapi/bundler": "^0.3.8",
-    "@asyncapi/converter": "^1.2.0",
+    "@asyncapi/converter": "^1.2.1",
     "@asyncapi/diff": "^0.4.1",
     "@asyncapi/generator": "^1.10.8",
     "@asyncapi/modelina": "^1.8.6",