Merge pull request #120 from Watts-Lab/schema-fall-fixes

Schema fall fixes

Author: darrenmo12309

deliberation-empirica

@@ -30,9 +30,7 @@ filesToCopy.forEach((filePath) => {
 });
 
 /**
- * This plugin hooks into the build process to print errors in a format that the problem matcher in
- * Visual Studio Code can understand.
- * @type {import('esbuild').Plugin}
+ * Plugin to display errors nicely in VS Code's problem matcher format
  */
 const esbuildProblemMatcherPlugin = {
   name: "esbuild-problem-matcher",
@@ -44,20 +42,19 @@ const esbuildProblemMatcherPlugin = {
     build.onEnd((result) => {
       result.errors.forEach(({ text, location }) => {
         console.error(`✘ [ERROR] ${text}`);
-        console.error(
-          `    ${location.file}:${location.line}:${location.column}:`
-        );
+        if (location) {
+          console.error(
+            `    ${location.file}:${location.line}:${location.column}:`
+          );
+        }
       });
       console.log("[watch] build finished");
     });
   },
 };
 
 /**
- * For web extension, all tests, including the test runner, need to be bundled into
- * a single module that has a exported `run` function .
- * This plugin bundles implements a virtual file extensionTests.ts that bundles all these together.
- * @type {import('esbuild').Plugin}
+ * Plugin for bundling all test files into a single entry (used for VS Code extension tests)
  */
 const testBundlePlugin = {
   name: "testBundlePlugin",
@@ -67,7 +64,7 @@ const testBundlePlugin = {
         return { path: path.resolve(args.path) };
       }
     });
