chore: updated getListItemsToTransform

makhnatkin · makhnatkin · commit ccaef16bfc1d · 2025-06-03T11:08:14.000+02:00
diff --git a/src/extensions/markdown/Lists/commands.test.ts b/src/extensions/markdown/Lists/commands.test.ts
@@ -1,37 +1,34 @@
 // eslint-disable-next-line import/no-extraneous-dependencies
-import ist from 'ist';
-import type {Node} from 'prosemirror-model';
+import {Schema} from 'prosemirror-model';
+import {builders, li, ul} from 'prosemirror-test-builder';
+
 import {
-    type Command,
-    EditorState,
-    NodeSelection,
-    Selection,
-    TextSelection,
-} from 'prosemirror-state';
-import {doc, eq, li, p, schema, ul} from 'prosemirror-test-builder';
-
-import {sinkOnlySelectedListItem} from 'src/extensions/markdown/Lists/commands';
-
-function selFor(doc: Node) {
-    const a = (doc as any).tag.a,
-        b = (doc as any).tag.b;
-    if (a !== null) {
-        const $a = doc.resolve(a);
-        if ($a.parent.inlineContent)
-            return new TextSelection($a, b !== null ? doc.resolve(b) : undefined);
-        else return new NodeSelection($a);
-    }
-    return Selection.atStart(doc);
-}
-
-function apply(doc: Node, command: Command, result: Node | null) {
-    let state = EditorState.create({doc, selection: selFor(doc)});
-    // eslint-disable-next-line no-return-assign
-    command(state, (tr) => (state = state.apply(tr)));
-    ist(state.doc, result || doc, eq);
-    // eslint-disable-next-line no-eq-null
-    if (result && (result as any).tag.a != null) ist(state.selection, selFor(result), eq);
-}
+    getListItemsToTransform,
+    sinkOnlySelectedListItem,
+} from 'src/extensions/markdown/Lists/commands';
+import {apply, assertMapEntries, getParams} from 'src/extensions/markdown/Lists/testUtils';
+import {getSchemaSpecs as getYfmNoteSchemaSpecs} from 'src/extensions/yfm/YfmNote/YfmNoteSpecs/schema';
+
+const schema = new Schema({
+    nodes: {
+        doc: {content: 'block+'},
+        text: {group: 'inline'},
+        paragraph: {
+            group: 'block',
+            content: 'inline*',
+            toDOM: () => ['p', 0],
+        },
+        ...getYfmNoteSchemaSpecs(),
+    },
+});
+
+const {
+    doc,
+    paragraph: p,
+    yfm_note: note,
+    yfm_note_title: noteTitle,
+    yfm_note_content: noteContent,
+} = builders(schema);
 
 describe('sinkOnlySelectedListItem', () => {
     const sink = sinkOnlySelectedListItem(schema.nodes.list_item);
@@ -289,3 +286,98 @@ describe('sinkOnlySelectedListItem', () => {
             doc(ul(li(p('11'), ul(li(p('22')))), li(p('33')))),
         ));
 });
+
+describe('getListItemsToTransform (using getParams helper)', () => {
+    it('1', () => {
+        const testDoc = doc(ul(li(p('11')), li(p('2<a><b>2')), li(p('33'))));
+
+        const resultMap = getListItemsToTransform(...getParams(testDoc));
+
+        assertMapEntries(resultMap, [[7, 13]]);
+    });
+
+    it('2', () => {
+        const testDoc = doc(ul(li(p('11')), li(p('2<a>2')), li(p('3<b>3'))));
+
+        const resultMap = getListItemsToTransform(...getParams(testDoc));
+
+        assertMapEntries(resultMap, [
+            [7, 13],
+            [13, 19],
+        ]);
+    });
+
+    it('3', () => {
+        const testDoc = doc(ul(li(p('11')), li(p('2<a>2'), ul(li(p('3<b>3'))))));
+        const resultMap = getListItemsToTransform(...getParams(testDoc));
+
+        assertMapEntries(resultMap, [
+            [7, 21],
+            [13, 19],
+        ]);
+    });
+
+    it('4', () => {
+        const testDoc = doc(ul(li(p('11')), li(p('2<a>2'), ul(li(p('33')))), li(p('4<b>4'))));
+        const resultMap = getListItemsToTransform(...getParams(testDoc));
+
+        assertMapEntries(resultMap, [
+            [7, 21],
+            [13, 19],
+            [21, 27],
+        ]);
+    });
+
+    it('5', () => {
+        const testDoc = doc(ul(li(p('11'), ul(li(p('22')), li(p('3<a>3')))), li(p('4<b>4'))));
+        const resultMap = getListItemsToTransform(...getParams(testDoc));
+
+        assertMapEntries(resultMap, [
+            [13, 19],
+            [21, 27],
+        ]);
+    });
+
+    it('6', () => {
+        const testDoc = doc(
+            ul(
+                li(p('11')),
+                li(p('2<a>2'), ul(li(p('33'), ul(li(p('44')))), li(p('55')))),
+                li(p('6<b>6')),
+            ),
+        );
+
+        const resultMap = getListItemsToTransform(...getParams(testDoc));
+
+        assertMapEntries(resultMap, [
+            [7, 35],
+            [13, 27],
+            [19, 25],
+            [27, 33],
+            [35, 41],
+        ]);
+    });
+
+    it('7', () => {
+        const testDoc = doc(
+            ul(
+                li(p('11')),
+                li(
+                    p('2<a>2'),
+                    note(noteTitle('Note'), noteContent(ul(li(p('33')), li(p('44')), li(p('55'))))),
+                ),
+                li(p('6<b>6')),
+            ),
+        );
+
+        const resultMap = getListItemsToTransform(...getParams(testDoc));
+
+        assertMapEntries(resultMap, [
+            [7, 43],
+            [43, 49],
+            [21, 27],
+            [27, 33],
+            [33, 39],
+        ]);
+    });
+});
diff --git a/src/extensions/markdown/Lists/commands.ts b/src/extensions/markdown/Lists/commands.ts
@@ -74,7 +74,7 @@ const sink = (tr: Transaction, range: NodeRange, itemType: NodeType) => {
     return true;
 };
 
