@unified-latex/unified-latex-util-environments 1.0.8 → 1.0.12

package/README.md

@@ -0,0 +1,91 @@
+<!-- DO NOT MODIFY -->
+<!-- This file was autogenerated by build-docs.ts -->
+<!-- Edit the docstring in index.ts and regenerate -->
+<!-- rather than editing this file directly. -->
+# unified-latex-util-environments
+
+## What is this?
+
+Functions to report on/manipulate environments in a `unified-latex` Abstract Syntax Tree (AST).
+
+## When should I use this?
+
+If you are working on the internals of `unified-latex-util-parse` or need to make a custom parser
+that treats environments differently.
+
+## Install
+
+```bash
+npm install @unified-latex/unified-latex-util-environments
+```
+
+This package contains both esm and commonjs exports. To explicitly access the esm export,
+import the `.js` file. To explicitly access the commonjs export, import the `.cjs` file.
+
+# Plugins
+
+## `unifiedLatexProcessEnvironments`
+
+Unified plugin to process environment content and attach arguments.
+
+### Usage
+
+`unified().use(unifiedLatexProcessEnvironments[, options])`
+
+#### options
+
+```typescript
+{ environments: Ast.EnvInfoRecord; }
+```
+
+### Type
+
+`Plugin<{ environments: Ast.EnvInfoRecord; }[], Ast.Root, Ast.Root>`
+
+```typescript
+function unifiedLatexProcessEnvironments(options: {
+  environments: Ast.EnvInfoRecord;
+}): (tree: Ast.Root) => void;
+```
+
+# Functions
+
+## `processEnvironment(envNode, envInfo)`
+
+Performs any needed processing on the environment (as specified by `envInfo`)
+include attaching arguments and possibly manipulating the environment's body.
+
+```typescript
+function processEnvironment(
+  envNode: Ast.Environment,
+  envInfo: Ast.EnvInfo
+): void;
+```
+
+**Parameters**
+
+| Param   | Type              |
+| :------ | :---------------- |
+| envNode | `Ast.Environment` |
+| envInfo | `Ast.EnvInfo`     |
+
+## `processEnvironments(tree, environments)`
+
+Recursively search for and process the specified environments. Arguments are
+consumed according to the `signature` specified. The body is processed
+with the specified `processContent` function (if given). Any specified `renderInfo`
+is attached to the environment node.
+
+```typescript
+function processEnvironments(
+  tree: Ast.Ast,
+  environments: Ast.EnvInfoRecord
+): void;
+```
+
+**Parameters**
+
+| Param        | Type                |
+| :----------- | :------------------ |
+| tree         | `Ast.Ast`           |
+| environments | `Ast.EnvInfoRecord` |

package/index.cjs