-    build.onLoad({ filter: /[\/\\]extensionTests\.ts$/ }, async (args) => {
+    build.onLoad({ filter: /[\/\\]extensionTests\.ts$/ }, async () => {
       const testsRoot = path.join(__dirname, "src/test/suite");
       const files = await glob.glob("*.test.{ts,tsx}", {
         cwd: testsRoot,
@@ -84,25 +81,27 @@ const testBundlePlugin = {
   },
 };
 
-// Points hooks.js from deliberation-empirica to the mock hooks.js file in src/views
-// Needed for rendering
+/**
+ * Alias plugin to handle ../components/hooks imports
+ * Used in deliberation-empirica code
+ */
 const aliasHooksImport = {
   name: "alias-hooks-imports",
   setup(build) {
-    build.onResolve({ filter: /^\.\.\/components\/hooks$/ }, args => {
+    build.onResolve({ filter: /^\.\.\/components\/hooks$/ }, () => {
       return {
         path: path.resolve(__dirname, "src/views/hooks.js"),
       };
     });
   },
 };
 
-
+/**
+ * Build VS Code extension backend
+ */
 async function buildExtension() {
   const ctx = await esbuild.context({
-    entryPoints: [
-      "src/extension.ts"
-    ],
+    entryPoints: ["src/extension.ts"],
     bundle: true,
     format: "cjs",
     minify: production,
@@ -112,34 +111,47 @@ async function buildExtension() {
     outdir: "dist/",
     external: ["vscode", "path", "assert"],
     logLevel: "silent",
-    // Node.js global to browser globalThis
-    define: {
-      global: "globalThis",
-    },
-    alias: { // Aliases of empirica modules to mocks for rendering
-      '@empirica/core/player/react': path.resolve(__dirname, 'src/views/mocks.js'),
-      '@empirica/core/player/classic/react': path.resolve(__dirname, 'src/views/mocks.js'),
-      'deliberation-empirica/client/src/components/hooks': path.resolve(__dirname, 'src/views/hooks.js')
+    define: { global: "globalThis" },
+    alias: {
+      "@empirica/core/player/react": path.resolve(__dirname, "src/views/mocks.js"),
+      "@empirica/core/player/classic/react": path.resolve(__dirname, "src/views/mocks.js"),
+      "components/hooks": path.resolve(__dirname, "src/views/hooks.js"),
+      "components/hooks.js": path.resolve(__dirname, "src/views/hooks.js"),
+      "deliberation-empirica/client/src/components/hooks": path.resolve(
+        __dirname,
+        "src/views/hooks.js"
+      ),
+      "deliberation-empirica/client/src/components/hooks.js": path.resolve(
+        __dirname,
+        "src/views/hooks.js"
+      ),
     },
 
     plugins: [
       polyfill.NodeGlobalsPolyfillPlugin({
         process: true,
         buffer: true,
       }),
-
       alias({
         aliases: {
-          "../components/hooks": path.resolve(__dirname, "src/views/hooks.js"),
+          "components/hooks": path.resolve(__dirname, "src/views/hooks.js"),
+          "components/hooks.js": path.resolve(__dirname, "src/views/hooks.js"),
+          "deliberation-empirica/client/src/components/hooks": path.resolve(
+            __dirname,
+            "src/views/hooks.js"
+          ),
+          "deliberation-empirica/client/src/components/hooks.js": path.resolve(
+            __dirname,
+            "src/views/hooks.js"
+          ),
         },
         resolve: [".js", ".jsx"],
       }),
-
       aliasHooksImport,
-
-      esbuildProblemMatcherPlugin /* add to the end of plugins array */,
+      esbuildProblemMatcherPlugin,
     ],
   });
+
   if (watch) {
     await ctx.watch();
   } else {
@@ -148,15 +160,17 @@ async function buildExtension() {
   }
 }
 
-// Builds index.jsx for prompt file rendering and CSS style files
+/**
+ * Build webview frontend (prompt preview, styles)
+ */
 async function buildPrompt() {
   const ctx = await esbuild.context({
     entryPoints: [
       "src/views/index.jsx",
       "src/views/styles.css",
       "src/views/playerStyles.css",
       "src/views/layout.css",
-      "src/views/baseStyles.css"
+      "src/views/baseStyles.css",
     ],
     bundle: true,
     format: "esm",
@@ -167,22 +181,40 @@ async function buildPrompt() {
     outdir: "dist/views/",
     logLevel: "silent",
     external: ["vscode", "path", "assert"],
-    alias: { // Aliasing empirica module methods to point to mocks
-      '@empirica/core/player/react': path.resolve(__dirname, 'src/views/mocks.js'),
-      '@empirica/core/player/classic/react': path.resolve(__dirname, 'src/views/mocks.js'),
-      'deliberation-empirica/client/src/components/hooks': path.resolve(__dirname, 'src/views/hooks.js')
+    alias: {
+      "@empirica/core/player/react": path.resolve(__dirname, "src/views/mocks.js"),
+      "@empirica/core/player/classic/react": path.resolve(__dirname, "src/views/mocks.js"),
+      "components/hooks": path.resolve(__dirname, "src/views/hooks.js"),
+      "components/hooks.js": path.resolve(__dirname, "src/views/hooks.js"),
+      "deliberation-empirica/client/src/components/hooks": path.resolve(
+        __dirname,
+        "src/views/hooks.js"
+      ),
+      "deliberation-empirica/client/src/components/hooks.js": path.resolve(
+        __dirname,
+        "src/views/hooks.js"
+      ),
     },
     plugins: [
       alias({
         aliases: {
-          "../components/hooks": path.resolve(__dirname, "src/views/hooks.js"),
+          "components/hooks": path.resolve(__dirname, "src/views/hooks.js"),
+          "components/hooks.js": path.resolve(__dirname, "src/views/hooks.js"),
+          "deliberation-empirica/client/src/components/hooks": path.resolve(
+            __dirname,
+            "src/views/hooks.js"
+          ),
+          "deliberation-empirica/client/src/components/hooks.js": path.resolve(
+            __dirname,
+            "src/views/hooks.js"
+          ),
         },
         resolve: [".js", ".jsx"],
       }),
-
-      aliasHooksImport
-    ]
+      aliasHooksImport,
+    ],
   });
+
   if (watch) {
     await ctx.watch();
   } else {
@@ -191,6 +223,9 @@ async function buildPrompt() {
   }
 }
 
+/**
+ * Run both builds
+ */
 async function main() {
   await buildExtension();
   await buildPrompt();
@@ -200,3 +235,5 @@ main().catch((e) => {
   console.error(e);
   process.exit(1);
 });
+
+

esbuild.js

@@ -21,8 +21,7 @@
     "Other"
   ],
   "activationEvents": [
-    "onLanguage:treatmentsYaml",
-    "onLanguage:markdown"
+    "onLanguage:treatmentsYaml"
   ],
   "contributes": {
     "configurationDefaults": {
@@ -91,7 +90,7 @@
     "compile-web": "npm run prepare-web && tsc -p tsconfig.json && npm run lint && node esbuild.js",
     "package-web": "npm run prepare-web && npm run check-types && npm run lint && node esbuild.js --production",
     "compile-test": "npm run build:css && tsc -p tsconfig.test.json",
-    "test": "npm run compile-test && ELECTRON_DISABLE_GPU=1 xvfb-run -a node runExtensionTests.js $TEST_FILES",
+    "test": "npm run compile-test && ELECTRON_DISABLE_GPU=1 node -e \"const { spawnSync } = require('child_process'); const run = (cmd) => spawnSync(cmd, { shell: true, stdio: 'inherit' }); const check = spawnSync('command -v xvfb-run', { shell: true, stdio: 'pipe' }); if (check.status === 0) { console.log('🖥️ Using xvfb virtual display'); const xvfb = run('xvfb-run -a node runExtensionTests.js'); process.exit(xvfb.status ?? 0); } else { console.log('⚠️ xvfb not found, running tests without virtual display'); const plain = run('node runExtensionTests.js'); process.exit(plain.status ?? 1); }\"",
     "test:electron": "vscode-test --extensionDevelopmentPath=. --extensionTestsPath=out/test/suite/extensionTests.js",
     "vscode:prepublish": "npm run package-web",
     "check-types": "tsc --noEmit",
@@ -140,9 +139,9 @@
     "axios": "^1.9.0",
     "cp": "^0.2.0",
     "daisyui": "^5.0.43",
+    "detect-browser": "^5.3.0",
     "fastest-levenshtein": "^1.0.16",
     "json-to-ast": "^2.1.0",
-    "detect-browser": "^5.3.0",
     "react": "18.2.0",
     "react-debounce-input": "^3.3.0",
     "react-device-detect": "^2.2.3",
@@ -163,4 +162,3 @@
     }
   }
 }
-

package-lock.json

@@ -6,7 +6,7 @@ import * as path from "path";
 
 // Detects if file is prompt Markdown format by parsing metadata with YAML
 export function detectPromptMarkdown(document: vscode.TextDocument) {
-  if (document.languageId === "markdown") {
+  if (document.languageId === "markdown" || document.languageId === "promptMarkdown") {
     // console.log("Markdown file");
 
     // define interface for metadata
@@ -39,7 +39,11 @@ export function detectPromptMarkdown(document: vscode.TextDocument) {
 // Function to detect if document is treatmentsYaml format - mostly for unit tests
 export function detectTreatmentsYaml(document: vscode.TextDocument) {
   // console.log("Document languageId:", document.languageId);
-  return document.languageId === "treatmentsYaml";
+  if (document.languageId === "treatmentsYaml") return true;
+  // Fallback: detect by file name suffix in case languageId isn't set to the contributed language
+  const fileName = document.fileName || "";
+  if (fileName.endsWith(".treatments.yaml") || fileName.endsWith(".treatments.yml")) return true;
+  return false;
 }
 
 export function detectdlConfig(document: vscode.TextDocument) {

package.json

@@ -129,7 +129,7 @@ export function findPositionFromPathJson(
 }
 
 // Helper function to find the position of a node in the AST based on the path  
-function findPositionFromPath(
+export function findPositionFromPath(
     path: (string | number)[],
     astNode: any,
     document: vscode.TextDocument // Pass the document as an additional parameter

src/detectFile.ts

@@ -17,6 +17,7 @@ async function parseDocument(document: vscode.TextDocument) {
   if (detectTreatmentsYaml(document)) {
     await parseYaml(document);
   } else if (detectPromptMarkdown(document)) {
+    console.log(detectPromptMarkdown(document));
     parseMarkdown(document);
   } else if (detectdlConfig(document)) {
     await parseDlConfig(document);
@@ -50,13 +51,12 @@ export async function activate(context: vscode.ExtensionContext) {
         await parseDocument(event);
       }
     }),
-
-    // for changing document
-    vscode.workspace.onDidChangeTextDocument(async (event) => {
-      if (event?.document !== undefined) {
-        parseDocument(event?.document);
-      };
-    }),
+  // for changing document
+  vscode.workspace.onDidChangeTextDocument(async (event) => {
+    if (event?.document !== undefined) {
+      parseDocument(event?.document);
+    };
+  }),
 
     // When we switch to a document open in another tab
     vscode.window.onDidChangeActiveTextEditor(async (event) => {