@asyncapi/cli 0.8.1 → 0.10.0

package/lib/commands/new.js

@@ -9,6 +9,7 @@ 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 {
     async run() {
         const { flags } = this.parse(New);
@@ -17,7 +18,8 @@ class New extends base_1.default {
             return this.runInteractive();
         }
         const fileName = flags['file-name'] || DEFAULT_ASYNCAPI_FILE_NAME;
-        this.createAsyncapiFile(fileName);
+        const template = flags['example'] || DEFAULT_ASYNCAPI_TEMPLATE;
+        this.createAsyncapiFile(fileName, template);
         if (flags.studio) {
             if (isTTY) {
                 Studio_1.start(fileName, flags.port || Studio_1.DEFAULT_PORT);
@@ -30,7 +32,9 @@ class New extends base_1.default {
     async runInteractive() {
         const { flags } = this.parse(New);
         let fileName = flags['file-name'];
+        let selectedTemplate = flags['example'];
         let openStudio = flags.studio;
+        let examples = [];
         const questions = [];
         if (!fileName) {
             questions.push({
@@ -40,6 +44,30 @@ class New extends base_1.default {
                 default: DEFAULT_ASYNCAPI_FILE_NAME,
             });
         }
+        try {
+            const exampleFiles = await readFile(path_1.resolve(__dirname, '../../assets/examples/examples.json'), { encoding: 'utf8' });
+            examples = JSON.parse(exampleFiles);
+        }
+        catch (error) {
+            // no examples found
+        }
+        if (!selectedTemplate && examples.length > 0) {
+            questions.push({
+                name: 'use-example',
+                message: 'would you like to start your new file from one of our examples?',
+                type: 'confirm',
+                default: true,
+            });
+            questions.push({
+                type: 'list',
+                name: 'selectedTemplate',
+                message: 'What example would you like to use?',
+                choices: examples,
+                when: (answers) => {
+                    return answers['use-example'];
+                },
+            });
+        }
         if (openStudio === undefined) {
             questions.push({
                 name: 'studio',
@@ -53,32 +81,36 @@ class New extends base_1.default {
             if (!fileName) {
                 fileName = answers.filename;
             }
+            if (!selectedTemplate) {
+                selectedTemplate = answers.selectedTemplate;
+            }
             if (openStudio === undefined) {
                 openStudio = answers.studio;
             }
         }
-        else {
-            fileName = DEFAULT_ASYNCAPI_FILE_NAME;
-        }
-        await this.createAsyncapiFile(fileName);
+        fileName = fileName || DEFAULT_ASYNCAPI_FILE_NAME;
+        selectedTemplate = selectedTemplate || DEFAULT_ASYNCAPI_TEMPLATE;
+        await this.createAsyncapiFile(fileName, selectedTemplate);
         if (openStudio) {
             Studio_1.start(fileName, flags.port || Studio_1.DEFAULT_PORT);
         }
     }
-    async createAsyncapiFile(fileName) {
-        const defaultAsyncapiFile = await readFile(path_1.resolve(__dirname, '../../assets/asyncapi.yaml'), { encoding: 'utf8' });
+    async createAsyncapiFile(fileName, selectedTemplate) {
+        const asyncApiFile = await readFile(path_1.resolve(__dirname, '../../assets/examples/', selectedTemplate), { encoding: 'utf8' });
+        const fileNameHasFileExtension = fileName.includes('.');
+        const fileNameToWriteToDisk = fileNameHasFileExtension ? fileName : `${fileName}.yaml`;
         try {
-            const content = await readFile(fileName, { encoding: 'utf8' });
+            const content = await readFile(fileNameToWriteToDisk, { encoding: 'utf8' });
             if (content !== '') {
-                console.log(`File ${fileName} already exists. Ignoring...`);
+                console.log(`File ${fileNameToWriteToDisk} already exists. Ignoring...`);
                 return;
             }
         }
         catch (e) {
             // File does not exist. Proceed creating it...
         }
-        await writeFile(fileName, defaultAsyncapiFile, { encoding: 'utf8' });
-        console.log(`Created file ${fileName}...`);
+        await writeFile(fileNameToWriteToDisk, asyncApiFile, { encoding: 'utf8' });
+        console.log(`Created file ${fileNameToWriteToDisk}...`);
     }
 }
 exports.default = New;
@@ -86,6 +118,7 @@ New.description = 'creates a new asyncapi file';
 New.flags = {
     help: command_1.flags.help({ char: 'h' }),
     'file-name': command_1.flags.string({ char: 'n', description: 'name of the file' }),
+    example: command_1.flags.string({ char: 'e', description: 'name of the example to use' }),
     studio: command_1.flags.boolean({ char: 's', description: 'open in Studio' }),
     port: command_1.flags.integer({ char: 'p', description: 'port in which to start Studio' }),
     'no-tty': command_1.flags.boolean({ description: 'do not use an interactive terminal' }),

package/lib/models/Context.js

@@ -13,7 +13,7 @@ exports.DEFAULT_CONTEXT_FILE_PATH = path.resolve(os.homedir(), CONTEXT_FILENAME)
 async function loadContext(contextName) {
     const fileContent = await loadContextFile();
     if (contextName) {
-        const context = fileContent.store[contextName];
+        const context = fileContent.store[String(contextName)];
         if (!context) {
             throw new context_error_1.ContextNotFound(contextName);
         }
@@ -46,19 +46,19 @@ async function addContext(contextName, pathToFile) {
             throw err;
         }
     }
-    fileContent.store[contextName] = pathToFile;
+    fileContent.store[String(contextName)] = pathToFile;
     await saveContextFile(fileContent);
 }
 exports.addContext = addContext;
 async function removeContext(contextName) {
     const fileContent = await loadContextFile();
-    if (!fileContent.store[contextName]) {
+    if (!fileContent.store[String(contextName)]) {
         throw new context_error_1.ContextNotFound(contextName);
     }
     if (fileContent.current === contextName) {
         delete fileContent.current;
     }
-    delete fileContent.store[contextName];
+    delete fileContent.store[String(contextName)];
     await saveContextFile(fileContent);
 }
 exports.removeContext = removeContext;
@@ -73,7 +73,7 @@ async function getCurrentContext() {
 exports.getCurrentContext = getCurrentContext;
 async function setCurrentContext(contextName) {
     const fileContent = await loadContextFile();
-    if (!fileContent.store[contextName]) {
+    if (!fileContent.store[String(contextName)]) {
         throw new context_error_1.ContextNotFound(contextName);
     }
     fileContent.current = contextName;

package/lib/models/SpecificationFile.js

@@ -39,14 +39,14 @@ async function load(filePathOrContextName) {
         return await loadFromContext();
     }
     catch (e) {
-        if (!filePathOrContextName) {
+        const autoDetectedSpecFile = await detectSpecFile();
+        if (autoDetectedSpecFile) {
+            return new SpecificationFile(autoDetectedSpecFile);
+        }
+        if (!filePathOrContextName || !autoDetectedSpecFile) {
             throw e;
         }
     }
-    const autoDetectedSpecFile = await detectSpecFile();
-    if (autoDetectedSpecFile) {
-        return new SpecificationFile(autoDetectedSpecFile);
-    }
     throw new specification_file_1.SpecificationFileNotFound();
 }
 exports.load = load;

package/oclif.manifest.json

@@ -1 +1 @@
-{"version":"0.8.1","commands":{"config":{"id":"config","description":"access configs","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"new":{"id":"new","description":"creates a new asyncapi file","pluginName":"@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"},"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"},"no-tty":{"name":"no-tty","type":"boolean","description":"do not use an interactive terminal","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate asyncapi file","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"spec-file","description":"spec path or context-name","required":false}]},"config:context":{"id":"config:context","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start:studio":{"id":"start:studio","description":"starts a new local instance of Studio","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"file":{"name":"file","type":"option","char":"f","description":"path to the AsyncAPI file to link with Studio"},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio"}},"args":[]},"config:context:add":{"id":"config:context:add","description":"Add or modify a context in the store","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"context-name","description":"context name","required":true},{"name":"spec-file-path","description":"file path of the spec file","required":true}]},"config:context:current":{"id":"config:context:current","description":"Shows the current context that is being used","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"config:context:list":{"id":"config:context:list","description":"List all the stored context in the store","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"config:context:remove":{"id":"config:context:remove","description":"Delete a context from the store","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"context-name","description":"Name of the context to delete","required":true}]},"config:context:use":{"id":"config:context:use","description":"Set a context as current","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"context-name","description":"name of the saved context","required":true}]}}}
+{"version":"0.10.0","commands":{"config":{"id":"config","description":"access configs","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"new":{"id":"new","description":"creates a new asyncapi file","pluginName":"@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"},"example":{"name":"example","type":"option","char":"e","description":"name of the example to use"},"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"},"no-tty":{"name":"no-tty","type":"boolean","description":"do not use an interactive terminal","allowNo":false}},"args":[]},"validate":{"id":"validate","description":"validate asyncapi file","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"spec-file","description":"spec path or context-name","required":false}]},"config:context":{"id":"config:context","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"start:studio":{"id":"start:studio","description":"starts a new local instance of Studio","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"file":{"name":"file","type":"option","char":"f","description":"path to the AsyncAPI file to link with Studio"},"port":{"name":"port","type":"option","char":"p","description":"port in which to start Studio"}},"args":[]},"config:context:add":{"id":"config:context:add","description":"Add or modify a context in the store","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"context-name","description":"context name","required":true},{"name":"spec-file-path","description":"file path of the spec file","required":true}]},"config:context:current":{"id":"config:context:current","description":"Shows the current context that is being used","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"config:context:list":{"id":"config:context:list","description":"List all the stored context in the store","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[]},"config:context:remove":{"id":"config:context:remove","description":"Delete a context from the store","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"context-name","description":"Name of the context to delete","required":true}]},"config:context:use":{"id":"config:context:use","description":"Set a context as current","pluginName":"@asyncapi/cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"context-name","description":"name of the saved context","required":true}]}}}

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@asyncapi/cli",
   "description": "All in one CLI for all AsyncAPI tools",
-  "version": "0.8.1",
+  "version": "0.10.0",
   "author": "@asyncapi",
   "bin": {
     "asyncapi": "./bin/run"
   },
   "bugs": "https://github.com/asyncapi/cli/issues",
   "dependencies": {
-    "@asyncapi/parser": "^1.10.2",
-    "@asyncapi/studio": "^0.2.1",
+    "@asyncapi/parser": "^1.11.0",
+    "@asyncapi/studio": "^0.3.2",
     "@fmvilas/oclif-plugin-spaced-commands": "^1.0.4",
     "@oclif/command": "^1.8.0",
     "@oclif/config": "^1.17.0",
@@ -20,8 +20,10 @@
     "inquirer": "^8.2.0",
     "open": "^8.4.0",
     "reflect-metadata": "^0.1.13",
+    "request": "^2.88.2",
     "serve-handler": "^6.1.3",
     "tslib": "^1.14.1",
+    "unzipper": "^0.10.11",
     "ws": "^8.2.3"
   },
   "devDependencies": {
@@ -63,6 +65,7 @@
   "files": [
     "/bin",
     "/lib",
+    "/assets",
     "/npm-shrinkwrap.json",
     "/oclif.manifest.json"
   ],
@@ -106,7 +109,7 @@
   },
   "repository": "asyncapi/cli",
   "scripts": {
-    "build": "tsc",
+    "build": "node scripts/fetch-asyncapi-example.js && tsc",
     "bump:version": "npm --no-git-tag-version --allow-same-version version $VERSION",
     "dev": "tsc --watch",
     "generate:assets": "npm run generate:readme:toc",