@asyncapi/cli 3.5.2 → 3.6.0

package/bin/dev

@@ -1,4 +1,4 @@
-#!/usr/bin/env nod
+#!/usr/bin/env node
 
 const oclif = require('@oclif/core')
 

package/lib/apps/cli/commands/diff.d.ts

@@ -10,7 +10,7 @@ export default class Diff extends Command {
         'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
         'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
-        output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'save-output': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         format: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         type: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
@@ -25,6 +25,7 @@ export default class Diff extends Command {
     };
     run(): Promise<void>;
     outputJSON(diffOutput: AsyncAPIDiff, outputType: string): void;
+    writeOutputToFile(diffOutput: AsyncAPIDiff, outputType: string, filePath: string, outputFormat: string): Promise<void>;
     outputYAML(diffOutput: AsyncAPIDiff, outputType: string): void;
     outputMarkdown(diffOutput: AsyncAPIDiff, outputType: string): void;
     parseDocuments(command: Command, firstDocument: Specification, secondDocument: Specification, flags: Record<string, any>): Promise<{

package/lib/apps/cli/commands/diff.js

@@ -32,6 +32,7 @@ class Diff extends base_1.default {
             let markdownSubtype = flags['markdownSubtype'];
             const watchMode = flags['watch'];
             const noError = flags['no-error'];
+            const writeOutput = flags['save-output'];
             let firstDocument, secondDocument;
             checkAndWarnFalseFlag(outputFormat, markdownSubtype);
             markdownSubtype = setDefaultMarkdownSubtype(outputFormat, markdownSubtype);
@@ -97,20 +98,25 @@ class Diff extends base_1.default {
                     outputType: outputFormat, // NOSONAR
                     markdownSubtype: markdownSubtype,
                 });
-                if (outputFormat === 'json') {
-                    this.outputJSON(diffOutput, outputType);
-                }
-                else if (outputFormat === 'yaml' || outputFormat === 'yml') {
-                    this.outputYAML(diffOutput, outputType);
-                }
-                else if (outputFormat === 'md') {
-                    this.outputMarkdown(diffOutput, outputType);
+                if (writeOutput) {
+                    yield this.writeOutputToFile(diffOutput, outputType, writeOutput, outputFormat);
                 }
                 else {
-                    this.log(`The output format ${outputFormat} is not supported at the moment.`);
-                }
-                if (!noError) {
-                    throwOnBreakingChange(diffOutput, outputFormat);
+                    if (outputFormat === 'json') {
+                        this.outputJSON(diffOutput, outputType);
+                    }
+                    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.`);
+                    }
+                    if (!noError) {
+                        throwOnBreakingChange(diffOutput, outputFormat);
+                    }
                 }
             }
             catch (error) {
@@ -142,6 +148,44 @@ class Diff extends base_1.default {
             this.log(`The output type ${outputType} is not supported at the moment.`);
         }
     }
+    writeOutputToFile(diffOutput, outputType, filePath, outputFormat) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            let content;
+            if (outputFormat === 'json') {
+                if (outputType === 'breaking') {
+                    content = JSON.stringify(diffOutput.breaking(), null, 2);
+                }
+                else if (outputType === 'non-breaking') {
+                    content = JSON.stringify(diffOutput.nonBreaking(), null, 2);
+                }
+                else if (outputType === 'unclassified') {
+                    content = JSON.stringify(diffOutput.unclassified(), null, 2);
+                }
+                else if (outputType === 'all') {
+                    content = JSON.stringify(diffOutput.getOutput(), null, 2);
+                }
+                else {
+                    content = `The output type ${outputType} is not supported at the moment.`;
+                }
+            }
+            else if (outputFormat === 'yaml' || outputFormat === 'yml') {
+                content = genericOutput(diffOutput, outputType);
+            }
+            else if (outputFormat === 'md') {
+                content = genericOutput(diffOutput, outputType);
+            }
+            else {
+                content = `The output format ${outputFormat} is not supported at the moment.`;
+            }
+            try {
+                yield fs_1.promises.writeFile(filePath, content);
+                this.log(`Output successfully written to: ${filePath}`);
+            }
+            catch (error) {
+                this.error(`Failed to write output to file: ${error.message}`);
+            }
+        });
+    }
     outputYAML(diffOutput, outputType) {
         this.log(genericOutput(diffOutput, outputType));
     }

package/lib/apps/cli/commands/validate.d.ts

@@ -11,7 +11,7 @@ export default class Validate extends Command {
         'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
         'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
-        output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'save-output': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };

package/lib/apps/cli/commands/validate.js

@@ -55,6 +55,7 @@ class Validate extends base_1.default {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g;
             const diagnosticsFormat = (_a = flags['diagnostics-format']) !== null && _a !== void 0 ? _a : 'stylish';
+            const writeOutput = flags['save-output'];
             const hasIssues = (_c = (((_b = result.data) === null || _b === void 0 ? void 0 : _b.diagnostics) && result.data.diagnostics.length > 0)) !== null && _c !== void 0 ? _c : false;
             const isFailSeverity = ((_d = result.data) === null || _d === void 0 ? void 0 : _d.status) === validation_service_1.ValidationStatus.INVALID;
             const sourceString = ((_e = this.specFile) === null || _e === void 0 ? void 0 : _e.toSourceString()) || '';
@@ -66,15 +67,15 @@ class Validate extends base_1.default {
                 this.log(governanceMessage);
             }
             const diagnosticsOutput = this.validationService.formatDiagnosticsOutput(((_f = result.data) === null || _f === void 0 ? void 0 : _f.diagnostics) || [], diagnosticsFormat, (_g = flags['fail-severity']) !== null && _g !== void 0 ? _g : 'error');
-            if (flags.output) {
-                const { success, error } = yield this.validationService.saveDiagnosticsToFile(flags.output, diagnosticsFormat, diagnosticsOutput);
+            if (writeOutput) {
+                const { success, error } = yield this.validationService.saveDiagnosticsToFile(writeOutput, diagnosticsFormat, diagnosticsOutput);
                 if (!success) {
                     this.logToStderr(error || 'Failed to save diagnostics to file', {
                         exit: 1,
                     });
                 }
                 else {
-                    this.log(`Diagnostics saved to ${flags.output}`);
+                    this.log(`Diagnostics saved to ${writeOutput}`);
                 }
             }
             else {

package/lib/apps/cli/internal/flags/diff.flags.d.ts

@@ -2,7 +2,7 @@ export declare const diffFlags: () => {
     'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
     'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
-    output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'save-output': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
     format: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
     type: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;

package/lib/apps/cli/internal/flags/parser.flags.d.ts

@@ -6,5 +6,5 @@ export declare function parserFlags({ logDiagnostics, }?: ValidationFlagsOptions
     'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
     'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
-    output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'save-output': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
 };

package/lib/apps/cli/internal/flags/parser.flags.js

@@ -20,9 +20,9 @@ function parserFlags({ logDiagnostics = true, } = {}) {
             options: ['error', 'warn', 'info', 'hint'],
             default: 'error',
         })(),
-        output: core_1.Flags.string({
+        'save-output': core_1.Flags.string({
             description: 'The output file name. Omitting this flag the result will be printed in the console.',
-            char: 'o',
+            char: 's',
         }),
     };
 }

package/lib/apps/cli/internal/flags/validate.flags.d.ts

@@ -5,7 +5,7 @@ export declare const validateFlags: () => {
     'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<import("@stoplight/spectral-cli/dist/services/config").OutputFormat, import("@oclif/core/lib/interfaces").CustomOptions>;
     'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<"error" | "warn" | "info" | "hint", import("@oclif/core/lib/interfaces").CustomOptions>;
-    output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'save-output': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
     watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
 };

package/oclif.manifest.json

@@ -288,10 +288,10 @@
           ],
           "type": "option"
         },
-        "output": {
-          "char": "o",
+        "save-output": {
+          "char": "s",
           "description": "The output file name. Omitting this flag the result will be printed in the console.",
-          "name": "output",
+          "name": "save-output",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -584,10 +584,10 @@
           ],
           "type": "option"
         },
-        "output": {
-          "char": "o",
+        "save-output": {
+          "char": "s",
           "description": "The output file name. Omitting this flag the result will be printed in the console.",
-          "name": "output",
+          "name": "save-output",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -1121,8 +1121,9 @@
         },
         "output": {
           "char": "o",
-          "description": "The output file name. Omitting this flag the result will be printed in the console.",
+          "description": "The output directory where the models should be written to. Omitting this flag will write the models to `stdout`.",
           "name": "output",
+          "required": false,
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -1377,6 +1378,14 @@
           ],
           "type": "option"
         },
+        "save-output": {
+          "char": "s",
+          "description": "The output file name. Omitting this flag the result will be printed in the console.",
+          "name": "save-output",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "proxyHost": {
           "description": "Name of the ProxyHost",
           "name": "proxyHost",
@@ -2142,5 +2151,5 @@
       ]
     }
   },
-  "version": "3.5.2"
+  "version": "3.6.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "3.5.2",
+  "version": "3.6.0",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run_bin"