@weborigami/origami 0.3.4-jse.7 → 0.3.4-jse.9

package/src/{help → dev}/help.yaml

@@ -1,4 +1,4 @@
-dev:
+Dev:
   description: Develop and debug Origami projects
   commands:
     audit:
@@ -10,151 +10,78 @@ dev:
     changes:
       args: (old, new)
       description: Return a tree of changes
+    clear:
+      args: (tree)
+      description: Remove all values from the tree (alias of Tree.clear)
     crawl:
       args: (tree, base)
       description: A tree of a site's discoverable resources
+    copy:
+      args: (source, target)
+      description: Copy the source tree to the target
     debug:
       args: (tree)
       description: Add debug features to the tree
     explore:
       args: ()
       description: Explore the current scope [when run in browser]
+    help:
+      args: (namespace|command)
+      description: Get help on builtin namespaces and commands
+    keys:
+      args: (tree)
+      description: The keys of the tree (alias of Tree.keys)
     log:
       args: (a, message)
       description: Log message to the console and return a
     serve:
       args: (tree, port)
       description: Start a web server for the tree
+    stdin:
+      description: Returns the content of the standard input stream
     svg:
       args: (tree, options)
       description: Render a tree visually in SVG format
+    version:
+      args: ()
+      description: Return the version number of the Origami language
     watch:
       args: (tree, fn)
       description: Reevaluate fn when tree changes
 
-explore:
-  description: URL protocol to treat a website with JSON keys as a tree
-
-files:
-  description: URL protocol for file system folders and files
-
-help:
-  description: Get help on builtin namespaces and commands
-
-http:
-  description: URL protocol for web resources via HTTP
-
-https:
-  description: URL protocol for web resources via HTTPS
-
-httpstree:
-  description: URL protocol for a website tree via HTTPS
-
-httptree:
-  description: URL protocol for a website tree via HTTP
-
-image:
-  description: Format and resize images
-  commands:
-    format:
-      args: (image, format, options)
-      description: Return the image in a different format
-    resize:
-      args: (image, options)
-      description: Resize the image
-
-inherited:
-  description: URL protocol to get an inherited value instead of a local one
-
-js:
-  description: JavaScript classes and functions
-  collection: true
-  commands:
-    Array:
-      description: JavaScript Array class
-    BigInt:
-      description: JavaScript BigInt class
-    Boolean:
-      description: JavaScript Boolean class
-    Date:
-      description: JavaScript Date class
-    Error:
-      description: JavaScript Error class
-    Infinity:
-      description: JavaScript Infinity constant
-    Intl:
-      description: JavaScript Intl object
-    JSON:
-      description: JavaScript JSON object
-    Map:
-      description: JavaScript Map class
-    Math:
-      description: JavaScript Math object
-    NaN:
-      description: JavaScript NaN constant
-    Number:
-      description: JavaScript Number class
-    Object:
-      description: JavaScript Object class
-    RegExp:
-      description: JavaScript RegExp class
-    Set:
-      description: JavaScript Set class
-    String:
-      description: JavaScript String class
-    Symbol:
-      description: JavaScript Symbol class
-    decodeURI:
-      description: JavaScript decodeURI function
-    decodeURIComponent:
-      description: JavaScript decodeURIComponent function
-    encodeURI:
-      description: JavaScript encodeURI function
-    encodeURIComponent:
-      description: JavaScript encodeURIComponent function
-    "false":
-      description: JavaScript false constant
-    fetch:
-      description: JavaScript fetch function
-    isFinite:
-      description: JavaScript isFinite function
-    isNaN:
-      description: JavaScript isNaN function
-    "null":
-      description: JavaScript null constant
-    parseFloat:
-      description: JavaScript parseFloat function
-    parseInt:
-      description: JavaScript parseInt function
-    "true":
-      description: JavaScript true constant
-    undefined:
-      description: JavaScript undefined constant
-
-new:
-  description: Create instances of JavaScript classes
-
-node:
-  description: Node.js modules
-
-origami:
-  description: Perform general Origami language functions
+Origami:
+  description: Create sites and other digital artifacts
   commands:
     basename:
       args: (key)
       description: Removes an extension from the key if present
-    builtins:
-      description: The set of installed builtin functions
     config:
       description: The current project's configuration
