@asyncapi/cli 2.0.4 → 2.1.0

package/assets/create-template/templates/default/asyncapi.yaml

@@ -0,0 +1,34 @@
+asyncapi: 3.0.0
+info:
+  title: Temperature Service
+  version: 1.0.0
+  description: This service is in charge of processing all the events related to temperature.
+
+servers:
+  dev:
+    url: test.mosquitto.org
+    protocol: mqtt
+
+channels:
+  temperature/changed:
+    description: Updates the bedroom temperature in the database when the temperature drops or goes up.
+    publish:
+      operationId: temperatureChange
+      message:
+        description: Message that is being sent when the temperature in the bedroom changes.
+        contentType: application/json
+        payload:
+          type: object
+          additionalProperties: false
+          properties:
+            temperatureId:
+              type: string
+
+components:
+  schemas:
+    temperatureId:
+      type: object
+      additionalProperties: false
+      properties:
+        temperatureId:
+          type: string

package/assets/create-template/templates/default/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "myTemplate",
+  "generator": {
+    "renderer": "react",
+    "supportedProtocols": []
+  },
+  "dependencies": {
+    "@asyncapi/generator-react-sdk": "^1.0.20"
+  }
+}

package/assets/create-template/templates/default/readme.md

@@ -0,0 +1,4 @@
+### First install all the dependencies for template using below command:
+npm install 
+### Run the template using for a specific asyncapi document 
+ asyncapi generate fromTemplate <templateName> ../asyncapi-template 

package/assets/create-template/templates/default/template/index.js

@@ -0,0 +1,11 @@
+import { File, Text } from '@asyncapi/generator-react-sdk';
+
+// Pass the others parameters to get the specificatin of the asyncapi document
+export default function ({ asyncapi }) {
+  return (
+    <File name="asyncapi.md">
+      <Text>My application's markdown file.</Text>
+      <Text>App name: **{asyncapi.info().title()}**</Text>
+    </File>
+  );
+}

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

@@ -0,0 +1,19 @@
+import Command from '../../core/base';
+export declare const successMessage: (projectName: string) => string;
+export default class template extends Command {
+    static description: string;
+    protected commandName: string;
+    static readonly successMessage: (projectName: string) => string;
+    static readonly errorMessages: {
+        alreadyExists: (projectName: string) => string;
+    };
+    static flags: {
+        help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+        name: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        template: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        file: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+        'force-write': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        renderer: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/new/template.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.successMessage = void 0;
+const tslib_1 = require("tslib");
+const fs_1 = require("fs");
+const base_1 = tslib_1.__importDefault(require("../../core/base"));
+const path_1 = require("path");
+const SpecificationFile_1 = require("../../core/models/SpecificationFile");
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const template_flags_1 = require("../../core/flags/new/template.flags");
+const picocolors_1 = require("picocolors");
+const jsonfile_1 = tslib_1.__importDefault(require("jsonfile"));
+const path_2 = tslib_1.__importDefault(require("path"));
+const successMessage = (projectName) => `🎉 Your template is succesfully created
+⏩ Next steps: follow the instructions ${(0, picocolors_1.cyan)('below')} to manage your project:
+
+  cd ${projectName}\t\t ${(0, picocolors_1.gray)('# Navigate to the project directory')}
+  npm install\t\t ${(0, picocolors_1.gray)('# Install the project dependencies')}
+  asyncapi generate fromTemplate <templateName> ../${projectName} \t\t ${(0, picocolors_1.gray)('# Execute the template from anasyncapi document')}
+
+You can also open the project in your favourite editor and start tweaking it.
+`;
+exports.successMessage = successMessage;
+const errorMessages = {
+    alreadyExists: (projectName) => `Unable to create the project because the directory "${(0, picocolors_1.cyan)(projectName)}" already exists at "${process.cwd()}/${projectName}".
+To specify a different name for the new project, please run the command below with a unique project name:
+
+    ${(0, picocolors_1.gray)('asyncapi new template --name ') + (0, picocolors_1.gray)(projectName) + (0, picocolors_1.gray)('-1')}`,
+};
+class template extends base_1.default {
+    constructor() {
+        super(...arguments);
+        this.commandName = 'template';
+    }
+    run() {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const { flags } = yield this.parse(template); // NOSONAR
+            const { name: projectName, template: templateName, renderer: rendererName } = flags;
+            const PROJECT_DIRECTORY = (0, path_1.join)(process.cwd(), projectName);
+            if (rendererName !== 'nunjucks' && rendererName !== 'react') {
+                this.error('Invalid flag check the flag name of renderer');
+            }
+            const templateDirectory = (0, path_1.resolve)(__dirname, '../../../assets/create-template/templates/', templateName);
+            {
+                try {
+                    yield fs_1.promises.mkdir(PROJECT_DIRECTORY);
+                }
+                catch (err) {
+                    switch (err.code) {
+                        case 'EEXIST':
+                            this.error(errorMessages.alreadyExists(projectName));
+                            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 copyAndModify(templateDirectory, PROJECT_DIRECTORY, rendererName, projectName);
+                    this.log((0, exports.successMessage)(projectName));
+                }
+                catch (err) {
+                    this.error(`Unable to create the project. Please check the following message for further info about the error:\n\n${err}`);
+                }
+                this.specFile = yield (0, SpecificationFile_1.load)(`${templateDirectory}/asyncapi.yaml`);
+                this.metricsMetadata.template = flags.template;
+            }
+        });
+    }
+}
+exports.default = template;
+template.description = 'Creates a new template';
+template.successMessage = exports.successMessage;
+template.errorMessages = errorMessages;
+template.flags = (0, template_flags_1.templateFlags)();
+function copyAndModify(templateDirectory, PROJECT_DIRECTORY, rendererName, projectName) {
+    return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        const packageJsonPath = path_2.default.join(templateDirectory, 'package.json');
+        try {
+            yield fs_extra_1.default.copy(templateDirectory, PROJECT_DIRECTORY, {
+                filter: (src) => {
+                    return !src.endsWith('package.json');
+                }
+            });
+            const packageData = yield jsonfile_1.default.readFile(packageJsonPath);
+            if ((packageData.generator && 'renderer' in packageData.generator)) {
+                packageData.generator.renderer = rendererName;
+            }
+            if (packageData.name) {
+                packageData.name = projectName;
+            }
+            yield fs_extra_1.default.writeJSON(`${PROJECT_DIRECTORY}/package.json`, packageData, { spaces: 2 });
+        }
+        catch (err) {
+            console.error('Error:', err);
+        }
+    });
+}

