Update config file check

Closes #30

Author: garrytrinder

.vscode-test.mjs

@@ -1,5 +1,9 @@
-import { defineConfig } from '@vscode/test-cli';
+import {defineConfig} from '@vscode/test-cli';
 
 export default defineConfig({
-	files: 'out/test/**/*.test.js',
+  files: 'out/test/**/*.test.js',
+  mocha: {
+    ui: 'tdd',
+    timeout: 20000,
+  },
 });

package.json

@@ -34,11 +34,12 @@
   "scripts": {
     "vscode:prepublish": "npm run package",
     "compile": "webpack",
+    "copy-examples": "node scripts/copy-examples.js",
     "watch": "webpack --watch",
     "package": "webpack --mode production --devtool hidden-source-map",
     "compile-tests": "tsc -p . --outDir out",
     "watch-tests": "tsc -p . -w --outDir out",
-    "pretest": "npm run compile-tests && npm run compile && npm run lint",
+    "pretest": "npm run compile-tests && npm run compile && npm run copy-examples && npm run lint",
     "lint": "gts lint",
     "test": "vscode-test",
     "clean": "gts clean",

scripts/copy-examples.js

@@ -0,0 +1,19 @@
+const fs = require('fs');
+const path = require('path');
+
+function copyFolderSync(from, to) {
+  fs.mkdirSync(to, {recursive: true});
+  fs.readdirSync(from).forEach(element => {
+    if (fs.lstatSync(path.join(from, element)).isFile()) {
+      fs.copyFileSync(path.join(from, element), path.join(to, element));
+    } else {
+      copyFolderSync(path.join(from, element), path.join(to, element));
+    }
+  });
+}
+
+const srcDir = 'src/test/examples';
+const destDir = 'out/test/examples';
+
+copyFolderSync(srcDir, destDir);
+console.log('Directory and contents have been copied successfully.');

src/extension.ts

@@ -1,7 +1,7 @@
 import * as vscode from 'vscode';
 import parse from 'json-to-ast';
-import {pluginSnippets} from './constants';
-import {getASTNode, getRangeFromASTNode} from './helpers';
+import { pluginSnippets } from './constants';
+import { getASTNode, getRangeFromASTNode, isConfigFile } from './helpers';
 
 export const activate = (context: vscode.ExtensionContext) => {
   const collection = vscode.languages.createDiagnosticCollection('Dev Proxy');
@@ -29,46 +29,18 @@ const updateDiagnostics = (
 ): void => {
   let diagnostics: vscode.Diagnostic[] = [];
 
-  // we need to ensure that we are looking at a config file before we start
-  const fileContents = parse(document.getText()) as parse.ObjectNode;
-  let isConfigFile = false;
+  const documentNode = parse(document.getText()) as parse.ObjectNode;
 
-  // we know that its a config file if
-  // 1. the file name is devproxy.config.json
-  if (document.fileName.endsWith('devproxyrc.json')) {
-    isConfigFile = true;
-  }
-
-  // 2. the file contains a $schema property with the value of https://raw.githubusercontent.com/microsoft/dev-proxy/main/schemas/v1.0/rc.schema.json
-  const schemaNode = getASTNode(fileContents.children, 'Identifier', '$schema');
-  if (schemaNode) {
-    const schema = (schemaNode?.value as parse.LiteralNode).value as string;
-    if (schema.includes('dev-proxy') && schema.endsWith('rc.schema.json')) {
-      isConfigFile = true;
-    }
+  if (!isConfigFile(document)) {
+    return;
   }
 
-  // 3. the file contains the following properties: urlsToWatch and plugins, as $schema is optional
-  const pluginsNode = getASTNode(
-    fileContents.children,
-    'Identifier',
-    'plugins'
-  );
+  // check if urlsToWatch is empty
   const urlsToWatchNode = getASTNode(
-    fileContents.children,
+    documentNode.children,
     'Identifier',
     'urlsToWatch'
-  );
-  if (pluginsNode && urlsToWatchNode) {
-    isConfigFile = true;
-  }
-
-  // if its not a config file, we don't need to do anything
-  if (!isConfigFile) {
-    return;
-  }
-
-  // check if urlsToWatch is empty
+  );  
   if (
     urlsToWatchNode &&
     (urlsToWatchNode.value as parse.ArrayNode).children.length === 0
@@ -83,6 +55,11 @@ const updateDiagnostics = (
   }
 
   // check validity of plugins
+  const pluginsNode = getASTNode(
+    documentNode.children,
+    'Identifier',
+    'plugins'
+  );
   if (
     pluginsNode &&
     (pluginsNode.value as parse.ArrayNode).children.length !== 0
@@ -146,7 +123,7 @@ const updateDiagnostics = (
             configSectionNode.value as parse.LiteralNode
           ).value as string;
           const configSection = getASTNode(
-            fileContents.children,
+            documentNode.children,
             'Identifier',
             configSectionName
           );
@@ -170,4 +147,4 @@ const updateDiagnostics = (
   collection.set(document.uri, diagnostics);
 };
 
-export const deactivate = () => {};
+export const deactivate = () => { };

src/helpers.ts

@@ -25,3 +25,37 @@ export const getRangeFromASTNode = (
     new vscode.Position(endLine - 1, endColumn)
   );
 };
+
+export const isConfigFile = (document: vscode.TextDocument) => {
+  let isConfigFile = false;
+
+  const documentNode = parse(document.getText()) as parse.ObjectNode;
+
+  // we know that its a config file if
+  // 1. the file name is devproxy.config.json
+  if (document.fileName.endsWith('devproxyrc.json')) {
+    isConfigFile = true;
+  }
+
+  // 2. the file contains a $schema property that contains dev-proxy and ends with rc.schema.json
+  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('rc.schema.json')) {
+      isConfigFile = true;
+    }
+  }
+
+  // 3. the file contains plugins array, as $schema is optional
+  const pluginsNode = getASTNode(
+    documentNode.children,
+    'Identifier',
+    'plugins'
+  );
+
+  if (pluginsNode && pluginsNode.value.type === 'Array') {
+    isConfigFile = true;
+  }
+
+  return isConfigFile;
+};

src/test/examples/config-incorrect-schema-with-plugins.json

@@ -0,0 +1,4 @@
+{
+    "$schema": "https://raw.githubusercontent.com/microsoft/dev-proxy/main/schemas/v1.0/mockresponseplugin.schema.json",
+    "plugins": {}
+}

src/test/examples/config-incorrect-schema.json

@@ -0,0 +1,3 @@
+{
+    "$schema": "https://raw.githubusercontent.com/microsoft/dev-proxy/main/schemas/v1.0/mockresponseplugin.schema.json"
+}

src/test/examples/config-plugins.json

@@ -0,0 +1,3 @@
+{
+    "plugins": []
+}

src/test/examples/config-schema.json

@@ -0,0 +1,4 @@
+{
+    "$schema": "https://raw.githubusercontent.com/microsoft/dev-proxy/main/schemas/v1.0/rc.schema.json",
+    "plugins": []
+}

src/test/examples/devproxyrc.json

@@ -0,0 +1,4 @@
+{
+    "$schema": "https://raw.githubusercontent.com/microsoft/dev-proxy/main/schemas/v1.0/rc.schema.json",
+    "plugins": []
+}