Fix bug in range updater when using CRLF line endings (#3263)

Fixes #3260

Author: AndreasArvidsson

packages/lib-engine/src/actions/Actions.ts

@@ -22,13 +22,10 @@ import GetText from "./GetText";
 import Highlight from "./Highlight";
 import { Decrement, Increment } from "./incrementDecrement";
 import { IndentLine, OutdentLine } from "./IndentLine";
+import { InsertCopyAfter, InsertCopyBefore } from "./InsertCopy";
 import {
-  CopyContentAfter as InsertCopyAfter,
-  CopyContentBefore as InsertCopyBefore,
-} from "./InsertCopy";
-import {
-  InsertEmptyLineBelow as InsertEmptyLineAfter,
-  InsertEmptyLineAbove as InsertEmptyLineBefore,
+  InsertEmptyLineAfter,
+  InsertEmptyLineBefore,
   InsertEmptyLinesAround,
 } from "./InsertEmptyLines";
 import InsertSnippet from "./InsertSnippet";

packages/lib-engine/src/actions/InsertCopy.ts

@@ -99,7 +99,7 @@ class InsertCopy implements SimpleAction {
   }
 }
 
-export class CopyContentBefore extends InsertCopy {
+export class InsertCopyBefore extends InsertCopy {
   constructor(
     ide: IDE,
     rangeUpdater: RangeUpdater,
@@ -109,7 +109,7 @@ export class CopyContentBefore extends InsertCopy {
   }
 }
 
-export class CopyContentAfter extends InsertCopy {
+export class InsertCopyAfter extends InsertCopy {
   constructor(
     ide: IDE,
     rangeUpdater: RangeUpdater,

packages/lib-engine/src/actions/InsertEmptyLines.ts

@@ -103,13 +103,13 @@ export class InsertEmptyLinesAround extends InsertEmptyLines {
   }
 }
 
-export class InsertEmptyLineAbove extends InsertEmptyLines {
+export class InsertEmptyLineBefore extends InsertEmptyLines {
   protected getEdits(targets: Target[]) {
     return targets.map((target) => constructChangeEdit(target, "before"));
   }
 }
 
-export class InsertEmptyLineBelow extends InsertEmptyLines {
+export class InsertEmptyLineAfter extends InsertEmptyLines {
   protected getEdits(targets: Target[]) {
     return targets.map((target) => constructChangeEdit(target, "after"));
   }

packages/lib-engine/src/core/updateSelections/updateSelections.test.ts

@@ -0,0 +1,71 @@
+import * as assert from "node:assert/strict";
+import type {
+  Disposable,
+  TextDocumentChangeEvent,
+} from "@cursorless/lib-common";
+import {
+  FakeIDE,
+  InMemoryTextEditor,
+  Range,
+  Selection,
+} from "@cursorless/lib-common";
+import { RangeUpdater } from "./RangeUpdater";
+import { performEditsAndUpdateSelections } from "./updateSelections";
+
+suite("performEditsAndUpdateSelections", () => {
+  test("treats CRLF-normalized replace inserts as replace edits", async () => {
+    const ide = new TestIDE();
+    const editor = new InMemoryTextEditor({
+      ide,
+      content: "abc\r\ndef",
+    });
+    const rangeUpdater = new RangeUpdater(ide);
+    const selection = new Selection(0, 3, 0, 3);
+
+    const { updated } = await performEditsAndUpdateSelections({
+      rangeUpdater,
+      editor,
+      edits: [
+        {
+          range: new Range(0, 3, 0, 3),
+          text: "\n",
+          isReplace: true,
+        },
+      ],
+      preserveCursorSelections: true,
+      selections: { updated: [selection] },
+    });
+
+    assert.equal(editor.document.getText(), "abc\r\n\r\ndef");
+    assert.equal(updated.length, 1);
+    assert.equal(updated[0].anchor.line, 0);
+    assert.equal(updated[0].anchor.character, 3);
+    assert.equal(updated[0].active.line, 0);
+    assert.equal(updated[0].active.character, 3);
+  });
+});
+
+class TestIDE extends FakeIDE {
+  private textDocumentChangeListeners: ((
+    event: TextDocumentChangeEvent,
+  ) => void)[] = [];
+
+  override onDidChangeTextDocument = (
+    listener: (event: TextDocumentChangeEvent) => void,
+  ): Disposable => {
+    this.textDocumentChangeListeners.push(listener);
+
+    return {
+      dispose: () => {
+        this.textDocumentChangeListeners =
+          this.textDocumentChangeListeners.filter(
+            (candidate) => candidate !== listener,
+          );
+      },
+    };
+  };
+
+  override emitDidChangeTextDocument = (event: TextDocumentChangeEvent) => {
+    this.textDocumentChangeListeners.forEach((listener) => listener(event));
+  };
+}

packages/lib-engine/src/util/performDocumentEdits.ts

@@ -6,9 +6,16 @@ export async function performDocumentEdits(
   editor: EditableTextEditor,
   edits: Edit[],
 ) {
+  const eol = editor.document.eol === "LF" ? "\n" : "\r\n";
+
   const deregister = rangeUpdater.registerReplaceEditList(
     editor.document,
-    edits.filter((edit) => edit.isReplace),
+    edits
+      .filter((edit) => edit.isReplace)
+      .map((edit) => ({
+        ...edit,
+        text: edit.text.replaceAll(/\r?\n/g, eol),
+      })),
   );
 
   try {

resources/fixtures/recorded/actions/insertEmptyLines/floatLine.yml

@@ -0,0 +1,30 @@
+languageId: plaintext
+command:
+  version: 7
+  spokenForm: float line
+  action:
+    name: insertEmptyLineAfter
+    target:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: line}
+  usePrePhraseSnapshot: false
+initialState:
+  documentContents: "abc\r\ndef"
+  selections:
+    - anchor: {line: 0, character: 3}
+      active: {line: 0, character: 3}
+  marks: {}
+finalState:
+  documentContents: "abc\r\n\r\ndef"
+  selections:
+    - anchor: {line: 0, character: 3}
+      active: {line: 0, character: 3}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 0, character: 0}
+        end: {line: 0, character: 3}
+      isReversed: false
+      hasExplicitRange: true