@asyncapi/cli 2.15.0 → 2.16.0

package/lib/commands/new/file.js

@@ -155,5 +155,5 @@ NewFile.description = 'Creates a new asyncapi file';
 NewFile.flags = (0, file_flags_1.fileFlags)(getExamplesFlagDescription());
 NewFile.examples = [
     'asyncapi new\t - start creation of a file in interactive mode',
-    'asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty\t - create a new file with a specific name, using one of the examples and without interactive mode'
+    'asyncapi new --file-name=my-asyncapi.yaml --example=default-example.yaml --no-tty\t - create a new file with a specific name, using one of the examples and without interactive mode'
 ];

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

@@ -6,5 +6,8 @@ export default class StartStudio extends Command {
         file: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
         port: import("@oclif/core/lib/interfaces").OptionFlag<number | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
     };
+    static readonly args: {
+        'spec-file': import("@oclif/core/lib/interfaces").Arg<string | undefined, Record<string, unknown>>;
+    };
     run(): Promise<void>;
 }

package/lib/commands/start/studio.js

@@ -5,13 +5,35 @@ const base_1 = tslib_1.__importDefault(require("../../core/base"));
 const Studio_1 = require("../../core/models/Studio");
 const SpecificationFile_1 = require("../../core/models/SpecificationFile");
 const studio_flags_1 = require("../../core/flags/start/studio.flags");
+const core_1 = require("@oclif/core");
 class StartStudio extends base_1.default {
     run() {
+        var _a;
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            const { flags } = yield this.parse(StartStudio);
-            const filePath = flags.file || (yield (0, SpecificationFile_1.load)()).getFilePath();
+            const { args, flags } = yield this.parse(StartStudio);
+            if (flags.file) {
+                this.warn('The file flag has been removed and is being replaced by the argument spec-file. Please pass the filename directly like `asyncapi start studio asyncapi.yml`');
+            }
+            let filePath = (_a = args['spec-file']) !== null && _a !== void 0 ? _a : flags.file;
             const port = flags.port;
-            this.specFile = yield (0, SpecificationFile_1.load)(filePath);
+            if (!filePath) {
+                try {
+                    filePath = ((yield (0, SpecificationFile_1.load)()).getFilePath());
+                    this.log(`Loaded specification from: ${filePath}`);
+                }
+                catch (error) {
+                    filePath = '';
+                    this.error('No file specified.');
+                }
+            }
+            try {
+                this.specFile = yield (0, SpecificationFile_1.load)(filePath);
+            }
+            catch (error) {
+                if (filePath) {
+                    this.error(error);
+                }
+            }
             this.metricsMetadata.port = port;
             (0, Studio_1.start)(filePath, port);
         });
