Remove actions from graph (cursorless-dev#1374)

pokey · web-flow · commit 96e06e75ec9c · 2023-04-02T07:27:44.000Z
## 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
diff --git a/packages/cursorless-engine/src/actions/Actions.ts b/packages/cursorless-engine/src/actions/Actions.ts
@@ -53,22 +53,22 @@ import ToggleBreakpoint from "./ToggleBreakpoint";
 import Wrap from "./Wrap";
 import WrapWithSnippet from "./WrapWithSnippet";
 
-class Actions implements ActionRecord {
+export class Actions implements ActionRecord {
   constructor(private graph: Graph) {}
 
-  callAsFunction = new Call(this.graph);
-  clearAndSetSelection = new Clear(this.graph);
+  callAsFunction = new Call(this);
+  clearAndSetSelection = new Clear(this);
   copyToClipboard = new CopyToClipboard(this.graph);
-  cutToClipboard = new CutToClipboard(this.graph);
+  cutToClipboard = new CutToClipboard(this);
   deselect = new Deselect(this.graph);
-  editNew = new EditNew(this.graph);
-  editNewLineAfter = new EditNewAfter(this.graph);
-  editNewLineBefore = new EditNewBefore(this.graph);
+  editNew = new EditNew(this.graph, this);
+  editNewLineAfter = new EditNewAfter(this.graph, this);
+  editNewLineBefore = new EditNewBefore(this.graph, this);
   executeCommand = new ExecuteCommand(this.graph);
   extractVariable = new ExtractVariable(this.graph);
-  findInWorkspace = new FindInWorkspace(this.graph);
+  findInWorkspace = new FindInWorkspace(this);
   foldRegion = new Fold(this.graph);
-  followLink = new FollowLink(this.graph);
+  followLink = new FollowLink(this);
   generateSnippet = new GenerateSnippet(this.graph);
   getText = new GetText(this.graph);
   highlight = new Highlight(this.graph);
@@ -78,18 +78,18 @@ class Actions implements ActionRecord {
   insertEmptyLineAfter = new InsertEmptyLineAfter(this.graph);
   insertEmptyLineBefore = new InsertEmptyLineBefore(this.graph);
   insertEmptyLinesAround = new InsertEmptyLinesAround(this.graph);
-  insertSnippet = new InsertSnippet(this.graph);
+  insertSnippet = new InsertSnippet(this.graph, this);
   moveToTarget = new Move(this.graph);
   outdentLine = new OutdentLine(this.graph);
-  pasteFromClipboard = new PasteFromClipboard(this.graph);
-  randomizeTargets = new Random(this.graph);
+  pasteFromClipboard = new PasteFromClipboard(this.graph, this);
+  randomizeTargets = new Random(this);
   remove = new Remove(this.graph);
   rename = new Rename(this.graph);
   replace = new Replace(this.graph);
   replaceWithTarget = new Bring(this.graph);
   revealDefinition = new RevealDefinition(this.graph);
   revealTypeDefinition = new RevealTypeDefinition(this.graph);
-  reverseTargets = new Reverse(this.graph);
+  reverseTargets = new Reverse(this);
   rewrapWithPairedDelimiter = new Rewrap(this.graph);
   scrollToBottom = new ScrollToBottom(this.graph);
   scrollToCenter = new ScrollToCenter(this.graph);
@@ -101,13 +101,11 @@ class Actions implements ActionRecord {
   showHover = new ShowHover(this.graph);
   showQuickFix = new ShowQuickFix(this.graph);
   showReferences = new ShowReferences(this.graph);
-  sortTargets = new Sort(this.graph);
+  sortTargets = new Sort(this);
   swapTargets = new Swap(this.graph);
   toggleLineBreakpoint = new ToggleBreakpoint(this.graph);
   toggleLineComment = new ToggleLineComment(this.graph);
   unfoldRegion = new Unfold(this.graph);
   wrapWithPairedDelimiter = new Wrap(this.graph);
   wrapWithSnippet = new WrapWithSnippet(this.graph);
 }
-
-export default Actions;
diff --git a/packages/cursorless-engine/src/actions/Call.ts b/packages/cursorless-engine/src/actions/Call.ts
@@ -1,10 +1,10 @@
 import { Target } from "../typings/target.types";
-import { Graph } from "../typings/Graph";
 import { ensureSingleTarget } from "../util/targetUtils";
+import { Actions } from "./Actions";
 import { Action, ActionReturnValue } from "./actions.types";
 
 export default class Call implements Action {
-  constructor(private graph: Graph) {
+  constructor(private actions: Actions) {
     this.run = this.run.bind(this);
   }
 
@@ -14,16 +14,13 @@ export default class Call implements Action {
   ]): Promise<ActionReturnValue> {
     ensureSingleTarget(sources);
 
-    const { returnValue: texts } = await this.graph.actions.getText.run(
-      [sources],
-      {
-        showDecorations: false,
-      },
-    );
+    const { returnValue: texts } = await this.actions.getText.run([sources], {
+      showDecorations: false,
+    });
 
     // NB: We unwrap and then rewrap the return value here so that we don't include the source mark
     const { thatSelections: thatMark } =
-      await this.graph.actions.wrapWithPairedDelimiter.run(
+      await this.actions.wrapWithPairedDelimiter.run(
         [destinations],
         texts[0] + "(",
         ")",
diff --git a/packages/cursorless-engine/src/actions/Clear.ts b/packages/cursorless-engine/src/actions/Clear.ts
@@ -1,13 +1,13 @@
-import { ide } from "../singletons/ide.singleton";
 import { PlainTarget } from "../processTargets/targets";
+import { ide } from "../singletons/ide.singleton";
 import { Target } from "../typings/target.types";
-import { Graph } from "../typings/Graph";
 import { setSelectionsAndFocusEditor } from "../util/setSelectionsAndFocusEditor";
 import { ensureSingleEditor } from "../util/targetUtils";
+import { Actions } from "./Actions";
 import { Action, ActionReturnValue } from "./actions.types";
 
 export default class Clear implements Action {
-  constructor(private graph: Graph) {
+  constructor(private actions: Actions) {
     this.run = this.run.bind(this);
   }
 
@@ -24,7 +24,7 @@ export default class Clear implements Action {
         }),
     );
 
-    const { thatTargets } = await this.graph.actions.remove.run([plainTargets]);
+    const { thatTargets } = await this.actions.remove.run([plainTargets]);
 
     if (thatTargets != null) {
       await setSelectionsAndFocusEditor(
diff --git a/packages/cursorless-engine/src/actions/CutToClipboard.ts b/packages/cursorless-engine/src/actions/CutToClipboard.ts
@@ -7,11 +7,11 @@ import {
 } from "@cursorless/common";
 import { ide } from "../singletons/ide.singleton";
 import { Target } from "../typings/target.types";
-import { Graph } from "../typings/Graph";
+import { Actions } from "./Actions";
 import { Action, ActionReturnValue } from "./actions.types";
 
 export class CutToClipboard implements Action {
-  constructor(private graph: Graph) {
+  constructor(private actions: Actions) {
     this.run = this.run.bind(this);
   }
 
@@ -55,12 +55,9 @@ export class CutToClipboard implements Action {
 
     const options = { showDecorations: false };
 
-    await this.graph.actions.copyToClipboard.run([targets], options);
+    await this.actions.copyToClipboard.run([targets], options);
 
-    const { thatTargets } = await this.graph.actions.remove.run(
-      [targets],
-      options,
-    );
+    const { thatTargets } = await this.actions.remove.run([targets], options);
 
     return { thatTargets };
   }
diff --git a/packages/cursorless-engine/src/actions/EditNew/EditNew.ts b/packages/cursorless-engine/src/actions/EditNew/EditNew.ts
@@ -1,23 +1,24 @@
-import { ide } from "../../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 { ide } from "../../singletons/ide.singleton";
 import { Graph } from "../../typings/Graph";
+import { Target } from "../../typings/target.types";
 import { setSelectionsAndFocusEditor } from "../../util/setSelectionsAndFocusEditor";
 import { createThatMark, ensureSingleEditor } from "../../util/targetUtils";
+import { Actions } from "../Actions";
 import { Action, ActionReturnValue } from "../actions.types";
 import { State } from "./EditNew.types";
-import { runInsertLineAfterTargets } from "./runInsertLineAfterTargets";
 import { runEditTargets } from "./runEditTargets";
+import { runInsertLineAfterTargets } from "./runInsertLineAfterTargets";
 import { runEditNewNotebookCellTargets } from "./runNotebookCellTargets";
 
 export class EditNew implements Action {
   getFinalStages(): ModifierStage[] {
     return [containingLineIfUntypedStage];
   }
 
-  constructor(private graph: Graph) {
+  constructor(private graph: Graph, private actions: Actions) {
     this.run = this.run.bind(this);
   }
 
@@ -26,7 +27,7 @@ export class EditNew implements Action {
       // It is not possible to "pour" a notebook cell and something else,
       // because each notebook cell is its own editor, and you can't have
       // cursors in multiple editors.
-      return runEditNewNotebookCellTargets(this.graph, targets);
+      return runEditNewNotebookCellTargets(this.actions, targets);
     }
 
     const editableEditor = ide().getEditableTextEditor(
diff --git a/packages/cursorless-engine/src/actions/EditNew/runNotebookCellTargets.ts b/packages/cursorless-engine/src/actions/EditNew/runNotebookCellTargets.ts
@@ -1,13 +1,13 @@
 import { Selection } from "@cursorless/common";
-import { ide } from "../../singletons/ide.singleton";
 import { NotebookCellPositionTarget } from "../../processTargets/targets";
+import { ide } from "../../singletons/ide.singleton";
 import { Target } from "../../typings/target.types";
-import { Graph } from "../../typings/Graph";
 import { createThatMark, ensureSingleTarget } from "../../util/targetUtils";
+import { Actions } from "../Actions";
 import { ActionReturnValue } from "../actions.types";
 
 export async function runEditNewNotebookCellTargets(
-  graph: Graph,
+  actions: Actions,
   targets: Target[],
 ): Promise<ActionReturnValue> {
   // Can only run on one target because otherwise we'd end up with cursors in
@@ -16,7 +16,7 @@ export async function runEditNewNotebookCellTargets(
   const editor = ide().getEditableTextEditor(target.editor);
   const isAbove = target.position === "before";
 
-  await graph.actions.setSelection.run([targets]);
+  await actions.setSelection.run([targets]);
 
   let modifyThatMark = (selection: Selection) => selection;
   if (isAbove) {
diff --git a/packages/cursorless-engine/src/actions/Find.ts b/packages/cursorless-engine/src/actions/Find.ts
@@ -1,19 +1,19 @@
 import { showWarning } from "@cursorless/common";
 import { ide } from "../singletons/ide.singleton";
 import { Target } from "../typings/target.types";
-import { Graph } from "../typings/Graph";
 import { ensureSingleTarget } from "../util/targetUtils";
+import { Actions } from "./Actions";
 import { Action, ActionReturnValue } from "./actions.types";
 
 export class FindInWorkspace implements Action {
-  constructor(private graph: Graph) {
+  constructor(private actions: Actions) {
     this.run = this.run.bind(this);
   }
 
   async run([targets]: [Target[]]): Promise<ActionReturnValue> {
     ensureSingleTarget(targets);
 
-    const { returnValue, thatTargets } = await this.graph.actions.getText.run([
+    const { returnValue, thatTargets } = await this.actions.getText.run([
       targets,
     ]);
     const [text] = returnValue as [string];
diff --git a/packages/cursorless-engine/src/actions/FollowLink.ts b/packages/cursorless-engine/src/actions/FollowLink.ts
@@ -1,16 +1,16 @@
 import { FlashStyle } from "@cursorless/common";
 import { ide } from "../singletons/ide.singleton";
 import { Target } from "../typings/target.types";
-import { Graph } from "../typings/Graph";
 import {
   createThatMark,
   ensureSingleTarget,
   flashTargets,
 } from "../util/targetUtils";
+import { Actions } from "./Actions";
 import { Action, ActionReturnValue } from "./actions.types";
 
 export default class FollowLink implements Action {
-  constructor(private graph: Graph) {
+  constructor(private actions: Actions) {
     this.run = this.run.bind(this);
   }
 
@@ -24,7 +24,7 @@ export default class FollowLink implements Action {
       .openLink(target.contentRange);
 
     if (!openedLink) {
-      await this.graph.actions.executeCommand.run(
+      await this.actions.executeCommand.run(
         [targets],
         "editor.action.revealDefinition",
         { restoreSelection: false },
diff --git a/packages/cursorless-engine/src/actions/InsertSnippet.ts b/packages/cursorless-engine/src/actions/InsertSnippet.ts
@@ -19,6 +19,7 @@ import { SnippetParser } from "../snippets/vendor/vscodeSnippet/snippetParser";
 import { Graph } from "../typings/Graph";
 import { Target } from "../typings/target.types";
 import { ensureSingleEditor } from "../util/targetUtils";
+import { Actions } from "./Actions";
 import { Action, ActionReturnValue } from "./actions.types";
 
 interface NamedSnippetArg {
@@ -37,7 +38,7 @@ type InsertSnippetArg = NamedSnippetArg | CustomSnippetArg;
 export default class InsertSnippet implements Action {
   private snippetParser = new SnippetParser();
 
-  constructor(private graph: Graph) {
+  constructor(private graph: Graph, private actions: Actions) {
     this.run = this.run.bind(this);
   }
 
@@ -131,7 +132,7 @@ export default class InsertSnippet implements Action {
 
     const snippetString = parsedSnippet.toTextmateString();
 
-    await this.graph.actions.editNew.run([targets]);
+    await this.actions.editNew.run([targets]);
 
     const targetSelectionInfos = editor.selections.map((selection) =>
       getSelectionInfo(
diff --git a/packages/cursorless-engine/src/actions/PasteFromClipboard.ts b/packages/cursorless-engine/src/actions/PasteFromClipboard.ts
@@ -8,14 +8,15 @@ import {
   callFunctionAndUpdateSelectionsWithBehavior,
 } from "../core/updateSelections/updateSelections";
 import { ide } from "../singletons/ide.singleton";
-import { Target } from "../typings/target.types";
 import { Graph } from "../typings/Graph";
+import { Target } from "../typings/target.types";
 import { setSelectionsWithoutFocusingEditor } from "../util/setSelectionsAndFocusEditor";
 import { ensureSingleEditor } from "../util/targetUtils";
+import { Actions } from "./Actions";
 import { ActionReturnValue } from "./actions.types";
 
 export class PasteFromClipboard {
-  constructor(private graph: Graph) {}
+  constructor(private graph: Graph, private actions: Actions) {}
 
   async run([targets]: [Target[]]): Promise<ActionReturnValue> {
     const editor = ide().getEditableTextEditor(ensureSingleEditor(targets));
@@ -27,7 +28,7 @@ export class PasteFromClipboard {
     const [originalCursorSelections] = await callFunctionAndUpdateSelections(
       this.graph.rangeUpdater,
       async () => {
-        await this.graph.actions.editNew.run([targets]);
+        await this.actions.editNew.run([targets]);
       },
       editor.document,
       [editor.selections],
diff --git a/packages/cursorless-engine/src/actions/Sort.ts b/packages/cursorless-engine/src/actions/Sort.ts
@@ -1,33 +1,31 @@
 import { shuffle } from "lodash";
 import { Target } from "../typings/target.types";
-import { Graph } from "../typings/Graph";
+import { Actions } from "./Actions";
 import { Action, ActionReturnValue } from "./actions.types";
 
 abstract class SortBase implements Action {
-  constructor(private graph: Graph) {
+  constructor(private actions: Actions) {
     this.run = this.run.bind(this);
   }
 
   protected abstract sortTexts(texts: string[]): string[];
 
-  async run(targets: Target[][]): Promise<ActionReturnValue> {
+  async run([targets]: [Target[]]): Promise<ActionReturnValue> {
     // First sort target by document order
-    const sortedTargets = targets.map((t) =>
-      t
-        .slice()
-        .sort((a, b) => a.contentRange.start.compareTo(b.contentRange.start)),
-    );
+    const sortedTargets = targets
+      .slice()
+      .sort((a, b) => a.contentRange.start.compareTo(b.contentRange.start));
 
-    const { returnValue: unsortedTexts } = await this.graph.actions.getText.run(
-      sortedTargets,
+    const { returnValue: unsortedTexts } = await this.actions.getText.run(
+      [sortedTargets],
       {
         showDecorations: false,
       },
     );
 
     const sortedTexts = this.sortTexts(unsortedTexts);
 
-    return this.graph.actions.replace.run(sortedTargets, sortedTexts);
+    return this.actions.replace.run([sortedTargets], sortedTexts);
   }
 }
 
diff --git a/packages/cursorless-engine/src/actions/index.ts b/packages/cursorless-engine/src/actions/index.ts
diff --git a/packages/cursorless-engine/src/core/commandRunner/CommandRunner.ts b/packages/cursorless-engine/src/core/commandRunner/CommandRunner.ts
@@ -4,6 +4,9 @@ import {
   HatTokenMap,
   PartialTargetV0V1,
 } from "@cursorless/common";
+import { ActionRecord } from "../../actions/actions.types";
+// eslint-disable-next-line @typescript-eslint/no-unused-vars, unused-imports/no-unused-imports
+import { Actions } from "../../actions/Actions";
 import { TestCaseRecorder } from "../../index";
 import processTargets from "../../processTargets";
 import { ide } from "../../singletons/ide.singleton";
@@ -32,6 +35,7 @@ export class CommandRunner {
     private debug: Debug,
     private hatTokenMap: HatTokenMap,
     private testCaseRecorder: TestCaseRecorder,
+    private actions: ActionRecord,
     private thatMark: ThatMark,
     private sourceMark: ThatMark,
   ) {
@@ -81,7 +85,7 @@ export class CommandRunner {
         usePrePhraseSnapshot,
       );
 
-      const action = this.graph.actions[actionName];
+      const action = this.actions[actionName];
 
       if (action == null) {
         throw new Error(`Unknown action ${actionName}`);
diff --git a/packages/cursorless-engine/src/index.ts b/packages/cursorless-engine/src/index.ts
diff --git a/packages/cursorless-engine/src/typings/Graph.ts b/packages/cursorless-engine/src/typings/Graph.ts
diff --git a/packages/cursorless-engine/src/util/graphFactories.ts b/packages/cursorless-engine/src/util/graphFactories.ts
diff --git a/packages/cursorless-vscode/src/extension.ts b/packages/cursorless-vscode/src/extension.ts
