feat: make text editor selections setter async in preparation for neovim (#2268)

## Checklist

- [ ] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [ ] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [ ] I have not broken the cheatsheet

I am making this small pr to be reviewed now. This is to make it easier
to merge the neovim branch later.

---------

Co-authored-by: Cedric Halbronn <cedric.halbronn@nccgroup.com>
Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>

Author: 3 people

packages/common/src/types/TextEditor.ts

@@ -54,7 +54,7 @@ export interface TextEditor {
 }
 
 export interface EditableTextEditor extends TextEditor {
-  selections: Selection[];
+  setSelections(selections: Selection[]): Promise<void>;
 
   options: TextEditorOptions;
 

packages/cursorless-engine/src/actions/BringMoveSwap.ts

@@ -209,7 +209,10 @@ abstract class BringMoveSwap {
           // NB: We set the selections here because we don't trust vscode to
           // properly move the cursor on a bring. Sometimes it will smear an
           // empty selection
-          setSelectionsWithoutFocusingEditor(editableEditor, cursorSelections);
+          await setSelectionsWithoutFocusingEditor(
+            editableEditor,
+            cursorSelections,
+          );
 
           const marks = [
             ...this.getMarks(sourceEdits, updatedSourceEditSelections),

packages/cursorless-engine/src/actions/CallbackAction.ts

@@ -116,7 +116,7 @@ export class CallbackAction {
       // very end. This code can run on multiple editors in the course of
       // one command, so we want to avoid focusing the editor multiple
       // times.
-      setSelectionsWithoutFocusingEditor(
+      await setSelectionsWithoutFocusingEditor(
         editableEditor,
         updatedOriginalSelections,
       );

packages/cursorless-engine/src/actions/Deselect.ts

@@ -24,7 +24,7 @@ export default class Deselect implements SimpleAction {
         throw new SelectionRequiredError();
       }
 
-      setSelectionsWithoutFocusingEditor(
+      await setSelectionsWithoutFocusingEditor(
         ide().getEditableTextEditor(editor),
         newSelections,
       );

packages/cursorless-engine/src/actions/GenerateSnippet/GenerateSnippet.ts

@@ -222,7 +222,9 @@ export default class GenerateSnippet {
 
     if (isTesting()) {
       // If we're testing, we just overwrite the current document
-      editableEditor.selections = [editor.document.range.toSelection(false)];
+      await editableEditor.setSelections([
+        editor.document.range.toSelection(false),
+      ]);
     } else {
       // Otherwise, we create and open a new document for the snippet in the
       // user snippets dir

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

@@ -86,7 +86,10 @@ class InsertCopy implements SimpleAction {
       ([edit, selection]) => edit!.updateRange(selection!),
     );
 
-    setSelectionsWithoutFocusingEditor(editableEditor, updatedCursorSelections);
+    await setSelectionsWithoutFocusingEditor(
+      editableEditor,
+      updatedCursorSelections,
+    );
     const primarySelection = editor.selections[0];
 
     if (

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

@@ -61,7 +61,7 @@ class InsertEmptyLines implements SimpleAction {
             ],
           );
 
-        setSelectionsWithoutFocusingEditor(
+        await setSelectionsWithoutFocusingEditor(
           editableEditor,
           updatedCursorSelections,
         );

packages/cursorless-engine/src/actions/PasteFromClipboard.ts

@@ -60,7 +60,7 @@ export class PasteFromClipboard {
     // Reset cursors on the editor where the edits took place.
     // NB: We don't focus the editor here because we want to focus the original
     // editor, not the one where the edits took place
-    setSelectionsWithoutFocusingEditor(editor, updatedCursorSelections);
+    await setSelectionsWithoutFocusingEditor(editor, updatedCursorSelections);
 
     // If necessary focus back original editor
     if (originalEditor != null && !originalEditor.isActive) {

packages/cursorless-engine/src/actions/Wrap.ts

@@ -111,7 +111,10 @@ export default class Wrap {
           ],
         );
 
-        setSelectionsWithoutFocusingEditor(editableEditor, cursorSelections);
+        await setSelectionsWithoutFocusingEditor(
+          editableEditor,
+          cursorSelections,
+        );
 
         await ide().flashRanges(
           delimiterSelections.map((selection) => ({

packages/cursorless-engine/src/util/setSelectionsAndFocusEditor.ts

@@ -9,7 +9,7 @@ export async function setSelectionsAndFocusEditor(
   selections: Selection[],
   revealRange: boolean = true,
 ) {
-  setSelectionsWithoutFocusingEditor(editor, selections);
+  await setSelectionsWithoutFocusingEditor(editor, selections);
 
   if (revealRange) {
     await editor.revealRange(editor.selections[0]);
@@ -20,13 +20,15 @@ export async function setSelectionsAndFocusEditor(
   await editor.focus();
 }
 
-export function setSelectionsWithoutFocusingEditor(
+export async function setSelectionsWithoutFocusingEditor(
   editor: EditableTextEditor,
   selections: Selection[],
 ) {
-  editor.selections = uniqWithHash(
-    selections,
-    (a, b) => a.isEqual(b),
-    (s) => s.concise(),
+  await editor.setSelections(
+    uniqWithHash(
+      selections,
+      (a, b) => a.isEqual(b),
+      (s) => s.concise(),
+    ),
   );
 }