入口总览
库按子路径提供功能,宿主可以只加载需要的部分。根入口是主入口;react-wikitext/view 是不加载解析器的精简入口。
处理管线
可选的前置阶段:
子路径
根入口不导出 parse、expand、hast 与 unified 的功能。/ast、/hast、/unified、/configs 不加载默认解析器;/parse 与 /expand 会加载;/view 只加载 React 与已准备好的文档。AST 树与节点检查器属于内部 playground,不是公共入口。
解析快照与渲染快照
解析快照 WikitextDocument
ast是原始归一化结果,准备阶段不会修改它。syntax只在retainSyntax: true时出现,供 playground 与源码坐标使用。meta记录解析器名称与版本、页面名、归一化状态与原长度。
渲染快照 WikitextRenderDocument
ast是插件处理后的工作树,节点 id 已重新分配。hast已完成清洗与最终整理,包含目录、引用区与分类底栏。meta记录实际生效的策略、文案、标题策略与授权图片。WikitextView只接受渲染快照,不接收源码。
查询转换后的节点时,必须使用渲染快照;不要用渲染快照里的 id 查原始解析快照。
如何选择
类型与错误
- 错误类按入口分别导出:
/ast、/parse提供WikitextError/WikitextParseError;/expand提供WikitextExpandError;/hast提供WikitextPrepareError。根入口与/view不导出错误类。 WikitextLabels类型可从/ast与/view导入;默认值DEFAULT_WIKITEXT_LABELS与DEFAULT_PREPARE_POLICY从/hast导出。- 完整节点子类型从
/ast导入;根入口只导出视图组件会用到的精选语义类型。 - 错误码、
stage与诊断字段见错误与诊断。