chore: json file supported in asyncapi new file command (#1713)

Co-authored-by: Sumitwarrior7 <[email protected]> Co-authored-by: Moderator <[email protected]>
asyncapi · Mar 12, 2025 · 819b585 · 819b585
1 parent 0c7928d
commit 819b585
Show file tree

Hide file tree

Showing 4 changed files with 76 additions and 4 deletions.
diff --git a/.changeset/blue-seas-destroy.md b/.changeset/blue-seas-destroy.md
@@ -0,0 +1,5 @@
+---
+"@asyncapi/cli": patch
+---
+
+[Fix]: Json file supported in asyncapi new file command
diff --git a/.gitignore b/.gitignore
@@ -11,7 +11,8 @@
 /yarn.lock
 /assets/examples/**
 !assets/examples/default-example.yaml
-!assets/examples/tutorial.yml
+!assets/examples/tutorial.yml'
+!assets/examples/default-example.json
 node_modules
 /test/integration/generate/models/
 test.asyncapi-cli

diff --git a/assets/examples/default-example.json b/assets/examples/default-example.json
@@ -0,0 +1,51 @@
+{
+    "asyncapi": "3.0.0",
+    "info": {
+      "title": "Account Service",
+      "version": "1.0.0",
+      "description": "This service is in charge of processing user signups"
+    },
+    "channels": {
+      "userSignedUp": {
+        "address": "user/signedup",
+        "messages": {
+          "UserSignedUp": {
+            "$ref": "#/components/messages/UserSignedUp"
+          }
+        }
+      }
+    },
+    "operations": {
+      "onUserSignUp": {
+        "action": "receive",
+        "channel": {
+          "$ref": "#/channels/userSignedUp"
+        },
+        "messages": [
+          {
+            "$ref": "#/channels/userSignedUp/messages/UserSignedUp"
+          }
+        ]
+      }
+    },
+    "components": {
+      "messages": {
+        "UserSignedUp": {
+          "payload": {
+            "type": "object",
+            "properties": {
+              "displayName": {
+                "type": "string",
+                "description": "Name of the user"
+              },
+              "email": {
+                "type": "string",
+                "format": "email",
+                "description": "Email of the user"
+              }
+            }
+          }
+        }
+      }
+    }
+  }
diff --git a/src/commands/new/file.ts b/src/commands/new/file.ts
@@ -9,7 +9,8 @@ import { fileFlags } from '../../core/flags/new/file.flags';
 
 const { writeFile, readFile } = fPromises;
 const DEFAULT_ASYNCAPI_FILE_NAME = 'asyncapi.yaml';
-const DEFAULT_ASYNCAPI_TEMPLATE = 'default-example.yaml';
+const DEFAULT_ASYNCAPI_YAML_TEMPLATE = 'default-example.yaml';
+const DEFAULT_ASYNCAPI_JSON_TEMPLATE = 'default-example.json';
 
 interface IExample{
   name: string,
@@ -49,7 +50,14 @@ export default class NewFile extends Command {
     }
 
     const fileName = flags['file-name'] || DEFAULT_ASYNCAPI_FILE_NAME;
-    const template = flags['example'] || DEFAULT_ASYNCAPI_TEMPLATE;
+    // Determine template based on file extension
+    let default_template;
+    if (fileName.endsWith('.json')) {
+      default_template = DEFAULT_ASYNCAPI_JSON_TEMPLATE;
+    } else {
+      default_template = DEFAULT_ASYNCAPI_YAML_TEMPLATE;
+    }
+    const template = flags['example'] || default_template;
 
     await this.createAsyncapiFile(fileName, template);
 
@@ -124,7 +132,14 @@ export default class NewFile extends Command {
     }
 
     fileName = fileName || DEFAULT_ASYNCAPI_FILE_NAME;
-    selectedTemplate = selectedTemplate || DEFAULT_ASYNCAPI_TEMPLATE;
+    // Determine template based on file extension
+    let default_template;
+    if (fileName.endsWith('.json')) {
+      default_template = DEFAULT_ASYNCAPI_JSON_TEMPLATE;
+    } else {
+      default_template = DEFAULT_ASYNCAPI_YAML_TEMPLATE;
+    }
+    selectedTemplate = selectedTemplate || default_template;
 
     await this.createAsyncapiFile(fileName, selectedTemplate);
     fileName = fileName.includes('.') ? fileName : `${fileName}.yaml`;