-const isListItemNode = (node: Node, itemType: NodeType) =>
+export const isNotFirstListItemNode = (node: Node, itemType: NodeType) =>
     node.childCount > 0 && node.firstChild!.type === itemType;
 
 function findDeepestListItem(tr: Transaction, itemType: NodeType, start: number): [number, number] {
@@ -99,7 +99,7 @@ function findDeepestListItem(tr: Transaction, itemType: NodeType, start: number)
 /**
  * Returns a map of list item positions that should be transformed (e.g., sink or lift).
  */
-function getListItemsToTransform(
+export function getListItemsToTransform(
     tr: Transaction,
     itemType: NodeType,
     {
@@ -209,7 +209,7 @@ export function sinkOnlySelectedListItem(itemType: NodeType): Command {
     return ({tr, selection}, dispatch) => {
         const {$from, $to, from, to} = selection;
         const listItemSelectionRange = $from.blockRange($to, (node) =>
-            isListItemNode(node, itemType),
+            isNotFirstListItemNode(node, itemType),
         );
 
         if (!listItemSelectionRange) {
diff --git a/src/extensions/markdown/Lists/testUtils.ts b/src/extensions/markdown/Lists/testUtils.ts
@@ -0,0 +1,89 @@
+import ist from 'ist';
+import type {Node} from 'prosemirror-model';
+import {
+    type Command,
+    EditorState,
+    NodeSelection,
+    Selection,
+    TextSelection,
+} from 'prosemirror-state';
+import {eq, schema} from 'prosemirror-test-builder';
+
+import {liType} from 'src/extensions';
+import {isNotFirstListItemNode} from 'src/extensions/markdown/Lists/commands';
+
+export function selFor(doc: Node) {
+    const a = (doc as any).tag.a,
+        b = (doc as any).tag.b;
+    if (a !== null) {
+        const $a = doc.resolve(a);
+        if ($a.parent.inlineContent)
+            return new TextSelection($a, b !== null ? doc.resolve(b) : undefined);
+        else return new NodeSelection($a);
+    }
+    return Selection.atStart(doc);
+}
+
+export function apply(doc: Node, command: Command, result: Node | null) {
+    let state = EditorState.create({doc, selection: selFor(doc)});
+
+    // eslint-disable-next-line no-return-assign
+    command(state, (tr) => (state = state.apply(tr)));
+    ist(state.doc, result || doc, eq);
+
+    if (result && (result as any).tag.a !== null) {
+        ist(state.selection, selFor(result), eq);
+    }
+}
+
+type Tags = {[tag: string]: number};
+
+export function getParams(docNode: Node & {tag: Tags}) {
+    const state = EditorState.create({
+        doc: docNode,
+        selection: TextSelection.create(docNode, docNode.tag.a, docNode.tag.b),
+    });
+    const {tr, selection} = state;
+    const {$from, $to, from, to} = selection;
+    const itemType = liType(schema);
+    const range = $from.blockRange($to, (node) => isNotFirstListItemNode(node, itemType));
+
+    if (!range) {
+        return [tr, schema.nodes.list_item, {start: 0, end: 0, from: 0, to: 0}] as const;
+    }
+
+    return [tr, schema.nodes.list_item, {start: range.start, end: range.end, from, to}] as const;
+}
+
+export function assertMapEntries(
+    resultMap: Map<number, number>,
+    expectedEntries: Array<[number, number]>,
+) {
+    // 1) Check that there are no extra or missing entries.
+    console.log('111-3', resultMap.size);
+    console.log('111-4', expectedEntries.length);
+
+    console.log('111-5', resultMap.size === expectedEntries.length);
+
+    const x = resultMap.size;
+    const y = expectedEntries.length;
+
+    ist(x, y);
+
+    // 2) For each expected [key, value], verify presence and equality.
+    for (const [key, value] of expectedEntries) {
+        // Ensure the key exists
+        console.log('==--==--==-->', resultMap);
+        console.log('222-1', key);
+        console.log('222-2', resultMap.has(key));
+        console.log(
+            '222-3',
+            resultMap.forEach((key) => console.log(key)),
+        );
+        ist(resultMap.has(key), true);
+
+        // Ensure the stored value matches
+        ist(resultMap.get(key), value);
+        console.log('333-1', ist(resultMap.get(key), value));
+    }
+}