@@ -20,3 +42,6 @@ class StartStudio extends base_1.default {
 exports.default = StartStudio;
 StartStudio.description = 'starts a new local instance of Studio';
 StartStudio.flags = (0, studio_flags_1.studioFlags)();
+StartStudio.args = {
+    'spec-file': core_1.Args.string({ description: 'spec path, url, or context-name', required: false }),
+};

package/lib/core/base.js

@@ -43,6 +43,10 @@ class default_1 extends core_1.Command {
                 return yield _super.catch.call(this, err);
             }
             catch (e) {
+                if (e.message.includes('EEXIT: 0')) {
+                    process.exitCode = 0;
+                    return;
+                }
                 if (e instanceof Error) {
                     this.logToStderr(`${e.name}: ${e.message}`);
                     process.exitCode = 1;

package/lib/core/flags/start/studio.flags.js

@@ -5,7 +5,7 @@ const core_1 = require("@oclif/core");
 const studioFlags = () => {
     return {
         help: core_1.Flags.help({ char: 'h' }),
-        file: core_1.Flags.string({ char: 'f', description: 'path to the AsyncAPI file to link with Studio' }),
+        file: core_1.Flags.string({ char: 'f', description: 'path to the AsyncAPI file to link with Studio', deprecated: true }),
         port: core_1.Flags.integer({ char: 'p', description: 'port in which to start Studio' }),
     };
 };

package/lib/core/models/Studio.js

@@ -20,30 +20,32 @@ function isValidFilePath(filePath) {
     return (0, fs_1.existsSync)(filePath);
 }
 function start(filePath, port = exports.DEFAULT_PORT) {
-    if (!isValidFilePath(filePath)) {
+    if (filePath && !isValidFilePath(filePath)) {
         throw new specification_file_1.SpecificationFileNotFound(filePath);
     }
-    chokidar_1.default.watch(filePath).on('all', (event, path) => {
-        switch (event) {
-            case 'add':
-            case 'change':
-                getFileContent(path).then((code) => {
+    if (filePath) {
+        chokidar_1.default.watch(filePath).on('all', (event, path) => {
+            switch (event) {
+                case 'add':
+                case 'change':
+                    getFileContent(path).then((code) => {
+                        messageQueue.push(JSON.stringify({
+                            type: 'file:changed',
+                            code,
+                        }));
+                        sendQueuedMessages();
+                    });
+                    break;
+                case 'unlink':
                     messageQueue.push(JSON.stringify({
-                        type: 'file:changed',
-                        code,
+                        type: 'file:deleted',
+                        filePath,
                     }));
                     sendQueuedMessages();
-                });
-                break;
-            case 'unlink':
-                messageQueue.push(JSON.stringify({
-                    type: 'file:deleted',
-                    filePath,
-                }));
-                sendQueuedMessages();
-                break;
-        }
-    });
+                    break;
+            }
+        });
+    }
     const server = (0, http_1.createServer)((request, response) => {
         //not all CLI users use npm. Some package managers put dependencies in different weird places
         //this is why we need to first figure out where exactly is the index.html located
@@ -67,17 +69,26 @@ function start(filePath, port = exports.DEFAULT_PORT) {
     const wsServer = new ws_1.WebSocketServer({ noServer: true });
     wsServer.on('connection', (socket) => {
         sockets.push(socket);
-        getFileContent(filePath).then((code) => {
+        if (filePath) {
+            getFileContent(filePath).then((code) => {
+                messageQueue.push(JSON.stringify({
+                    type: 'file:loaded',
+                    code,
+                }));
+                sendQueuedMessages();
+            });
+        }
+        else {
             messageQueue.push(JSON.stringify({
                 type: 'file:loaded',
-                code,
+                code: '',
             }));
             sendQueuedMessages();
-        });
+        }
         socket.on('message', (event) => {
             try {
                 const json = JSON.parse(event);
-                if (json.type === 'file:update') {
+                if (filePath && json.type === 'file:update') {
                     saveFileContent(filePath, json.code);
                 }
                 else {
@@ -97,7 +108,12 @@ function start(filePath, port = exports.DEFAULT_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(`Watching changes on file ${filePath}`);
+        if (filePath) {
+            console.log(`Watching changes on file ${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.');
+        }
         (0, open_1.default)(url);
     });
 }

package/oclif.manifest.json

@@ -1210,7 +1210,7 @@
       "description": "Creates a new asyncapi file",
       "examples": [
         "asyncapi new\t - start creation of a file in interactive mode",
-        "asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty\t - create a new file with a specific name, using one of the examples and without interactive mode"
+        "asyncapi new --file-name=my-asyncapi.yaml --example=default-example.yaml --no-tty\t - create a new file with a specific name, using one of the examples and without interactive mode"
       ],
       "flags": {
         "help": {
@@ -1340,7 +1340,7 @@
       "description": "Creates a new asyncapi file",
       "examples": [
         "asyncapi new\t - start creation of a file in interactive mode",
-        "asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty\t - create a new file with a specific name, using one of the examples and without interactive mode"
+        "asyncapi new --file-name=my-asyncapi.yaml --example=default-example.yaml --no-tty\t - create a new file with a specific name, using one of the examples and without interactive mode"
       ],
       "flags": {
         "help": {
@@ -1494,7 +1494,13 @@
     },
     "start:studio": {
       "aliases": [],
-      "args": {},
+      "args": {
+        "spec-file": {
+          "description": "spec path, url, or context-name",
+          "name": "spec-file",
+          "required": false
+        }
+      },
       "description": "starts a new local instance of Studio",
       "flags": {
         "help": {
@@ -1506,6 +1512,7 @@
         },
         "file": {
           "char": "f",
+          "deprecated": true,
           "description": "path to the AsyncAPI file to link with Studio",
           "name": "file",
           "hasDynamicHelp": false,
@@ -1810,5 +1817,5 @@
       ]
     }
   },
-  "version": "2.15.0"
+  "version": "2.16.0"
 }

package/package.json

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