@unifast/node

概述

@unifast/node 是在 Node.js 中使用 unifast 的主要入口。它提供了 compile() 函数，通过 napi-rs 调用原生 Rust 编译器，以获得最佳性能。它同时支持插件系统，允许在 Rust 编译阶段之后在 JavaScript 中应用 HAST 转换。

安装

原生 Rust 扩展必须预先构建。如果原生二进制文件不可用，请运行 cargo build -p unifast-bindings-node --release。

快速开始

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

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

插件流水线

当传入插件时，compile() 会按以下流程执行：

1. 抽离插件 —— 将 plugins 与其他选项分开

2. 合并选项 —— 深度合并每个插件的 options 到编译选项中

3. 强制 HAST —— 只要有任一插件带有 hastTransform，原生调用就会使用 outputKind: "hast"

4. 原生编译 —— 通过 napi-rs 调用 Rust 编译器

5. HAST 转换 —— 按顺序应用每个插件的 hastTransform

6. 转换输出 —— 如果用户没有请求 HAST 输出，则通过 hastToHtml 转换回 HTML

内置插件

包中已内置以下插件工厂函数 —— 无需单独安装：

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()],
});

导出列表