@asyncapi/cli 0.37.2 → 0.39.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/lib/commands/{new.d.ts → new/file.d.ts}

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

package/lib/commands/{new.js → new/file.js}

@@ -3,17 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const fs_1 = require("fs");
-const base_1 = tslib_1.__importDefault(require("../base"));
+const base_1 = tslib_1.__importDefault(require("../../base"));
 const inquirer = tslib_1.__importStar(require("inquirer"));
-const Studio_1 = require("../models/Studio");
+const Studio_1 = require("../../models/Studio");
 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';
-class New extends base_1.default {
+class NewFile extends base_1.default {
     run() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            const { flags } = yield this.parse(New); // NOSONAR
+            const { flags } = yield this.parse(NewFile); // NOSONAR
             const isTTY = process.stdout.isTTY;
             if (!flags['no-tty'] && isTTY) {
                 return this.runInteractive();
@@ -34,7 +34,7 @@ class New extends base_1.default {
     /* eslint-disable sonarjs/cognitive-complexity */
     runInteractive() {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            const { flags } = yield this.parse(New); // NOSONAR
+            const { flags } = yield this.parse(NewFile); // NOSONAR
             let fileName = flags['file-name'];
             let selectedTemplate = flags['example'];
             let openStudio = flags.studio;
@@ -102,12 +102,12 @@ class New extends base_1.default {
     }
     createAsyncapiFile(fileName, selectedTemplate) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            const asyncApiFile = yield readFile((0, path_1.resolve)(__dirname, '../../assets/examples/', selectedTemplate), { encoding: 'utf8' });
+            const asyncApiFile = yield readFile((0, path_1.resolve)(__dirname, '../../../assets/examples/', selectedTemplate), { encoding: 'utf8' });
             const fileNameHasFileExtension = fileName.includes('.');
             const fileNameToWriteToDisk = fileNameHasFileExtension ? fileName : `${fileName}.yaml`;
             try {
                 const content = yield readFile(fileNameToWriteToDisk, { encoding: 'utf8' });
-                if (content !== '') {
+                if (content !== undefined) {
                     console.log(`File ${fileNameToWriteToDisk} already exists. Ignoring...`);
                     return;
                 }
@@ -120,9 +120,9 @@ class New extends base_1.default {
         });
     }
 }
-exports.default = New;
-New.description = 'Creates a new asyncapi file';
-New.flags = {
+exports.default = NewFile;
+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' }),
@@ -130,4 +130,3 @@ New.flags = {
     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' }),
 };
-New.args = [];

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

@@ -0,0 +1,10 @@
+import Command from '../../base';
+export default class NewGlee extends Command {
+    static description: string;
+    protected commandName: string;
+    static flags: {
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+        name: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/new/glee.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const fs_1 = require("fs");
+const base_1 = tslib_1.__importDefault(require("../../base"));
+const path_1 = require("path");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+class NewGlee extends base_1.default {
+    constructor() {
+        super(...arguments);
+        this.commandName = 'glee';
+    }
+    run() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const { flags } = yield this.parse(NewGlee); // NOSONAR
+            const projectName = flags.name;
+            const PROJECT_DIRECTORY = (0, path_1.join)(process.cwd(), projectName);
+            const GLEE_TEMPLATES_DIRECTORY = (0, path_1.resolve)(__dirname, '../../../create-glee-app/templates/default');
+            try {
+                yield fs_1.promises.mkdir(PROJECT_DIRECTORY);
+            }
+            catch (err) {
+                switch (err.code) {
+                    case 'EEXIST':
+                        this.error(`Unable to create the project. We tried to use "${projectName}" as the directory of your new project but it already exists (${PROJECT_DIRECTORY}). Please specify a different name for the new project. For example, run the following command instead:\n\n  asyncapi new ${this.commandName} --name ${projectName}-1\n`);
+                        break;
+                    case 'EACCES':
+                        this.error(`Unable to create the project. We tried to access the "${PROJECT_DIRECTORY}" directory but it was not possible due to file access permissions. Please check the write permissions of your current working directory ("${process.cwd()}").`);
+                        break;
+                    case 'EPERM':
+                        this.error(`Unable to create the project. We tried to create the "${PROJECT_DIRECTORY}" directory but the operation requires elevated privileges. Please check the privileges for your current user.`);
+                        break;
+                    default:
+                        this.error(`Unable to create the project. Please check the following message for further info about the error:\n\n${err}`);
+                }
+            }
+            try {
+                yield fs_extra_1.default.copy(GLEE_TEMPLATES_DIRECTORY, PROJECT_DIRECTORY);
+                yield fs_1.promises.rename(`${PROJECT_DIRECTORY}/env`, `${PROJECT_DIRECTORY}/.env`);
+                yield fs_1.promises.rename(`${PROJECT_DIRECTORY}/gitignore`, `${PROJECT_DIRECTORY}/.gitignore`);
+                yield fs_1.promises.rename(`${PROJECT_DIRECTORY}/README-template.md`, `${PROJECT_DIRECTORY}/README.md`);
+                this.log(`Your project "${projectName}" has been created successfully!\n\nNext steps:\n\n  cd ${projectName}\n  npm install\n  npm run dev\n\nAlso, you can already open the project in your favorite editor and start tweaking it.`);
+            }
+            catch (err) {
+                this.error(`Unable to create the project. Please check the following message for further info about the error:\n\n${err}`);
+            }
+        });
+    }
+}
+exports.default = NewGlee;
+NewGlee.description = 'Creates a new Glee project';
+NewGlee.flags = {
+    help: core_1.Flags.help({ char: 'h' }),
+    name: core_1.Flags.string({ char: 'n', description: 'name of the project', default: 'project' }),
+};

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

@@ -0,0 +1,3 @@
+import File from './file';
+export default class New extends File {
+}

package/lib/commands/new/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const file_1 = tslib_1.__importDefault(require("./file"));
+class New extends file_1.default {
+}
+exports.default = New;

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

@@ -0,0 +1,5 @@
+import { Config } from '@oclif/core';
+import NewGlee from './glee';
+export default class NewProject extends NewGlee {
+    constructor(argv: string[], config: Config);
+}

package/lib/commands/new/project.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const glee_1 = tslib_1.__importDefault(require("./glee"));
+class NewProject extends glee_1.default {
+    constructor(argv, config) {
+        super(argv, config);
+        this.commandName = 'project';
+    }
+}
+exports.default = NewProject;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.37.2",
+  "version": "0.39.0",
   "commands": {
     "bundle": {
       "id": "bundle",
@@ -195,59 +195,6 @@
         }
       }
     },
-    "new": {
-      "id": "new",
-      "description": "Creates a new asyncapi file",
-      "strict": true,
-      "pluginName": "@asyncapi/cli",
-      "pluginAlias": "@asyncapi/cli",
-      "pluginType": "core",
-      "aliases": [],
-      "flags": {
-        "help": {
-          "name": "help",
-          "type": "boolean",
-          "char": "h",
-          "description": "Show CLI help.",
-          "allowNo": false
-        },
-        "file-name": {
-          "name": "file-name",
-          "type": "option",
-          "char": "n",
-          "description": "name of the file",
-          "multiple": false
-        },
-        "example": {
-          "name": "example",
-          "type": "option",
-          "char": "e",
-          "description": "name of the example to use",
-          "multiple": false
-        },
-        "studio": {
-          "name": "studio",
-          "type": "boolean",
-          "char": "s",
-          "description": "open in Studio",
-          "allowNo": false
-        },
-        "port": {
-          "name": "port",
-          "type": "option",
-          "char": "p",
-          "description": "port in which to start Studio",
-          "multiple": false
-        },
-        "no-tty": {
-          "name": "no-tty",
-          "type": "boolean",
-          "description": "do not use an interactive terminal",
-          "allowNo": false
-        }
-      },
-      "args": {}
-    },
     "optimize": {
       "id": "optimize",
       "description": "optimize asyncapi specification file",
@@ -559,6 +506,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",
@@ -673,6 +627,166 @@
         }
       }
     },
+    "new:file": {
+      "id": "new:file",
+      "description": "Creates a new asyncapi file",
+      "strict": true,
+      "pluginName": "@asyncapi/cli",
+      "pluginAlias": "@asyncapi/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        },
+        "file-name": {
+          "name": "file-name",
+          "type": "option",
+          "char": "n",
+          "description": "name of the file",
+          "multiple": false
+        },
+        "example": {
+          "name": "example",
+          "type": "option",
+          "char": "e",
+          "description": "name of the example to use",
+          "multiple": false
+        },
+        "studio": {
+          "name": "studio",
+          "type": "boolean",
+          "char": "s",
+          "description": "open in Studio",
+          "allowNo": false
+        },
+        "port": {
+          "name": "port",
+          "type": "option",
+          "char": "p",
+          "description": "port in which to start Studio",
+          "multiple": false
+        },
+        "no-tty": {
+          "name": "no-tty",
+          "type": "boolean",
+          "description": "do not use an interactive terminal",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "new:glee": {
+      "id": "new:glee",
+      "description": "Creates a new Glee project",
+      "strict": true,
+      "pluginName": "@asyncapi/cli",
+      "pluginAlias": "@asyncapi/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        },
+        "name": {
+          "name": "name",
+          "type": "option",
+          "char": "n",
+          "description": "name of the project",
+          "multiple": false,
+          "default": "project"
+        }
+      },
+      "args": {}
+    },
+    "new": {
+      "id": "new",
+      "description": "Creates a new asyncapi file",
+      "strict": true,
+      "pluginName": "@asyncapi/cli",
+      "pluginAlias": "@asyncapi/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        },
+        "file-name": {
+          "name": "file-name",
+          "type": "option",
+          "char": "n",
+          "description": "name of the file",
+          "multiple": false
+        },
+        "example": {
+          "name": "example",
+          "type": "option",
+          "char": "e",
+          "description": "name of the example to use",
+          "multiple": false
+        },
+        "studio": {
+          "name": "studio",
+          "type": "boolean",
+          "char": "s",
+          "description": "open in Studio",
+          "allowNo": false
+        },
+        "port": {
+          "name": "port",
+          "type": "option",
+          "char": "p",
+          "description": "port in which to start Studio",
+          "multiple": false
+        },
+        "no-tty": {
+          "name": "no-tty",
+          "type": "boolean",
+          "description": "do not use an interactive terminal",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "new:project": {
+      "id": "new:project",
+      "description": "Creates a new Glee project",
+      "strict": true,
+      "pluginName": "@asyncapi/cli",
+      "pluginAlias": "@asyncapi/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "help": {
+          "name": "help",
+          "type": "boolean",
+          "char": "h",
+          "description": "Show CLI help.",
+          "allowNo": false
+        },
+        "name": {
+          "name": "name",
+          "type": "option",
+          "char": "n",
+          "description": "name of the project",
+          "multiple": false,
+          "default": "project"
+        }
+      },
+      "args": {}
+    },
     "start": {
       "id": "start",
       "description": "Start asyncapi studio",

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.39.0",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run"
@@ -23,6 +23,7 @@
     "ajv": "^8.12.0",
     "chalk": "^4.1.0",
     "chokidar": "^3.5.2",
+    "fs-extra": "^11.1.0",
     "indent-string": "^4.0.0",
     "inquirer": "^8.2.0",
     "lodash.template": "^4.4.0",
@@ -49,6 +50,7 @@
     "@swc/core": "^1.3.2",
     "@swc/jest": "^0.2.22",
     "@types/chai": "^4.3.3",
+    "@types/fs-extra": "^11.0.1",
     "@types/inquirer": "^8.1.3",
     "@types/jest": "^29.0.3",
     "@types/lodash.template": "^4.4.4",