Autocompletion / links on hover for Registry types (#200)

* creating JSON patch for JSON schema based on registry schema
* overwriting template schema file with patched template schema

Co-authored-by: Kevin DeJong <[email protected]>

Author: PatMyron

schema/resource-patch-stub.json

@@ -0,0 +1,68 @@
+[
+    {
+       "op":"add",
+       "path":"/definitions/RESOURCE_TYPE",
+       "value":{
+          "type":"object",
+          "properties":{
+             "DependsOn":{
+                "type":[
+                   "string",
+                   "array"
+                ],
+                "items":{
+                   "type":"string"
+                }
+             },
+             "Metadata":{
+                "description":"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html",
+                "type":"object"
+             },
+             "DeletionPolicy":{
+                "description":"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html",
+                "type":"string",
+                "enum":[
+                   "Delete",
+                   "Retain",
+                   "Snapshot"
+                ]
+             },
+             "UpdateReplacePolicy":{
+                "description":"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html",
+                "type":"string",
+                "enum":[
+                   "Delete",
+                   "Retain",
+                   "Snapshot"
+                ]
+             },
+             "CreationPolicy":{
+                "description":"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-creationpolicy.html",
+                "type":"object"
+             },
+             "UpdatePolicy":{
+                "description":"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html",
+                "type":"object"
+             },
+             "Type":{
+                "type":"string",
+                "enum":[
+                   "RESOURCE_TYPE"
+                ]
+             },
+             "Properties": "RESOURCE_SCHEMA"
+          },
+          "required":[
+             "Type"
+          ],
+          "additionalProperties":false
+       }
+    },
+    {
+       "op":"add",
+       "path":"/definitions/resources/patternProperties/^[a-zA-Z0-9]{1,255}$/oneOf/-",
+       "value":{
+          "$ref":"#/definitions/RESOURCE_TYPE"
+       }
+    }
+ ]

server/package-lock.json

@@ -14,6 +14,7 @@
 	},
 	"dependencies": {
 		"commander": "^3.0.2",
+		"fast-json-patch": "^3.1.0",
 		"vscode-languageserver": "^5.2.1",
 		"vscode-uri": "^2.1.1"
 	},

server/package.json

@@ -25,6 +25,8 @@ import {
 import { URI } from 'vscode-uri';
 
 import { spawn } from "child_process";
+import { readdirSync, readFileSync, writeFileSync } from 'fs';
+import { applyPatch } from 'fast-json-patch';
 
 const program = new Command('cfn-lsp')
 	.allowUnknownOption()
@@ -157,6 +159,17 @@ function isCloudFormation(template: string, filename: string): Boolean {
 	return false;
 }
 
+function patchTemplateSchema(registrySchemaDirectory: string) {
+	const stub = readFileSync(__dirname + '/../../schema/resource-patch-stub.json', 'utf8');
+	let templateSchema = JSON.parse(readFileSync(__dirname + '/../../schema/all-spec.json', 'utf8'));
+	for (const schemaFile of readdirSync(registrySchemaDirectory)) {
+		const registrySchema = readFileSync(registrySchemaDirectory + schemaFile, 'utf8');
+		const patch = JSON.parse(stub.replace(/RESOURCE_TYPE/g, JSON.parse(registrySchema)['typeName']).replace(/"RESOURCE_SCHEMA"/g, registrySchema));
+		templateSchema = applyPatch(templateSchema, patch).newDocument;
+	}
+	writeFileSync(__dirname + '/../../schema/all-spec.json', JSON.stringify(templateSchema));
+}
+
 function runLinter(document: TextDocument): void {
 	let uri = document.uri;
 
@@ -174,6 +187,14 @@ function runLinter(document: TextDocument): void {
 	let build_graph = isPreviewing[uri];
 
 	if (is_cfn) {
+		if (Path.includes(' --registry-schemas ') || Path.includes(' -s ')) {
+			for (const segment of Path.split('-')) {
+				if (segment.startsWith('schemas ') || segment.startsWith('s ')) {
+					patchTemplateSchema(segment.split(' ')[1] + "/");
+				}
+			}
+		}
+
 		let args = ['--format', 'json'];
 		if (build_graph) {
 			args.push('--build-graph');