@asyncapi/cli 0.53.0 → 0.54.0

package/lib/commands/new/file.d.ts

@@ -9,6 +9,7 @@ export default class NewFile extends Command {
         port: import("@oclif/core/lib/interfaces").OptionFlag<number | undefined>;
         'no-tty': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
+    static examples: string[];
     run(): Promise<void>;
     runInteractive(): Promise<void>;
     createAsyncapiFile(fileName: string, selectedTemplate: string): Promise<void>;

package/lib/commands/new/file.js

@@ -10,6 +10,18 @@ const path_1 = require("path");
 const { writeFile, readFile } = fs_1.promises;
 const DEFAULT_ASYNCAPI_FILE_NAME = 'asyncapi.yaml';
 const DEFAULT_ASYNCAPI_TEMPLATE = 'default-example.yaml';
+function loadExampleFile() {
+    const exampleFiles = (0, fs_1.readFileSync)((0, path_1.resolve)(__dirname, '../../../assets/examples/examples.json'), { encoding: 'utf8' });
+    return JSON.parse(exampleFiles);
+}
+function getExamplesFlagDescription() {
+    const examples = loadExampleFile();
+    let description = 'name of the example to use. Available examples are:';
+    for (const example of examples) {
+        description += `\n\t - ${example.value}`;
+    }
+    return description;
+}
 class NewFile extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
@@ -125,8 +137,12 @@ NewFile.description = 'Creates a new asyncapi file';
 NewFile.flags = {
     help: core_1.Flags.help({ char: 'h' }),
     'file-name': core_1.Flags.string({ char: 'n', description: 'name of the file' }),
-    example: core_1.Flags.string({ char: 'e', description: 'name of the example to use' }),
+    example: core_1.Flags.string({ char: 'e', description: getExamplesFlagDescription() }),
     studio: core_1.Flags.boolean({ char: 's', description: 'open in Studio' }),
     port: core_1.Flags.integer({ char: 'p', description: 'port in which to start Studio' }),
     'no-tty': core_1.Flags.boolean({ description: 'do not use an interactive terminal' }),
 };
+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'
+];

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.53.0",
+  "version": "0.54.0",
   "commands": {
     "bundle": {
       "id": "bundle",
@@ -716,6 +716,10 @@
       "pluginAlias": "@asyncapi/cli",
       "pluginType": "core",
       "aliases": [],
+      "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"
+      ],
       "flags": {
         "help": {
           "name": "help",
@@ -735,7 +739,7 @@
           "name": "example",
           "type": "option",
           "char": "e",
-          "description": "name of the example to use",
+          "description": "name of the example to use. Available examples are:\n\t - simple.yml\n\t - anyof.yml\n\t - application-headers.yml\n\t - correlation-id.yml\n\t - websocket-gemini.yml\n\t - gitter-streaming.yml\n\t - mercure.yml\n\t - not.yml\n\t - operation-security.yml\n\t - oneof.yml\n\t - rpc-client.yml\n\t - rpc-server.yml\n\t - slack-rtm.yml\n\t - tutorial.yml\n\t - streetlights-kafka.yml\n\t - streetlights-operation-security.yml\n\t - streetlights-mqtt.yml",
           "multiple": false
         },
         "studio": {
@@ -796,6 +800,10 @@
       "pluginAlias": "@asyncapi/cli",
       "pluginType": "core",
       "aliases": [],
+      "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"
+      ],
       "flags": {
         "help": {
           "name": "help",
@@ -815,7 +823,7 @@
           "name": "example",
           "type": "option",
           "char": "e",
-          "description": "name of the example to use",
+          "description": "name of the example to use. Available examples are:\n\t - simple.yml\n\t - anyof.yml\n\t - application-headers.yml\n\t - correlation-id.yml\n\t - websocket-gemini.yml\n\t - gitter-streaming.yml\n\t - mercure.yml\n\t - not.yml\n\t - operation-security.yml\n\t - oneof.yml\n\t - rpc-client.yml\n\t - rpc-server.yml\n\t - slack-rtm.yml\n\t - tutorial.yml\n\t - streetlights-kafka.yml\n\t - streetlights-operation-security.yml\n\t - streetlights-mqtt.yml",
           "multiple": false
         },
         "studio": {

package/package.json

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