@asyncapi/cli 0.28.0 → 0.30.0

package/lib/commands/diff.d.ts

@@ -3,6 +3,9 @@ import Command from '../base';
 export default class Diff extends Command {
     static description: string;
     static flags: {
+        '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>;
+        'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<import("../parser").SeveritytKind>;
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         format: import("@oclif/core/lib/interfaces").OptionFlag<string>;
         type: import("@oclif/core/lib/interfaces").OptionFlag<string>;

package/lib/commands/diff.js

@@ -4,7 +4,6 @@ const tslib_1 = require("tslib");
 /* eslint-disable sonarjs/no-duplicate-string */
 const core_1 = require("@oclif/core");
 const diff = tslib_1.__importStar(require("@asyncapi/diff"));
-const parser = tslib_1.__importStar(require("@asyncapi/parser"));
 const fs_1 = require("fs");
 const SpecificationFile_1 = require("../models/SpecificationFile");
 const base_1 = tslib_1.__importDefault(require("../base"));
@@ -13,6 +12,7 @@ const specification_file_1 = require("../errors/specification-file");
 const diff_error_1 = require("../errors/diff-error");
 const globals_1 = require("../globals");
 const flags_1 = require("../flags");
+const parser_1 = require("../parser");
 const { readFile } = fs_1.promises;
 class Diff extends base_1.default {
     run() {
@@ -73,9 +73,11 @@ class Diff extends base_1.default {
                 }
             }
             try {
-                const firstDocumentParsed = yield parser.parse(firstDocument.text());
-                const secondDocumentParsed = yield parser.parse(secondDocument.text());
-                const diffOutput = diff.diff(firstDocumentParsed.json(), secondDocumentParsed.json(), {
+                const parsed = yield parseDocuments(this, firstDocument, secondDocument, flags);
+                if (!parsed) {
+                    return;
+                }
+                const diffOutput = diff.diff(parsed.firstDocumentParsed.json(), parsed.secondDocumentParsed.json(), {
                     override: overrides,
                     outputType: outputFormat, // NOSONAR
                 });
@@ -134,26 +136,20 @@ class Diff extends base_1.default {
 }
 exports.default = Diff;
 Diff.description = 'Find diff between two asyncapi files';
-Diff.flags = {
-    help: core_1.Flags.help({ char: 'h' }),
-    format: core_1.Flags.string({
+Diff.flags = Object.assign({ help: core_1.Flags.help({ char: 'h' }), format: core_1.Flags.string({
         char: 'f',
         description: 'format of the output',
         default: 'yaml',
         options: ['json', 'yaml', 'yml'],
-    }),
-    type: core_1.Flags.string({
+    }), type: core_1.Flags.string({
         char: 't',
         description: 'type of the output',
         default: 'all',
         options: ['breaking', 'non-breaking', 'unclassified', 'all'],
-    }),
-    overrides: core_1.Flags.string({
+    }), overrides: core_1.Flags.string({
         char: 'o',
         description: 'path to JSON file containing the override properties',
-    }),
-    watch: (0, flags_1.watchFlag)(),
-};
+    }), watch: (0, flags_1.watchFlag)() }, (0, parser_1.validationFlags)({ logDiagnostics: false }));
 Diff.args = [
     {
         name: 'old',
@@ -166,6 +162,18 @@ Diff.args = [
         required: true,
     },
 ];
+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);
+        const { document: newSecondDocumentParsed, status: secondDocumentStatus } = yield (0, parser_1.parse)(command, secondDocument, flags);
+        if (!newFirstDocumentParsed || !newSecondDocumentParsed || firstDocumentStatus === 'invalid' || secondDocumentStatus === 'invalid') {
+            return;
+        }
+        const firstDocumentParsed = (0, parser_1.convertToOldAPI)(newFirstDocumentParsed);
+        const secondDocumentParsed = (0, parser_1.convertToOldAPI)(newSecondDocumentParsed);
+        return { firstDocumentParsed, secondDocumentParsed };
+    });
+}
 /**
  * Reads the file from give path and parses it as JSON
  * @param path The path to override file

package/lib/commands/generate/fromTemplate.js

@@ -271,7 +271,7 @@ Template.flags = {
     }),
     'map-base-url': core_1.Flags.string({
         description: 'Maps all schema references from base url to local folder'
-    })
+    }),
 };
 Template.args = [
     { name: 'asyncapi', description: '- Local path, url or context-name pointing to AsyncAPI file', required: true },

package/lib/commands/generate/models.d.ts

@@ -13,6 +13,9 @@ export default class Models extends Command {
         options?: undefined;
     })[];
     static flags: {
+        '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>;
+        'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<import("../../parser").SeveritytKind>;
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
         /**

package/lib/commands/generate/models.js

@@ -5,7 +5,7 @@ const modelina_1 = require("@asyncapi/modelina");
 const core_1 = require("@oclif/core");
 const base_1 = tslib_1.__importDefault(require("../../base"));
 const SpecificationFile_1 = require("../../models/SpecificationFile");
-const parser_1 = require("@asyncapi/parser");
+const parser_1 = require("../../parser");
 var Languages;
 (function (Languages) {
     Languages["typescript"] = "typescript";
@@ -25,7 +25,10 @@ class Models extends base_1.default {
             const { tsModelType, tsEnumType, tsModuleSystem, tsExportType, namespace, packageName, output } = flags;
             const { language, file } = args;
             const inputFile = (yield (0, SpecificationFile_1.load)(file)) || (yield (0, SpecificationFile_1.load)());
-            const parsedInput = yield (0, parser_1.parse)(inputFile.text());
+            const { document, status } = yield (0, parser_1.parse)(this, inputFile, flags);
+            if (!document || status === 'invalid') {
+                return;
+            }
             modelina_1.Logger.setLogger({
                 info: (message) => {
                     this.log(message);
@@ -101,22 +104,20 @@ class Models extends base_1.default {
                 default:
                     throw new Error(`Could not determine generator for language ${language}, are you using one of the following values ${possibleLanguageValues}?`);
             }
-            let models;
             if (output) {
-                models = yield fileGenerator.generateToFiles(parsedInput, output, Object.assign({}, fileOptions));
+                const models = yield fileGenerator.generateToFiles(document, output, Object.assign({}, fileOptions));
                 const generatedModels = models.map((model) => { return model.modelName; });
                 this.log(`Successfully generated the following models: ${generatedModels.join(', ')}`);
+                return;
             }
-            else {
-                models = yield fileGenerator.generateCompleteModels(parsedInput, Object.assign({}, fileOptions));
-                const generatedModels = models.map((model) => {
-                    return `
+            const models = yield fileGenerator.generateCompleteModels(document, Object.assign({}, fileOptions));
+            const generatedModels = models.map((model) => {
+                return `
 ## Model name: ${model.modelName}
 ${model.result}
 `;
-                });
-                this.log(`Successfully generated the following models: ${generatedModels.join('\n')}`);
-            }
+            });
+            this.log(`Successfully generated the following models: ${generatedModels.join('\n')}`);
         });
     }
 }
@@ -131,13 +132,11 @@ Models.args = [
     },
     { name: 'file', description: 'Path or URL to the AsyncAPI document, or context-name', required: true },
 ];
-Models.flags = {
-    help: core_1.Flags.help({ char: 'h' }),
-    output: core_1.Flags.string({
+Models.flags = Object.assign({ help: core_1.Flags.help({ char: 'h' }), output: core_1.Flags.string({
         char: 'o',
         description: 'The output directory where the models should be written to. Omitting this flag will write the models to `stdout`.',
         required: false
-    }),
+    }), 
     /**
      * TypeScript specific options
      */
@@ -146,37 +145,33 @@ Models.flags = {
         options: ['class', 'interface'],
         description: 'TypeScript specific, define which type of model needs to be generated.',
         required: false,
-    }),
-    tsEnumType: core_1.Flags.string({
+    }), tsEnumType: core_1.Flags.string({
         type: 'option',
         options: ['enum', 'union'],
         description: 'TypeScript specific, define which type of enums needs to be generated.',
         required: false,
-    }),
-    tsModuleSystem: core_1.Flags.string({
+    }), tsModuleSystem: core_1.Flags.string({
         type: 'option',
         options: ['ESM', 'CJS'],
         description: 'TypeScript specific, define the module system to be used.',
         required: false,
-    }),
-    tsExportType: core_1.Flags.string({
+    }), tsExportType: core_1.Flags.string({
         type: 'option',
         options: ['default', 'named'],
         description: 'TypeScript specific, define which type of export needs to be generated.',
         required: false,
-    }),
+    }), 
     /**
      * Go and Java specific package name to use for the generated models
      */
     packageName: core_1.Flags.string({
         description: 'Go and Java specific, define the package to use for the generated models. This is required when language is `go` or `java`.',
         required: false
-    }),
+    }), 
     /**
      * C# specific options
      */
     namespace: core_1.Flags.string({
         description: 'C# specific, define the namespace to use for the generated models. This is required when language is `csharp`.',
         required: false
-    }),
-};
+    }) }, (0, parser_1.validationFlags)({ logDiagnostics: false }));

