Expand schema check to all files. Closes #80 (#105)

Author: garrytrinder

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Snippets: `devproxy-plugin-http-file-generator` - HttpFileGeneratorPlugin instance
 - Snippets: `devproxy-plugin-http-file-generator-config` - HttpFileGeneratorPlugin config section
 - Snippets: `devproxy-plugin-openai-mock-response` - OpenAIMockResponsePlugin instance
+- File Diagnostic: Check that schema matches installed version of Dev Proxy expanded to all files
 
 ### Changed:
 

src/diagnostics.ts

@@ -4,7 +4,7 @@ import { pluginSnippets } from "./constants";
 import { getASTNode, getRangeFromASTNode } from "./helpers";
 import { DevProxyInstall } from './types';
 
-export const updateDiagnostics = (
+export const updateConfigDiagnostics = (
   context: vscode.ExtensionContext,
   document: vscode.TextDocument,
   collection: vscode.DiagnosticCollection,
@@ -17,20 +17,7 @@ export const updateDiagnostics = (
   const documentNode = parse(document.getText()) as parse.ObjectNode;
 
   // check if schema version is compatible
-  const schemaNode = getASTNode(documentNode.children, 'Identifier', '$schema');
-  if (schemaNode) {
-    const schemaValue = (schemaNode.value as parse.LiteralNode).value as string;
-    const devProxyVersion = devProxyInstall.isBeta ? devProxyInstall.version.split('-')[0] : devProxyInstall.version;
-    if (!schemaValue.includes(`${devProxyVersion}`)) {
-      const diagnostic = new vscode.Diagnostic(
-        getRangeFromASTNode(schemaNode),
-        `Schema version is not compatible with the installed version of Dev Proxy. Expected v${devProxyVersion}`,
-        vscode.DiagnosticSeverity.Warning
-      );
-      diagnostic.code = 'invalidSchema';
-      diagnostics.push(diagnostic);
-    }
-  }
+  checkSchemaCompatibility(documentNode, devProxyInstall, diagnostics);
 
   // check validity of plugins
   const pluginsNode = getASTNode(
@@ -163,4 +150,40 @@ export const updateDiagnostics = (
   }
 
   collection.set(document.uri, diagnostics);
-};
+};
+
+export const updateDiagnostics = (
+  context: vscode.ExtensionContext,
+  document: vscode.TextDocument,
+  collection: vscode.DiagnosticCollection,
+): void => {
+  const devProxyInstall = context.globalState.get<DevProxyInstall>('devProxyInstall');
+  if (!devProxyInstall) {
+    return;
+  }
+
+  const diagnostics: vscode.Diagnostic[] = [];
+  const documentNode = parse(document.getText()) as parse.ObjectNode;
+
+  // check if schema version is compatible
+  checkSchemaCompatibility(documentNode, devProxyInstall, diagnostics);
+
+  collection.set(document.uri, diagnostics);
+};
+
+export const checkSchemaCompatibility = (documentNode: parse.ObjectNode, devProxyInstall: DevProxyInstall, diagnostics: vscode.Diagnostic[]) => {
+  const schemaNode = getASTNode(documentNode.children, 'Identifier', '$schema');
+  if (schemaNode) {
+    const schemaValue = (schemaNode.value as parse.LiteralNode).value as string;
+    const devProxyVersion = devProxyInstall.isBeta ? devProxyInstall.version.split('-')[0] : devProxyInstall.version;
+    if (!schemaValue.includes(`${devProxyVersion}`)) {
+      const diagnostic = new vscode.Diagnostic(
+        getRangeFromASTNode(schemaNode),
+        `Schema version is not compatible with the installed version of Dev Proxy. Expected v${devProxyVersion}`,
+        vscode.DiagnosticSeverity.Warning
+      );
+      diagnostic.code = 'invalidSchema';
+      diagnostics.push(diagnostic);
+    }
+  }
+};

src/documents.ts

@@ -1,24 +1,32 @@
 import * as vscode from 'vscode';
-import { isConfigFile } from './helpers';
-import { updateDiagnostics } from './diagnostics';
+import { isConfigFile, isProxyFile } from './helpers';
+import { updateConfigDiagnostics, updateDiagnostics } from './diagnostics';
 
 export const registerDocumentListeners = (context: vscode.ExtensionContext, collection: vscode.DiagnosticCollection) => {
     context.subscriptions.push(
         vscode.workspace.onDidOpenTextDocument(document => {
+            if (isProxyFile(document)) {
+                updateDiagnostics(context, document, collection);
+            }
             if (!isConfigFile(document)) {
                 return;
             }
-            updateDiagnostics(context, document, collection);
+            updateConfigDiagnostics(context, document, collection);
         })
     );
 
     context.subscriptions.push(
         vscode.workspace.onDidChangeTextDocument(event => {
-            if (!isConfigFile(event.document)) {
+            if (!isConfigFile(event.document) || !isProxyFile(event.document)) {
                 collection.delete(event.document.uri);
                 return;
             }
-            updateDiagnostics(context, event.document, collection);
+            if (isConfigFile(event.document)) {
+                updateConfigDiagnostics(context, event.document, collection);
+            }
+            if (isProxyFile(event.document)) {
+                updateDiagnostics(context, event.document, collection);
+            }
         })
     );
 };

src/helpers.ts

@@ -78,6 +78,20 @@ export const isConfigFile = (document: vscode.TextDocument) => {
   return isConfigFile;
 };
 
+export const isProxyFile = (document: vscode.TextDocument) => {
+  let isProxyFile = false;
+  const documentNode = parse(document.getText()) as parse.ObjectNode;
+
+  const schemaNode = getASTNode(documentNode.children, 'Identifier', '$schema');
+  if (schemaNode) {
+    const schema = (schemaNode?.value as parse.LiteralNode).value as string;
+    if (schema.includes('dev-proxy') && schema.endsWith('.schema.json')) {
+      isProxyFile = true;
+    }
+  }
+  return isProxyFile;
+};
+
 export const sleep = (ms: number): Promise<void> => {
   return new Promise(resolve => {
     setTimeout(resolve, ms);
@@ -86,14 +100,14 @@ export const sleep = (ms: number): Promise<void> => {
 
 export const executeCommand = async (cmd: string): Promise<string> => {
   return new Promise((resolve, reject) => {
-      exec(cmd, (error, stdout, stderr) => {
-          if (error) {
-              reject(`exec error: ${error}`);
-          } else if (stderr) {
-              reject(`stderr: ${stderr}`);
-          } else {
-              resolve(stdout);
-          }
-      });
+    exec(cmd, (error, stdout, stderr) => {
+      if (error) {
+        reject(`exec error: ${error}`);
+      } else if (stderr) {
+        reject(`stderr: ${stderr}`);
+      } else {
+        resolve(stdout);
+      }
+    });
   });
 };