Implement our own types instead of vscode (#1128)

* Started working on our own replacement for vscode types

* remove unused imports

* More workl

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* more changes

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* More stuff

* Stuff stuff

* Some super secret clean up stuff

* Additional changes beyond human comprehension

* clean up

* Trans dimensional super fixes

* Mind boggling changes

* Hopefully done with this suffering

* Fixed circular dependencies

* Updated fake ide

* Added test for position

* Added range test

* Added getter to vscode editable editor implementation

* Convert position

* Added text line implementation

* Better handling of selections

* group  document by uri

* Remove on use to vscode converter

* Clean up tests

* Make sure functions use arrow format

* Use weak map to keep track of text editors

* cleanup

* empty

* use arrow functions

* updated lock file

* restore normal methods for position and range

* Remove arrow expressions as method

* added is active on the text editor

* Error when trying to deselect all selections

* added types

* Make use of `@cursorless` imports

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Moved vscode utilities

* update

* Fixed stupid bug

* empty

* stuff

* stuff

* Added to empty range on position

* cleaned up vscode edit

* clean up

* clean up vscode focus editor

* move creation of text editors into ide

* cleanup

* moved get node at location into editor

* empty

* remove spread

* Add license reference

* use full vscode implementation

* Revert "moved get node at location into editor"

This reverts commit 4c2ec1c.

* remove location type

* Switch `getNodeAtLocation` to use document

* Use editable editor for performing edits

* Add `ide` reference to editable text editor

* docs

* Tweak

* tweak

* Fix bug with id / editor generation

* Remove unnecessary functions

* Tweak name

* merged vscode text editor implementations

* Add back comments about range adjustment

* Tweak docstrings

* docs

* add a couple tests

* Updated line behavior

* Test tweaks

* updated behavior

* added selection isEqual

* `isEqual` => `isRangeEqual`

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* cleanup

* Capture more unit tests in launch config

* move `openNewEditor`

* Basic `TextLine` test

* Selection + more range tests

* yarn.lock tweak

* more line tests

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>

Author: 3 people

.eslintrc.json

@@ -48,13 +48,7 @@
 			}
 		],
 		"no-throw-literal": "warn",
-		"semi": "off",
-		"no-restricted-properties": [
-			2,
-			{
-				"property": "activeTextEditor"
-			}
-		]
+		"semi": "off"
 	},
 	"ignorePatterns": ["**/vendor/**/*.ts", "**/vendor/**/*.js"]
 }

package.json

@@ -590,18 +590,20 @@
 		"@types/chai": "^4.3.3",
 		"@types/glob": "^7.1.3",
 		"@types/js-yaml": "^4.0.2",
+		"@types/lodash": "^4.14.168",
 		"@types/mocha": "^8.0.4",
 		"@types/node": "^16.11.3",
 		"@types/semver": "^7.3.9",
 		"@types/sinon": "^10.0.2",
+		"@types/uuid": "^8.3.4",
 		"@types/vscode": "~1.61.0",
 		"@typescript-eslint/eslint-plugin": "^5.20.0",
 		"@typescript-eslint/parser": "^5.20.0",
 		"@vscode/test-electron": "^2.1.3",
 		"chai": "^4.3.6",
 		"esbuild": "^0.11.12",
-		"eslint": "^8.13.0",
 		"eslint-config-prettier": "^8.5.0",
+		"eslint": "^8.13.0",
 		"fast-xml-parser": "^3.20.0",
 		"glob": "^7.1.7",
 		"js-yaml": "^4.1.0",
@@ -615,12 +617,12 @@
 		"typescript": "4.6.3"
 	},
 	"dependencies": {
-		"@types/lodash": "^4.14.168",
 		"immer": "^9.0.15",
 		"immutability-helper": "^3.1.1",
 		"itertools": "^1.7.1",
 		"lodash": "^4.17.21",
 		"node-html-parser": "^5.3.3",
+		"uuid": "^9.0.0",
 		"vscode-uri": "^3.0.6"
 	}
 }

src/actions/BringMoveSwap.ts

@@ -1,12 +1,13 @@
+import { Selection, TextEditor } from "@cursorless/common";
 import { flatten } from "lodash";
-import { DecorationRangeBehavior, Selection, TextEditor } from "vscode";
+import { DecorationRangeBehavior } from "vscode";
 import {
   getSelectionInfo,
   performEditsAndUpdateFullSelectionInfos,
 } from "../core/updateSelections/updateSelections";
+import ide from "../libs/cursorless-engine/singletons/ide.singleton";
 import { Target } from "../typings/target.types";
 import { EditWithRangeUpdater, Graph } from "../typings/Types";
-import { selectionFromRange } from "../util/selectionUtils";
 import { setSelectionsWithoutFocusingEditor } from "../util/setSelectionsAndFocusEditor";
 import { getContentRange, runForEachEditor } from "../util/targetUtils";
 import { unifyRemovalTargets } from "../util/unifyRanges";
@@ -167,7 +168,7 @@ class BringMoveSwap implements Action {
             ({ edit: { range }, originalTarget }) =>
               getSelectionInfo(
                 editor.document,
-                selectionFromRange(originalTarget.isReversed, range),
+                range.toSelection(originalTarget.isReversed),
                 DecorationRangeBehavior.OpenOpen,
               ),
           );
@@ -180,26 +181,28 @@ class BringMoveSwap implements Action {
             ),
           );
 
+          const editableEditor = ide().getEditableTextEditor(editor);
+
           const [updatedEditSelections, cursorSelections]: Selection[][] =
             await performEditsAndUpdateFullSelectionInfos(
               this.graph.rangeUpdater,
-              editor,
+              editableEditor,
               filteredEdits.map(({ edit }) => edit),
               [editSelectionInfos, cursorSelectionInfos],
             );
 
           // 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(editor, cursorSelections);
+          setSelectionsWithoutFocusingEditor(editableEditor, cursorSelections);
 
           return edits.map((edit, index): MarkEntry => {
             const selection = updatedEditSelections[index];
             const range = edit.edit.updateRange(selection);
             const target = edit.originalTarget;
             return {
               editor,
-              selection: selectionFromRange(target.isReversed, range),
+              selection: range.toSelection(target.isReversed),
               isSource: edit.isSource,
               target,
             };

src/actions/Clear.ts

@@ -1,3 +1,4 @@
+import ide from "../libs/cursorless-engine/singletons/ide.singleton";
 import { PlainTarget } from "../processTargets/targets";
 import { Target } from "../typings/target.types";
 import { Graph } from "../typings/Types";
@@ -29,7 +30,7 @@ export default class Clear implements Action {
 
     if (thatMark != null) {
       await setSelectionsAndFocusEditor(
-        editor,
+        ide().getEditableTextEditor(editor),
         thatMark.map(({ selection }) => selection),
       );
     }

src/actions/CommandAction.ts

@@ -2,10 +2,10 @@ import { flatten } from "lodash";
 import { commands } from "vscode";
 import { selectionToThatTarget } from "../core/commandRunner/selectionToThatTarget";
 import { callFunctionAndUpdateSelections } from "../core/updateSelections/updateSelections";
+import ide from "../libs/cursorless-engine/singletons/ide.singleton";
 import { Target } from "../typings/target.types";
 import { Graph } from "../typings/Types";
 import {
-  focusEditor,
   setSelectionsAndFocusEditor,
   setSelectionsWithoutFocusingEditor,
 } from "../util/setSelectionsAndFocusEditor";
@@ -15,7 +15,6 @@ import {
   runOnTargetsForEachEditor,
 } from "../util/targetUtils";
 import { Action, ActionReturnValue } from "./actions.types";
-import { getActiveTextEditor } from "../ide/vscode/activeTextEditor";
 
 export interface CommandOptions {
   command?: string;
@@ -53,7 +52,11 @@ export default class CommandAction implements Action {
         );
 
         // For command to the work we have to have the correct editor focused
-        await setSelectionsAndFocusEditor(editor, targetSelections, false);
+        await setSelectionsAndFocusEditor(
+          ide().getEditableTextEditor(editor),
+          targetSelections,
+          false,
+        );
 
         const [updatedOriginalSelections, updatedTargetSelections] =
           await callFunctionAndUpdateSelections(
@@ -70,7 +73,10 @@ export default class CommandAction implements Action {
           // 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(editor, updatedOriginalSelections);
+          setSelectionsWithoutFocusingEditor(
+            ide().getEditableTextEditor(editor),
+            updatedOriginalSelections,
+          );
         }
 
         // If the document hasn't changed then we just return the original targets
@@ -120,7 +126,7 @@ export default class CommandAction implements Action {
       ensureSingleTarget(targets);
     }
 
-    const originalEditor = getActiveTextEditor();
+    const originalEditor = ide().activeEditableTextEditor;
 
     const thatTargets = await this.runCommandAndUpdateSelections(
       targets,
@@ -131,12 +137,12 @@ export default class CommandAction implements Action {
     if (
       actualOptions.restoreSelection &&
       originalEditor != null &&
-      originalEditor !== getActiveTextEditor()
+      !originalEditor.isActive
     ) {
       // NB: We just do one editor focus at the end, instead of using
       // setSelectionsAndFocusEditor because the command might operate on
       // multiple editors, so we just do one focus at the end.
-      await focusEditor(originalEditor);
+      await originalEditor.focus();
     }
 
     return { thatTargets };

src/actions/Deselect.ts

@@ -1,4 +1,4 @@
-import { Selection } from "vscode";
+import ide from "../libs/cursorless-engine/singletons/ide.singleton";
 import { Target } from "../typings/target.types";
 import { Graph } from "../typings/Types";
 import { setSelectionsWithoutFocusingEditor } from "../util/setSelectionsAndFocusEditor";
@@ -20,12 +20,14 @@ export default class Deselect implements Action {
             return intersection && (!intersection.isEmpty || selection.isEmpty);
           }),
       );
-      // The editor requires at least one selection. Keep "primary" selection active
+
+      if (newSelections.length === 0) {
+        throw new SelectionRequiredError();
+      }
+
       setSelectionsWithoutFocusingEditor(
-        editor,
-        newSelections.length > 0
-          ? newSelections
-          : [new Selection(editor.selection.active, editor.selection.active)],
+        ide().getEditableTextEditor(editor),
+        newSelections,
       );
     });
 
@@ -34,3 +36,10 @@ export default class Deselect implements Action {
     };
   }
 }
+
+class SelectionRequiredError extends Error {
+  constructor() {
+    super("Can't deselect every selection. At least one is required");
+    this.name = "SelectionRequiredError";
+  }
+}

src/actions/EditNew/EditNew.ts

@@ -1,16 +1,16 @@
+import ide from "../../libs/cursorless-engine/singletons/ide.singleton";
 import { containingLineIfUntypedStage } from "../../processTargets/modifiers/commonContainingScopeIfUntypedStages";
 import PositionStage from "../../processTargets/modifiers/PositionStage";
 import { ModifierStage } from "../../processTargets/PipelineStages.types";
 import { Target } from "../../typings/target.types";
 import { Graph } from "../../typings/Types";
-import { selectionFromRange } from "../../util/selectionUtils";
 import { setSelectionsAndFocusEditor } from "../../util/setSelectionsAndFocusEditor";
 import { createThatMark, ensureSingleEditor } from "../../util/targetUtils";
 import { Action, ActionReturnValue } from "../actions.types";
 import { State } from "./EditNew.types";
-import { runNotebookCellTargets } from "./runNotebookCellTargets";
 import { runCommandTargets } from "./runCommandTargets";
 import { runEditTargets } from "./runEditTargets";
+import { runNotebookCellTargets } from "./runNotebookCellTargets";
 
 export class EditNew implements Action {
   getFinalStages(): ModifierStage[] {
@@ -29,7 +29,9 @@ export class EditNew implements Action {
       return runNotebookCellTargets(this.graph, targets);
     }
 
-    const editor = ensureSingleEditor(targets);
+    const editableEditor = ide().getEditableTextEditor(
+      ensureSingleEditor(targets),
+    );
 
     /**
      * Keeps track of the desired cursor positions and "that" marks as we
@@ -41,13 +43,13 @@ export class EditNew implements Action {
       cursorRanges: new Array(targets.length).fill(undefined) as undefined[],
     };
 
-    state = await runCommandTargets(this.graph, editor, state);
-    state = await runEditTargets(this.graph, editor, state);
+    state = await runCommandTargets(this.graph, editableEditor, state);
+    state = await runEditTargets(this.graph, editableEditor, state);
 
     const newSelections = state.targets.map((target, index) =>
-      selectionFromRange(target.isReversed, state.cursorRanges[index]!),
+      state.cursorRanges[index]!.toSelection(target.isReversed),
     );
-    await setSelectionsAndFocusEditor(editor, newSelections);
+    await setSelectionsAndFocusEditor(editableEditor, newSelections);
 
     return {
       thatSelections: createThatMark(state.targets, state.thatRanges),

src/actions/EditNew/EditNew.types.ts

@@ -1,5 +1,5 @@
-import { Range } from "vscode";
-import { Target } from "../../typings/target.types";
+import type { Range } from "@cursorless/common";
+import type { Target } from "../../typings/target.types";
 
 /**
  * Internal type to be used for storing a reference to a target that will use a

src/actions/EditNew/runCommandTargets.ts

@@ -1,4 +1,5 @@
-import { commands, TextEditor } from "vscode";
+import { EditableTextEditor } from "@cursorless/common";
+import { commands } from "vscode";
 import { callFunctionAndUpdateRanges } from "../../core/updateSelections/updateSelections";
 import { Graph } from "../../typings/Types";
 import { CommandTarget, State } from "./EditNew.types";
@@ -16,7 +17,7 @@ import { CommandTarget, State } from "./EditNew.types";
  */
 export async function runCommandTargets(
   graph: Graph,
-  editor: TextEditor,
+  editor: EditableTextEditor,
   state: State,
 ): Promise<State> {
   const commandTargets: CommandTarget[] = state.targets

src/actions/EditNew/runEditTargets.ts

@@ -1,5 +1,6 @@
+import { Selection, EditableTextEditor } from "@cursorless/common";
 import { zip } from "lodash";
-import { DecorationRangeBehavior, Range, Selection, TextEditor } from "vscode";
+import { DecorationRangeBehavior } from "vscode";
 import { performEditsAndUpdateSelectionsWithBehavior } from "../../core/updateSelections/updateSelections";
 import { Graph } from "../../typings/Types";
 import { EditTarget, State } from "./EditNew.types";
@@ -19,7 +20,7 @@ import { EditTarget, State } from "./EditNew.types";
  */
 export async function runEditTargets(
   graph: Graph,
-  editor: TextEditor,
+  editor: EditableTextEditor,
   state: State,
 ): Promise<State> {
   const editTargets: EditTarget[] = state.targets
@@ -43,7 +44,7 @@ export async function runEditTargets(
   );
 
   const thatSelections = {
-    selections: state.thatRanges.map(toSelection),
+    selections: state.thatRanges.map((r) => r.toSelection(false)),
   };
 
   // We need to remove undefined cursor locations.  Note that these undefined
@@ -57,11 +58,11 @@ export async function runEditTargets(
   const cursorIndices = cursorInfos.map(({ index }) => index);
 
   const cursorSelections = {
-    selections: cursorInfos.map(({ range }) => toSelection(range!)),
+    selections: cursorInfos.map(({ range }) => range!.toSelection(false)),
   };
 
   const editSelections = {
-    selections: edits.map((edit) => toSelection(edit.range)),
+    selections: edits.map((edit) => edit.range.toSelection(false)),
     rangeBehavior: DecorationRangeBehavior.OpenOpen,
   };
 
@@ -96,7 +97,3 @@ export async function runEditTargets(
     cursorRanges: updatedCursorRanges,
   };
 }
-
-function toSelection(range: Range) {
-  return new Selection(range.start, range.end);
-}

src/actions/EditNew/runNotebookCellTargets.ts

@@ -1,4 +1,5 @@
-import { commands, Selection } from "vscode";
+import { Selection } from "@cursorless/common";
+import { commands } from "vscode";
 import { NotebookCellPositionTarget } from "../../processTargets/targets";
 import { Target } from "../../typings/target.types";
 import { Graph } from "../../typings/Types";
@@ -20,8 +21,8 @@ export async function runNotebookCellTargets(
   // Inserting a new jupyter cell above pushes the previous one down two lines
   if (command === "jupyter.insertCellAbove") {
     thatMark[0].selection = new Selection(
-      thatMark[0].selection.anchor.translate({ lineDelta: 2 }),
-      thatMark[0].selection.active.translate({ lineDelta: 2 }),
+      thatMark[0].selection.anchor.translate(2, undefined),
+      thatMark[0].selection.active.translate(2, undefined),
     );
   }