插件注册必须暴露 editor 实例引用，否则插件无法调用 execCommand、insertContent 等核心方法；Scribe、Tiptap、wangEditor 等均要求插件函数接收完整 editor 对象，漏传将导致按钮无响应、命令静默失败等问题。
插件注册必须暴露 editor 实例引用
不把 editor 实例传给插件函数，插件就等于没接入编辑器内核。Scribe、Trix、Tiptap 都要求插件接收一个带完整 API 的 editor 对象；TinyMCE 的 register 函数第二个参数是 url，但第一个参数 editor 才是操作主体；wangEditor 和 Squire 则直接把实例作为唯一入参。漏传或只传配置对象，插件连 execCommand 或 insertContent 都调不了。
常见错误现象：
- 插件初始化后按钮点击无反应 —— 实际是
editor.execCommand调用报Cannot read property 'execCommand' of undefined - 自定义命令注册成功但无法触发 —— 原因是插件内部没拿到真实 editor 实例，而是用了 mock 或空对象
实操建议：
- 统一约定插件导出为函数，签名固定为
(editor) => { ... }（如 Scribe/Tiptap）或(editor, url) => { ... }（如 TinyMCE） - 在编辑器主类中做参数校验：
if (!editor || typeof editor !== 'object') throw new Error('Plugin requires valid editor instance') - 避免在插件里自行 new Editor() —— 这会破坏单例和状态同步，尤其影响协作、撤销栈等全局能力
命令系统必须支持 command + action 双层抽象
只靠 execCommand 原生接口撑不起复杂插件。原生命令如 'bold'、'insertImage' 无法携带参数、无法定制执行逻辑、也无法拦截或增强行为。Trix 用 action 字符串绑定到 toolbar 按钮，再由内部映射到具体 handler；Tiptap 把命令封装成 Command 类型的函数，支持链式调用和条件判断；Scribe 则通过 scribe.commands.highlight = new scribe.api.Command('highlight') 显式注册可执行单元。
立即学习“前端免费学习笔记（深入）”；
为什么必须分两层：
-
command是能力标识（如'toggleCodeBlock'），用于快捷键绑定、菜单项复用、API 外露 -
action是 UI 触发入口（如 toolbar 按钮点击、右键菜单选择），可对应多个 command 或组合 command
容易踩的坑：
- 把按钮 click 直接写死 DOM 操作 —— 导致无法响应快捷键
Ctrl+Shift+C，也无法被插件系统统一管理 - 命令名硬编码在 HTML 里（如
data-action="insert-table"）—— 后续想动态启用/禁用某个功能时得遍历 DOM 改属性，不可维护 - 没做 command 存在性检查，
editor.execute('nonexistent')静默失败，调试困难
插件生命周期必须覆盖 mount / update / unmount
很多轻量编辑器只提供“加载即运行”模式，但真实业务中插件要能动态启停：比如「实时协作」插件只在多人编辑页激活，「代码高亮」插件仅在技术文档场景加载。Scribe 的 use() / unuse()、Tiptap 的 extension.enable() / disable()、TinyMCE 的 editor.plugins.myplugin?.destroy() 都明确支持卸载。没有 unmount 能力的插件，会持续监听事件、占用内存、干扰其他插件的 DOM 操作。
典型问题场景：
- 切换编辑器 tab 后，上一个 tab 的「字数统计」插件还在后台每秒计算
getContent().length，导致卡顿 - 「图片懒加载」插件未清理 IntersectionObserver，页面滚动时持续触发回调，引发重绘抖动
- 「Markdown 预览」插件挂载了
input事件，但切换到纯文本模式后没解绑，造成事件重复绑定
实操建议：
- 插件内部用 WeakMap 缓存 editor 实例与私有状态的映射，避免内存泄漏
- 所有事件监听必须配套
off或用AbortController控制信号（Tiptap v2+ 已内置） - 提供
destroy()方法，并在编辑器destroy()时自动调用所有已注册插件的销毁逻辑
插件间通信不能依赖全局变量或 DOM 查找
当多个插件需要协同（比如「表格」插件插入表格后，「自动编号」插件要立刻更新序号列），靠 window.myTablePlugin 或 document.querySelector('.table-plugin-state') 是反模式。Trix 用 editor.element.dispatchEvent(new CustomEvent(...))；Tiptap 基于 ProseMirror 的 state 和 dispatch 机制天然支持跨插件状态读写；Squire 提供 editor.addEventListener('formatChange', ...) 这类语义化事件。
真正可靠的方式是编辑器暴露一个轻量总线：
- 统一事件名空间，如
editor.on('table:created', handler)、editor.emit('link:updated', { url, title }) - 禁止插件之间直接 import 彼此模块 —— 这会导致循环依赖、构建失败、版本冲突
- 状态共享走 editor 实例上的属性（如
editor._tableState = {...}），但必须加前缀和类型注释，避免命名污染
最容易被忽略的一点：插件初始化顺序会影响事件订阅时机。如果「自动保存」插件在「内容变更检测」插件之前注册，它就收不到首次 input 事件 —— 必须提供 onReady 钩子或延迟到 editor.isReady 为 true 后再绑定。
