unified-latex-util-print-raw

What is this?

Functions to print a unified-latex Abstract Syntax Tree (AST) to a string.

When should I use this?

If you want to directly print an Ast.Ast to a string without any pretty printing or formatting.

Install

npm install @unified-latex/unified-latex-util-print-raw

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.

Functions

`printRaw(node, options)`

Renders the AST to a string without any pretty printing.

function printRaw(
  node: Printable | Printable[],
  options: { asArray: false }
): string;

Parameters

Param	Type	Description
node	`Printable \| Printable[]`
options	`{ asArray: false; }`	* Setting `asArray` to `true` will return an array of strings and the symbol `linebreak`, so that printing can be customized.

Constants

Name	Type
`linebreak`	`Symbol`

unified-latex Changelog

v1.8.0

Added initial PreTeXt conversion support
Upgraded deps
Added amsart macros
Consume the whitespace after special character macros when expanding ligatures. For example \o y produces øy instead of ø y
Fix signatures of \hyphenation

v1.7.1

Types fix for @unified-latex/unified-latex-types
Fixed AST when expanding \sysdelim macros for rendering \systeme{} macros with KaTeX

v1.7.0

Switch build system to vite. Should result in smaller bundles.
Save default arguments when parsing if the macro signature specifies them e.g. {signature: "O{foo}"}. The defaults are substituted in when expanding the macros with the optional arguments omitted.
Preserve position information when comments are modified. (Sometimes, during a parse, but never during a parseMinimal, comments are modified to remove leading whitespace. Previously, modified comments would have their position information deleted. Position information is now preserved.)

v1.6.1

Pass VisitInfo as an additional argument ot macroReplacers and environmentReplacers in unifiedLatexToHast.
Allow skipping of HTML validation in unifiedLatexToHast.
The minted environment parses its contents as a verbatim.

v1.6.0

Embellishment tokens are now supported in macro signatures. E.g., a xxx: {signature: "e{^_}"} will allow \xxx_{foo}^{bar} and \xxx^{foo}_{bar} to parse correctly.
Stop tokens can now be regular string characters. For example xxx: {signature: "ua"} will allow \xxx YYYaBBB to consume YYY leaving BBB unconsumed.
Break after \\ macro when pretty printing (Issue #59)
[DEVELOPMENT] Added tsconfig.json files to each test/ folder for more granular control of the typescript settings.

v1.5.0

HTML conversion: vspace and hspace now give the amount in a data-amount attribute.
HTML conversion: unknown macros now have their arguments wrapped in spans instead of appearing as formatted LaTeX code.
Add basic Markdown conversion support.

v1.4.2

Avoid slowdown when paring incomplete environments (e.g. \newcommand{\x}{\begin{x}}). This is accomplished by enabling caching in PEGjs.
Added " ligature and \paragraph and \subparagraph to HTML conversion.

v1.4.1

Many more ligatures added to the HTML converter.
Fixed issue #40 where the optional argument to \\ was being parsed even if preceded by a space. (E.g., \\[10pt] and \\ [10pt]) were parsed the same. Not allowing the space should more closely match expected behavior.
Bump Prettier to v2.8.8

v1.4.0

Better CJS support (now unified is compiled in rather than left as an external dependency. This is needed because unified is ESM-only).
minted and listings environments now accept optional arguments and parse their contents verbatim. This makes them much more efficient.

v1.3.0

Initial support for parsing and pretty-printing of tikz environments.
Added support for xparse u-type arguments.
Can now pass an argumentParser attribute for custom argument parsing (instead of relying on an xparse signature)

Package detail

@unified-latex/unified-latex-util-print-raw

readme