+    csv:
+      args: (tree)
+      description: Render the tree as a CSV file
+    document:
+      args: (text, [data])
+      description: Create a document object with the text and data
     extension:
       description: Helpers for working with file extensions
-    json:
-      args: (obj)
-      description: Render the object in JSON format
+    image:
+      description: Collection of functions for working with images
+    indexPage:
+      args: (tree)
+      description: A default index.html page for the tree
+    inline:
+      args: (text)
+      description: Inline Origami expressions found in the text
+    jsonKeys:
+      args: (tree)
+      description: Add .keys.json files to a tree
     jsonParse:
       args: (text)
       description: Parse text as JSON
+    mdHtml:
+      args: (markdown)
+      description: Render the markdown as HTML
     naturalOrder:
       description: A comparison function for natural sort order
     once:
@@ -168,19 +95,29 @@ origami:
       description: POST the given data to the URL
     project:
       description: The root folder for the current Origami project
-    regexMatch:
-      args: (text, regex)
-      description: Return matches of the regex in the text
+    redirect:
+      args: (url, options)
+      description: Redirect to the given URL
     repeat:
       args: (n, obj)
       description: An array of n copies of the object
+    rss:
+      args: (feed)
+      description: Transforms a JSON Feed tree to RSS XML
     shell:
       args: (text)
       description: Run the text as a shell command, return the output
+    sitemap:
+      args: (tree)
+      description: Generate a sitemap for the tree
     slash:
       description: Helpers for working with trailing slashes
-    stdin:
-      description: Returns the content of the standard input stream
+    slug:
+      args: (text)
+      description: A version of the text suitable for use in URLs
+    static:
+      args: (tree)
+      description: Define common static files for the tree
     string:
       args: (obj)
       description: Coerce a buffer or document to a string
@@ -190,9 +127,6 @@ origami:
     unpack:
       args: (buffer)
       description: Unpack the buffer into a usable form
-    version:
-      args: ()
-      description: Return the version number of the Origami language
     yaml:
       args: (obj)
       description: Render the object in YAML format
@@ -200,54 +134,28 @@ origami:
       args: (text)
       description: Parse text as YAML
 
-package:
-  description: URL protocol for packages installed in node_modules
-
-scope:
-  description: URL protocol to explicitly reference a key in scope
-
-site:
-  description: Add common website features
-  commands:
-    index:
-      args: (tree)
-      description: A default index.html page for the tree
-    jsonKeys:
-      args: (tree)
-      description: Add .keys.json files to a tree
-    redirect:
-      args: (url, options)
-      description: Redirect to the given URL
-    rss:
-      args: (feed)
-      description: Transforms a JSON Feed tree to RSS XML
-    sitemap:
-      args: (tree)
-      description: Generate a sitemap for the tree
-    slug:
-      args: (text)
-      description: A version of the text suitable for use in URLs
-    static:
-      args: (tree)
-      description: Define common static files for the tree
-
-text:
-  description: Manipulate text
+Protocol:
+  description: Retrieve resources via URL protocols
   commands:
-    document:
-      args: (text, [data])
-      description: Create a document object with the text and data
-    indent:
-      description: Tagged template literal for normalizing indentation
-    inline:
-      args: (text)
-      description: Inline Origami expressions found in the text
-    mdHtml:
-      args: (markdown)
-      description: Render the markdown as HTML
+    explore:
+      description: Treat a website with JSON keys as a tree
+    files:
+      description: File system folders and files
+    http:
+      description: Web resources via HTTP
+    https:
+      description: Web resources via HTTPS
+    httptree:
+      description: Website tree via HTTP
+    httpstree:
+      description: Website tree via HTTPS
+    node:
+      description: Installed Node.js modules
+    package:
+      description: Packages installed in node_modules
 
-tree:
-  description: Work with trees
+Tree:
+  description: Work with trees of files and data
   commands:
     addNextPrevious:
       args: (tree)
@@ -267,9 +175,6 @@ tree:
     constant:
       args: (value)
       description: Return a deep tree with a single constant value
-    copy:
-      args: (source, target)
-      description: Copy the source tree to the target
     deepMap:
       args: (tree, options)
       description: Map the keys and values of a deep tree
@@ -315,6 +220,8 @@ tree:
     has:
       args: (tree, key)
       description: True if key exists in tree