package/lib/commands/validate.d.ts

@@ -2,6 +2,9 @@ import Command from '../base';
 export default class Validate extends Command {
     static description: string;
     static flags: {
+        '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>;
+        'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<import("../parser").SeveritytKind>;
         help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
         watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };

package/lib/commands/validate.js

@@ -2,9 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
-const parser = tslib_1.__importStar(require("@asyncapi/parser"));
 const base_1 = tslib_1.__importDefault(require("../base"));
-const validation_error_1 = require("../errors/validation-error");
+const parser_1 = require("../parser");
 const SpecificationFile_1 = require("../models/SpecificationFile");
 const globals_1 = require("../globals");
 const flags_1 = require("../flags");
@@ -13,36 +12,18 @@ class Validate extends base_1.default {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const { args, flags } = yield this.parse(Validate); //NOSONAR
             const filePath = args['spec-file'];
-            const watchMode = flags['watch'];
+            const watchMode = flags.watch;
             const specFile = yield (0, SpecificationFile_1.load)(filePath);
             if (watchMode) {
                 (0, globals_1.specWatcher)({ spec: specFile, handler: this, handlerName: 'validate' });
             }
-            try {
-                if (specFile.getFilePath()) {
-                    yield parser.parse(specFile.text());
-                    this.log(`File ${specFile.getFilePath()} successfully validated!`);
-                }
-                else if (specFile.getFileURL()) {
-                    yield parser.parse(specFile.text());
-                    this.log(`URL ${specFile.getFileURL()} successfully validated`);
-                }
-            }
-            catch (error) {
-                throw new validation_error_1.ValidationError({
-                    type: 'parser-error',
-                    err: error
-                });
-            }
+            yield (0, parser_1.validate)(this, specFile, flags);
         });
     }
 }
 exports.default = Validate;
 Validate.description = 'validate asyncapi file';
