@weborigami/language 0.3.4-jse.6 → 0.3.4-jse.8

package/src/runtime/errors.js

@@ -1,6 +1,7 @@
 // Text we look for in an error stack to guess whether a given line represents a
 
 import {
+  box,
   scope as scopeFn,
   trailingSlash,
   TraverseError,
@@ -8,6 +9,7 @@ import {
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 import codeFragment from "./codeFragment.js";
+import * as symbols from "./symbols.js";
 import { typos } from "./typos.js";
 
 // function in the Origami source code.
@@ -18,6 +20,19 @@ const origamiSourceSignals = [
   "at Scope.evaluate",
 ];
 
+const displayedWarnings = new Set();
+
+export function attachWarning(value, message) {
+  if (typeof value === "object" && value?.[symbols.warningSymbol]) {
+    // Already has a warning, don't overwrite it
+    return value;
+  }
+
+  const boxed = box(value);
+  boxed[symbols.warningSymbol] = message;
+  return boxed;
+}
+
 export async function builtinReferenceError(tree, builtins, key) {
   // See if the key is in scope (but not as a builtin)
   const scope = scopeFn(tree);
@@ -40,6 +55,16 @@ export async function builtinReferenceError(tree, builtins, key) {
   return new ReferenceError(message);
 }
 
+// Display a warning message in the console, but only once for each unique
+// message and location.
+export function displayWarning(message, location) {
+  const warning = "Warning: " + message + lineInfo(location);
+  if (!displayedWarnings.has(warning)) {
+    displayedWarnings.add(warning);
+    console.warn(warning);
+  }
+}
+
 /**
  * Format an error for display in the console.
  *
@@ -80,33 +105,10 @@ export function formatError(error) {
 
   // Add location
   if (location) {
-    let { source, start } = location;
-    // Adjust line number with offset if present (for example, if the code is in
-    // an Origami template document with front matter that was stripped)
-    let line = start.line + (source.offset ?? 0);
     if (!fragmentInMessage) {
       message += `\nevaluating: ${fragment}`;
     }
-
-    if (typeof source === "object" && source.url) {
-      const { url } = source;
-      let fileRef;
-      // If URL is a file: URL, change to a relative path
-      if (url.protocol === "file:") {
-        fileRef = fileURLToPath(url);
-        const relativePath = path.relative(process.cwd(), fileRef);
-        if (!relativePath.startsWith("..")) {
-          fileRef = relativePath;
-        }
-      } else {
-        // Not a file: URL, use as is
-        fileRef = url.href;
-      }
-      message += `\n    at ${fileRef}:${line}:${start.column}`;
-    } else if (source.text.includes("\n")) {
-      // Don't know the URL, but has multiple lines so add line number
-      message += `\n    at line ${line}, column ${start.column}`;
-    }
+    message += lineInfo(location);
   }
 
   return message;
@@ -128,6 +130,36 @@ export function maybeOrigamiSourceCode(text) {
   return origamiSourceSignals.some((signal) => text.includes(signal));
 }
 
+// Return user-friendly line information for the error location
+function lineInfo(location) {
+  let { source, start } = location;
+  // Adjust line number with offset if present (for example, if the code is in
+  // an Origami template document with front matter that was stripped)
+  let line = start.line + (source.offset ?? 0);
+
+  if (typeof source === "object" && source.url) {
+    const { url } = source;
+    let fileRef;
+    // If URL is a file: URL, change to a relative path
+    if (url.protocol === "file:") {
+      fileRef = fileURLToPath(url);
+      const relativePath = path.relative(process.cwd(), fileRef);
+      if (!relativePath.startsWith("..")) {
+        fileRef = relativePath;
+      }
+    } else {
+      // Not a file: URL, use as is
+      fileRef = url.href;
+    }
+    return `\n    at ${fileRef}:${line}:${start.column}`;
+  } else if (source.text.includes("\n")) {
+    // Don't know the URL, but has multiple lines so add line number
+    return `\n    at line ${line}, column ${start.column}`;
+  } else {
+    return "";
+  }
+}
+
 export async function scopeReferenceError(scope, key) {
   const messages = [
     `"${key}" is not in scope or is undefined.`,

package/src/runtime/evaluate.js

@@ -1,4 +1,5 @@
 import { Tree, isUnpackable } from "@weborigami/async-tree";
+import { displayWarning, symbols } from "@weborigami/language";
 import codeFragment from "./codeFragment.js";
 
 /**
@@ -66,33 +67,10 @@ export default async function evaluate(code) {
     throw error;
   }
 
-  // To aid debugging, add the code to the result.
-  // if (Object.isExtensible(result)) {
-  //   try {
-  //     if (code.location && !result[sourceSymbol]) {
-  //       Object.defineProperty(result, sourceSymbol, {
-  //         value: codeFragment(code.location),
-  //         enumerable: false,
-  //       });
-  //     }
-  //     if (!result[codeSymbol]) {
-  //       Object.defineProperty(result, codeSymbol, {
-  //         value: code,
-  //         enumerable: false,
-  //       });
-  //     }
-  //     if (!result[scopeSymbol]) {
-  //       Object.defineProperty(result, scopeSymbol, {
-  //         get() {
-  //           return scope(this).trees;
-  //         },
-  //         enumerable: false,
-  //       });
-  //     }
-  //   } catch (/** @type {any} */ error) {
-  //     // Ignore errors.
-  //   }
-  // }
+  if (result?.[symbols.warningSymbol]) {
+    displayWarning(result[symbols.warningSymbol], code.location);
+    delete result[symbols.warningSymbol];
+  }
 
   return result;
 }

package/src/runtime/symbols.js

@@ -2,3 +2,4 @@ export const codeSymbol = Symbol("code");
 export const configSymbol = Symbol("config");
 export const scopeSymbol = Symbol("scope");
 export const sourceSymbol = Symbol("source");
+export const warningSymbol = Symbol("warning");

package/test/compiler/optimize.test.js

@@ -155,8 +155,8 @@ describe("optimize", () => {
     test("global reference", () => {
       // Compilation of `Math` where Math is a global variable
       const code = createCode([markers.traverse, [markers.reference, "Math"]]);
-      const globals = { Math: null }; // value doesn't matter
-      const expected = [globals, "Math"];
+      const globals = { Math: {} }; // value doesn't matter
+      const expected = globals.Math;
       assertCodeEqual(optimize(code, { globals }), expected);
     });
 
@@ -167,7 +167,7 @@ describe("optimize", () => {
         [markers.reference, "Math.PI"],
       ]);
       const globals = { Math: { PI: null } }; // value doesn't matter
-      const expected = [[globals, "Math"], "PI"];
+      const expected = [globals.Math, "PI"];
       assertCodeEqual(optimize(code, { globals }), expected);
     });
 

package/test/compiler/parse.test.js

@@ -618,6 +618,12 @@ Body`,
         [markers.traverse, [markers.reference, "keys"]],
         [markers.traverse, [markers.external, "~"]],
       ]);
+      assertParse("expression", "!x ? 0 : 1", [
+        ops.conditional,
+        [ops.logicalNot, [markers.traverse, [markers.reference, "x"]]],
+        [ops.literal, 0],
+        [ops.literal, 1],
+      ]);
     });
 
     test("complex object", () => {