@unifast/node

Visión general

@unifast/node es el punto de entrada principal para usar unifast en Node.js. Proporciona la función compile(), que invoca el compilador nativo en Rust a través de napi-rs para máximo rendimiento. También soporta el sistema de plugins, permitiendo que las transformaciones HAST se apliquen en JavaScript después del paso de compilación en Rust.

Instalación

El addon nativo de Rust debe estar precompilado. Ejecuta cargo build -p unifast-bindings-node --release si el binario nativo no está disponible.

Inicio rápido

import { compile } from "@unifast/node";

const result = compile("# Hello, **world**!");
console.log(result.output);
// <h1 id="hello-world">Hello, <strong>world</strong>!</h1>

Pipeline de plugins

Cuando se proporcionan plugins, compile() ejecuta la siguiente pipeline:

1. Extraer plugins - Separa plugins del resto de las opciones

2. Combinar opciones - Realiza un deep-merge de las options de cada plugin con las opciones de compilación

3. Forzar HAST - Si algún plugin tiene un hastTransform, la llamada nativa usa outputKind: "hast"

4. Compilación nativa - Invoca el compilador en Rust a través de napi-rs

5. Transformaciones HAST - Aplica el hastTransform de cada plugin en orden

6. Convertir salida - Si el usuario no solicitó salida HAST, convierte de vuelta a HTML mediante hastToHtml

Plugins integrados

Las siguientes funciones factory de plugins están incluidas; no es necesaria una instalación aparte:

gfm, frontmatter, sanitize, syntect, treeSitter, toc, externalLinks, autolinkHeadings, smartypants, wikiLink, codeImport, emoji, breaks, math, githubAlert, sectionize, directive, definitionList, rubyAnnotation, cjk

import { compile, gfm, frontmatter, syntect } from "@unifast/node";

const result = compile(source, {
  plugins: [gfm(), frontmatter(), syntect()],
});

Resumen de exports