improve editing experience w/ content assistance asyncapi#132 asyncap…

…i#133

README.md

@@ -14,6 +14,27 @@ You can open AsyncAPI Preview from the editor title/context menu.
 
 Automatic hot-reloading on editor save, but currently, it doesn't reload when saving referenced external files.
 
+## Content Assistance
+
+### Available snippets:
+
+Open an empty or otherwise yaml file and start typing one of the following prefixes:
+
+- `add asyncapi skeleton`: Adds an asyncapi skeleton for jump starting your API editing.
+- `add asyncapi subscribe to async request`: Inserts a new subscribe operation, for listening to incoming async requests/commands.
+- `add asyncapi publish event operation`: Inserts a new publish operation, for producing domain events.
+- `add asyncapi message`: Inserts a new message, you can choose it to be either a **Request** or an **Event**.
+
+Once snippets are inserted use the `<TAB>` key to travel between snippet placeholders.
+
+## Paste as Schema
+
+You can also autogenerate an Schema object from a JSON example.
+
+Right-click inside `#/components/schemas` section and choose `AsyncAPI: Paste as Schema` from the context menu.
+
+![VSCode AsyncapiPreview - Content Assistance](docs/VSCode%20AsyncAPI%20Content%20Assistance-X4.gif)
+
 ### Credits
 
 AsyncAPI Viewer utilizes the following open source projects:

package.json

@@ -109,6 +109,7 @@
     "@semantic-release/github": "7.2.3",
     "@semantic-release/release-notes-generator": "^9.0.1",
     "@types/glob": "^7.2.0",
+    "@types/js-yaml": "^4.0.5",
     "@types/mocha": "^9.1.1",
     "@types/node": "14.x",
     "@types/vscode": "^1.66.0",

snippets/snippets.json

@@ -1,6 +1,6 @@
 {
     "Add AsyncAPI Skeleton": {
-        "prefix": "asyncapi",
+        "prefix": "add asyncapi skeleton",
         "body": [
             "asyncapi: '2.4.0'",
             "info:",
@@ -22,7 +22,7 @@
             "",
             "channels:",
             "  this.is.one.channel.please.rename:",
-            "    description: The topic on which messages may be produced and consumed.",
+            "    description: A sample topic on which messages may be produced and consumed.",
             "${4:# type 'add publish' or 'add subscribe' to get snippets autocomplete}",
             "",
             "",
@@ -32,22 +32,16 @@
             "    description: add one message and remove this line",
             "    # type here 'add message' to get snippets autocomplete",
             "",
+            "",
             "  schemas:",
             "    OneEntity:",
             "      type: object",
             "",
-            "  messageTraits:",
-            "    CommonHeaders:",
-            "      headers:",
-            "        type: object",
-            "        properties:",
-            "          metadata-session:",
-            "            type: string",
             ""
         ]
     },
     "Add Subscribe to Async Request": {
-        "prefix": "add subscribe to async request",
+        "prefix": "add asyncapi subscribe to async request",
         "body": [
             "    subscribe:",
             "      summary: ${1:Entity} Async Requests",
@@ -60,7 +54,7 @@
         ]
     },
     "Add Publish Event Operation": {
-        "prefix": "add publish event operation",
+        "prefix": "add asyncapi publish event operation",
         "body": [
             "    publish:",
             "      summary: ${1:Entity} Domain Events",
@@ -73,15 +67,15 @@
         ]
     },
     "Add Message": {
-        "prefix": "add message",
+        "prefix": "add asyncapi message",
         "body": [
-            "    ${1:Entity}${2:Type|Request,Event|}Message:",
+            "    ${1:Entity}${2|Request,Event|}Message:",
             "      name: ${1}${2}Message",
             "      title: Async ${2} for a ${1}",
             "      summary: Async ${2} for a ${1}",
             "      schemaFormat: application/vnd.aai.asyncapi;version=2.4.0",
             "      payload:",
-            "        \\$ref: '#/components/schemas/${1}${2}'",
+            "        \\$ref: '#/components/schemas/${1}'",
             ""
         ]
     }

src/PreviewWebPanel.ts

@@ -1,7 +1,7 @@
 import * as vscode from 'vscode';
 import * as path from 'path';
 
-export function previewAsyncAPI(context) {
+export function previewAsyncAPI(context: vscode.ExtensionContext) {
  return async (uri: vscode.Uri) => {
     uri = uri || (await promptForAsyncapiFile()) as vscode.Uri;
     if (uri) {

src/SmartPasteCommand.ts

@@ -1,6 +1,6 @@
 import * as vscode from 'vscode';
 import * as yml from 'js-yaml';
-import { createSchema } from './lib/genson-js/schema-builder';
+import { createSchema } from 'genson-js';
 
 export async function asyncapiSmartPaste() {
     let editor = vscode.window.activeTextEditor;
@@ -13,7 +13,6 @@ export async function asyncapiSmartPaste() {
     let currentLineText = editor.document.lineAt(start.line).text;
     let clipboad = await vscode.env.clipboard.readText();
 
-    console.log("Smart Pasting", clipboad);
     const json = parse(clipboad);
     if(typeof json === 'object') {
         const schema = { PastedSchema: createSchema(json) };
@@ -50,7 +49,7 @@ function parse(text: string) {
     }
 }
 
-function stringify(schema, languageId: string, indentYml: number) {
+function stringify(schema: object, languageId: string, indentYml: number) {
     if(languageId === 'json') {
         return JSON.stringify(schema, null, 2);
     } else {

tsconfig.json

@@ -7,7 +7,7 @@
 		],
 		"sourceMap": true,
 		"rootDir": "src",
-		"strict": false   /* enable all strict type-checking options */
+		"strict": true   /* enable all strict type-checking options */
 		/* Additional Checks */
 		// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
 		// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */