feat: made the start studio command interactive along with addition of… (#1765)

* feat: made the start studio command inteactive along with addition of a flag to disable prompt.

* chore: add changeset for PR #1765

---------

Co-authored-by: asyncapi-bot <info@asyncapi.io>

Author: neoandmatrix

.changeset/1765.md

@@ -0,0 +1,9 @@
+---
+'@asyncapi/cli': patch
+---
+
+feat: made the start studio command interactive along with addition of…
+
+- 0e8e3c1: feat: made the start studio command inteactive along with addition of a flag to disable prompt.
+
+

docs/usage.md

@@ -745,15 +745,16 @@ starts a new local instance of Studio
 
 ```
 USAGE
-  $ asyncapi start studio [SPEC-FILE] [-h] [-f <value>] [-p <value>]
+  $ asyncapi start studio [SPEC-FILE] [-h] [-f <value>] [-p <value>]  [--no-interactive]
 
 ARGUMENTS
   SPEC-FILE  spec path, url, or context-name
 
 FLAGS
-  -f, --file=<value>  path to the AsyncAPI file to link with Studio
-  -h, --help          Show CLI help.
-  -p, --port=<value>  port in which to start Studio
+  -f, --file=<value>   path to the AsyncAPI file to link with Studio
+  -h, --help           Show CLI help.
+  -p, --port=<value>   port in which to start Studio
+      --no-interactive disable prompts for this command which asks for file path if not passed via the arguments.
 
 DESCRIPTION
   starts a new local instance of Studio

src/commands/start/studio.ts

@@ -3,6 +3,7 @@ import { start as startStudio } from '../../core/models/Studio';
 import { load } from '../../core/models/SpecificationFile';
 import { studioFlags } from '../../core/flags/start/studio.flags';
 import { Args } from '@oclif/core';
+import { isCancel, text, cancel } from '@clack/prompts';
 
 export default class StartStudio extends Command {
   static description = 'starts a new local instance of Studio';
@@ -16,13 +17,22 @@ export default class StartStudio extends Command {
   async run() {
     const { args, flags } = await this.parse(StartStudio);
 
+    let filePath = args['spec-file'] ?? flags.file;
+
+    let port = flags.port;
+
     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 = args['spec-file'] ?? flags.file;
+    const isInteractive = !flags['no-interactive'];
+
+    if (isInteractive && !filePath) {
+      const parsedArgs = await this.parseArgs({ filePath }, port?.toString());
+      filePath = parsedArgs.filePath;
+      port = parseInt(parsedArgs.port,10);
+    }
 
-    const port = flags.port;
     if (!filePath) {
       try {
         filePath = ((await load()).getFilePath());
@@ -42,4 +52,42 @@ export default class StartStudio extends Command {
     this.metricsMetadata.port = port;
     startStudio(filePath as string, port);
   }
+
+  private async parseArgs(args:Record<string,any>,port?:string) {
+    const operationCancelled = 'Operation cancelled by the user.';
+    let askForPort = false;
+    let {filePath} = args;
+    if (!filePath) {
+      filePath = await text({
+        message: 'Enter the path to the AsyncAPI document',
+        defaultValue: 'asyncapi.yaml',
+        placeholder: 'asyncapi.yaml',
+        validate: (value) => {
+          if (!value) {return 'The path to the AsyncAPI document is required';}
+        },
+      });
+      askForPort = true;
+    }
+
+    if (isCancel(filePath)) {
+      cancel(operationCancelled);
+      this.exit();
+    }
+
+    if (!port && askForPort) {
+      port = await text({
+        message: 'Enter the port in which to start Studio',
+        defaultValue: '3210',
+        placeholder: '3210',
+        validate: (value) => (!value ? 'The port number is required' : undefined),
+      }) as string;
+    }
+
+    if (isCancel(port)) {
+      cancel(operationCancelled);
+      this.exit();
+    }
+
+    return { filePath, port: port ?? '3210' };
+  }
 }

src/core/flags/start/studio.flags.ts

@@ -5,5 +5,10 @@ export const studioFlags = () => {
     help: Flags.help({ char: 'h' }),
     file: Flags.string({ char: 'f', description: 'path to the AsyncAPI file to link with Studio', deprecated: true }),
     port: Flags.integer({ char: 'p', description: 'port in which to start Studio' }),
+    'no-interactive': Flags.boolean({
+      description: 'disable prompts for this command which asks for file path if not passed via the arguments.',
+      required: false,
+      default: false,
+    }),
   };
 };