@asyncapi/cli 0.37.2 → 0.38.0

package/lib/commands/generate/models.d.ts

@@ -24,6 +24,7 @@ export default class Models extends Command {
         tsModelType: import("@oclif/core/lib/interfaces").OptionFlag<string>;
         tsEnumType: import("@oclif/core/lib/interfaces").OptionFlag<string>;
         tsModuleSystem: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        tsIncludeComments: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         tsExportType: import("@oclif/core/lib/interfaces").OptionFlag<string>;
         tsJsonBinPack: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         /**

package/lib/commands/generate/models.js

@@ -24,7 +24,7 @@ class Models extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const { args, flags } = yield this.parse(Models);
-            const { tsModelType, tsEnumType, tsModuleSystem, tsExportType, tsJsonBinPack, namespace, csharpAutoImplement, csharpArrayType, packageName, output } = flags;
+            const { tsModelType, tsEnumType, tsIncludeComments, tsModuleSystem, tsExportType, tsJsonBinPack, namespace, csharpAutoImplement, csharpArrayType, packageName, output } = flags;
             const { language, file } = args;
             const inputFile = (yield (0, SpecificationFile_1.load)(file)) || (yield (0, SpecificationFile_1.load)());
             const { document, status } = yield (0, parser_1.parse)(this, inputFile, flags);
@@ -47,20 +47,24 @@ class Models extends base_1.default {
             });
             let fileGenerator;
             let fileOptions = {};
+            const presets = [];
             switch (language) {
                 case Languages.typescript:
+                    if (tsIncludeComments) {
+                        presets.push(modelina_1.TS_DESCRIPTION_PRESET);
+                    }
+                    if (tsJsonBinPack) {
+                        presets.push({
+                            preset: modelina_1.TS_COMMON_PRESET,
+                            options: {
+                                marshalling: true
+                            }
+                        }, modelina_1.TS_JSONBINPACK_PRESET);
+                    }
                     fileGenerator = new modelina_1.TypeScriptFileGenerator({
                         modelType: tsModelType,
                         enumType: tsEnumType,
-                        presets: tsJsonBinPack ? [
-                            {
-                                preset: modelina_1.TS_COMMON_PRESET,
-                                options: {
-                                    marshalling: true
-                                }
-                            },
-                            modelina_1.TS_JSONBINPACK_PRESET
-                        ] : []
+                        presets
                     });
                     fileOptions = {
                         moduleSystem: tsModuleSystem,
@@ -188,6 +192,10 @@ Models.flags = Object.assign({ help: core_1.Flags.help({ char: 'h' }), output: c
         description: 'TypeScript specific, define the module system to be used.',
         required: false,
         default: 'ESM',
+    }), tsIncludeComments: core_1.Flags.boolean({
+        description: 'TypeScript specific, if enabled add comments while generating models.',
+        required: false,
+        default: false,
     }), tsExportType: core_1.Flags.string({
         type: 'option',
         options: ['default', 'named'],

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.37.2",
+  "version": "0.38.0",
   "commands": {
     "bundle": {
       "id": "bundle",
@@ -559,6 +559,13 @@
           ],
           "default": "ESM"
         },
+        "tsIncludeComments": {
+          "name": "tsIncludeComments",
+          "type": "boolean",
+          "description": "TypeScript specific, if enabled add comments while generating models.",
+          "required": false,
+          "allowNo": false
+        },
         "tsExportType": {
           "name": "tsExportType",
           "type": "option",

package/package.json

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