编写插件 - Fluxdown
Repair 插件处理 Markdown AST,在转换成 HAST、交给组件渲染之前修复节点。可以覆盖某个内置插件的配置,也可以添加自己的处理。
自定义插件
这个插件在生成中的最后一个内容块之后加一段 …;结束后不再添加。
内置修复
这是一段正在生成的文字。
加入自定义修复
这是一段正在生成的文字。
…
将 StreamingIndicatorRepairPlugin 加入 plugins.repairs;各渲染库的传参方式见接入组件。
配置字段
disabled、priority 的含义与默认值见插件设计 · 通用选项。
插件配置
这些字段属于类实例的 config: RepairPluginSystemConfig,不是任意内置插件的构造选项。需要改变某类插件的遍历方式时,在自己的类中声明。
开关配置
直接接入 Core 时,将列表传入 repairs,并在 build 中设置 repair、repairEnding;界面组件的 streaming 会替你转换末尾开关。见 Core 快速开始。
插件成员字段
key、static 方法、constructor、config 与 destroy 见插件设计 · 插件成员。除 runner 外,下列钩子在基类中默认不做处理,按需 override。
prepare本轮插件 A · B · CbeforebeforeEachrunnerafterEachafterrunner
类型: RepairPluginRunner | RepairPluginRunner[]
遍历节点并修改语法树;每个 runner 单独执行一次遍历。
原文可读取可选的 node.data.source。
prepare
类型: RepairPluginPrepare
为本轮准备共享信息,可返回清理函数;全部插件执行后逆序清理。
before / after
类型: RepairPluginHookType
在当前插件的全部 runner 执行前、后各调用一次,接收本轮根节点。
beforeEach / afterEach
类型: RepairPluginHookType
在每个 runner 的遍历前、后各调用一次,接收本轮根节点。
内置插件配置
没有列在这里的内置 repair 不提供额外构造选项。完整导入路径见 Core 插件清单。
接入组件
通过 plugins.repairs 配置内置插件或添加上面的自定义插件。声明方式、覆盖规则与各渲染库的完整示例见插件设计 · 声明与配置。
streaming 随接收状态变化,开启、暂停与结束的设置见语法修复 · 开启、暂停与结束。