@asyncapi/cli 2.16.0 → 2.16.1

package/README.md

@@ -12,6 +12,7 @@ CLI to work with your AsyncAPI files. Currently under development, we are workin
 
 - [Installation](#installation)
 - [Usage](#usage)
+- [Github Action](#github-action)
 - [Contributing](#contributing)
   * [Set up development environment](#set-up-development-environment)
   * [Command Structure and Patterns](#command-structure-and-patterns)
@@ -25,6 +26,9 @@ Learn how to install the AsyncAPI CLI by following the instructions in the [inst
 ## Usage
 The [usage guide](/docs/usage.md) provides information about different ways to use the CLI.
 
+## Github Action
+
+The AsyncAPI CLI can be used as a GitHub Action. You can find more information in the [GitHub Action guide](https://www.asyncapi.com/docs/tools/cli/github-action).
 
 ## Contributing
 

package/lib/commands/config/analytics.js

@@ -6,6 +6,7 @@ const base_1 = tslib_1.__importDefault(require("../../core/base"));
 const fs_1 = require("fs");
 const os_1 = require("os");
 const analytics_flags_1 = require("../../core/flags/config/analytics.flags");
+const picocolors_1 = require("picocolors");
 const { readFile, writeFile } = fs_1.promises;
 class Analytics extends base_1.default {
     run() {
@@ -25,7 +26,7 @@ class Analytics extends base_1.default {
                     this.metricsMetadata.analytics_enabled = flags.enable;
                 }
                 else if (!flags.status) {
-                    this.log('\nPlease append the "--disable" flag to the command in case you prefer to disable analytics, or use the "--enable" flag if you want to enable analytics back again. In case you do not know the analytics current status, then you can append the "--status" flag to be aware of it.\n');
+                    this.log(`\nPlease append the ${(0, picocolors_1.blueBright)('--disable')} flag to the command if you prefer to disable analytics, or use the ${(0, picocolors_1.blueBright)('--enable')} flag if you want to enable analytics again. To check the current analytics status, use the ${(0, picocolors_1.blueBright)('--status')} flag.\n`);
                     return;
                 }
                 yield writeFile(analyticsConfigFile, JSON.stringify(analyticsConfigFileContent), { encoding: 'utf8' });
@@ -34,7 +35,7 @@ class Analytics extends base_1.default {
                         this.log('\nAnalytics are enabled.\n');
                     }
                     else {
-                        this.log('\nAnalytics are disabled. Please append the "--enable" flag to the command in case you prefer to enable analytics.\n');
+                        this.log(`\n${(0, picocolors_1.redBright)('Analytics are disabled.')} To enable analytics, use the ${(0, picocolors_1.blueBright)('--enable')} flag.\n`);
                     }
                     this.metricsMetadata.analytics_status_checked = flags.status;
                 }
@@ -42,13 +43,13 @@ class Analytics extends base_1.default {
             catch (e) {
                 switch (e.code) {
                     case 'ENOENT':
-                        this.error(`Unable to access the analytics configuration file. We tried to access the ".asyncapi-analytics" file in in the path "${analyticsConfigFile}" but the file could not be found.`);
+                        this.error(`Unable to access the analytics configuration file. We tried to access the ${(0, picocolors_1.blueBright)('.asyncapi-analytics')} file in the path "${(0, picocolors_1.blueBright)(analyticsConfigFile)}" but the file could not be found.`);
                         break;
                     case 'EEXIST':
-                        this.error(`Unable to update the analytics configuration file. We tried to update your ".asyncapi-analytics" file in the path "${analyticsConfigFile}" but the file does not exist.`);
+                        this.error(`Unable to update the analytics configuration file. We tried to update your ".asyncapi-analytics" file in the path "${(0, picocolors_1.blueBright)(analyticsConfigFile)}" but the file does not exist.`);
                         break;
                     default:
-                        this.error(`Unable to change your analytics configuration. Please check the following message for further info about the error:\n\n${e}`);
+                        this.error(`Unable to change your analytics configuration. Please check the following message for further info about the error:\n\n${(0, picocolors_1.redBright)(e)}`);
                 }
             }
         });

package/lib/commands/config/context/add.js

@@ -6,6 +6,7 @@ const base_1 = tslib_1.__importDefault(require("../../../core/base"));
 const Context_1 = require("../../../core/models/Context");
 const context_error_1 = require("../../../core/errors/context-error");
 const context_flags_1 = require("../../../core/flags/config/context.flags");
+const picocolors_1 = require("picocolors");
 class ContextAdd extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -15,16 +16,15 @@ class ContextAdd extends base_1.default {
             const setAsCurrent = flags['set-current'];
             try {
                 yield (0, Context_1.addContext)(contextName, specFilePath);
-                this.log(`Added context "${contextName}".\n\nYou can set it as your current context: asyncapi config context use ${contextName}\nYou can use this context when needed by passing ${contextName} as a parameter: asyncapi validate ${contextName}`);
+                this.log(`🎉 Context ${(0, picocolors_1.blueBright)(contextName)} added successfully!\nYou can set it as your current context:\n  ${(0, picocolors_1.blueBright)('asyncapi')} ${(0, picocolors_1.blueBright)('config')} ${(0, picocolors_1.blueBright)('context')} ${(0, picocolors_1.blueBright)('use')} ${(0, picocolors_1.blueBright)(contextName)}\nYou can use this context when needed by passing ${(0, picocolors_1.blueBright)(contextName)} as a parameter:\n  ${(0, picocolors_1.blueBright)('asyncapi')} ${(0, picocolors_1.blueBright)('validate')} ${(0, picocolors_1.blueBright)(contextName)}`);
                 if (setAsCurrent) {
                     yield (0, Context_1.setCurrentContext)(contextName);
-                    this.log(`The newly added context "${contextName}", is set as your current context!`);
+                    this.log(`\nThe newly added context, ${(0, picocolors_1.blueBright)(contextName)}, is set as your current context!`);
                 }
             }
             catch (e) {
                 if (e instanceof (context_error_1.MissingContextFileError || context_error_1.ContextFileWrongFormatError)) {
-                    this.log('You have no context file configured. Run "asyncapi config context init" to initialize it.');
-                    return;
+                    this.error(`Unable to add context. You have no context file configured.\nRun ${(0, picocolors_1.blueBright)('asyncapi config context init')} to initialize it.`);
                 }
                 throw e;
             }

package/lib/commands/config/context/current.js

@@ -5,6 +5,7 @@ const base_1 = tslib_1.__importDefault(require("../../../core/base"));
 const Context_1 = require("../../../core/models/Context");
 const context_error_1 = require("../../../core/errors/context-error");
 const global_flags_1 = require("../../../core/flags/global.flags");
+const picocolors_1 = require("picocolors");
 class ContextCurrent extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -14,22 +15,19 @@ class ContextCurrent extends base_1.default {
             }
             catch (e) {
                 if (e instanceof (context_error_1.MissingContextFileError || context_error_1.ContextFileWrongFormatError)) {
-                    this.log('You have no context file configured. Run "asyncapi config context init" to initialize it.');
-                    return;
+                    this.error(`Unable to show current context. You have no context file configured.\nRun ${(0, picocolors_1.blueBright)('asyncapi config context init')} to initialize it.`);
                 }
                 else if (e instanceof context_error_1.ContextFileEmptyError) {
-                    this.log(`Context file "${Context_1.CONTEXT_FILE_PATH}" is empty.`);
-                    return;
+                    this.error(`Context file ${(0, picocolors_1.blueBright)(Context_1.CONTEXT_FILE_PATH)} is empty.`);
                 }
                 else if (e instanceof context_error_1.ContextNotFoundError ||
                     (fileContent && !fileContent.current)) {
-                    this.log('No context is set as current. Run "asyncapi config context" to see all available options.');
-                    return;
+                    this.error(`No context is set as current.\nRun ${(0, picocolors_1.blueBright)('asyncapi config context')} to see all available options.`);
                 }
                 throw e;
             }
             if (fileContent) {
-                this.log(`${fileContent.current}: ${fileContent.context}`);
+                this.log(`${(0, picocolors_1.blueBright)(fileContent.current)}: ${fileContent.context}`);
             }
         });
     }

package/lib/commands/config/context/edit.js

@@ -6,6 +6,7 @@ const base_1 = tslib_1.__importDefault(require("../../../core/base"));
 const Context_1 = require("../../../core/models/Context");
 const context_error_1 = require("../../../core/errors/context-error");
 const global_flags_1 = require("../../../core/flags/global.flags");
+const picocolors_1 = require("picocolors");
 class ContextEdit extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -14,16 +15,14 @@ class ContextEdit extends base_1.default {
             const newSpecFilePath = args['new-spec-file-path'];
             try {
                 yield (0, Context_1.editContext)(contextName, newSpecFilePath);
-                this.log(`Edited context "${contextName}".\n\nYou can set it as your current context: asyncapi config context use ${contextName}\nYou can use this context when needed by passing ${contextName} as a parameter: asyncapi validate ${contextName}`);
+                this.log(`🎉 Context ${(0, picocolors_1.blueBright)(contextName)} edited successfully!\nYou can set it as your current context:\n  ${(0, picocolors_1.blueBright)('asyncapi')} ${(0, picocolors_1.blueBright)('config')} ${(0, picocolors_1.blueBright)('context')} ${(0, picocolors_1.blueBright)('use')} ${(0, picocolors_1.blueBright)(contextName)}\nYou can use this context when needed by passing ${(0, picocolors_1.blueBright)(contextName)} as a parameter:\n  ${(0, picocolors_1.blueBright)('asyncapi')} ${(0, picocolors_1.blueBright)('validate')} ${(0, picocolors_1.blueBright)(contextName)}`);
             }
             catch (e) {
                 if (e instanceof (context_error_1.MissingContextFileError || context_error_1.ContextFileWrongFormatError)) {
-                    this.log('You have no context file configured. Run "asyncapi config context init" to initialize it.');
-                    return;
+                    this.error(`Unable to edit context. You have no context file configured.\nRun ${(0, picocolors_1.blueBright)('asyncapi config context init')} to initialize it.`);
                 }
                 else if (e instanceof context_error_1.ContextFileEmptyError) {
-                    this.log(`Context file "${Context_1.CONTEXT_FILE_PATH}" is empty.`);
-                    return;
+                    this.error(`Context file ${(0, picocolors_1.blueBright)(Context_1.CONTEXT_FILE_PATH)} is empty.`);
                 }
                 throw e;
             }

package/lib/commands/config/context/init.js

@@ -5,13 +5,14 @@ const core_1 = require("@oclif/core");
 const base_1 = tslib_1.__importDefault(require("../../../core/base"));
 const Context_1 = require("../../../core/models/Context");
 const global_flags_1 = require("../../../core/flags/global.flags");
+const picocolors_1 = require("picocolors");
 class ContextInit extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const { args } = yield this.parse(ContextInit);
             const contextFilePath = args['context-file-path'];
             const contextWritePath = yield (0, Context_1.initContext)(contextFilePath);
-            this.log(`Initialized context ${contextWritePath}`);
+            this.log(`🎉 Context initialized at ${(0, picocolors_1.blueBright)(contextWritePath)}`);
         });
     }
 }
@@ -19,9 +20,9 @@ exports.default = ContextInit;
 ContextInit.description = 'Initialize context';
 ContextInit.flags = (0, global_flags_1.helpFlag)();
 ContextInit.contextFilePathMessage = `Specify directory in which context file should be created:
-    - current directory          : asyncapi config context init . (default)
-    - root of current repository : asyncapi config context init ./
-    - user's home directory      : asyncapi config context init ~`;
+    - current directory          : ${(0, picocolors_1.blueBright)('asyncapi config context init .')}(default)
+    - root of current repository : ${(0, picocolors_1.blueBright)('asyncapi config context init ./ ')}
+    - user's home directory      : ${(0, picocolors_1.blueBright)('asyncapi config context init ~`')}`;
 ContextInit.args = {
     'context-file-path': core_1.Args.string({ description: `${ContextInit.contextFilePathMessage}`, required: false })
 };

package/lib/commands/config/context/list.js

@@ -5,24 +5,25 @@ const base_1 = tslib_1.__importDefault(require("../../../core/base"));
 const Context_1 = require("../../../core/models/Context");
 const context_error_1 = require("../../../core/errors/context-error");
 const global_flags_1 = require("../../../core/flags/global.flags");
+const picocolors_1 = require("picocolors");
 class ContextList extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             try {
                 const fileContent = yield (0, Context_1.loadContextFile)();
                 if (yield (0, Context_1.isContextFileEmpty)(fileContent)) {
-                    this.log(`Context file "${Context_1.CONTEXT_FILE_PATH}" is empty.`);
+                    this.log(`Context file ${(0, picocolors_1.blueBright)(Context_1.CONTEXT_FILE_PATH)} is empty.`);
                     return;
                 }
                 if (fileContent) {
                     for (const [contextName, filePath] of Object.entries(fileContent.store)) {
-                        this.log(`${contextName}: ${filePath}`);
+                        this.log(`${(0, picocolors_1.blueBright)(contextName)}: ${filePath}`);
                     }
                 }
             }
             catch (e) {
                 if (e instanceof (context_error_1.MissingContextFileError || context_error_1.ContextFileWrongFormatError)) {
-                    this.log('You have no context file configured. Run "asyncapi config context init" to initialize it.');
+                    this.log(`Unable to list contexts. You have no context file configured.\nRun ${(0, picocolors_1.blueBright)('asyncapi config context init')} to initialize it.\n`);
                     return;
                 }
                 throw e;

package/lib/commands/config/context/remove.js

@@ -6,6 +6,7 @@ const base_1 = tslib_1.__importDefault(require("../../../core/base"));
 const Context_1 = require("../../../core/models/Context");
 const context_error_1 = require("../../../core/errors/context-error");
 const global_flags_1 = require("../../../core/flags/global.flags");
+const picocolors_1 = require("picocolors");
 class ContextRemove extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -13,16 +14,14 @@ class ContextRemove extends base_1.default {
             const contextName = args['context-name'];
             try {
                 yield (0, Context_1.removeContext)(contextName);
-                this.log(`${contextName} successfully deleted`);
+                this.log(`Context ${(0, picocolors_1.blueBright)(contextName)} removed successfully!\n`);
             }
             catch (e) {
                 if (e instanceof (context_error_1.MissingContextFileError || context_error_1.ContextFileWrongFormatError)) {
-                    this.log('You have no context file configured. Run "asyncapi config context init" to initialize it.');
-                    return;
+                    this.error(`Unable to remove context. You have no context file configured.\nRun ${(0, picocolors_1.blueBright)('asyncapi config context init')} to initialize it.`);
                 }
                 else if (e instanceof context_error_1.ContextFileEmptyError) {
-                    this.log(`Context file "${Context_1.CONTEXT_FILE_PATH}" is empty.`);
-                    return;
+                    this.error(`Context file ${(0, picocolors_1.blueBright)(Context_1.CONTEXT_FILE_PATH)} is empty.`);
                 }
                 throw e;
             }

package/lib/commands/config/context/use.js

@@ -6,6 +6,7 @@ const base_1 = tslib_1.__importDefault(require("../../../core/base"));
 const Context_1 = require("../../../core/models/Context");
 const context_error_1 = require("../../../core/errors/context-error");
 const global_flags_1 = require("../../../core/flags/global.flags");
+const picocolors_1 = require("picocolors");
 class ContextUse extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -13,15 +14,14 @@ class ContextUse extends base_1.default {
             const contextName = args['context-name'];
             try {
                 yield (0, Context_1.setCurrentContext)(contextName);
-                this.log(`${contextName} is set as current`);
+                this.log(`Context ${(0, picocolors_1.blueBright)(contextName)} is now set as current.`);
             }
             catch (e) {
                 if (e instanceof (context_error_1.MissingContextFileError || context_error_1.ContextFileWrongFormatError)) {
-                    this.log('You have no context file configured. Run "asyncapi config context init" to initialize it.');
-                    return;
+                    this.error(`Unable to set the current context. You have no context file configured.\nRun ${(0, picocolors_1.blueBright)('asyncapi config context init')} to initialize it.`);
                 }
                 else if (e instanceof context_error_1.ContextFileEmptyError) {
-                    this.log(`Context file "${Context_1.CONTEXT_FILE_PATH}" is empty.`);
+                    this.error(`Context file ${(0, picocolors_1.blueBright)(Context_1.CONTEXT_FILE_PATH)} is empty.`);
                     return;
                 }
                 throw e;

package/lib/commands/config/versions.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const base_1 = tslib_1.__importDefault(require("../../core/base"));
 const global_flags_1 = require("../../core/flags/global.flags");
+const picocolors_1 = require("picocolors");
 class Versions extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -29,7 +30,7 @@ class Versions extends base_1.default {
                 }
             }
             // Showing information available with `--version` flag.
-            this.log(this.config.userAgent);
+            this.log((0, picocolors_1.gray)(`\n${this.config.userAgent}\n`));
             // Iteration through the array containing all dependencies '@asyncapi/*'
             // along with their versions.
             for (let i = 0; i < dependencies.length; i++) {
@@ -47,7 +48,7 @@ class Versions extends base_1.default {
                     this.log(`  └${dependency}\n`);
                 }
             }
-            this.log(`Repository: ${this.config.pjson.homepage}`);
+            this.log(`Repository: ${(0, picocolors_1.blueBright)(this.config.pjson.homepage)}`);
         });
     }
 }

package/lib/commands/new/file.js

@@ -109,6 +109,7 @@ class NewFile extends base_1.default {
             fileName = fileName || DEFAULT_ASYNCAPI_FILE_NAME;
             selectedTemplate = selectedTemplate || DEFAULT_ASYNCAPI_TEMPLATE;
             yield this.createAsyncapiFile(fileName, selectedTemplate);
+            fileName = fileName.includes('.') ? fileName : `${fileName}.yaml`;
             if (openStudio) {
                 (0, Studio_1.start)(fileName, flags.port || Studio_1.DEFAULT_PORT);
             }

package/lib/core/models/Studio.js

@@ -106,10 +106,11 @@ function start(filePath, port = exports.DEFAULT_PORT) {
     });
     server.listen(port, () => {
         const url = `http://localhost:${port}?liveServer=${port}&studio-version=${package_json_1.version}`;
-        console.log(`Studio is now running at ${url}.`);
-        console.log(`You can open this URL in your web browser, and if needed, press ${(0, picocolors_1.gray)('Ctrl + C')} to stop the process.`);
+        console.log(`🎉 Connected to Live Server running at ${(0, picocolors_1.blueBright)(url)}.`);
+        console.log(`🌐 Open this URL in your web browser: ${(0, picocolors_1.blueBright)(url)}`);
+        console.log(`🛑 If needed, press ${(0, picocolors_1.redBright)('Ctrl + C')} to stop the process.`);
         if (filePath) {
-            console.log(`Watching changes on file ${filePath}`);
+            console.log(`👁️ Watching changes on file ${(0, picocolors_1.blueBright)(filePath)}`);
         }
         else {
             console.warn('Warning: No file was provided, and we couldn\'t find a default file (like "asyncapi.yaml" or "asyncapi.json") in the current folder. Starting Studio with a blank workspace.');

package/oclif.manifest.json

@@ -1685,7 +1685,7 @@
       "aliases": [],
       "args": {
         "context-file-path": {
-          "description": "Specify directory in which context file should be created:\n    - current directory          : asyncapi config context init . (default)\n    - root of current repository : asyncapi config context init ./\n    - user's home directory      : asyncapi config context init ~",
+          "description": "Specify directory in which context file should be created:\n    - current directory          : \u001b[94masyncapi config context init .\u001b[39m(default)\n    - root of current repository : \u001b[94masyncapi config context init ./ \u001b[39m\n    - user's home directory      : \u001b[94masyncapi config context init ~`\u001b[39m",
           "name": "context-file-path",
           "required": false
         }
@@ -1707,7 +1707,7 @@
       "pluginName": "@asyncapi/cli",
       "pluginType": "core",
       "strict": true,
-      "contextFilePathMessage": "Specify directory in which context file should be created:\n    - current directory          : asyncapi config context init . (default)\n    - root of current repository : asyncapi config context init ./\n    - user's home directory      : asyncapi config context init ~",
+      "contextFilePathMessage": "Specify directory in which context file should be created:\n    - current directory          : \u001b[94masyncapi config context init .\u001b[39m(default)\n    - root of current repository : \u001b[94masyncapi config context init ./ \u001b[39m\n    - user's home directory      : \u001b[94masyncapi config context init ~`\u001b[39m",
       "isESM": false,
       "relativePath": [
         "lib",
@@ -1817,5 +1817,5 @@
       ]
     }
   },
-  "version": "2.16.0"
+  "version": "2.16.1"
 }

package/package.json

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