package/lib/core/flags/new/template.flags.d.ts

@@ -0,0 +1,8 @@
+export declare const templateFlags: () => {
+    help: import("@oclif/core/lib/interfaces").BooleanFlag<void>;
+    name: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    template: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+    file: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces").CustomOptions>;
+    'force-write': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    renderer: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+};

package/lib/core/flags/new/template.flags.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.templateFlags = void 0;
+const core_1 = require("@oclif/core");
+const templateFlags = () => {
+    return {
+        help: core_1.Flags.help({ char: 'h' }),
+        name: core_1.Flags.string({
+            char: 'n',
+            description: 'Name of the Project',
+            default: 'project',
+        }),
+        template: core_1.Flags.string({
+            char: 't',
+            description: 'Name of the Template',
+            default: 'default',
+        }),
+        file: core_1.Flags.string({
+            char: 'f',
+            description: 'The path to the AsyncAPI file for generating a template.',
+        }),
+        'force-write': core_1.Flags.boolean({
+            default: false,
+            description: 'Force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)',
+        }),
+        renderer: core_1.Flags.string({
+            char: 'r',
+            default: 'react',
+            description: 'Creating a template for particular engine, Its value can be either react or nunjucks.'
+        })
+    };
+};
+exports.templateFlags = templateFlags;

package/oclif.manifest.json

@@ -1159,6 +1159,76 @@
         "index.js"
       ]
     },
+    "new:template": {
+      "aliases": [],
+      "args": {},
+      "description": "Creates a new template",
+      "flags": {
+        "help": {
+          "char": "h",
+          "description": "Show CLI help.",
+          "name": "help",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "name": {
+          "char": "n",
+          "description": "Name of the Project",
+          "name": "name",
+          "default": "project",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "template": {
+          "char": "t",
+          "description": "Name of the Template",
+          "name": "template",
+          "default": "default",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "file": {
+          "char": "f",
+          "description": "The path to the AsyncAPI file for generating a template.",
+          "name": "file",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force-write": {
+          "description": "Force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)",
+          "name": "force-write",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "renderer": {
+          "char": "r",
+          "description": "Creating a template for particular engine, Its value can be either react or nunjucks.",
+          "name": "renderer",
+          "default": "react",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "new:template",
+      "pluginAlias": "@asyncapi/cli",
+      "pluginName": "@asyncapi/cli",
+      "pluginType": "core",
+      "strict": true,
+      "errorMessages": {},
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "new",
+        "template.js"
+      ]
+    },
     "start": {
       "aliases": [],
       "args": {},
@@ -1497,5 +1567,5 @@
       ]
     }
   },
-  "version": "2.0.4"
+  "version": "2.1.0"
 }

package/package.json

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