+    indent:
+      description: Tagged template literal for normalizing indentation
     inners:
       args: (tree)
       description: The tree's interior nodes
@@ -330,6 +237,9 @@ tree:
     isTreelike:
       args: (object)
       description: True if object can be coerced to a tree
+    json:
+      args: (obj)
+      description: Render the object in JSON format
     keys:
       args: (tree)
       description: The keys of the tree

package/src/dev/serve.js

@@ -22,7 +22,7 @@ const defaultPort = 5000;
  * @this {AsyncTree|null}
  */
 export default async function serve(treelike, port) {
-  assertTreeIsDefined(this, "dev:serve");
+  assertTreeIsDefined(this, "serve");
   let tree;
   if (treelike) {
     tree = Tree.from(treelike, { parent: this });

package/src/{origami → dev}/version.js

@@ -1,13 +1,13 @@
 // When this is no longer experimental in Node:
 // import packageJson from "../../package.json" with { type: "json" };
 
-import fs from "node:fs/promises";
+import fs from "node:fs";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 
 const dirname = path.dirname(fileURLToPath(import.meta.url));
 const packageJsonPath = path.resolve(dirname, "../../package.json");
-const buffer = await fs.readFile(packageJsonPath);
+const buffer = fs.readFileSync(packageJsonPath);
 const data = JSON.parse(String(buffer));
 
 export default data.version;

package/src/dev/watch.js

@@ -63,7 +63,7 @@ async function evaluateTree(parent, fn) {
     return tree;
   }
   if (!message) {
-    message = `warning: watch expression did not return a tree`;
+    message = `Warning: watch expression did not return a tree`;
   }
   console.warn(message);
   tree = new ConstantTree(message);

package/src/handlers/ori.handler.js

@@ -1,5 +1,5 @@
 import { compile } from "@weborigami/language";
-import builtinsShell from "../builtinsShell.js";
+import builtinsProgram from "../builtinsProgram.js";
 import getConfig from "../cli/getConfig.js";
 import * as utilities from "../common/utilities.js";
 import getParent from "./getParent.js";
@@ -39,7 +39,7 @@ export default {
 
     const config = getConfig(parent) ?? {};
     const globals = {
-      ...(options.globals ?? builtinsShell()),
+      ...(options.globals ?? builtinsProgram()),
       ...config,
     };
 

package/src/handlers/oridocument.handler.js

@@ -1,6 +1,6 @@
 import { extension, trailingSlash } from "@weborigami/async-tree";
 import { compile } from "@weborigami/language";
-import builtinsShell from "../builtinsShell.js";
+import builtinsProgram from "../builtinsProgram.js";
 import { toString } from "../common/utilities.js";
 import getParent from "./getParent.js";
 import processUnpackedContent from "./processUnpackedContent.js";
@@ -41,7 +41,7 @@ export default {
     if (options.globals) {
       globals = options.globals;
     } else {
-      globals = builtinsShell();
+      globals = builtinsProgram();
     }
 
     const defineFn = compile.templateDocument(source, {

package/src/handlers/txt.handler.js

@@ -1,5 +1,5 @@
 import { isPacked, symbols } from "@weborigami/async-tree";
-import { compile } from "@weborigami/language";
+import { attachWarning, compile } from "@weborigami/language";
 import { parseYaml, toYaml } from "../common/serialize.js";
 import { toString } from "../common/utilities.js";
 import parseFrontMatter from "./parseFrontMatter.js";
@@ -44,6 +44,7 @@ export default {
 
     /** @type {any} */
     const dataWithoutText = Object.assign({}, object);
+    delete dataWithoutText._body;
     delete dataWithoutText["@text"];
     if (Object.keys(dataWithoutText).length > 0) {
       const frontMatter = (await toYaml(dataWithoutText)).trimEnd();
@@ -74,11 +75,21 @@ export default {
         frontData = parseYaml(frontText);
       }
       // TODO: Deprecate @text
-      unpacked = Object.assign({}, frontData, { "@text": body });
+      unpacked = { ...frontData };
+      Object.defineProperty(unpacked, "@text", {
+        configurable: true,
+        enumerable: true,
+        get() {
+          return attachWarning(
+            body,
+            "The @text property is deprecated. Use _body instead."
+          );
+        },
+      });
       Object.defineProperty(unpacked, "_body", {
         configurable: true,
+        enumerable: true,
         value: body,
-        enumerable: false, // TODO: Make enumerable
         writable: true,
       });
     } else {
@@ -87,6 +98,7 @@ export default {
     }
 
     unpacked[symbols.parent] = parent;
+
     return unpacked;
   },
 };

package/src/handlers/xhtml.handler.js

@@ -1,2 +1,2 @@
 // .xhtml is a synonynm for .html
-export { default } from "./html.handler.js";
+export { htmlHandler as default } from "./handlers.js";

package/src/handlers/yml.handler.js

@@ -1,2 +1,2 @@
 // .yml is a synonym for .yaml
-export { default } from "./yaml.handler.js";
+export { yamlHandler as default } from "./handlers.js";

package/src/image/format.js

@@ -13,6 +13,6 @@ import imageFormatFn from "./formatFn.js";
  * @param {any} options
  */
 export default async function imageFormat(input, format, options) {
-  assertTreeIsDefined(this, "image:format");
+  assertTreeIsDefined(this, "format");
   return imageFormatFn.call(this, format, options)(input);
 }

package/src/image/resize.js

@@ -9,7 +9,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {import("sharp").ResizeOptions} options
  */
 export default async function resize(input, options) {
-  assertTreeIsDefined(this, "image:resize");
+  assertTreeIsDefined(this, "resize");
   return input instanceof Uint8Array || input instanceof ArrayBuffer
     ? sharp(input).rotate().resize(options).toBuffer()
     : undefined;

package/src/origami/csv.js

@@ -11,7 +11,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {any} [object]
  */
 export default async function csv(object) {
-  assertTreeIsDefined(this, "origami:csv");
+  assertTreeIsDefined(this, "csv");
   object = object ?? this;
   if (object === undefined) {
     return undefined;

package/src/origami/json.js

@@ -9,7 +9,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {any} [obj]
  */
 export default async function json(obj) {
-  assertTreeIsDefined(this, "origami:json");
+  assertTreeIsDefined(this, "json");
   // A fragment of the logic from getTreeArgument.js
   if (arguments.length > 0 && obj === undefined) {
     throw new Error(

package/src/origami/once.js

@@ -11,7 +11,7 @@ const codePromiseMap = new Map();
  * @param {Function} fn
  */
 export default async function once(fn) {
-  assertTreeIsDefined(this, "origami:once");
+  assertTreeIsDefined(this, "once");
 
   const code = /** @type {any} */ (fn).code;
   if (code) {

package/src/origami/ori.js

@@ -24,7 +24,7 @@ export default async function ori(
   expression,
   options = { formatResult: true }
 ) {
-  assertTreeIsDefined(this, "origami:ori");
+  assertTreeIsDefined(this, "ori");
 
   // In case expression has come from a file, cast it to a string.
   expression = toString(expression);

package/src/origami/origami.js

@@ -1,7 +1,7 @@
 export { extension } from "@weborigami/async-tree";
 export { toFunction } from "../common/utilities.js";
 
-export { default as help } from "../help/help.js"; // Alias
+export { default as help } from "../dev/help.js"; // Alias
 export { default as basename } from "./basename.js";
 export { default as config } from "./config.js";
 export { default as csv } from "./csv.js";
@@ -17,9 +17,7 @@ export { default as regexMatch } from "./regexMatch.js";
 export { default as repeat } from "./repeat.js";
 export { default as shell } from "./shell.js";
 export { default as slash } from "./slash.js";
-export { default as stdin } from "./stdin.js";
 export { default as string } from "./string.js";
 export { default as unpack } from "./unpack.js";
-export { default as version } from "./version.js";
 export { default as yaml } from "./yaml.js";
 export { default as yamlParse } from "./yamlParse.js";

package/src/origami/pack.js

@@ -8,6 +8,6 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @returns
  */
 export default function pack(obj) {
-  assertTreeIsDefined(this, "origami:pack");
+  assertTreeIsDefined(this, "pack");
   return obj?.pack?.();
 }

package/src/origami/project.js

@@ -24,7 +24,7 @@ const configFileName = "config.ori";
  * @this {AsyncTree|null}
  */
 export default async function project() {
-  assertTreeIsDefined(this, "origami:project");
+  assertTreeIsDefined(this, "project");
 
   const dirname = process.cwd();
   const currentTree = new OrigamiFiles(dirname);

package/src/origami/regexMatch.js

@@ -1,13 +1,16 @@
+import { attachWarning } from "@weborigami/language";
+
 const parsers = {};
 
 // TODO: Remove this deprecated function
 export default function regexMatch(text, regex) {
-  console.warn(
-    "warning: regexMatch is deprecated, use a JavaScript regular expression instead."
-  );
   if (!parsers[regex]) {
     const regexp = new RegExp(regex);
     parsers[regex] = (input) => input.match(regexp)?.groups;
   }
-  return parsers[regex](text);
+  const match = parsers[regex](text);
+  return attachWarning(
+    match,
+    "The regexMatch function is deprecated. Use a JavaScript regular expression instead."
+  );
 }

package/src/origami/string.js

@@ -9,6 +9,6 @@ import { toString } from "../common/utilities.js";
  * @param {any} object
  */
 export default function stringBuiltin(object) {
-  assertTreeIsDefined(this, "origami:string");
+  assertTreeIsDefined(this, "string");
   return toString(object);
 }

package/src/origami/unpack.js

@@ -9,6 +9,6 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {any} obj
  */
 export default function unpack(obj) {
-  assertTreeIsDefined(this, "origami:unpack");
+  assertTreeIsDefined(this, "unpack");
   return obj?.unpack?.() ?? obj;
 }

package/src/origami/yaml.js

@@ -10,7 +10,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {any} [obj]
  */
 export default async function toYaml(obj) {
-  assertTreeIsDefined(this, "origami:yaml");
+  assertTreeIsDefined(this, "yaml");
   // A fragment of the logic from getTreeArgument.js
   if (arguments.length > 0 && obj === undefined) {
     throw new Error(

package/src/protocols/explore.js

@@ -14,6 +14,6 @@ import constructSiteTree from "../common/constructSiteTree.js";
  * @param  {...string} keys
  */
 export default function explore(host, ...keys) {
-  assertTreeIsDefined(this, "explore:");
+  assertTreeIsDefined(this, "explore");
   return constructSiteTree("https:", ExplorableSiteTree, this, host, ...keys);
 }

package/src/protocols/files.js

@@ -11,7 +11,7 @@ import assertTreeIsDefined from "../common/assertTreeIsDefined.js";
  * @param {string[]} keys
  */
 export default async function files(...keys) {
-  assertTreeIsDefined(this, "files:");
+  assertTreeIsDefined(this, "files");
 
   // If path begins with `~`, treat it relative to the home directory.
   // Otherwise, treat it relative to the current working directory.
@@ -26,6 +26,6 @@ export default async function files(...keys) {
   const resolved = path.resolve(basePath, relativePath);
 
   const result = new OrigamiFiles(resolved);
-  result.handlers = getHandlers(this);
+  /** @type {any} */ (result).handlers = getHandlers(this);
   return result;
 }

package/src/protocols/http.js

@@ -12,7 +12,7 @@ import fetchAndHandleExtension from "../common/fetchAndHandleExtension.js";
  * @param  {...string} keys
  */
 export default async function http(host, ...keys) {
-  assertTreeIsDefined(this, "http:");
+  assertTreeIsDefined(this, "http");
   const href = constructHref("http:", host, ...keys);
   return fetchAndHandleExtension.call(this, href);
 }

package/src/protocols/https.js

@@ -12,7 +12,7 @@ import fetchAndHandleExtension from "../common/fetchAndHandleExtension.js";
  * @param  {...string} keys
  */
 export default async function https(host, ...keys) {
-  assertTreeIsDefined(this, "https:");
+  assertTreeIsDefined(this, "https");
   const href = constructHref("https:", host, ...keys);
   return fetchAndHandleExtension.call(this, href);
 }

package/src/protocols/httpstree.js

@@ -14,6 +14,6 @@ import constructSiteTree from "../common/constructSiteTree.js";
  * @param  {...string} keys
  */
 export default function httpstree(host, ...keys) {
-  assertTreeIsDefined(this, "treehttps:");
+  assertTreeIsDefined(this, "treehttps");
   return constructSiteTree("https:", SiteTree, this, host, ...keys);
 }