用途:面向 Plate 仓库的插件创作执行指南,覆盖语义归属、创作顺序、类型契约保真以及 React/Plate 包装层边界。公开插件文档应交给 docs-creator。
核心理念为“Slate 优先,Plate 其次”:若插件脱离 React 仍有文档语义,先在 packages/*/src/lib 写语义基座,仅在需要渲染、hooks 或 Plate 专属编辑器集成时再加 React/Plate 层。
主要规则:createSlatePlugin / createTSlatePlugin 负责语义基座;toPlatePlugin / toTPlatePlugin 把基座提升到 React/Plate 层;createPlatePlugin / createTPlatePlugin 用于真正的 React 原生插件或现有插件的组合包。已有语义基座时用包装而非重写。共享插件键应从 packages/utils/src/lib/plate-keys.ts 的 KEYS 取用。禁止手写或手改 index.ts / index.tsx 桶文件,新增、移动、重命名或删除公开文件后需运行 pnpm brl 再验证;若产物损坏应修生成器或文件位置,而非手改。非公开契约的辅助逻辑放 internal/。源码禁用 any(非类型测试代码中刻意的局部松散可例外)。
使用方式:先读 creation-flow.md 决策树再选 API,检索 packages//src/lib、packages//src/react、packages/core/type-tests 中最接近的范例,判定类型(语义基座、Plate/React 包装、React 原生例外、组合包),锁定契约形状(options、插件专属与合并编辑器 API/transforms、嵌套子插件),再按 typing.md 规则添加注解。若改动涉及可复用 API 形态、运行时边界、builder/factory 模式或命名分层,须先路由到 north-star 并声明已更新或重申。验证按最小面进行:语义/插件行为用包测试,公开契约变化用类型测试,包装层变化才用 React 测试。
适用场景:编写或重构 Plate 插件、设计插件 API 与包装层。限制:不负责公开文档;不在本技能重复 north-star 的法条与反模式;现有资料未提供具体版本、收费或平台支持信息。