@weborigami/origami 0.1.0 → 0.2.0

package/package.json

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

package/src/calc/calc.js

@@ -7,6 +7,7 @@ export function add(...args) {
 }
 
 export function and(...args) {
+  console.warn(`Warning: "and" is deprecated. Use the "&&" operator instead.`);
   return args.every((arg) => arg);
 }
 
@@ -15,6 +16,9 @@ export function divide(a, b) {
 }
 
 export function equals(a, b) {
+  console.warn(
+    `Warning: "equals" is deprecated. Use the "===" operator instead.`
+  );
   return a === b;
 }
 
@@ -27,6 +31,10 @@ export function equals(a, b) {
  * @param {any} [falseResult]
  */
 export async function ifBuiltin(value, trueResult, falseResult) {
+  console.warn(
+    `Warning: "if" is deprecated. Use the conditional "a ? b : c" operator instead.`
+  );
+
   assertTreeIsDefined(this, "calc:if");
   let condition = await value;
   if (Tree.isAsyncTree(condition)) {
@@ -49,10 +57,12 @@ export function multiply(...args) {
 }
 
 export function not(value) {
+  console.warn(`Warning: "not" is deprecated. Use the "!" operator instead.`);
   return !value;
 }
 
 export function or(...args) {
+  console.warn(`Warning: "or" is deprecated. Use the "||" operator instead.`);
   return args.find((arg) => arg);
 }
 

package/src/common/utilities.d.ts

@@ -1,5 +1,5 @@
 
-export const keySymbol: unique symbol;
+export function getDescriptor(object: any): string;
 export function hasNonPrintableCharacters(text: string): boolean;
 export function isTransformApplied(Transform: Function, object: any): boolean;
 export function toFunction(object: any): Function;

package/src/common/utilities.js

@@ -3,7 +3,29 @@ import {
   toString as asyncTreeToString,
   isPlainObject,
   isUnpackable,
+  trailingSlash,
 } from "@weborigami/async-tree";
+import { symbols } from "@weborigami/language";
+import { basename } from "node:path";
+
+// For a given tree, return some user-friendly descriptor
+export function getDescriptor(tree) {
+  if ("path" in tree) {
+    return trailingSlash.add(basename(tree.path));
+  }
+
+  const source = tree[symbols.sourceSymbol];
+  if (source) {
+    // If the source looks like an identifier, use that.
+    // TODO: Use real identifier parsing.
+    const identifierRegex = /^[A-Za-z0-9_\-\.]+\/?$/;
+    if (identifierRegex.test(source)) {
+      return trailingSlash.add(source);
+    }
+  }
+
+  return null;
+}
 
 // Return true if the text appears to contain non-printable binary characters;
 // used to infer whether a file is binary or text.
@@ -30,8 +52,6 @@ export function isTransformApplied(Transform, obj) {
   return false;
 }
 
-export const keySymbol = Symbol("key");
-
 /**
  * Convert the given object to a function.
  *

package/src/dev/explore.js

@@ -4,7 +4,7 @@ import { OrigamiFiles } from "@weborigami/language";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
-import { keySymbol } from "../common/utilities.js";
+import { getDescriptor } from "../common/utilities.js";
 import { builtinsTree } from "../internal.js";
 import debug from "./debug.js";
 
@@ -61,7 +61,7 @@ async function getScopeData(scope) {
       // Skip builtins.
       continue;
     }
-    const name = tree[keySymbol];
+    const name = getDescriptor(tree);
     const treeKeys = Array.from(await tree.keys());
     // Skip system-ish files that start with a period.
     const keys = treeKeys.filter((key) => !key.startsWith?.("."));

package/src/dev/explore.ori

@@ -18,7 +18,7 @@
     </div>
     ${ map(scope, (scopeTree) => `
       <ul>
-        <h2>${ scopeTree/name }</h2>
+        <h2>${ scopeTree/name ?? "" }</h2>
         ${ map(scopeTree/keys, (key) => `
         <li>
           <a href="./!explore/${ key }" target="frame">${ key }</a>

package/src/dev/treeDot.js

@@ -6,7 +6,7 @@ import {
   trailingSlash,
 } from "@weborigami/async-tree";
 import * as serialize from "../common/serialize.js";
-import { keySymbol } from "../common/utilities.js";
+import { getDescriptor } from "../common/utilities.js";
 
 /**
  * Render a tree in DOT format.
@@ -21,7 +21,7 @@ import { keySymbol } from "../common/utilities.js";
  */
 export default async function dot(treelike, options = {}) {
   const tree = Tree.from(treelike, { deep: true });
-  const rootLabel = tree[keySymbol] ?? "";
+  const rootLabel = getDescriptor(tree) ?? "";
   const treeArcs = await statements(tree, "", rootLabel, options);
   return `digraph g {
   bgcolor="transparent";

package/src/help/help.yaml

@@ -1,30 +1,30 @@
 calc:
-  description: Perform math and logical operations
+  description: Perform math operations
   commands:
     add:
       args: (a, b, ...)
       description: Add the numbers
-    and:
-      args: (a, b, ...)
-      description: Return true if all the arguments are true
+    # and:
+    #   args: (a, b, ...)
+    #   description: Return true if all the arguments are true
     divide:
       args: (a, b)
       description: Divide a by b
-    equals:
-      args: (a, b)
-      description: Return true if a equals b
-    if:
-      args: (a, b, c)
-      description: If a is true return b, otherwise c
+    # equals:
+    #   args: (a, b)
+    #   description: Return true if a equals b
+    # if:
+    #   args: (a, b, c)
+    #   description: If a is true return b, otherwise c
     multiply:
       args: (a, b, ...)
       description: Multiply the numbers
-    not:
-      args: (value)
-      description: Return true if a is false and vice versa
-    or:
-      args: (a, b, ...)
-      description: Return true if any of the arguments are true
+    # not:
+    #   args: (value)
+    #   description: Return true if a is false and vice versa
+    # or:
+    #   args: (a, b, ...)
+    #   description: Return true if any of the arguments are true
     subtract:
       args: (a, b)
       description: Subtract b from a
@@ -399,6 +399,9 @@ tree:
     reverse:
       args: (tree)
       description: Reverse the order of the tree's keys
+    root:
+      args: (tree)
+      description: The root node of the given tree
     setDeep:
       args: (target, source)
       description: Applies the source tree to the target

package/src/protocols/package.js

@@ -7,22 +7,39 @@ import project from "../origami/project.js";
  */
 export default async function packageNamespace(...keys) {
   const parent = this ?? (await project.call(null));
-  const parentScope = scope(parent);
 
-  const packageKeys = [keys.shift()];
-  if (packageKeys[0]?.startsWith("@")) {
-    // First key is an npm organization, get the next key too.
-    packageKeys.push(keys.shift());
+  let name = keys.shift();
+  let organization;
+  if (name?.startsWith("@")) {
+    // First key is an npm organization
+    organization = name;
+    if (keys.length === 0) {
+      // Return a function that will process the next key
+      return async (name, ...keys) =>
+        getPackage(parent, organization, name, keys);
+    }
+    name = keys.shift();
+  }
+
+  return getPackage(parent, organization, name, keys);
+}
+
+async function getPackage(parent, organization, name, keys) {
+  const packagePath = ["node_modules"];
+  if (organization) {
+    packagePath.push(organization);
   }
+  packagePath.push(name);
 
+  const parentScope = scope(parent);
   const packageRoot = await Tree.traverse(
     // @ts-ignore
     parentScope,
-    "node_modules",
-    ...packageKeys
+    ...packagePath
   );
+
   if (!packageRoot) {
-    throw new Error(`Can't find node_modules/${packageKeys.join("/")}`);
+    throw new Error(`Can't find ${packagePath.join("/")}`);
   }
 
   const mainPath = await Tree.traverse(packageRoot, "package.json", "main");
@@ -44,5 +61,10 @@ export default async function packageNamespace(...keys) {
     keys.length > 0
       ? await Tree.traverse(packageExports, ...keys)
       : packageExports;
+
+  if (Tree.isAsyncTree(result)) {
+    result.parent = parent;
+  }
+
   return result;
 }

package/src/protocols/scope.js

@@ -9,6 +9,16 @@ import { ops } from "@weborigami/language";
  */
 export default async function scope(...keys) {
   const key = keys.shift();
-  const value = await ops.scope.call(this, key);
+  let value;
+  try {
+    // Look up key in scope but don't throw if it's undefined
+    value = await ops.scope.call(this, key);
+  } catch (error) {
+    if (error instanceof ReferenceError) {
+      value = undefined;
+    } else {
+      throw error;
+    }
+  }
   return keys.length > 0 ? await Tree.traverse(value, ...keys) : value;
 }

package/src/site/index.js

@@ -1,5 +1,5 @@
 import getTreeArgument from "../common/getTreeArgument.js";
-import { keySymbol } from "../common/utilities.js";
+import { getDescriptor } from "../common/utilities.js";
 
 /**
  * Return a default index.html page for the current tree.
@@ -26,7 +26,7 @@ export default async function index(treelike) {
     links.push(link);
   }
 
-  const heading = tree[keySymbol] ?? "Index";
+  const heading = getDescriptor(tree) ?? "Index";
   const list = `    <ul>\n${links.join("\n")}\n    </ul>`;
 
   const html = `<!DOCTYPE html>

package/src/text/origamiHighlightDefinition.js

@@ -36,7 +36,7 @@ export default function origamiHighlightDefinition(hljs) {
         // Treat identifier containing a period before an open paren or backtick as a variable
         className: "variable",
         begin:
-          /\b[^(){}\[\]<>\-=,/:\`"'«»\\ →⇒\t\n\r]+\.[^(){}\[\]<>\-=,/:\`"'«»\\ →⇒\t\n\r]+(?=(\(|\`))\b/,
+          /\b[^(){}\[\]<>\-=,/:\`"'«»\\ →⇒\t\n\r]+\.[^(){}\[\]<>\?!&\|\-=,/:\`"'«»\\ →⇒\t\n\r]+(?=(\(|\`))\b/,
       },
       {
         className: "built_in",
@@ -46,7 +46,11 @@ export default function origamiHighlightDefinition(hljs) {
       {
         // Treat remaining identifiers as variables
         className: "variable",
-        begin: /\b[^(){}\[\]<>\-=,/:\`"'«»\\ →⇒\t\n\r]+\b/,
+        begin: /\b[^(){}\[\]<>\?!&\|\-=,/:\`"'«»\\ →⇒\t\n\r]+\b/,
+      },
+      {
+        className: "operator",
+        begin: /===|!==|==|!=|=>|⇒|->|→|=|\.\.\.|…|&&|\|\||!|\?\?/,
       },
     ],
   };

package/src/tree/tree.js

@@ -44,6 +44,7 @@ export const isTreelike = Tree.isTreelike;
 export const mapReduce = Tree.mapReduce;
 export const paths = Tree.paths;
 export const remove = Tree.remove;
+export const root = Tree.root;
 export const traverse = Tree.traverse;
 export const traverseOrThrow = Tree.traverseOrThrow;
 export const traversePath = Tree.traversePath;