@asyncapi/cli 0.13.3 → 0.15.0

package/README.md

@@ -69,8 +69,9 @@ USAGE
 
 COMMANDS
   config    access configs
-  help      display help for asyncapi
+  diff      find diff between two asyncapi files
   new       creates a new asyncapi file
+  start     starts a new local instance of Studio
   validate  validate asyncapi file
 ```
 
@@ -92,3 +93,35 @@ UX developed for the CLI should be compliant with [Command Line Interface Guidel
 ### Command Structure and Patterns
 
 We are following `verb + noun` and `namespace + noun + [verb]` pattern for making our commands and arguments. For example `asyncapi validate <spec-file-path>` and `asyncapi config context add <context-name> <spec-file-path>`.
+
+## Contributors
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/jotamusik"><img src="https://avatars.githubusercontent.com/u/14940638?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Jorge Aguiar Martín</b></sub></a><br /><a href="https://github.com/asyncapi/cli/commits?author=jotamusik" title="Code">💻</a> <a href="#ideas-jotamusik" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/asyncapi/cli/commits?author=jotamusik" title="Tests">⚠️</a> <a href="https://github.com/asyncapi/cli/commits?author=jotamusik" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://www.brainfart.dev/"><img src="https://avatars.githubusercontent.com/u/6995927?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Lukasz Gornicki</b></sub></a><br /><a href="#ideas-derberg" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/asyncapi/cli/commits?author=derberg" title="Code">💻</a> <a href="https://github.com/asyncapi/cli/pulls?q=is%3Apr+reviewed-by%3Aderberg" title="Reviewed Pull Requests">👀</a> <a href="#maintenance-derberg" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="https://souvik.vercel.app/"><img src="https://avatars.githubusercontent.com/u/41781438?v=4?s=100" width="100px;" alt=""/><br /><sub><b>souvik</b></sub></a><br /><a href="https://github.com/asyncapi/cli/commits?author=Souvikns" title="Code">💻</a> <a href="#ideas-Souvikns" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/asyncapi/cli/commits?author=Souvikns" title="Tests">⚠️</a> <a href="https://github.com/asyncapi/cli/pulls?q=is%3Apr+reviewed-by%3ASouvikns" title="Reviewed Pull Requests">👀</a> <a href="#maintenance-Souvikns" title="Maintenance">🚧</a> <a href="https://github.com/asyncapi/cli/commits?author=Souvikns" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://boyney.io/"><img src="https://avatars.githubusercontent.com/u/3268013?v=4?s=100" width="100px;" alt=""/><br /><sub><b>David Boyne</b></sub></a><br /><a href="https://github.com/asyncapi/cli/commits?author=boyney123" title="Code">💻</a> <a href="#ideas-boyney123" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-boyney123" title="Maintenance">🚧</a></td>
+    <td align="center"><a href="http://www.fmvilas.com/"><img src="https://avatars.githubusercontent.com/u/242119?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Fran Méndez</b></sub></a><br /><a href="https://github.com/asyncapi/cli/commits?author=fmvilas" title="Code">💻</a> <a href="#ideas-fmvilas" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/asyncapi/cli/pulls?q=is%3Apr+reviewed-by%3Afmvilas" title="Reviewed Pull Requests">👀</a></td>
+    <td align="center"><a href="https://github.com/magicmatatjahu"><img src="https://avatars.githubusercontent.com/u/20404945?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Maciej Urbańczyk</b></sub></a><br /><a href="https://github.com/asyncapi/cli/pulls?q=is%3Apr+reviewed-by%3Amagicmatatjahu" title="Reviewed Pull Requests">👀</a> <a href="#maintenance-magicmatatjahu" title="Maintenance">🚧</a> <a href="#ideas-magicmatatjahu" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://aayushsahu.com/"><img src="https://avatars.githubusercontent.com/u/54525741?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Aayush Kumar Sahu</b></sub></a><br /><a href="https://github.com/asyncapi/cli/commits?author=aayushmau5" title="Code">💻</a> <a href="https://github.com/asyncapi/cli/commits?author=aayushmau5" title="Tests">⚠️</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/mihirterna"><img src="https://avatars.githubusercontent.com/u/31316452?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Mihir Kulkarni</b></sub></a><br /><a href="https://github.com/asyncapi/cli/commits?author=mihirterna" title="Code">💻</a></td>
+    <td align="center"><a href="https://imabp.github.io/resume/"><img src="https://avatars.githubusercontent.com/u/53480076?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Abir</b></sub></a><br /><a href="https://github.com/asyncapi/cli/commits?author=imabp" title="Tests">⚠️</a> <a href="https://github.com/asyncapi/cli/commits?author=imabp" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/peter-rr"><img src="https://avatars.githubusercontent.com/u/81691177?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Peter Ramos</b></sub></a><br /><a href="https://github.com/asyncapi/cli/commits?author=peter-rr" title="Code">💻</a></td>
+    <td align="center"><a href="https://samridhi-98.github.io/Portfolio"><img src="https://avatars.githubusercontent.com/u/54466041?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Samriddhi</b></sub></a><br /><a href="https://github.com/asyncapi/cli/commits?author=Samridhi-98" title="Tests">⚠️</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

package/lib/commands/diff.d.ts

@@ -8,6 +8,7 @@ export default class Diff extends Command {
         format: flags.IOptionFlag<string>;
         type: flags.IOptionFlag<string>;
         overrides: flags.IOptionFlag<string | undefined>;
+        watch: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
     };
     static args: {
         name: string;

package/lib/commands/diff.js

@@ -11,6 +11,8 @@ const base_1 = tslib_1.__importDefault(require("../base"));
 const validation_error_1 = require("../errors/validation-error");
 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 { readFile } = fs_1.promises;
 class Diff extends base_1.default {
     async run() {
@@ -20,9 +22,11 @@ class Diff extends base_1.default {
         const outputFormat = flags['format'];
         const outputType = flags['type'];
         const overrideFilePath = flags['overrides'];
+        const watchMode = flags['watch'];
         let firstDocument, secondDocument;
         try {
             firstDocument = await SpecificationFile_1.load(firstDocumentPath);
+            enableWatch(watchMode, { spec: firstDocument, handler: this, handlerName: 'diff', docVersion: 'old', label: 'DIFF_OLD' });
         }
         catch (err) {
             if (err instanceof specification_file_1.SpecificationFileNotFound) {
@@ -37,6 +41,7 @@ class Diff extends base_1.default {
         }
         try {
             secondDocument = await SpecificationFile_1.load(secondDocumentPath);
+            enableWatch(watchMode, { spec: secondDocument, handler: this, handlerName: 'diff', docVersion: 'new', label: 'DIFF_NEW' });
         }
         catch (err) {
             if (err instanceof specification_file_1.SpecificationFileNotFound) {
@@ -116,6 +121,7 @@ Diff.flags = {
         char: 'o',
         description: 'path to JSON file containing the override properties',
     }),
+    watch: flags_1.watchFlag
 };
 Diff.args = [
     {
@@ -149,3 +155,12 @@ async function readOverrideFile(path) {
         throw new diff_error_1.DiffOverrideJSONError();
     }
 }
+/**
+ * function to enable watchmode.
+ * The function is abstracted here, to avoid eslint cognitive complexity error.
+ */
+const enableWatch = (status, watcher) => {
+    if (status) {
+        globals_1.specWatcher(watcher);
+    }
+};

package/lib/commands/new.js

@@ -19,7 +19,7 @@ class New extends base_1.default {
         }
         const fileName = flags['file-name'] || DEFAULT_ASYNCAPI_FILE_NAME;
         const template = flags['example'] || DEFAULT_ASYNCAPI_TEMPLATE;
-        this.createAsyncapiFile(fileName, template);
+        await this.createAsyncapiFile(fileName, template);
         if (flags.studio) {
             if (isTTY) {
                 Studio_1.start(fileName, flags.port || Studio_1.DEFAULT_PORT);

package/lib/commands/validate.d.ts

@@ -3,6 +3,7 @@ export default class Validate extends Command {
     static description: string;
     static flags: {
         help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+        watch: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;
     };
     static args: {
         name: string;

package/lib/commands/validate.js

@@ -6,11 +6,17 @@ 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 SpecificationFile_1 = require("../models/SpecificationFile");
+const globals_1 = require("../globals");
+const flags_1 = require("../flags");
 class Validate extends base_1.default {
     async run() {
-        const { args } = this.parse(Validate);
+        const { args, flags } = this.parse(Validate); // NOSONAR
         const filePath = args['spec-file'];
+        const watchMode = flags['watch'];
         const specFile = await SpecificationFile_1.load(filePath);
+        if (watchMode) {
+            globals_1.specWatcher({ spec: specFile, handler: this, handlerName: 'validate' });
+        }
         try {
             if (specFile.getFilePath()) {
                 await parser.parse(specFile.text());
@@ -32,7 +38,8 @@ class Validate extends base_1.default {
 exports.default = Validate;
 Validate.description = 'validate asyncapi file';
 Validate.flags = {
-    help: command_1.flags.help({ char: 'h' })
+    help: command_1.flags.help({ char: 'h' }),
+    watch: flags_1.watchFlag
 };
 Validate.args = [
     { name: 'spec-file', description: 'spec path, url, or context-name', required: false },

package/lib/flags.d.ts

@@ -0,0 +1 @@
+export declare const watchFlag: import("@oclif/parser/lib/flags").IBooleanFlag<boolean>;

package/lib/flags.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.watchFlag = void 0;
+const command_1 = require("@oclif/command");
+exports.watchFlag = command_1.flags.boolean({
+    char: 'w',
+    description: 'Enable watch mode'
+});

package/lib/globals.d.ts

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

package/lib/globals.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.specWatcher = void 0;
+const tslib_1 = require("tslib");
+const chokidar_1 = tslib_1.__importDefault(require("chokidar"));
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const GreenLog = chalk_1.default.hex('#00FF00');
+const OrangeLog = chalk_1.default.hex('#FFA500');
+const CHOKIDAR_CONFIG = {
+// awaitWriteFinish: true // Used for large size specification files.
+};
+const WATCH_MESSAGES = {
+    logOnStart: (filePath) => console.log(GreenLog(`Watching AsyncAPI file at ${filePath}\n`)),
+    logOnChange: (handlerName) => console.log(OrangeLog(`Change detected, running ${handlerName}\n`)),
+    logOnAutoDisable: (docVersion = '') => console.log(OrangeLog(`Watch mode for ${docVersion || 'AsyncAPI'} file was not enabled.`), OrangeLog('\nINFO: Watch works only with files from local file system\n'))
+};
+const CHOKIDAR_INSTANCE_STORE = new Map();
+exports.specWatcher = (params) => {
+    if (!params.spec.getFilePath()) {
+        return WATCH_MESSAGES.logOnAutoDisable(params.docVersion);
+    }
+    if (CHOKIDAR_INSTANCE_STORE.get(params.label || '_default')) {
+        return;
+    }
+    const filePath = params.spec.getFilePath();
+    try {
+        WATCH_MESSAGES.logOnStart(filePath);
+        chokidar_1.default
+            .watch(filePath, CHOKIDAR_CONFIG)
+            .on('change', async () => {
+            WATCH_MESSAGES.logOnChange(params.handlerName);
+            try {
+                await params.handler.run();
+            }
+            catch (err) {
+                await params.handler.catch(err);
+            }
+        });
+        CHOKIDAR_INSTANCE_STORE.set(params.label || '_default', true);
+    }
+    catch (error) {
+        console.log(error);
+    }
+};

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.13.3","commands":{"config":{"id":"config","description":"access configs","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"diff":{"id":"diff","description":"find diff between two asyncapi files","pluginName":"@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","options":["json"],"default":"json"},"type":{"name":"type","type":"option","char":"t","description":"type of the output","options":["breaking","non-breaking","unclassified","all"],"default":"all"},"overrides":{"name":"overrides","type":"option","char":"o","description":"path to JSON file containing the override properties"}},"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","pluginName":"@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"},"example":{"name":"example","type":"option","char":"e","description":"name of the example to use"},"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"},"no-tty":{"name":"no-tty","type":"boolean","description":"do not use an interactive terminal","allowNo":false}},"args":[]},"start":{"id":"start","description":"starts a new local instance of Studio","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate asyncapi file","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"spec-file","description":"spec path, url, or context-name","required":false}]},"config:context":{"id":"config:context","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start:studio":{"id":"start:studio","description":"starts a new local instance of Studio","pluginName":"@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"},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio"}},"args":[]},"config:context:add":{"id":"config:context:add","description":"Add or modify a context in the store","pluginName":"@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","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"config:context:list":{"id":"config:context:list","description":"List all the stored context in the store","pluginName":"@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","pluginName":"@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","pluginName":"@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.15.0","commands":{"config":{"id":"config","description":"access configs","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"diff":{"id":"diff","description":"find diff between two asyncapi files","pluginName":"@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","options":["json"],"default":"json"},"type":{"name":"type","type":"option","char":"t","description":"type of the output","options":["breaking","non-breaking","unclassified","all"],"default":"all"},"overrides":{"name":"overrides","type":"option","char":"o","description":"path to JSON file containing the override properties"},"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","pluginName":"@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"},"example":{"name":"example","type":"option","char":"e","description":"name of the example to use"},"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"},"no-tty":{"name":"no-tty","type":"boolean","description":"do not use an interactive terminal","allowNo":false}},"args":[]},"start":{"id":"start","description":"starts a new local instance of Studio","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate asyncapi file","pluginName":"@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:context":{"id":"config:context","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start:studio":{"id":"start:studio","description":"starts a new local instance of Studio","pluginName":"@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"},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio"}},"args":[]},"config:context:add":{"id":"config:context:add","description":"Add or modify a context in the store","pluginName":"@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","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"config:context:list":{"id":"config:context:list","description":"List all the stored context in the store","pluginName":"@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","pluginName":"@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","pluginName":"@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.13.3",
+  "version": "0.15.0",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run"
@@ -10,7 +10,7 @@
   "dependencies": {
     "@asyncapi/diff": "^0.3.0",
     "@asyncapi/parser": "^1.14.0",
-    "@asyncapi/studio": "^0.9.0",
+    "@asyncapi/studio": "^0.10.0",
     "@fmvilas/oclif-plugin-spaced-commands": "^1.0.4",
     "@oclif/command": "^1.8.0",
     "@oclif/config": "^1.17.0",