@asyncapi/cli 0.23.1 → 0.24.0

package/README.md

@@ -1,6 +1,6 @@
 [![AsyncAPI CLI](./assets/logo.png)](https://www.asyncapi.com)
 
-CLI to work with your AsyncAPI files. Currently supports validation, but it is under development for more features.
+CLI to work with your AsyncAPI files. Currently under development, we are working to bring more features. 
 
 [![GitHub license](https://img.shields.io/github/license/asyncapi/cli)](https://github.com/asyncapi/cli/blob/master/LICENSE)
 [![PR testing - if Node project](https://github.com/asyncapi/cli/actions/workflows/if-nodejs-pr-testing.yml/badge.svg)](https://github.com/asyncapi/cli/actions/workflows/if-nodejs-pr-testing.yml)
@@ -114,7 +114,7 @@ asyncapi
 
 ## Usage
 
-As of now, the `@asyncapi/cli` only supports validation of the specification file. (This is still under development for more features.)
+`@asyncapi/cli` makes it easier to work with asyncpi files. 
 
 We have well-documented help commands so just run:
 
@@ -144,6 +144,7 @@ COMMANDS
       java          generate the models for Java
       javascript    generate the models for JavaScript
       dart          generate the models for Dart
+    fromTemplate    generate whatever you want using templates compatible with AsyncAPI Generator 
 ```
 
 ## Contributing

package/lib/commands/config/index.d.ts

@@ -1,4 +1,5 @@
 import Command from '../../base';
 export default class Config extends Command {
+    static description: string;
     run(): Promise<void>;
 }

package/lib/commands/config/index.js

@@ -11,3 +11,4 @@ class Config extends base_1.default {
     }
 }
 exports.default = Config;
+Config.description = 'CLI config settings';

package/lib/commands/convert.js

@@ -52,7 +52,7 @@ class Convert extends base_1.default {
     }
 }
 exports.default = Convert;
-Convert.description = 'convert asyncapi documents older to newer versions';
+Convert.description = 'Convert asyncapi documents older to newer versions';
 Convert.flags = {
     help: core_1.Flags.help({ char: 'h' }),
     output: core_1.Flags.string({ char: 'o', description: 'path to the file where the result is saved' }),

package/lib/commands/diff.js

@@ -131,7 +131,7 @@ class Diff extends base_1.default {
     }
 }
 exports.default = Diff;
-Diff.description = 'find diff between two asyncapi files';
+Diff.description = 'Find diff between two asyncapi files';
 Diff.flags = {
     help: core_1.Flags.help({ char: 'h' }),
     format: core_1.Flags.string({
@@ -150,7 +150,7 @@ Diff.flags = {
         char: 'o',
         description: 'path to JSON file containing the override properties',
     }),
-    watch: flags_1.watchFlag,
+    watch: (0, flags_1.watchFlag)(),
 };
 Diff.args = [
     {

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

@@ -0,0 +1,32 @@
+import Command from '../../base';
+import type { Example } from '@oclif/core/lib/interfaces';
+export default class Template extends Command {
+    static description: string;
+    static examples: Example[];
+    static flags: {
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+        'disable-hook': import("@oclif/core/lib/interfaces").OptionFlag<string[]>;
+        install: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        debug: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'no-overwrite': import("@oclif/core/lib/interfaces").OptionFlag<string[]>;
+        output: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        'force-write': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        watch: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        param: import("@oclif/core/lib/interfaces").OptionFlag<string[]>;
+        'map-base-url': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    run(): Promise<void>;
+    private parseFlags;
+    private paramParser;
+    private disableHooksParser;
+    private mapBaseURLParser;
+    private generate;
+    private runWatchMode;
+    private watcherHandler;
+    private getMapBaseUrlToFolderResolver;
+}

package/lib/commands/generate/fromTemplate.js

@@ -0,0 +1,273 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const base_1 = tslib_1.__importDefault(require("../../base"));
+// eslint-disable-next-line
+// @ts-ignore
+const generator_1 = tslib_1.__importDefault(require("@asyncapi/generator"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const os_1 = tslib_1.__importDefault(require("os"));
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const SpecificationFile_1 = require("../../models/SpecificationFile");
+const flags_1 = require("../../flags");
+const generator_2 = require("../../utils/generator");
+const validation_error_1 = require("../../errors/validation-error");
+const generator_error_1 = require("../../errors/generator-error");
+const red = (text) => `\x1b[31m${text}\x1b[0m`;
+const magenta = (text) => `\x1b[35m${text}\x1b[0m`;
+const yellow = (text) => `\x1b[33m${text}\x1b[0m`;
+const green = (text) => `\x1b[32m${text}\x1b[0m`;
+class Template extends base_1.default {
+    constructor() {
+        super(...arguments);
+        this.getMapBaseUrlToFolderResolver = (urlToFolder) => {
+            return {
+                order: 1,
+                canRead() {
+                    return true;
+                },
+                read(file) {
+                    const baseUrl = urlToFolder.url;
+                    const baseDir = urlToFolder.folder;
+                    return new Promise(((resolve, reject) => {
+                        let localpath = file.url;
+                        localpath = localpath.replace(baseUrl, baseDir);
+                        try {
+                            fs_1.default.readFile(localpath, (err, data) => {
+                                if (err) {
+                                    reject(`Error opening file "${localpath}"`);
+                                }
+                                else {
+                                    resolve(data);
+                                }
+                            });
+                        }
+                        catch (err) {
+                            reject(`Error opening file "${localpath}"`);
+                        }
+                    }));
+                }
+            };
+        };
+    }
+    async run() {
+        const { args, flags } = await this.parse(Template); // NOSONAR
+        const asyncapi = args['asyncapi'];
+        const template = args['template'];
+        const output = flags.output || process.cwd();
+        const parsedFlags = this.parseFlags(flags['disable-hook'], flags['param'], flags['map-base-url']);
+        const options = {
+            forceWrite: flags['force-write'],
+            install: flags.install,
+            debug: flags.debug,
+            templateParams: parsedFlags.params,
+            noOverwriteGlobs: flags['no-overwrite'],
+            mapBaseUrlToFolder: parsedFlags.mapBaseUrlToFolder,
+            disabledHooks: parsedFlags.disableHooks,
+        };
+        const watchTemplate = flags['watch'];
+        const genOption = {};
+        if (flags['map-base-url']) {
+            genOption.resolve = { resolve: this.getMapBaseUrlToFolderResolver(parsedFlags.mapBaseUrlToFolder) };
+        }
+        await this.generate(asyncapi, template, output, options, genOption);
+        if (watchTemplate) {
+            const watcherHandler = this.watcherHandler(asyncapi, template, output, options, genOption);
+            await this.runWatchMode(asyncapi, template, output, watcherHandler);
+        }
+    }
+    parseFlags(disableHooks, params, mapBaseUrl) {
+        return {
+            params: this.paramParser(params),
+            disableHooks: this.disableHooksParser(disableHooks),
+            mapBaseUrlToFolder: this.mapBaseURLParser(mapBaseUrl),
+        };
+    }
+    paramParser(inputs) {
+        if (!inputs) {
+            return {};
+        }
+        const params = {};
+        for (const input of inputs) {
+            if (!input.includes('=')) {
+                throw new Error(`Invalid param ${input}. It must be in the format of --param name1=value1 name2=value2 `);
+            }
+            const [paramName, paramValue] = input.split(/=(.+)/, 2);
+            params[String(paramName)] = paramValue;
+        }
+        return params;
+    }
+    disableHooksParser(inputs) {
+        if (!inputs) {
+            return {};
+        }
+        const disableHooks = {};
+        for (const input of inputs) {
+            const [hookType, hookNames] = input.split(/=/);
+            if (!hookType) {
+                throw new Error('Invalid --disable-hook flag. It must be in the format of: --disable-hook <hookType> or --disable-hook <hookType>=<hookName1>,<hookName2>,...');
+            }
+            if (hookNames) {
+                disableHooks[String(hookType)] = hookNames.split(',');
+            }
+            else {
+                disableHooks[String(hookType)] = true;
+            }
+        }
+        return disableHooks;
+    }
+    mapBaseURLParser(input) {
+        if (!input) {
+            return;
+        }
+        const mapBaseURLToFolder = {};
+        const re = /(.*):(.*)/g; // NOSONAR
+        let mapping = [];
+        if ((mapping = re.exec(input)) === null || mapping.length !== 3) {
+            throw new Error('Invalid --map-base-url flag. A mapping <url>:<folder> with delimiter : expected.');
+        }
+        mapBaseURLToFolder.url = mapping[1].replace(/\/$/, '');
+        mapBaseURLToFolder.folder = path_1.default.resolve(mapping[2]);
+        const isURL = /^https?:/;
+        if (!isURL.test(mapBaseURLToFolder.url.toLowerCase())) {
+            throw new Error('Invalid --map-base-url flag. The mapping <url>:<folder> requires a valid http/https url and valid folder with delimiter `:`.');
+        }
+        return mapBaseURLToFolder;
+    }
+    async generate(asyncapi, template, output, options, genOption) {
+        let specification;
+        try {
+            specification = await (0, SpecificationFile_1.load)(asyncapi);
+        }
+        catch (err) {
+            return this.error(new validation_error_1.ValidationError({
+                type: 'invalid-file',
+                filepath: asyncapi,
+            }), { exit: 1 });
+        }
+        const generator = new generator_1.default(template, output || path_1.default.resolve(os_1.default.tmpdir(), 'asyncapi-generator'), options);
+        core_1.CliUx.ux.action.start('Generation in progress. Keep calm and wait a bit');
+        try {
+            await generator.generateFromString(specification.text(), genOption);
+            core_1.CliUx.ux.action.stop();
+        }
+        catch (err) {
+            core_1.CliUx.ux.action.stop('done\n');
+            throw new generator_error_1.GeneratorError(err);
+        }
+        console.log(`${yellow('Check out your shiny new generated files at ') + magenta(output) + yellow('.')}\n`);
+    }
+    async runWatchMode(asyncapi, template, output, watchHandler) {
+        const specification = await (0, SpecificationFile_1.load)(asyncapi);
+        const watchDir = path_1.default.resolve(template);
+        const outputPath = path_1.default.resolve(watchDir, output);
+        const transpiledTemplatePath = path_1.default.resolve(watchDir, generator_1.default.TRANSPILED_TEMPLATE_LOCATION);
+        const ignorePaths = [outputPath, transpiledTemplatePath];
+        const specificationFile = specification.getFilePath();
+        // Template name is needed as it is not always a part of the cli commad
+        // There is a use case that you run generator from a root of the template with `./` path
+        let templateName = '';
+        try {
+            // eslint-disable-next-line
+            templateName = require(path_1.default.resolve(watchDir, 'package.json')).name;
+        }
+        catch (err) {
+            // intentional
+        }
+        let watcher;
+        if (specificationFile) { // is local AsyncAPI file
+            this.log(`[WATCHER] Watching for changes in the template directory ${magenta(watchDir)} and in the AsyncAPI file ${magenta(specificationFile)}`);
+            watcher = new generator_2.Watcher([specificationFile, watchDir], ignorePaths);
+        }
+        else {
+            this.log(`[WATCHER] Watching for changes in the template directory ${magenta(watchDir)}`);
+            watcher = new generator_2.Watcher(watchDir, ignorePaths);
+        }
+        // Must check template in its installation path in generator to use isLocalTemplate function
+        if (!await (0, generator_2.isLocalTemplate)(path_1.default.resolve(generator_1.default.DEFAULT_TEMPLATES_DIR, templateName))) {
+            this.warn(`WARNING: ${template} is a remote template. Changes may be lost on subsequent installations.`);
+        }
+        watcher.watch(watchHandler, (paths) => {
+            this.error(`[WATCHER] Could not find the file path ${paths}, are you sure it still exists? If it has been deleted or moved please rerun the generator.`, {
+                exit: 1,
+            });
+        });
+    }
+    watcherHandler(asyncapi, template, output, options, genOption) {
+        return async (changedFiles) => {
+            console.clear();
+            console.log('[WATCHER] Change detected');
+            for (const [, value] of Object.entries(changedFiles)) {
+                let eventText;
+                switch (value.eventType) {
+                    case 'changed':
+                        eventText = green(value.eventType);
+                        break;
+                    case 'removed':
+                        eventText = red(value.eventType);
+                        break;
+                    case 'renamed':
+                        eventText = yellow(value.eventType);
+                        break;
+                    default:
+                        eventText = yellow(value.eventType);
+                }
+                this.log(`\t${magenta(value.path)} was ${eventText}`);
+            }
+            try {
+                await this.generate(asyncapi, template, output, options, genOption);
+            }
+            catch (err) {
+                throw new generator_error_1.GeneratorError(err);
+            }
+        };
+    }
+}
+exports.default = Template;
+Template.description = 'Generates whatever you want using templates compatible with AsyncAPI Generator.';
+Template.examples = [
+    'asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write'
+];
+Template.flags = {
+    help: core_1.Flags.help({ char: 'h' }),
+    'disable-hook': core_1.Flags.string({
+        char: 'd',
+        description: 'Disable a specific hook type or hooks from a given hook type',
+        multiple: true
+    }),
+    install: core_1.Flags.boolean({
+        char: 'i',
+        default: false,
+        description: 'Installs the template and its dependencies (defaults to false)'
+    }),
+    debug: core_1.Flags.boolean({
+        description: 'Enable more specific errors in the console'
+    }),
+    'no-overwrite': core_1.Flags.string({
+        char: 'n',
+        multiple: true,
+        description: 'Glob or path of the file(s) to skip when regenerating'
+    }),
+    output: core_1.Flags.string({
+        char: 'o',
+        description: 'Directory where to put the generated files (defaults to current directory)',
+    }),
+    'force-write': core_1.Flags.boolean({
+        default: false,
+        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)'
+    }),
+    watch: (0, flags_1.watchFlag)('Watches the template directory and the AsyncAPI document, and re-generate the files when changes occur. Ignores the output directory.'),
+    param: core_1.Flags.string({
+        char: 'p',
+        description: 'Additional param to pass to templates',
+        multiple: true
+    }),
+    '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 },
+    { name: 'template', description: '- Name of the generator template like for example @asyncapi/html-template or https://github.com/asyncapi/html-template', required: true }
+];

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

@@ -0,0 +1,5 @@
+import Command from '../../base';
+export default class Generate extends Command {
+    static description: string;
+    run(): Promise<void>;
+}

package/lib/commands/generate/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const base_1 = tslib_1.__importDefault(require("../../base"));
+const core_1 = require("@oclif/core");
+class Generate extends base_1.default {
+    async run() {
+        const help = new core_1.Help(this.config);
+        help.showHelp(['generate', '--help']);
+    }
+}
+exports.default = Generate;
+Generate.description = 'Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates.';

package/lib/commands/new.js

@@ -115,7 +115,7 @@ class New extends base_1.default {
     }
 }
 exports.default = New;
-New.description = 'creates a new asyncapi file';
+New.description = 'Creates a new asyncapi file';
 New.flags = {
     help: core_1.Flags.help({ char: 'h' }),
     'file-name': core_1.Flags.string({ char: 'n', description: 'name of the file' }),

package/lib/commands/start/index.d.ts

@@ -1,4 +1,5 @@
 import Command from '../../base';
 export default class Start extends Command {
+    static description: string;
     run(): Promise<void>;
 }

package/lib/commands/start/index.js

@@ -5,9 +5,9 @@ const base_1 = tslib_1.__importDefault(require("../../base"));
 const core_1 = require("@oclif/core");
 class Start extends base_1.default {
     async run() {
-        const Help = await (0, core_1.loadHelpClass)(this.config);
-        const help = new Help(this.config);
+        const help = new core_1.Help(this.config);
         help.showHelp(['start', '--help']);
     }
 }
 exports.default = Start;
+Start.description = 'Start asyncapi studio';

package/lib/commands/validate.js

@@ -39,7 +39,7 @@ exports.default = Validate;
 Validate.description = 'validate asyncapi file';
 Validate.flags = {
     help: core_1.Flags.help({ char: 'h' }),
-    watch: flags_1.watchFlag
+    watch: (0, flags_1.watchFlag)()
 };
 Validate.args = [
     { name: 'spec-file', description: 'spec path, url, or context-name', required: false },

package/lib/errors/generator-error.d.ts

@@ -0,0 +1,3 @@
+export declare class GeneratorError extends Error {
+    constructor(err: Error);
+}

package/lib/errors/generator-error.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeneratorError = void 0;
+class GeneratorError extends Error {
+    constructor(err) {
+        super();
+        this.name = 'Generator Error';
+        this.message = err.message;
+    }
+}
+exports.GeneratorError = GeneratorError;

package/lib/flags.d.ts

@@ -1 +1 @@
-export declare const watchFlag: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+export declare const watchFlag: (description?: string) => import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;

package/lib/flags.js

@@ -2,7 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.watchFlag = void 0;
 const core_1 = require("@oclif/core");
-exports.watchFlag = core_1.Flags.boolean({
-    char: 'w',
-    description: 'Enable watch mode'
-});
+const watchFlag = (description) => {
+    return core_1.Flags.boolean({
+        default: false,
+        char: 'w',
+        description: description || 'Enable watch mode',
+    });
+};
+exports.watchFlag = watchFlag;

package/lib/utils/generator.d.ts

@@ -0,0 +1,48 @@
+export declare function isLocalTemplate(templatePath: string): Promise<boolean>;
+export declare class Watcher {
+    private watchers;
+    private fsWait;
+    private filesChanged;
+    private ignorePaths;
+    private paths;
+    constructor(paths: string | string[], ignorePaths: string[]);
+    /**
+     * Initiates watch on a path.
+     * @param {*} path The path the watcher is listening on.
+     * @param {*} changeCallback Callback to call when changed occur.
+     * @param {*} errorCallback Calback to call when it is no longer possible to watch a file.
+     */
+    initiateWatchOnPath(path: string, changeCallback: any, errorCallback: any): void;
+    /**
+     * This method initiate the watch for change in all files
+     * @param {*} callback called when the file(s) change
+     */
+    watch(changeCallback: any, errorCallback: any): Promise<void>;
+    /**
+     * Should be called when a file has changed one way or another.
+     * @param {*} listenerPath The path the watcher is listening on.
+     * @param {*} changedPath The file/dir that was changed
+     * @param {*} eventType What kind of change
+     * @param {*} changeCallback Callback to call when changed occur.
+     * @param {*} errorCallback Calback to call when it is no longer possible to watch a file.
+     */
+    fileChanged(listenerPath: string, changedPath: string, eventType: string, changeCallback: any, errorCallback: any): void;
+    /**
+     * Convert the event type to a more usefull one.
+     * @param {*} currentEventType The current event type (from chokidar)
+     */
+    convertEventType(currentEventType: string): string;
+    /**
+     * Get all paths which no longer exists
+     */
+    getAllNonExistingPaths(): any[];
+    /**
+     * Closes all active watchers down.
+     */
+    closeWatchers(): void;
+    /**
+     * Closes an active watcher down.
+     * @param {*} path The path to close the watcher for.
+     */
+    closeWatcher(path: string): void;
+}

package/lib/utils/generator.js

@@ -0,0 +1,153 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Watcher = exports.isLocalTemplate = void 0;
+const tslib_1 = require("tslib");
+// eslint-disable security/detect-object-injection
+const fs = tslib_1.__importStar(require("fs"));
+const util_1 = require("util");
+const chokidar_1 = tslib_1.__importDefault(require("chokidar"));
+const lstat = (0, util_1.promisify)(fs.lstat);
+async function isLocalTemplate(templatePath) {
+    const stats = await lstat(templatePath);
+    return stats.isSymbolicLink();
+}
+exports.isLocalTemplate = isLocalTemplate;
+class Watcher {
+    constructor(paths, ignorePaths) {
+        if (Array.isArray(paths)) {
+            this.paths = paths;
+        }
+        else {
+            this.paths = [paths];
+        }
+        //Ensure all backwards slashes are replaced with forward slash based on the requirement from chokidar
+        for (const pathIndex in this.paths) {
+            const path = this.paths[String(pathIndex)];
+            this.paths[String(pathIndex)] = path.replace(/[\\]/g, '/');
+        }
+        this.fsWait = false;
+        this.watchers = {};
+        this.filesChanged = {};
+        this.ignorePaths = ignorePaths;
+    }
+    /**
+     * Initiates watch on a path.
+     * @param {*} path The path the watcher is listening on.
+     * @param {*} changeCallback Callback to call when changed occur.
+     * @param {*} errorCallback Calback to call when it is no longer possible to watch a file.
+     */
+    initiateWatchOnPath(path, changeCallback, errorCallback) {
+        const watcher = chokidar_1.default.watch(path, { ignoreInitial: true, ignored: this.ignorePaths });
+        watcher.on('all', (eventType, changedPath) => this.fileChanged(path, changedPath, eventType, changeCallback, errorCallback));
+        this.watchers[String(path)] = watcher;
+    }
+    /**
+     * This method initiate the watch for change in all files
+     * @param {*} callback called when the file(s) change
+     */
+    async watch(changeCallback, errorCallback) {
+        for (const index in this.paths) {
+            const path = this.paths[String(index)];
+            this.initiateWatchOnPath(path, changeCallback, errorCallback);
+        }
+    }
+    /**
+     * Should be called when a file has changed one way or another.
+     * @param {*} listenerPath The path the watcher is listening on.
+     * @param {*} changedPath The file/dir that was changed
+     * @param {*} eventType What kind of change
+     * @param {*} changeCallback Callback to call when changed occur.
+     * @param {*} errorCallback Calback to call when it is no longer possible to watch a file.
+     */
+    fileChanged(listenerPath, changedPath, eventType, changeCallback, errorCallback) {
+        try {
+            if (fs.existsSync(listenerPath)) {
+                const newEventType = this.convertEventType(eventType);
+                this.filesChanged[String(changedPath)] = { eventType: newEventType, path: changedPath };
+                // Since multiple changes can occur at the same time, lets wait a bit before processing.
+                if (this.fsWait) {
+                    return;
+                }
+                this.fsWait = setTimeout(async () => {
+                    await changeCallback(this.filesChanged);
+                    this.filesChanged = {};
+                    this.fsWait = false;
+                }, 500);
+            }
+        }
+        catch (e) {
+            // File was not, find all files that are missing..
+            const unknownPaths = this.getAllNonExistingPaths();
+            this.closeWatchers();
+            errorCallback(unknownPaths);
+        }
+    }
+    /**
+     * Convert the event type to a more usefull one.
+     * @param {*} currentEventType The current event type (from chokidar)
+     */
+    convertEventType(currentEventType) {
+        let newEventType = currentEventType;
+        //Change the naming of the event type
+        switch (newEventType) {
+            case 'unlink':
+            case 'unlinkDir':
+                newEventType = 'removed';
+                break;
+            case 'addDir':
+            case 'add':
+                newEventType = 'added';
+                break;
+            case 'change':
+                newEventType = 'changed';
+                break;
+            case 'rename':
+                newEventType = 'renamed';
+                break;
+            default:
+                newEventType = `unknown (${currentEventType})`;
+        }
+        return newEventType;
+    }
+    /**
+     * Get all paths which no longer exists
+     */
+    getAllNonExistingPaths() {
+        const unknownPaths = [];
+        for (const index in this.paths) {
+            const path = this.paths[String(index)];
+            if (!fs.existsSync(path)) {
+                unknownPaths.push(path);
+            }
+        }
+        return unknownPaths;
+    }
+    /**
+     * Closes all active watchers down.
+     */
+    closeWatchers() {
+        this.filesChanged = {};
+        for (const index in this.paths) {
+            const path = this.paths[String(index)];
+            this.closeWatcher(path);
+        }
+    }
+    /**
+     * Closes an active watcher down.
+     * @param {*} path The path to close the watcher for.
+     */
+    closeWatcher(path) {
+        // Ensure if called before `watch` to do nothing
+        if (path !== null) {
+            const watcher = this.watchers[String(path)];
+            if (watcher !== null) {
+                watcher.close();
+                this.watchers[String(path)] = null;
+            }
+            else {
+                //Watcher not found for path
+            }
+        }
+    }
+}
+exports.Watcher = Watcher;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.23.1","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.4.0"}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}],"_globalFlags":{}},"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}],"_globalFlags":{}},"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":[],"_globalFlags":{}},"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}],"_globalFlags":{}},"config":{"id":"config","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},"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"]},{"name":"file","description":"Path or URL to the AsyncAPI document, or context-name","required":true}],"_globalFlags":{}},"start":{"id":"start","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":[],"_globalFlags":{}},"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}],"_globalFlags":{}},"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":[],"_globalFlags":{}},"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":[],"_globalFlags":{}},"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}],"_globalFlags":{}},"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}],"_globalFlags":{}}}}
+{"version":"0.24.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.4.0"}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}],"_globalFlags":{}},"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}],"_globalFlags":{}},"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":[],"_globalFlags":{}},"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}],"_globalFlags":{}},"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}],"_globalFlags":{}},"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},"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"]},{"name":"file","description":"Path or URL to the AsyncAPI document, or context-name","required":true}],"_globalFlags":{}},"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":[],"_globalFlags":{}},"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}],"_globalFlags":{}},"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":[],"_globalFlags":{}},"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":[],"_globalFlags":{}},"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}],"_globalFlags":{}},"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}],"_globalFlags":{}}}}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "0.23.1",
+  "version": "0.24.0",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run"
@@ -10,6 +10,7 @@
   "dependencies": {
     "@asyncapi/converter": "^1.0.0",
     "@asyncapi/diff": "^0.4.0",
+    "@asyncapi/generator": "^1.9.4",
     "@asyncapi/modelina": "^0.59.7",
     "@asyncapi/parser": "^1.16.0",
     "@asyncapi/studio": "^0.12.15",
@@ -33,6 +34,7 @@
     "ws": "^8.2.3"
   },
   "devDependencies": {
+    "@babel/core": "^7.17.9",
     "@oclif/test": "^2",
     "@semantic-release/commit-analyzer": "^8.0.1",
     "@semantic-release/github": "^7.2.3",
@@ -67,7 +69,8 @@
     "souvikns-oclif": "^2.5.0",
     "ts-node": "^10.4.0",
     "tslib": "^2.3.1",
-    "typescript": "^4.4.3"
+    "typescript": "^4.4.3",
+    "@asyncapi/minimaltemplate": "./test/minimaltemplate"
   },
   "engines": {
     "node": ">12.16"
@@ -97,7 +100,12 @@
     "topicSeparator": " ",
     "topics": {
       "config:context": {},
-      "config": {}
+      "config": {
+        "description": "CLI config settings"
+      },
+      "generate": {
+        "description": "Generate models and template"
+      }
     }
   },
   "publishConfig": {