@@ -0,0 +1,81 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// index.ts
+var unified_latex_util_environments_exports = {};
+__export(unified_latex_util_environments_exports, {
+  processEnvironment: () => processEnvironment,
+  processEnvironments: () => processEnvironments,
+  unifiedLatexProcessEnvironments: () => unifiedLatexProcessEnvironments
+});
+module.exports = __toCommonJS(unified_latex_util_environments_exports);
+
+// libs/process-environment.ts
+var import_unified_latex_util_render_info = require("@unified-latex/unified-latex-util-render-info");
+var import_unified_latex_util_arguments = require("@unified-latex/unified-latex-util-arguments");
+var import_unified_latex_util_match = require("@unified-latex/unified-latex-util-match");
+var import_unified_latex_util_visit = require("@unified-latex/unified-latex-util-visit");
+var import_unified_latex_util_print_raw = require("@unified-latex/unified-latex-util-print-raw");
+function processEnvironment(envNode, envInfo) {
+  if (envInfo.signature && envNode.args == null) {
+    const { args } = (0, import_unified_latex_util_arguments.gobbleArguments)(envNode.content, envInfo.signature);
+    envNode.args = args;
+  }
+  (0, import_unified_latex_util_render_info.updateRenderInfo)(envNode, envInfo.renderInfo);
+  if (typeof envInfo.processContent === "function") {
+    envNode.content = envInfo.processContent(envNode.content);
+  }
+}
+function processEnvironments(tree, environments) {
+  const isRelevantEnvironment = import_unified_latex_util_match.match.createEnvironmentMatcher(environments);
+  (0, import_unified_latex_util_visit.visit)(tree, {
+    leave: (node) => {
+      const envName = (0, import_unified_latex_util_print_raw.printRaw)(node.env);
+      const envInfo = environments[envName];
+      if (!envInfo) {
+        throw new Error(`Could not find environment info for environment "${envName}"`);
+      }
+      processEnvironment(node, envInfo);
+    }
+  }, { test: isRelevantEnvironment });
+}
+
+// libs/unified-latex-process-environment.ts
+var import_unified_latex_util_visit2 = require("@unified-latex/unified-latex-util-visit");
+var import_unified_latex_util_match2 = require("@unified-latex/unified-latex-util-match");
+var import_unified_latex_util_print_raw2 = require("@unified-latex/unified-latex-util-print-raw");
+var unifiedLatexProcessEnvironments = function unifiedLatexAttachMacroArguments(options) {
+  const { environments = {} } = options || {};
+  const isRelevantEnvironment = import_unified_latex_util_match2.match.createEnvironmentMatcher(environments);
+  return (tree) => {
+    if (Object.keys(environments).length === 0) {
+      console.warn("Attempting to attach macro arguments but no macros are specified.");
+    }
+    (0, import_unified_latex_util_visit2.visit)(tree, {
+      leave: (node) => {
+        const envName = (0, import_unified_latex_util_print_raw2.printRaw)(node.env);
+        const envInfo = environments[envName];
+        if (!envInfo) {
+          throw new Error(`Could not find environment info for environment "${envName}"`);
+        }
+        processEnvironment(node, envInfo);
+      }
+    }, { test: isRelevantEnvironment });
+  };
+};
+//# sourceMappingURL=index.cjs.map

package/package.json

@@ -1,16 +1,16 @@
 {
     "name": "@unified-latex/unified-latex-util-environments",
-    "version": "1.0.8",
+    "version": "1.0.12",
     "description": "Tools for manipulating unified-latex ASTs",
     "main": "index.js",
     "type": "module",
     "dependencies": {
-        "@unified-latex/unified-latex-types": "^1.0.7",
-        "@unified-latex/unified-latex-util-arguments": "^1.0.8",
-        "@unified-latex/unified-latex-util-match": "^1.0.8",
-        "@unified-latex/unified-latex-util-print-raw": "^1.0.8",
-        "@unified-latex/unified-latex-util-render-info": "^1.0.8",
-        "@unified-latex/unified-latex-util-visit": "^1.0.8",
+        "@unified-latex/unified-latex-types": "^1.0.12",
+        "@unified-latex/unified-latex-util-arguments": "^1.0.12",
+        "@unified-latex/unified-latex-util-match": "^1.0.12",
+        "@unified-latex/unified-latex-util-print-raw": "^1.0.12",
+        "@unified-latex/unified-latex-util-render-info": "^1.0.12",
+        "@unified-latex/unified-latex-util-visit": "^1.0.12",
         "unified": "^10.1.2"
     },
     "repository": {
@@ -33,8 +33,8 @@
     "homepage": "https://github.com/siefkenj/unified-latex#readme",
     "exports": {
         ".": {
-            "import": "index.js",
-            "require": "index.cjs"
+            "import": "./index.js",
+            "require": "./index.cjs"
         },
         "./*js": "./*js",
         "./*": {
@@ -48,8 +48,8 @@
         }
     },
     "files": [
-        "**/*.ts",
-        "**/*.js",
+        "**/*ts",
+        "**/*js",
         "**/*.map",
         "**/*.json"
     ]