@weborigami/origami 0.2.7 → 0.2.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@weborigami/origami",
-  "version": "0.2.7",
+  "version": "0.2.8",
   "description": "Web Origami language, CLI, framework, and server",
   "type": "module",
   "repository": {
@@ -17,9 +17,9 @@
     "typescript": "5.7.2"
   },
   "dependencies": {
-    "@weborigami/async-tree": "0.2.7",
-    "@weborigami/language": "0.2.7",
-    "@weborigami/types": "0.2.7",
+    "@weborigami/async-tree": "0.2.8",
+    "@weborigami/language": "0.2.8",
+    "@weborigami/types": "0.2.8",
     "exif-parser": "0.1.12",
     "graphviz-wasm": "3.0.2",
     "highlight.js": "11.11.0",

package/src/builtins.js

@@ -1,5 +1,4 @@
 import * as calc from "./calc/calc.js";
-import deprecated from "./deprecated.js";
 import * as dev from "./dev/dev.js";
 import * as handlers from "./handlers/handlers.js";
 import help from "./help/help.js";
@@ -46,9 +45,6 @@ export default {
 
   // Some builtins need to be exposed at top level
   ...handlers.default,
-
-  // Deprecated builtins
-  ...deprecated,
 };
 
 // Handle cases where a builtin name conflicts with a JS reserved word

package/src/handlers/oridocument.handler.js

@@ -40,6 +40,7 @@ export default {
     let text;
     let frontData = null;
     let frontSource = null;
+    let offset = 0;
     let extendedParent = parent;
     const parsed = parseFrontMatter(unpacked);
     if (!parsed) {
@@ -58,11 +59,21 @@ export default {
         extendedParent = new ObjectTree(frontData);
         extendedParent.parent = parent;
       }
+
+      // Determine how many lines the source code is offset by (if any) to
+      // account for front matter, plus 2 lines for `---` separators
+      offset = (frontText.match(/\r?\n/g) ?? []).length + 2;
+
       text = body;
     }
 
     // Construct an object to represent the source code
-    const bodySource = { name: key, text, url };
+    const bodySource = {
+      name: key,
+      offset,
+      text,
+      url,
+    };
 
     // Compile the source as an Origami template document
     const scopeCaching = frontSource ? false : true;

package/src/tree/map.js

@@ -7,6 +7,7 @@ import {
 } from "@weborigami/async-tree";
 import getTreeArgument from "../common/getTreeArgument.js";
 import { toFunction } from "../common/utilities.js";
+import parseExtensions from "./parseExtensions.js";
 
 /**
  * Map a hierarchical tree of keys and values to a new tree of keys and values.
@@ -142,37 +143,3 @@ function extendKeyFn(keyFn) {
     return resultKey;
   };
 }
-
-/**
- * Given a string specifying an extension or a mapping of one extension to another,
- * return the source and result extensions.
- *
- * Syntax:
- *   foo
- *   foo→bar      Unicode Rightwards Arrow
- *   foo->bar     hyphen and greater-than sign
- *
- * @param {string} specifier
- */
-function parseExtensions(specifier) {
-  const lowercase = specifier?.toLowerCase() ?? "";
-  const extensionRegex =
-    /^((?<sourceExtension>\.?\S*)\s*(→|->)\s*(?<resultExtension>\.?\S*))|(?<extension>\.?\S*)$/;
-  const match = lowercase.match(extensionRegex);
-  if (!match) {
-    // Shouldn't happen because the regex is exhaustive.
-    throw new Error(`map: Invalid extension specifier "${specifier}".`);
-  }
-  // @ts-ignore
-  const { extension, resultExtension, sourceExtension } = match.groups;
-  if (extension) {
-    // foo
-    return {
-      resultExtension: extension,
-      sourceExtension: extension,
-    };
-  } else {
-    // foo→bar
-    return { resultExtension, sourceExtension };
-  }
-}

package/src/tree/mapFn.js

@@ -6,6 +6,7 @@ import {
 } from "@weborigami/async-tree";
 import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
 import { toFunction } from "../common/utilities.js";
+import parseExtensions from "./parseExtensions.js";
 
 /**
  * Return a function that transforms a tree of keys and values to a new tree of
@@ -123,37 +124,3 @@ export default function mapFnBuiltin(operation) {
     return mapped;
   };
 }
-
-/**
- * Given a string specifying an extension or a mapping of one extension to another,
- * return the source and result extensions.
- *
- * Syntax:
- *   foo
- *   foo→bar      Unicode Rightwards Arrow
- *   foo->bar     hyphen and greater-than sign
- *
- * @param {string} specifier
- */
-function parseExtensions(specifier) {
-  const lowercase = specifier?.toLowerCase() ?? "";
-  const extensionRegex =
-    /^(\.?(?<sourceExtension>\S*)\s*(→|->)\s*\.?(?<resultExtension>\S*))|(\.?(?<extension>\S*))$/;
-  const match = lowercase.match(extensionRegex);
-  if (!match) {
-    // Shouldn't happen because the regex is exhaustive.
-    throw new Error(`@mapFn: Invalid extension specifier "${specifier}".`);
-  }
-  // @ts-ignore
-  const { extension, resultExtension, sourceExtension } = match.groups;
-  if (sourceExtension || resultExtension) {
-    // foo→bar
-    return { resultExtension, sourceExtension };
-  } else {
-    // foo
-    return {
-      resultExtension: specifier,
-      sourceExtension: specifier,
-    };
-  }
-}

package/src/tree/parseExtensions.js

@@ -0,0 +1,43 @@
+/**
+ * Given a string specifying an extension or a mapping of one extension to another,
+ * return the source and result extensions.
+ *
+ * Syntax:
+ *   .foo           source and result extension are the same
+ *   .foo→.bar      Unicode Rightwards Arrow
+ *   .foo→          Unicode Rightwards Arrow, no result extension
+ *   .foo->.bar     hyphen and greater-than sign
+ *
+ * @param {string} specifier
+ */
+export default function parseExtensions(specifier) {
+  const lowercase = specifier?.toLowerCase() ?? "";
+  const extensionRegex =
+    /^((?<sourceExtension>\/|\.\S*)?\s*(→|->)\s*(?<resultExtension>\/|\.\S*)?)|(?<extension>\/|\.\S*)$/;
+  const match = lowercase.match(extensionRegex);
+  if (!match) {
+    throw new Error(`Invalid file extension specifier "${specifier}".`);
+  }
+
+  // @ts-ignore
+  let { extension, resultExtension, sourceExtension } = match.groups;
+  if (extension) {
+    // foo
+    return {
+      resultExtension: extension,
+      sourceExtension: extension,
+    };
+  } else {
+    // foo→bar
+
+    if (resultExtension === undefined && sourceExtension === undefined) {
+      throw new Error(
+        `A file extension mapping must indicate a source or result extension: "${specifier}".`
+      );
+    }
+
+    resultExtension ??= "";
+    sourceExtension ??= "";
+    return { resultExtension, sourceExtension };
+  }
+}

package/src/deprecated.js

@@ -1,140 +0,0 @@
-import { Tree } from "@weborigami/async-tree";
-import * as calc from "./calc/calc.js";
-import * as dev from "./dev/dev.js";
-import * as image from "./image/image.js";
-import js from "./js.js";
-import node from "./node.js";
-import * as origami from "./origami/origami.js";
-import files from "./protocols/files.js";
-import * as site from "./site/site.js";
-import * as text from "./text/text.js";
-import * as tree from "./tree/tree.js";
-
-const warningsDisplayedForKeys = new Set();
-
-export function command(namespace, newKey, oldKey, fn) {
-  const wrappedFn = function (...args) {
-    const keys = newKey
-      ? `"${namespace}${newKey}" or just "${newKey}"`
-      : `"${namespace}"`;
-    if (!warningsDisplayedForKeys.has(oldKey)) {
-      console.warn(
-        `ori: Warning: "${oldKey}" is deprecated. Use ${keys} instead.`
-      );
-      warningsDisplayedForKeys.add(oldKey);
-    }
-    return fn instanceof Function
-      ? // @ts-ignore
-        fn.call(this, ...args)
-      : Tree.traverseOrThrow(fn, ...args);
-  };
-  if (fn.key) {
-    wrappedFn.key = fn.key;
-  }
-  if (fn.inverseKey) {
-    wrappedFn.inverseKey = fn.inverseKey;
-  }
-  return wrappedFn;
-}
-
-export function commands(namespace, object) {
-  const deprecatedEntries = Object.entries(object).map(([key, fn]) => [
-    `@${fn.key ?? key}`,
-    command(namespace, fn.key ?? key, `@${fn.key ?? key}`, fn),
-  ]);
-  return Object.fromEntries(deprecatedEntries);
-}
-
-export default {
-  ...commands("calc:", calc),
-  ...commands("dev:", dev),
-  "@false": command("js:", "false", "@false", js.false),
-  "@fetch": command("js:", "fetch", "@fetch", js.fetch),
-  "@files": command("files:", null, "@files/", files),
-  "@image": command("image:", null, "@image/", image),
-  "@js": command("js:", null, "@js/", js),
-  "@math": command("calc:", null, "@math/", calc),
-  "@mdHtml": command("text:", "mdHtml", "@mdHtml", text.mdHtml),
-  "@node": command("node:", null, "@node/", node),
-  ...commands("origami:", origami),
-  ...commands("site:", site),
-  ...commands("text:", text),
-  ...commands("tree:", tree),
-  "@tree": command("tree:", null, "@tree/", Tree),
-  "@true": command("js:", "true", "@true", js.true),
-
-  // Renamed commands
-  "@clean": command("tree:", "clear", "@clean", tree.clear),
-
-  // Deprecated commands
-  "@deepTakeFn": command(
-    "tree:",
-    "deepTake",
-    "@deepTakeFn",
-    (options) =>
-      /** @this {any} */
-      function (treelike) {
-        return tree.deepTake.call(this, treelike, options);
-      }
-  ),
-  "@deepMapFn": command(
-    "tree:",
-    "deepMap",
-    "@deepMapFn",
-    (options) =>
-      /** @this {any} */
-      function (treelike) {
-        return tree.deepMap.call(this, treelike, options);
-      }
-  ),
-  "@groupFn": command(
-    "tree:",
-    "group",
-    "@groupFn",
-    (options) =>
-      /** @this {any} */
-      function (treelike) {
-        return tree.group.call(this, treelike, options);
-      }
-  ),
-  "@mapFn": command(
-    "tree:",
-    "map",
-    "@mapFn",
-    (options) =>
-      /** @this {any} */
-      function (treelike) {
-        return tree.map.call(this, treelike, options);
-      }
-  ),
-  "@paginateFn": command(
-    "tree:",
-    "paginate",
-    "@paginateFn",
-    (options) =>
-      /** @this {any} */
-      function (treelike) {
-        return tree.paginate.call(this, treelike, options);
-      }
-  ),
-  "@sortFn": command(
-    "tree:",
-    "sort",
-    "@sortFn",
-    (options) =>
-      /** @this {any} */
-      function (treelike) {
-        return tree.sort.call(this, treelike, options);
-      }
-  ),
-  "@takeFn": command(
-    "tree:",
-    "take",
-    "@takeFn",
-    (options) =>
-      /** @this {any} */
-      function (treelike) {
-        return tree.take.call(this, treelike, options);
-      }
-  ),
-};