Fix mergeNodes moving node into parent sibling (#4296)

* test: add test case for bug * prefer next will transforming selection in remove_node * add remove_node test * Add changeset * review: handle nested blocks * refactor * Revert "refactor" This reverts commit 45a8aab. Co-authored-by: Dylan Schiemann <dylan@dojotoolkit.org>
ianstormtaylor · Aug 11, 2021 · 479a759 · 479a759
1 parent 4dea740
commit 479a759
Show file tree

Hide file tree

Showing 8 changed files with 187 additions and 1 deletion.
diff --git a/.changeset/orange-jeans-sing.md b/.changeset/orange-jeans-sing.md
@@ -0,0 +1,5 @@
+---
+'slate': patch
+---
+
+Fix mergeNodes moving node into parent sibling
diff --git a/packages/slate/src/transforms/general.ts b/packages/slate/src/transforms/general.ts
@@ -150,7 +150,18 @@ const applyToDraft = (editor: Editor, selection: Selection, op: Operation) => {
               }
             }
 
-            if (prev) {
+            let preferNext = false
+            if (prev && next) {
+              if (Path.equals(next[1], path)) {
+                preferNext = !Path.hasPrevious(next[1])
+              } else {
+                preferNext =
+                  Path.common(prev[1], path).length <
+                  Path.common(next[1], path).length
+              }
+            }
+
+            if (prev && !preferNext) {
               point.path = prev[1]
               point.offset = prev[0].text.length
             } else if (next) {

diff --git a/packages/slate/test/normalization/text/merge-adjacent-empty-after-nested.tsx b/packages/slate/test/normalization/text/merge-adjacent-empty-after-nested.tsx
@@ -0,0 +1,28 @@
+/** @jsx jsx */
+import { jsx } from '../..'
+
+export const input = (
+  <editor>
+    <block>
+      <text />
+    </block>
+    <block>
+      <block>
+        <cursor />
+        <text />
+      </block>
+    </block>
+  </editor>
+)
+export const output = (
+  <editor>
+    <block>
+      <text />
+    </block>
+    <block>
+      <block>
+        <cursor />
+      </block>
+    </block>
+  </editor>
+)
diff --git a/packages/slate/test/normalization/text/merge-adjacent-empty-after.tsx b/packages/slate/test/normalization/text/merge-adjacent-empty-after.tsx
@@ -0,0 +1,24 @@
+/** @jsx jsx */
+import { jsx } from '../..'
+
+export const input = (
+  <editor>
+    <block>
+      <text />
+    </block>
+    <block>
+      <cursor />
+      <text />
+    </block>
+  </editor>
+)
+export const output = (
+  <editor>
+    <block>
+      <text />
+    </block>
+    <block>
+      <cursor />
+    </block>
+  </editor>
+)
diff --git a/packages/slate/test/operations/remove_node/cursor-nested.tsx b/packages/slate/test/operations/remove_node/cursor-nested.tsx
@@ -0,0 +1,35 @@
+/** @jsx jsx */
+import { jsx } from 'slate-hyperscript'
+
+export const input = (
+  <editor>
+    <element>
+      <text />
+    </element>
+    <element>
+      <element>
+        <cursor />
+        <text />
+      </element>
+    </element>
+  </editor>
+)
+export const operations = [
+  {
+    type: 'remove_node',
+    path: [1, 0, 0],
+    node: { text: '' },
+  },
+]
+export const output = (
+  <editor>
+    <element>
+      <text />
+    </element>
+    <element>
+      <element>
+        <cursor />
+      </element>
+    </element>
+  </editor>
+)
diff --git a/packages/slate/test/operations/remove_node/cursor.tsx b/packages/slate/test/operations/remove_node/cursor.tsx
@@ -0,0 +1,31 @@
+/** @jsx jsx */
+import { jsx } from 'slate-hyperscript'
+
+export const input = (
+  <editor>
+    <element>
+      <text />
+    </element>
+    <element>
+      <cursor />
+      <text />
+    </element>
+  </editor>
+)
+export const operations = [
+  {
+    type: 'remove_node',
+    path: [1, 0],
+    node: { text: '' },
+  },
+]
+export const output = (
+  <editor>
+    <element>
+      <text />
+    </element>
+    <element>
+      <cursor />
+    </element>
+  </editor>
+)
diff --git a/packages/slate/test/transforms/mergeNodes/path/text-hanging-nested.tsx b/packages/slate/test/transforms/mergeNodes/path/text-hanging-nested.tsx
@@ -0,0 +1,28 @@
+/** @jsx jsx */
+import { Transforms, Text } from 'slate'
+import { jsx } from '../../..'
+
+export const input = (
+  <editor>
+    <block>one</block>
+    <block>
+      <block>
+        <cursor />
+        <text />
+      </block>
+    </block>
+  </editor>
+)
+export const run = editor => {
+  Transforms.mergeNodes(editor, { at: [1, 0, 1], match: Text.isText })
+}
+export const output = (
+  <editor>
+    <block>one</block>
+    <block>
+      <block>
+        <cursor />
+      </block>
+    </block>
+  </editor>
+)
diff --git a/packages/slate/test/transforms/mergeNodes/path/text-hanging.tsx b/packages/slate/test/transforms/mergeNodes/path/text-hanging.tsx
@@ -0,0 +1,24 @@
+/** @jsx jsx */
+import { Transforms, Text } from 'slate'
+import { jsx } from '../../..'
+
+export const input = (
+  <editor>
+    <block>one</block>
+    <block>
+      <cursor />
+      <text />
+    </block>
+  </editor>
+)
+export const run = editor => {
+  Transforms.mergeNodes(editor, { at: [1, 1], match: Text.isText })
+}
+export const output = (
+  <editor>
+    <block>one</block>
+    <block>
+      <cursor />
+    </block>
+  </editor>
+)