refactor: refine method naming

loro-dev · Jul 28, 2024 · 4421987 · 4421987
1 parent c634077
commit 4421987
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 15 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -7,7 +7,7 @@ export {
 export type { LoroDocType } from "./lib";
 export {
   createNodeFromLoroObj,
-  updateLoroOnPmChange,
+  updateLoroToPmState,
   ROOT_DOC_KEY,
   NODE_NAME_KEY,
   CHILDREN_KEY,

diff --git a/src/lib.ts b/src/lib.ts
@@ -62,13 +62,12 @@ export const NODE_NAME_KEY = "nodeName";
  */
 export const WEAK_NODE_TO_LORO_CONTAINER_MAPPING = new WeakMap<Node, ContainerID>();
 
-export function updateLoroOnPmChange(
+export function updateLoroToPmState(
   doc: LoroDocType,
   mapping: LoroNodeMapping,
-  oldEditorState: EditorState,
-  newEditorState: EditorState,
+  editorState: EditorState,
 ) {
-  const node = newEditorState.doc;
+  const node = editorState.doc;
   const map = doc.getMap(ROOT_DOC_KEY);
 
   let isInit = false;

diff --git a/src/sync-plugin.ts b/src/sync-plugin.ts
@@ -12,7 +12,7 @@ import {
   LoroNodeMapping,
   clearChangedNodes,
   createNodeFromLoroObj,
-  updateLoroOnPmChange,
+  updateLoroToPmState,
 } from "./lib";
 
 export const loroSyncPluginKey = new PluginKey<LoroSyncPluginState>("loro-sync");
@@ -68,7 +68,7 @@ export const LoroSyncPlugin = (props: LoroSyncPluginProps): Plugin => {
         }
         switch (meta?.type) {
           case "doc-changed":
-            updateLoroOnPmChange(state.doc as LoroDocType, state.mapping, oldEditorState, newEditorState);
+            updateLoroToPmState(state.doc as LoroDocType, state.mapping, oldEditorState, newEditorState);
             break;
           case "update-state":
             state = { ...state, ...meta.state };

diff --git a/tests/basic.test.ts b/tests/basic.test.ts
@@ -12,7 +12,7 @@ import {
   createNodeFromLoroObj,
   getLoroMapAttributes,
   getLoroMapChildren,
-  updateLoroOnPmChange,
+  updateLoroToPmState,
 } from "../src/lib";
 
 import { schema } from "./schema";
@@ -198,7 +198,7 @@ describe("updateDoc", () => {
     const editorState = createEditorState(schema, examplePmContent.doc);
     const loroDoc: LoroDocType = new Loro();
     const mapping: LoroNodeMapping = new Map();
-    updateLoroOnPmChange(loroDoc, mapping, editorState, editorState);
+    updateLoroToPmState(loroDoc, mapping, editorState, editorState);
     expect(loroDoc.toJSON()).toEqual(exampleLoroContent);
   });
 
@@ -212,7 +212,7 @@ describe("updateDoc", () => {
     pmContent["content"] = [];
     let editorState = createEditorState(schema, pmContent);
 
-    updateLoroOnPmChange(loroDoc, mapping, editorState, editorState);
+    updateLoroToPmState(loroDoc, mapping, editorState, editorState);
     expect(loroDoc.toJSON()).toEqual({
       [ROOT_DOC_KEY]: {
         nodeName: ROOT_DOC_KEY,
@@ -228,7 +228,7 @@ describe("updateDoc", () => {
     });
     editorState = createEditorState(schema, pmContent);
 
-    updateLoroOnPmChange(loroDoc, mapping, editorState, editorState);
+    updateLoroToPmState(loroDoc, mapping, editorState, editorState);
     expect(loroDoc.toJSON()).toEqual({
       [ROOT_DOC_KEY]: {
         nodeName: ROOT_DOC_KEY,
@@ -250,7 +250,7 @@ describe("updateDoc", () => {
     });
     editorState = createEditorState(schema, pmContent);
 
-    updateLoroOnPmChange(loroDoc, mapping, editorState, editorState);
+    updateLoroToPmState(loroDoc, mapping, editorState, editorState);
     expect(loroDoc.toJSON()).toEqual({
       [ROOT_DOC_KEY]: {
         nodeName: ROOT_DOC_KEY,
@@ -287,7 +287,7 @@ describe("updateDoc", () => {
     });
     editorState = createEditorState(schema, pmContent);
 
-    updateLoroOnPmChange(loroDoc, mapping, editorState, editorState);
+    updateLoroToPmState(loroDoc, mapping, editorState, editorState);
     expect(loroDoc.toJSON()).toEqual({
       [ROOT_DOC_KEY]: {
         nodeName: ROOT_DOC_KEY,
@@ -343,7 +343,7 @@ describe("updateDoc", () => {
     });
     editorState = createEditorState(schema, pmContent);
 
-    updateLoroOnPmChange(loroDoc, mapping, editorState, editorState);
+    updateLoroToPmState(loroDoc, mapping, editorState, editorState);
     expect(loroDoc.toJSON()).toEqual({
       [ROOT_DOC_KEY]: {
         nodeName: ROOT_DOC_KEY,
@@ -395,7 +395,7 @@ describe("createNodeFromLoroObj", () => {
     const _editorState = createEditorState(schema, examplePmContent.doc);
     const loroDoc: LoroDocType = new Loro();
     const mapping: LoroNodeMapping = new Map();
-    updateLoroOnPmChange(loroDoc, mapping, _editorState, _editorState);
+    updateLoroToPmState(loroDoc, mapping, _editorState, _editorState);
 
     const node = createNodeFromLoroObj(
       schema,