Velt CRDT Best Practices 是 Velt 维护的实时协作编辑最佳实践指南,基于 Velt CRDT(Yjs),共含 42 条规则,分 5 类并按影响优先级排列,用于指导自动化代码生成与调试。
用途:在搭建 Velt 客户端与 CRDT 存储、集成 Tiptap、BlockNote、CodeMirror、ReactFlow、实现实时同步、管理版本历史与检查点、调试协作或同步问题、测试多用户协作时参考。
规则类别与优先级:核心 CRDT(CRITICAL,前缀 core-);Tiptap 集成(CRITICAL,tiptap-);BlockNote 集成(HIGH,blocknote-);CodeMirror 集成(HIGH,codemirror-);ReactFlow 集成(HIGH,reactflow-)。
主要能力:核心规则覆盖安装、初始化、v2 存储 API(useStore、useAwareness、createVeltStore 配置 forceResetInitialContent、contentKey、userId、collection、logLevel)、v1 到 v2 迁移、非 React 的 createVeltStore、存储类型选择(text/array/map/xml/xmltext)、订阅变更、update()、版本检查点、加密、Webhook、REST 检索、活动防抖 setActivityDebounceTime()、CrdtActivityActionTypes、消息流方法(pushMessage、onMessage、getMessages、getSnapshot、saveSnapshot、pruneMessages)、VeltCrdtStoreMap 调试、多浏览器配置测试。集成规则覆盖各编辑器的 v2 安装、useCollaboration/createCollaboration 与 CollaborationManager API、v1 到 v2 迁移、editorId 唯一性、禁用 Tiptap history、协作光标 CSS、Tiptap 初始内容用 HTML 字符串、与 Velt Comments 集成、Next.js SSR 处理、CodeMirror 的 yCollab 配合 manager.getCollaborationPrimitives()、ReactFlow 的 CRDT handlers,以及多用户测试。
使用方式:阅读规则文件如 rules/shared/core/core-install.md、rules/shared/tiptap/tiptap-disable-history.md,每条含原因说明、错误与正确代码示例、验证清单及 Velt 文档来源;压缩索引见 AGENTS.md,完整版见 AGENTS.full.md。部分 XML 存储需 npm i yjs。具体安装命令与完整代码示例需查阅原始规则文件,此处暂未提供。