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

package/package.json

@@ -1,44 +1,21 @@
 {
     "name": "@unified-latex/unified-latex-util-parse",
-    "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-ctan": "^1.0.5",
-        "@unified-latex/unified-latex-types": "^1.0.5",
-        "@unified-latex/unified-latex-util-arguments": "^1.0.5",
-        "@unified-latex/unified-latex-util-environments": "^1.0.5",
-        "@unified-latex/unified-latex-util-match": "^1.0.5",
-        "@unified-latex/unified-latex-util-pegjs": "^1.0.5",
-        "@unified-latex/unified-latex-util-print-raw": "^1.0.5",
-        "@unified-latex/unified-latex-util-trim": "^1.0.5",
-        "@unified-latex/unified-latex-util-visit": "^1.0.5",
+        "@unified-latex/unified-latex-ctan": "^1.0.8",
+        "@unified-latex/unified-latex-types": "^1.0.7",
+        "@unified-latex/unified-latex-util-arguments": "^1.0.8",
+        "@unified-latex/unified-latex-util-environments": "^1.0.8",
+        "@unified-latex/unified-latex-util-match": "^1.0.8",
+        "@unified-latex/unified-latex-util-pegjs": "^1.0.8",
+        "@unified-latex/unified-latex-util-print-raw": "^1.0.8",
+        "@unified-latex/unified-latex-util-trim": "^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"
@@ -57,15 +34,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,170 +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-parse
-
-## What is this?
-
-Functions parse strings to a `unified-latex` Abstract Syntax Tree (AST).
-
-## When should I use this?
-
-If you have a string that you would like to parse to a `unified-latex` `Ast.Ast`, or
-if you are building a plugin for `unified()` that manipulates LaTeX.
-
-## Install
-
-```bash
-npm install @unified-latex/unified-latex-util-parse
-```
-
-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
-
-## `unifiedLatexAstComplier`
-
-Unified complier plugin that passes through a LaTeX AST without modification.
-
-### Usage
-
-`unified().use(unifiedLatexAstComplier)`
-
-### Type
-
-`Plugin<void[], Ast.Root, Ast.Root>`
-
-```typescript
-function unifiedLatexAstComplier(): void;
-```
-
-## `unifiedLatexFromString`
-
-Parse a string to a LaTeX AST.
-
-### Usage
-
-`unified().use(unifiedLatexFromString[, options])`
-
-#### options
-
-```typescript
-{ mode?: "math" | "regular"; macros?: Ast.MacroInfoRecord; environments?: Ast.EnvInfoRecord; }
-```
-
-### Type
-
-`Plugin<{ mode?: "math" | "regular"; macros?: Ast.MacroInfoRecord; environments?: Ast.EnvInfoRecord; }[], string, Ast.Root>`
-
-```typescript
-function unifiedLatexFromString(options: {
-  mode?: "math" | "regular";
-  macros?: Ast.MacroInfoRecord;
-  environments?: Ast.EnvInfoRecord;
-}): void;
-```
-
-## `unifiedLatexFromStringMinimal`
-
-Parse a string to a LaTeX AST with no post processing. For example,
-no macro arguments will be attached, etc.
-
-### Usage
-
-`unified().use(unifiedLatexFromStringMinimal[, options])`
-
-#### options
-
-```typescript
-PluginOptions
-```
-
-### Type
-
-`Plugin<PluginOptions[], string, Ast.Root>`
-
-```typescript
-function unifiedLatexFromStringMinimal(options: PluginOptions): void;
-```
-
-# Functions
-
-## `parse(str)`
-
-Parse the string into an AST.
-
-```typescript
-function parse(str: String): Ast.Root;
-```
-
-**Parameters**
-
-| Param | Type     |
-| :---- | :------- |
-| str   | `String` |
-
-## `parseMath(str)`
-
-Parse `str` into an AST. Parsing starts in math mode and a list of
-nodes is returned (instead of a "root" node).
-
-```typescript
-function parseMath(str: string | Ast.Ast): Ast.Node[];
-```
-
-**Parameters**
-
-| Param | Type                |
-| :---- | :------------------ |
-| str   | `string \| Ast.Ast` |
-
-## `parseMathMinimal(str)`
-
-Parse `str` to an AST with minimal processing. E.g., macro
-arguments are not attached to macros, etc. when parsed with this
-function.
-
-The parsing assumes a math-mode context, so, for example, `^` and `_` are
-parsed as macros (even though arguments are not attached to them).
-
-```typescript
-function parseMathMinimal(str: String): Ast.Node[];
-```
-
-**Parameters**
-
-| Param | Type     |
-| :---- | :------- |
-| str   | `String` |
-
-## `parseMinimal(str)`
-
-Parse `str` to an AST with minimal processing. E.g., macro
-arguments are not attached to macros, etc. when parsed with this
-function.
-
-```typescript
-function parseMinimal(str: String): Ast.Root;
-```
-
-**Parameters**
-
-| Param | Type     |
-| :---- | :------- |
-| str   | `String` |
-
-# Types
-
-## `PluginOptions`
-
-```typescript
-export type PluginOptions =
-    | {
-          mode?: "math" | "regular";
-          macros?: MacroInfoRecord;
-          environments?: EnvInfoRecord;
-      }
-    | undefined;
-```