-Validate.flags = {
-    help: core_1.Flags.help({ char: 'h' }),
-    watch: (0, flags_1.watchFlag)()
-};
+Validate.flags = Object.assign({ help: core_1.Flags.help({ char: 'h' }), watch: (0, flags_1.watchFlag)() }, (0, parser_1.validationFlags)());
 Validate.args = [
     { name: 'spec-file', description: 'spec path, url, or context-name', required: false },
 ];

package/lib/globals.d.ts

@@ -1,10 +1,10 @@
 import Command from './base';
 import { Specification } from './models/SpecificationFile';
-export declare type specWatcherParams = {
+export declare type SpecWatcherParams = {
     spec: Specification;
     handler: Command;
     handlerName: string;
     label?: string;
     docVersion?: 'old' | 'new';
 };
-export declare const specWatcher: (params: specWatcherParams) => void;
+export declare const specWatcher: (params: SpecWatcherParams) => void;

package/lib/globals.js

@@ -28,7 +28,9 @@ const specWatcher = (params) => {
         chokidar_1.default
             .watch(filePath, CHOKIDAR_CONFIG)
             .on('change', () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
-            WATCH_MESSAGES.logOnChange(params.handlerName);
+            if (params.handlerName) {
+                WATCH_MESSAGES.logOnChange(params.handlerName);
+            }
             try {
                 yield params.handler.run();
             }

package/lib/models/SpecificationFile.d.ts

@@ -2,6 +2,7 @@ export declare class Specification {
     private readonly spec;
     private readonly filePath?;
     private readonly fileURL?;
+    private readonly kind?;
     constructor(spec: string, options?: {
         filepath?: string;
         fileURL?: string;
@@ -9,6 +10,9 @@ export declare class Specification {
     text(): string;
     getFilePath(): string | undefined;
     getFileURL(): string | undefined;
+    getKind(): "file" | "url" | undefined;
+    getSource(): string | undefined;
+    toSourceString(): string;
     static fromFile(filepath: string): Promise<Specification>;
     static fromURL(URLpath: string): Promise<Specification>;
 }

package/lib/models/SpecificationFile.js

@@ -19,10 +19,16 @@ const TYPE_CONTEXT_NAME = 'context-name';
 const TYPE_FILE_PATH = 'file-path';
 const TYPE_URL = 'url-path';
 class Specification {
-    constructor(spec, options) {
+    constructor(spec, options = {}) {
         this.spec = spec;
-        this.filePath = options === null || options === void 0 ? void 0 : options.filepath;
-        this.fileURL = options === null || options === void 0 ? void 0 : options.fileURL;
+        if (options.filepath) {
+            this.filePath = options.filepath;
+            this.kind = 'file';
+        }
+        else if (options.fileURL) {
+            this.fileURL = options.fileURL;
+            this.kind = 'url';
+        }
     }
     text() {
         return this.spec;
@@ -33,6 +39,18 @@ class Specification {
     getFileURL() {
         return this.fileURL;
     }
+    getKind() {
+        return this.kind;
+    }
+    getSource() {
+        return this.getFilePath() || this.getFileURL();
+    }
+    toSourceString() {
+        if (this.kind === 'file') {
+            return `File ${this.filePath}`;
+        }
+        return `URL ${this.fileURL}`;
+    }
     static fromFile(filepath) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             let spec;

package/lib/parser.d.ts

@@ -0,0 +1,25 @@
+import { convertToOldAPI } from '@asyncapi/parser/cjs';
+import { OutputFormat } from '@stoplight/spectral-cli/dist/services/config';
+import type Command from './base';
+import type { Specification } from './models/SpecificationFile';
+export declare type SeveritytKind = 'error' | 'warn' | 'info' | 'hint';
+export { convertToOldAPI };
+export interface ValidationFlagsOptions {
+    logDiagnostics?: boolean;
+}
+export declare function validationFlags({ logDiagnostics }?: ValidationFlagsOptions): {
+    'log-diagnostics': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    'diagnostics-format': import("@oclif/core/lib/interfaces").OptionFlag<OutputFormat>;
+    'fail-severity': import("@oclif/core/lib/interfaces").OptionFlag<SeveritytKind>;
+};
+interface ValidateOptions {
+    'log-diagnostics'?: boolean;
+    'diagnostics-format'?: `${OutputFormat}`;
+    'fail-severity'?: SeveritytKind;
+}
+export declare function validate(command: Command, specFile: Specification, options?: ValidateOptions): Promise<"valid" | "invalid">;
+export declare function parse(command: Command, specFile: Specification, options?: ValidateOptions): Promise<{
+    document: import("@asyncapi/parser/cjs").AsyncAPIDocumentInterface | undefined;
+    diagnostics: import("@stoplight/spectral-core").ISpectralDiagnostic[];
+    status: "valid" | "invalid";
+}>;

package/lib/parser.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parse = exports.validate = exports.validationFlags = exports.convertToOldAPI = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const cjs_1 = require("@asyncapi/parser/cjs");
+Object.defineProperty(exports, "convertToOldAPI", { enumerable: true, get: function () { return cjs_1.convertToOldAPI; } });
+const avro_schema_parser_1 = require("@asyncapi/parser/cjs/schema-parser/avro-schema-parser");
+const openapi_schema_parser_1 = require("@asyncapi/parser/cjs/schema-parser/openapi-schema-parser");
+const raml_schema_parser_1 = require("@asyncapi/parser/cjs/schema-parser/raml-schema-parser");
+const spectral_core_1 = require("@stoplight/spectral-core");
+const formatters_1 = require("@stoplight/spectral-cli/dist/formatters");
+const config_1 = require("@stoplight/spectral-cli/dist/services/config");
+const parser = new cjs_1.Parser({
+    __unstable: {
+        resolver: {
+            cache: false,
+        }
+    }
+});
+parser.registerSchemaParser((0, avro_schema_parser_1.AvroSchemaParser)());
+parser.registerSchemaParser((0, openapi_schema_parser_1.OpenAPISchemaParser)());
+parser.registerSchemaParser((0, raml_schema_parser_1.RamlSchemaParser)());
+function validationFlags({ logDiagnostics = true } = {}) {
+    return {
+        'log-diagnostics': core_1.Flags.boolean({
+            description: 'log validation diagnostics or not',
+            default: logDiagnostics,
+            allowNo: true,
+        }),
+        'diagnostics-format': core_1.Flags.enum({
+            description: 'format to use for validation diagnostics',
+            options: Object.values(config_1.OutputFormat),
+            default: config_1.OutputFormat.STYLISH,
+        }),
+        'fail-severity': core_1.Flags.enum({
+            description: 'diagnostics of this level or above will trigger a failure exit code',
+            options: ['error', 'warn', 'info', 'hint'],
+            default: 'error',
+        }),
+    };
+}
+exports.validationFlags = validationFlags;
+function validate(command, specFile, options = {}) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const diagnostics = yield parser.validate(specFile.text(), { source: specFile.getSource() });
+        return logDiagnostics(diagnostics, command, specFile, options);
+    });
+}
+exports.validate = validate;
+function parse(command, specFile, options = {}) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const { document, diagnostics } = yield parser.parse(specFile.text(), { source: specFile.getSource() });
+        const status = logDiagnostics(diagnostics, command, specFile, options);
+        return { document, diagnostics, status };
+    });
+}
+exports.parse = parse;
+function logDiagnostics(diagnostics, command, specFile, options = {}) {
+    const logDiagnostics = options['log-diagnostics'];
+    const failSeverity = options['fail-severity'] || 'error';
+    const diagnosticsFormat = options['diagnostics-format'] || 'stylish';
+    const sourceString = specFile.toSourceString();
+    if (diagnostics.length) {
+        if (hasFailSeverity(diagnostics, failSeverity)) {
+            if (logDiagnostics) {
+                command.logToStderr(`\n${sourceString} and/or referenced documents have governance issues.`);
+                command.logToStderr(formatOutput(diagnostics, diagnosticsFormat, failSeverity));
+            }
+            command.exit(1);
+            return 'invalid';
+        }
+        if (logDiagnostics) {
+            command.log(`\n${sourceString} is valid but has (itself and/or referenced documents) governance issues.`);
+            command.log(formatOutput(diagnostics, diagnosticsFormat, failSeverity));
+        }
+    }
+    else if (logDiagnostics) {
+        command.log(`\n${sourceString} is valid! ${sourceString} and referenced documents don't have governance issues.`);
+    }
+    return 'valid';
+}
+function formatOutput(diagnostics, format, failSeverity) {
+    const options = { failSeverity: (0, spectral_core_1.getDiagnosticSeverity)(failSeverity) };
+    switch (format) {
+        case 'stylish': return (0, formatters_1.stylish)(diagnostics, options);
+        case 'json': return (0, formatters_1.json)(diagnostics, options);
+        case 'junit': return (0, formatters_1.junit)(diagnostics, options);
+        case 'html': return (0, formatters_1.html)(diagnostics, options);
+        case 'text': return (0, formatters_1.text)(diagnostics, options);
+        case 'teamcity': return (0, formatters_1.teamcity)(diagnostics, options);
+        case 'pretty': return (0, formatters_1.pretty)(diagnostics, options);
+        default: return (0, formatters_1.stylish)(diagnostics, options);
+    }
+}
+function hasFailSeverity(diagnostics, failSeverity) {
+    const diagnosticSeverity = (0, spectral_core_1.getDiagnosticSeverity)(failSeverity);
+    return diagnostics.some(diagnostic => diagnostic.severity <= diagnosticSeverity);
+}

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.28.0","commands":{"convert":{"id":"convert","description":"Convert asyncapi documents older to newer versions","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"output":{"name":"output","type":"option","char":"o","description":"path to the file where the result is saved","multiple":false},"target-version":{"name":"target-version","type":"option","char":"t","description":"asyncapi version to convert to","multiple":false,"default":"2.5.0"}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}]},"diff":{"id":"diff","description":"Find diff between two asyncapi files","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"format":{"name":"format","type":"option","char":"f","description":"format of the output","multiple":false,"options":["json","yaml","yml"],"default":"yaml"},"type":{"name":"type","type":"option","char":"t","description":"type of the output","multiple":false,"options":["breaking","non-breaking","unclassified","all"],"default":"all"},"overrides":{"name":"overrides","type":"option","char":"o","description":"path to JSON file containing the override properties","multiple":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Enable watch mode","allowNo":false}},"args":[{"name":"old","description":"old spec path, URL or context-name","required":true},{"name":"new","description":"new spec path, URL or context-name","required":true}]},"new":{"id":"new","description":"Creates a new asyncapi file","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"file-name":{"name":"file-name","type":"option","char":"n","description":"name of the file","multiple":false},"example":{"name":"example","type":"option","char":"e","description":"name of the example to use","multiple":false},"studio":{"name":"studio","type":"boolean","char":"s","description":"open in Studio","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio","multiple":false},"no-tty":{"name":"no-tty","type":"boolean","description":"do not use an interactive terminal","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate asyncapi file","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Enable watch mode","allowNo":false}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}]},"config":{"id":"config","description":"CLI config settings","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"generate:fromTemplate":{"id":"generate:fromTemplate","description":"Generates whatever you want using templates compatible with AsyncAPI Generator.","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"examples":["asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"disable-hook":{"name":"disable-hook","type":"option","char":"d","description":"Disable a specific hook type or hooks from a given hook type","multiple":true},"install":{"name":"install","type":"boolean","char":"i","description":"Installs the template and its dependencies (defaults to false)","allowNo":false},"debug":{"name":"debug","type":"boolean","description":"Enable more specific errors in the console","allowNo":false},"no-overwrite":{"name":"no-overwrite","type":"option","char":"n","description":"Glob or path of the file(s) to skip when regenerating","multiple":true},"output":{"name":"output","type":"option","char":"o","description":"Directory where to put the generated files (defaults to current directory)","multiple":false},"force-write":{"name":"force-write","type":"boolean","description":"Force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory.","allowNo":false},"param":{"name":"param","type":"option","char":"p","description":"Additional param to pass to templates","multiple":true},"map-base-url":{"name":"map-base-url","type":"option","description":"Maps all schema references from base url to local folder","multiple":false}},"args":[{"name":"asyncapi","description":"- Local path, url or context-name pointing to AsyncAPI file","required":true},{"name":"template","description":"- Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template","required":true}]},"generate":{"id":"generate","description":"Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"generate:models":{"id":"generate:models","description":"Generates typed models","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"output":{"name":"output","type":"option","char":"o","description":"The output directory where the models should be written to. Omitting this flag will write the models to `stdout`.","required":false,"multiple":false},"tsModelType":{"name":"tsModelType","type":"option","description":"TypeScript specific, define which type of model needs to be generated.","required":false,"multiple":false,"options":["class","interface"]},"tsEnumType":{"name":"tsEnumType","type":"option","description":"TypeScript specific, define which type of enums needs to be generated.","required":false,"multiple":false,"options":["enum","union"]},"tsModuleSystem":{"name":"tsModuleSystem","type":"option","description":"TypeScript specific, define the module system to be used.","required":false,"multiple":false,"options":["ESM","CJS"]},"tsExportType":{"name":"tsExportType","type":"option","description":"TypeScript specific, define which type of export needs to be generated.","required":false,"multiple":false,"options":["default","named"]},"packageName":{"name":"packageName","type":"option","description":"Go and Java specific, define the package to use for the generated models. This is required when language is `go` or `java`.","required":false,"multiple":false},"namespace":{"name":"namespace","type":"option","description":"C# specific, define the namespace to use for the generated models. This is required when language is `csharp`.","required":false,"multiple":false}},"args":[{"name":"language","description":"The language you want the typed models generated for.","required":true,"options":["typescript","csharp","golang","java","javascript","dart","python","rust"]},{"name":"file","description":"Path or URL to the AsyncAPI document, or context-name","required":true}]},"start":{"id":"start","description":"Start asyncapi studio","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"start:studio":{"id":"start:studio","description":"starts a new local instance of Studio","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"file":{"name":"file","type":"option","char":"f","description":"path to the AsyncAPI file to link with Studio","multiple":false},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio","multiple":false}},"args":[]},"config:context:add":{"id":"config:context:add","description":"Add or modify a context in the store","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"context-name","description":"context name","required":true},{"name":"spec-file-path","description":"file path of the spec file","required":true}]},"config:context:current":{"id":"config:context:current","description":"Shows the current context that is being used","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"config:context":{"id":"config:context","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"config:context:list":{"id":"config:context:list","description":"List all the stored context in the store","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"config:context:remove":{"id":"config:context:remove","description":"Delete a context from the store","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"context-name","description":"Name of the context to delete","required":true}]},"config:context:use":{"id":"config:context:use","description":"Set a context as current","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"context-name","description":"name of the saved context","required":true}]}}}
+{"version":"0.30.0","commands":{"convert":{"id":"convert","description":"Convert asyncapi documents older to newer versions","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"output":{"name":"output","type":"option","char":"o","description":"path to the file where the result is saved","multiple":false},"target-version":{"name":"target-version","type":"option","char":"t","description":"asyncapi version to convert to","multiple":false,"default":"2.5.0"}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}]},"diff":{"id":"diff","description":"Find diff between two asyncapi files","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"format":{"name":"format","type":"option","char":"f","description":"format of the output","multiple":false,"options":["json","yaml","yml"],"default":"yaml"},"type":{"name":"type","type":"option","char":"t","description":"type of the output","multiple":false,"options":["breaking","non-breaking","unclassified","all"],"default":"all"},"overrides":{"name":"overrides","type":"option","char":"o","description":"path to JSON file containing the override properties","multiple":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Enable watch mode","allowNo":false},"log-diagnostics":{"name":"log-diagnostics","type":"boolean","description":"log validation diagnostics or not","allowNo":true},"diagnostics-format":{"name":"diagnostics-format","type":"option","description":"format to use for validation diagnostics","helpValue":"(json|stylish|junit|html|text|teamcity|pretty)","multiple":false,"options":["json","stylish","junit","html","text","teamcity","pretty"],"default":"stylish"},"fail-severity":{"name":"fail-severity","type":"option","description":"diagnostics of this level or above will trigger a failure exit code","helpValue":"(error|warn|info|hint)","multiple":false,"options":["error","warn","info","hint"],"default":"error"}},"args":[{"name":"old","description":"old spec path, URL or context-name","required":true},{"name":"new","description":"new spec path, URL or context-name","required":true}]},"new":{"id":"new","description":"Creates a new asyncapi file","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"file-name":{"name":"file-name","type":"option","char":"n","description":"name of the file","multiple":false},"example":{"name":"example","type":"option","char":"e","description":"name of the example to use","multiple":false},"studio":{"name":"studio","type":"boolean","char":"s","description":"open in Studio","allowNo":false},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio","multiple":false},"no-tty":{"name":"no-tty","type":"boolean","description":"do not use an interactive terminal","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate asyncapi file","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Enable watch mode","allowNo":false},"log-diagnostics":{"name":"log-diagnostics","type":"boolean","description":"log validation diagnostics or not","allowNo":true},"diagnostics-format":{"name":"diagnostics-format","type":"option","description":"format to use for validation diagnostics","helpValue":"(json|stylish|junit|html|text|teamcity|pretty)","multiple":false,"options":["json","stylish","junit","html","text","teamcity","pretty"],"default":"stylish"},"fail-severity":{"name":"fail-severity","type":"option","description":"diagnostics of this level or above will trigger a failure exit code","helpValue":"(error|warn|info|hint)","multiple":false,"options":["error","warn","info","hint"],"default":"error"}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}]},"config":{"id":"config","description":"CLI config settings","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"generate:fromTemplate":{"id":"generate:fromTemplate","description":"Generates whatever you want using templates compatible with AsyncAPI Generator.","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"examples":["asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"disable-hook":{"name":"disable-hook","type":"option","char":"d","description":"Disable a specific hook type or hooks from a given hook type","multiple":true},"install":{"name":"install","type":"boolean","char":"i","description":"Installs the template and its dependencies (defaults to false)","allowNo":false},"debug":{"name":"debug","type":"boolean","description":"Enable more specific errors in the console","allowNo":false},"no-overwrite":{"name":"no-overwrite","type":"option","char":"n","description":"Glob or path of the file(s) to skip when regenerating","multiple":true},"output":{"name":"output","type":"option","char":"o","description":"Directory where to put the generated files (defaults to current directory)","multiple":false},"force-write":{"name":"force-write","type":"boolean","description":"Force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)","allowNo":false},"watch":{"name":"watch","type":"boolean","char":"w","description":"Watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory.","allowNo":false},"param":{"name":"param","type":"option","char":"p","description":"Additional param to pass to templates","multiple":true},"map-base-url":{"name":"map-base-url","type":"option","description":"Maps all schema references from base url to local folder","multiple":false}},"args":[{"name":"asyncapi","description":"- Local path, url or context-name pointing to AsyncAPI file","required":true},{"name":"template","description":"- Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template","required":true}]},"generate":{"id":"generate","description":"Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"generate:models":{"id":"generate:models","description":"Generates typed models","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"output":{"name":"output","type":"option","char":"o","description":"The output directory where the models should be written to. Omitting this flag will write the models to `stdout`.","required":false,"multiple":false},"tsModelType":{"name":"tsModelType","type":"option","description":"TypeScript specific, define which type of model needs to be generated.","required":false,"multiple":false,"options":["class","interface"]},"tsEnumType":{"name":"tsEnumType","type":"option","description":"TypeScript specific, define which type of enums needs to be generated.","required":false,"multiple":false,"options":["enum","union"]},"tsModuleSystem":{"name":"tsModuleSystem","type":"option","description":"TypeScript specific, define the module system to be used.","required":false,"multiple":false,"options":["ESM","CJS"]},"tsExportType":{"name":"tsExportType","type":"option","description":"TypeScript specific, define which type of export needs to be generated.","required":false,"multiple":false,"options":["default","named"]},"packageName":{"name":"packageName","type":"option","description":"Go and Java specific, define the package to use for the generated models. This is required when language is `go` or `java`.","required":false,"multiple":false},"namespace":{"name":"namespace","type":"option","description":"C# specific, define the namespace to use for the generated models. This is required when language is `csharp`.","required":false,"multiple":false},"log-diagnostics":{"name":"log-diagnostics","type":"boolean","description":"log validation diagnostics or not","allowNo":true},"diagnostics-format":{"name":"diagnostics-format","type":"option","description":"format to use for validation diagnostics","helpValue":"(json|stylish|junit|html|text|teamcity|pretty)","multiple":false,"options":["json","stylish","junit","html","text","teamcity","pretty"],"default":"stylish"},"fail-severity":{"name":"fail-severity","type":"option","description":"diagnostics of this level or above will trigger a failure exit code","helpValue":"(error|warn|info|hint)","multiple":false,"options":["error","warn","info","hint"],"default":"error"}},"args":[{"name":"language","description":"The language you want the typed models generated for.","required":true,"options":["typescript","csharp","golang","java","javascript","dart","python","rust"]},{"name":"file","description":"Path or URL to the AsyncAPI document, or context-name","required":true}]},"start":{"id":"start","description":"Start asyncapi studio","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"start:studio":{"id":"start:studio","description":"starts a new local instance of Studio","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false},"file":{"name":"file","type":"option","char":"f","description":"path to the AsyncAPI file to link with Studio","multiple":false},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio","multiple":false}},"args":[]},"config:context:add":{"id":"config:context:add","description":"Add or modify a context in the store","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"context-name","description":"context name","required":true},{"name":"spec-file-path","description":"file path of the spec file","required":true}]},"config:context:current":{"id":"config:context:current","description":"Shows the current context that is being used","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"config:context":{"id":"config:context","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"config:context:list":{"id":"config:context:list","description":"List all the stored context in the store","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[]},"config:context:remove":{"id":"config:context:remove","description":"Delete a context from the store","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"context-name","description":"Name of the context to delete","required":true}]},"config:context:use":{"id":"config:context:use","description":"Set a context as current","strict":true,"pluginName":"@asyncapi/cli","pluginAlias":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"Show CLI help.","allowNo":false}},"args":[{"name":"context-name","description":"name of the saved context","required":true}]}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "0.28.0",
+  "version": "0.30.0",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run"
@@ -12,11 +12,12 @@
     "@asyncapi/diff": "^0.4.1",
     "@asyncapi/generator": "^1.9.12",
     "@asyncapi/modelina": "^1.0.0-next.40",
-    "@asyncapi/parser": "^1.17.1",
+    "@asyncapi/parser": "^2.0.0-next-major.11",
     "@asyncapi/studio": "^0.15.4",
     "@oclif/core": "^1.18.0",
     "@oclif/errors": "^1.3.5",
     "@oclif/plugin-not-found": "^2.3.1",
+    "@stoplight/spectral-cli": "6.6.0",
     "ajv": "^8.12.0",
     "chalk": "^4.1.0",
     "chokidar": "^3.5.2",
@@ -159,7 +160,8 @@
     "pretest:coverage": "npm run build",
     "release": "semantic-release",
     "pretest": "npm run build",
-    "test": "cross-env NODE_ENV=development TEST=1 CONTEXT_FILENAME=\"./test.asyncapi\" CONTEXT_FILE_PATH=\"./\" jest --coverage -i",
+    "test": "npm run test:unit",
+    "test:unit": "cross-env NODE_ENV=development TEST=1 CONTEXT_FILENAME=\"./test.asyncapi\" CONTEXT_FILE_PATH=\"./\" jest --coverage -i",
     "get-version": "echo $npm_package_version"
   },
   "types": "lib/index.d.ts"