# @unified-latex/unified-latex-util-parse > Tools for manipulating unified-latex ASTs Latest version **1.8.4** (published 2026-04-03) · MIT license · 0 weekly downloads ## Install ```sh npm install @unified-latex/unified-latex-util-parse pnpm add @unified-latex/unified-latex-util-parse yarn add @unified-latex/unified-latex-util-parse bun add @unified-latex/unified-latex-util-parse ``` ## Health **Score 60/100 (C)** — status: active. Positive: has types; esm support; no vulnerabilities; high maintenance score. Warnings: low downloads. ## Facts | | | |---|---| | Version | 1.8.4 | | Published | 2026-04-03 | | First published | 2022-05-14 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 11 | | Unpacked size | 199.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 127 | | Author | Jason Siefken | | Maintainers | siefkenj | | Keywords | pegjs, latex, parser, prettier, unified-latex, unified | ## Links - npm: https://www.npmjs.com/package/@unified-latex/unified-latex-util-parse - Repository: https://github.com/siefkenj/unified-latex - Homepage: https://github.com/siefkenj/unified-latex#readme - Issues: https://github.com/siefkenj/unified-latex/issues - npm.io page: https://npm.io/package/@unified-latex/unified-latex-util-parse ## Dependencies (11) - [unified](https://npm.io/package/unified.md) ^10.1.2 - [@unified-latex/unified-latex-ctan](https://npm.io/package/@unified-latex/unified-latex-ctan.md) ^1.8.4 - [@unified-latex/unified-latex-types](https://npm.io/package/@unified-latex/unified-latex-types.md) ^1.8.4 - [@unified-latex/unified-latex-util-trim](https://npm.io/package/@unified-latex/unified-latex-util-trim.md) ^1.8.4 - [@unified-latex/unified-latex-util-match](https://npm.io/package/@unified-latex/unified-latex-util-match.md) ^1.8.4 - [@unified-latex/unified-latex-util-pegjs](https://npm.io/package/@unified-latex/unified-latex-util-pegjs.md) ^1.8.4 - [@unified-latex/unified-latex-util-visit](https://npm.io/package/@unified-latex/unified-latex-util-visit.md) ^1.8.4 - [@unified-latex/unified-latex-util-catcode](https://npm.io/package/@unified-latex/unified-latex-util-catcode.md) ^1.8.4 - [@unified-latex/unified-latex-util-arguments](https://npm.io/package/@unified-latex/unified-latex-util-arguments.md) ^1.8.4 - [@unified-latex/unified-latex-util-print-raw](https://npm.io/package/@unified-latex/unified-latex-util-print-raw.md) ^1.8.4 - [@unified-latex/unified-latex-util-environments](https://npm.io/package/@unified-latex/unified-latex-util-environments.md) ^1.8.4 ## Alternatives - [babylon](https://npm.io/package/babylon.md) — 5.1M weekly downloads - [csscolorparser](https://npm.io/package/csscolorparser.md) — 3.7M weekly downloads - [expr-eval-fork](https://npm.io/package/expr-eval-fork.md) — 1.5M weekly downloads - [@leeoniya/ufuzzy](https://npm.io/package/@leeoniya/ufuzzy.md) — 247.7K weekly downloads - [xml-parser](https://npm.io/package/xml-parser.md) — 78.4K weekly downloads ## Recent versions - 1.8.4 (latest) — 2026-04-03 - 1.8.3 — 2025-06-16 - 1.8.2 — 2025-02-09 - 1.8.1 — 2024-10-21 - 1.8.0 — 2024-08-22 - 1.7.1 — 2024-03-19 - 1.7.0 — 2024-02-25 - 1.6.1 — 2024-02-18 - 1.6.0 — 2024-01-17 - 1.4.2 — 2023-09-30 - 1.4.1 — 2023-09-02 - 1.4.0 — 2023-06-20 - 1.3.2 — 2023-04-26 - 1.3.1 — 2023-03-05 - 1.3.0 — 2023-02-06 - … 13 more at https://npm.io/package/@unified-latex/unified-latex-util-parse/versions ## README # 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` ```typescript function unifiedLatexAstComplier(): void; ``` ## `unifiedLatexFromString` Parse a string to a LaTeX AST. ### Usage `unified().use(unifiedLatexFromString[, options])` #### options ```typescript { mode?: "math" | "regular"; macros?: MacroInfoRecord; environments?: EnvInfoRecord; flags?: { atLetter?: boolean; expl3?: boolean; autodetectExpl3AndAtLetter?: boolean; }; } ``` ### Type `Plugin<{ mode?: "math" | "regular"; macros?: MacroInfoRecord; environments?: EnvInfoRecord; flags?: { atLetter?: boolean; expl3?: boolean; autodetectExpl3AndAtLetter?: boolean; }; }[], string, Ast.Root>` ```typescript function unifiedLatexFromString(options: { mode?: "math" | "regular"; macros?: MacroInfoRecord; environments?: EnvInfoRecord; flags?: { atLetter?: boolean; expl3?: boolean; autodetectExpl3AndAtLetter?: boolean; }; }): 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` ```typescript function unifiedLatexFromStringMinimal(options: PluginOptions): void; ``` ## `unifiedLatexProcessAtLetterAndExplMacros` Unified plugin to reprocess macros names to possibly include `@`, `_`, or `:`. This plugin detects the `\makeatletter` and `\ExplSyntaxOn` commands and reprocesses macro names inside of those blocks to include those characters. ### Usage `unified().use(unifiedLatexProcessAtLetterAndExplMacros[, options])` #### options ```typescript { atLetter?: boolean; expl3?: boolean; autodetectExpl3AndAtLetter?: boolean; } ``` ### Type `Plugin<{ atLetter?: boolean; expl3?: boolean; autodetectExpl3AndAtLetter?: boolean; }[], Ast.Root, Ast.Root>` ```typescript function unifiedLatexProcessAtLetterAndExplMacros(options: { atLetter?: boolean; expl3?: boolean; autodetectExpl3AndAtLetter?: boolean; }): (tree: Ast.Root) => void; ``` ## `unifiedLatexProcessMacrosAndEnvironmentsWithMathReparse` Unified plugin to process macros and environments. Any environments that contain math content are reparsed (if needed) in math mode. ### Usage `unified().use(unifiedLatexProcessMacrosAndEnvironmentsWithMathReparse[, options])` #### options ```typescript { environments: EnvInfoRecord; macros: MacroInfoRecord; } ``` ### Type `Plugin<{ environments: EnvInfoRecord; macros: MacroInfoRecord; }[], Ast.Root, Ast.Root>` ```typescript function unifiedLatexProcessMacrosAndEnvironmentsWithMathReparse(options: { environments: EnvInfoRecord; macros: MacroInfoRecord; }): (tree: Ast.Root) => void; ``` ## `unifiedLatexReparseMath` Reparse math environments/macro contents that should have been parsed in math mode but weren't. ### Usage `unified().use(unifiedLatexReparseMath[, options])` #### options ```typescript { mathEnvs: string[]; mathMacros: string[]; } ``` ### Type `Plugin<{ mathEnvs: string[]; mathMacros: string[]; }[], Ast.Root, Ast.Root>` ```typescript function unifiedLatexReparseMath(options: { mathEnvs: string[]; mathMacros: string[]; }): (tree: Ast.Root) => void; ``` # Functions ## `getParser(options)` Returns the default `unified-latex` parser, or create a new one with the provided `unifiedLatexFromString` options ```typescript function getParser(options: { mode?: "math" | "regular"; macros?: Ast.MacroInfoRecord; environments?: Ast.EnvInfoRecord; flags?: { atLetter?: boolean; expl3?: boolean; autodetectExpl3AndAtLetter?: boolean; }; }): FrozenProcessor; ``` **Parameters** | Param | Type | Description | | :------ | :-------------------------------- | -------------------------------------------------- | | options | Omitted | Plugin options of `unifiedLatexFromString` plugin. | ## `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` | `unifiedLatexReparseMathConstructPlugin({ mathEnvs, mathMacros, })` --- Construct the inner function for the `unifiedLatexReparseMath` plugin. This function should not be used by libraries. ```typescript function unifiedLatexReparseMathConstructPlugin({ mathEnvs, mathMacros, }: { mathEnvs: string[]; mathMacros: string[]; }): (tree: Ast.Root) => void; ``` **Parameters** | Param | Type | | :-------------------------------------------- | :-------------------------------- | | { mathEnvs, mathMacros, } | Omitted | # Types ## `PluginOptions` ```typescript export type PluginOptions = | { mode?: "math" | "regular"; macros?: MacroInfoRecord; environments?: EnvInfoRecord; flags?: { /** * Whether to parse macros as if `\makeatletter` is set (i.e., parse `@` as a regular macro character) */ atLetter?: boolean; /** * Whether to parse macros as if `\ExplSyntaxOn` is set (i.e., parse `_` and `:` as a regular macro character) */ expl3?: boolean; /** * Attempt to autodetect whether there are macros that look like they should contain `@`, `_`, or `:`. * Defaults to `false`. */ autodetectExpl3AndAtLetter?: boolean; }; } | undefined; ``` --- _Source: https://npm.io/package/@unified-latex/unified-latex-util-parse · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._