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

package/package.json

@@ -1,41 +1,18 @@
 {
     "name": "@unified-latex/unified-latex-util-environments",
-    "version": "1.0.5",
+    "version": "1.0.8",
     "description": "Tools for manipulating unified-latex ASTs",
-    "main": "dist/index.js",
+    "main": "index.js",
     "type": "module",
     "dependencies": {
-        "@unified-latex/unified-latex-types": "^1.0.5",
-        "@unified-latex/unified-latex-util-arguments": "^1.0.5",
-        "@unified-latex/unified-latex-util-match": "^1.0.5",
-        "@unified-latex/unified-latex-util-print-raw": "^1.0.5",
-        "@unified-latex/unified-latex-util-render-info": "^1.0.5",
-        "@unified-latex/unified-latex-util-visit": "^1.0.5",
+        "@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": "^10.1.2"
     },
-    "files": [
-        "dist/**/*.ts",
-        "dist/**/*.js",
-        "dist/**/*.map",
-        "dist/**/*.json"
-    ],
-    "exports": {
-        ".": {
-            "import": "./dist/index.js",
-            "require": "./dist/index.cjs"
-        },
-        "./*js": "./dist/*js",
-        "./*": {
-            "import": "./dist/*.js",
-            "require": "./dist/*.cjs"
-        }
-    },
-    "scripts": {
-        "build": "npm run clean && mkdirp ./dist && npm run compile",
-        "clean": "rm -rf ./dist && rm -rf tsconfig.tsbuildinfo",
-        "compile": "tsc -b tsconfig.json & node build.js & wait",
-        "test": "jest"
-    },
     "repository": {
         "type": "git",
         "url": "git+https://github.com/siefkenj/unified-latex.git"
@@ -54,15 +31,26 @@
         "url": "https://github.com/siefkenj/unified-latex/issues"
     },
     "homepage": "https://github.com/siefkenj/unified-latex#readme",
-    "jest": {
-        "transformIgnorePatterns": [
-            "node_modules/(?!unified|bail|is-plain-obj|trough|vfile.*|unist.*|hast.*|property-information|html-void-elements|.*-separated-tokens|.*entities.*|ccount|rehype*|string-width|strip-ansi|ansi-regex|supports-color)"
-        ],
-        "transform": {
-            "\\.m?jsx?$": "esbuild-jest",
-            "latex.pegjs$": "<rootDir>/../../tests/pegjs-preprocessor-latex.js",
-            "\\.pegjs$": "<rootDir>/../../tests/pegjs-preprocessor.js",
-            "^.+\\.tsx?$": "ts-jest"
+    "exports": {
+        ".": {
+            "import": "index.js",
+            "require": "index.cjs"
+        },
+        "./*js": "./*js",
+        "./*": {
+            "import": "./*/index.js",
+            "require": "./*/index.cjs",
+            "types": "./*/index.d.ts"
+        },
+        "./*/index": {
+            "import": "./*/index.js",
+            "require": "./*/index.cjs"
         }
-    }
-}
+    },
+    "files": [
+        "**/*.ts",
+        "**/*.js",
+        "**/*.map",
+        "**/*.json"
+    ]
+}

package/README.md

@@ -1,91 +0,0 @@
-<!-- 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` |