Split define action (#2392)

jaresty · pokey · web-flow · commit 11037efa38b7 · 2024-07-02T14:07:01.000Z
This pull request adds a command to split the window and follow in one command. ## Checklist - [x] 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 --------- Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>
diff --git a/cursorless-talon/src/spoken_forms.json b/cursorless-talon/src/spoken_forms.json
@@ -23,6 +23,7 @@
       "float": "insertEmptyLineAfter",
       "fold": "foldRegion",
       "follow": "followLink",
+      "follow split": "followLinkAside",
       "give": "deselect",
       "highlight": "highlight",
       "hover": "showHover",
diff --git a/data/fixtures/recorded/actions/followSplitVest.yml b/data/fixtures/recorded/actions/followSplitVest.yml
@@ -0,0 +1,35 @@
+languageId: typescript
+command:
+  version: 7
+  spokenForm: follow split vest
+  action:
+    name: followLinkAside
+    target:
+      type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: v}
+  usePrePhraseSnapshot: true
+initialState:
+  documentContents: |2-
+        const value = "value";
+        console.log(value);
+  selections:
+    - anchor: {line: 1, character: 23}
+      active: {line: 1, character: 23}
+  marks:
+    default.v:
+      start: {line: 1, character: 16}
+      end: {line: 1, character: 21}
+finalState:
+  documentContents: |2-
+        const value = "value";
+        console.log(value);
+  selections:
+    - anchor: {line: 0, character: 10}
+      active: {line: 0, character: 10}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 1, character: 16}
+        end: {line: 1, character: 21}
+      isReversed: false
+      hasExplicitRange: true
diff --git a/packages/cheatsheet/src/lib/sampleSpokenFormInfos/defaults.json b/packages/cheatsheet/src/lib/sampleSpokenFormInfos/defaults.json
@@ -158,6 +158,16 @@
             }
           ]
         },
+        {
+          "id": "followLinkAside",
+          "type": "action",
+          "variations": [
+            {
+              "spokenForm": "follow split <target>",
+              "description": "Follow link aside"
+            }
+          ]
+        },
         {
           "id": "generateSnippet",
           "type": "action",
diff --git a/packages/common/src/types/TextEditor.ts b/packages/common/src/types/TextEditor.ts
@@ -1,6 +1,5 @@
 import type {
   Edit,
-  Position,
   Range,
   RevealLineAt,
   Selection,
@@ -58,6 +57,10 @@ export interface SetSelectionsOpts {
   revealRange?: boolean;
 }
 
+export type OpenLinkOptions = {
+  openAside: boolean;
+};
+
 export interface EditableTextEditor extends TextEditor {
   /**
    * Set the selections in this text editor, optionally focusing the editor
@@ -122,9 +125,9 @@ export interface EditableTextEditor extends TextEditor {
   /**
    * Open link at location.
    * @param location Position or range
-   * @return True if a link was opened
+   * @param options Options for opening the link.
    */
-  openLink(location?: Position | Range): Promise<boolean>;
+  openLink(range: Range, options?: OpenLinkOptions): Promise<void>;
 
   /**
    * Fold ranges
diff --git a/packages/common/src/types/command/ActionDescriptor.ts b/packages/common/src/types/command/ActionDescriptor.ts
@@ -22,6 +22,7 @@ export const simpleActionNames = [
   "findInWorkspace",
   "foldRegion",
   "followLink",
+  "followLinkAside",
   "increment",
   "indentLine",
   "insertCopyAfter",
diff --git a/packages/cursorless-engine/src/CommandHistory.ts b/packages/cursorless-engine/src/CommandHistory.ts
@@ -153,6 +153,7 @@ function sanitizeActionInPlace(action: ActionDescriptor): void {
     case "findInWorkspace":
     case "foldRegion":
     case "followLink":
+    case "followLinkAside":
     case "increment":
     case "indentLine":
     case "insertCopyAfter":
diff --git a/packages/cursorless-engine/src/actions/Actions.ts b/packages/cursorless-engine/src/actions/Actions.ts
@@ -94,7 +94,8 @@ export class Actions implements ActionRecord {
   findInDocument = new FindInDocument(this);
   findInWorkspace = new FindInWorkspace(this);
   foldRegion = new Fold(this.rangeUpdater);
-  followLink = new FollowLink(this);
+  followLink = new FollowLink({ openAside: false });
+  followLinkAside = new FollowLink({ openAside: true });
   generateSnippet = new GenerateSnippet();
   getText = new GetText();
   highlight = new Highlight();
diff --git a/packages/cursorless-engine/src/actions/FollowLink.ts b/packages/cursorless-engine/src/actions/FollowLink.ts
@@ -1,16 +1,15 @@
-import { FlashStyle } from "@cursorless/common";
+import { FlashStyle, OpenLinkOptions } from "@cursorless/common";
 import { ide } from "../singletons/ide.singleton";
 import { Target } from "../typings/target.types";
 import {
   createThatMark,
   ensureSingleTarget,
   flashTargets,
 } from "../util/targetUtils";
-import { Actions } from "./Actions";
-import { SimpleAction, ActionReturnValue } from "./actions.types";
+import { ActionReturnValue, SimpleAction } from "./actions.types";
 
 export default class FollowLink implements SimpleAction {
-  constructor(private actions: Actions) {
+  constructor(private options: OpenLinkOptions) {
     this.run = this.run.bind(this);
   }
 
@@ -19,17 +18,9 @@ export default class FollowLink implements SimpleAction {
 
     await flashTargets(ide(), targets, FlashStyle.referenced);
 
-    const openedLink = await ide()
+    await ide()
       .getEditableTextEditor(target.editor)
-      .openLink(target.contentRange);
-
-    if (!openedLink) {
-      await this.actions.executeCommand.run(
-        targets,
-        "editor.action.revealDefinition",
-        { restoreSelection: false },
-      );
-    }
+      .openLink(target.contentRange, this.options);
 
     return {
       thatSelections: createThatMark(targets),
diff --git a/packages/cursorless-engine/src/generateSpokenForm/defaultSpokenForms/actions.ts b/packages/cursorless-engine/src/generateSpokenForm/defaultSpokenForms/actions.ts
@@ -25,6 +25,7 @@ export const actions = {
   insertEmptyLineAfter: "float",
   foldRegion: "fold",
   followLink: "follow",
+  followLinkAside: "follow split",
   deselect: "give",
   highlight: "highlight",
   showHover: "hover",
diff --git a/packages/cursorless-vscode/package.json b/packages/cursorless-vscode/package.json
@@ -883,6 +883,7 @@
                   "findInWorkspace",
                   "foldRegion",
                   "followLink",
+                  "followLinkAside",
                   "generateSnippet",
                   "getText",
                   "highlight",
@@ -943,6 +944,7 @@
                       "findInWorkspace",
                       "foldRegion",
                       "followLink",
+                      "followLinkAside",
                       "generateSnippet",
                       "getText",
                       "highlight",
diff --git a/packages/cursorless-vscode/src/ide/vscode/VscodeOpenLink.ts b/packages/cursorless-vscode/src/ide/vscode/VscodeOpenLink.ts
@@ -1,43 +1,52 @@
 import * as vscode from "vscode";
 import { VscodeTextEditorImpl } from "./VscodeTextEditorImpl";
+import { OpenLinkOptions, Range } from "@cursorless/common";
+import { toVscodePositionOrRange } from "@cursorless/vscode-common";
 
 export default async function vscodeOpenLink(
   editor: VscodeTextEditorImpl,
-  location: vscode.Position | vscode.Range | undefined,
-): Promise<boolean> {
+  range: Range,
+  { openAside }: OpenLinkOptions,
+): Promise<void> {
   const rawEditor = editor.vscodeEditor;
   const links = await getLinksForEditor(rawEditor);
-  const actualLocation = location ?? getSelection(rawEditor);
+  const vscodeRange = toVscodePositionOrRange(range);
   const filteredLinks = links.filter((link) =>
-    link.range.contains(actualLocation),
+    link.range.contains(vscodeRange),
   );
 
   if (filteredLinks.length > 1) {
     throw Error("Multiple links found at location");
   }
 
   if (filteredLinks.length === 0) {
-    return false;
+    await runCommandAtRange(
+      editor,
+      openAside
+        ? "editor.action.revealDefinitionAside"
+        : "editor.action.revealDefinition",
+      range,
+    );
+    return;
   }
 
   try {
-    await openLink(filteredLinks[0]);
+    await openLink(filteredLinks[0], openAside);
   } catch (err) {
     // Fallback to moving cursor and running open link command
-
-    // Set the selection to the link
-    rawEditor.selections = [
-      "start" in actualLocation
-        ? new vscode.Selection(actualLocation.start, actualLocation.end)
-        : new vscode.Selection(actualLocation, actualLocation),
-    ];
-    await editor.focus();
-
-    // Run the open link command
-    await vscode.commands.executeCommand("editor.action.openLink");
+    await runCommandAtRange(editor, "editor.action.openLink", range);
   }
+}
 
-  return true;
+async function runCommandAtRange(
+  editor: VscodeTextEditorImpl,
+  command: string,
+  range: Range,
+) {
+  await editor.setSelections([range.toSelection(false)], {
+    focusEditor: true,
+  });
+  await vscode.commands.executeCommand(command);
 }
 
 async function getLinksForEditor(
@@ -49,30 +58,30 @@ async function getLinksForEditor(
   ))!;
 }
 
-function openLink(link: vscode.DocumentLink) {
+function openLink(link: vscode.DocumentLink, openAside: boolean) {
   if (link.target == null) {
     throw Error("Document link is missing uri");
   }
-  return openUri(link.target);
+  return openUri(link.target, openAside);
 }
 
-async function openUri(uri: vscode.Uri) {
+async function openUri(uri: vscode.Uri, openAside: boolean) {
   switch (uri.scheme) {
     case "http":
     case "https":
       await vscode.env.openExternal(uri);
       break;
     case "file":
-      await vscode.window.showTextDocument(uri);
+      await vscode.window.showTextDocument(
+        uri,
+        openAside
+          ? {
+              viewColumn: vscode.ViewColumn.Beside,
+            }
+          : undefined,
+      );
       break;
     default:
       throw Error(`Unknown uri scheme '${uri.scheme}'`);
   }
 }
-
-function getSelection(editor: vscode.TextEditor) {
-  if (editor.selections.length > 1) {
-    throw Error("Can't open links for multiple selections");
-  }
-  return editor.selection;
-}
diff --git a/packages/cursorless-vscode/src/ide/vscode/VscodeTextEditorImpl.ts b/packages/cursorless-vscode/src/ide/vscode/VscodeTextEditorImpl.ts
@@ -2,7 +2,7 @@ import {
   BreakpointDescriptor,
   Edit,
   EditableTextEditor,
-  Position,
+  OpenLinkOptions,
   Range,
   RevealLineAt,
   Selection,
@@ -16,7 +16,6 @@ import {
 import {
   fromVscodeRange,
   fromVscodeSelection,
-  toVscodePositionOrRange,
   toVscodeRange,
   toVscodeSelection,
 } from "@cursorless/vscode-common";
@@ -149,11 +148,11 @@ export class VscodeTextEditorImpl implements EditableTextEditor {
     return vscodeEditNewNotebookCellBelow(this);
   }
 
-  public openLink(location?: Position | Range): Promise<boolean> {
-    return vscodeOpenLink(
-      this,
-      location != null ? toVscodePositionOrRange(location) : undefined,
-    );
+  public openLink(
+    range: Range,
+    options: OpenLinkOptions = { openAside: false },
+  ): Promise<void> {
+    return vscodeOpenLink(this, range, options);
   }
 
   public fold(ranges?: Range[]): Promise<void> {

Original file line number	Diff line number	Diff line change
`@@ -158,6 +158,16 @@`
`158`	`158`	`}`
`159`	`159`	`]`
`160`	`160`	`},`
	`161`	`+ {`
	`162`	`+ "id": "followLinkAside",`
	`163`	`+ "type": "action",`
	`164`	`+ "variations": [`
	`165`	`+ {`
	`166`	`+ "spokenForm": "follow split <target>",`
	`167`	`+ "description": "Follow link aside"`
	`168`	`+ }`
	`169`	`+ ]`
	`170`	`+ },`
`161`	`171`	`{`
`162`	`172`	`"id": "generateSnippet",`
`163`	`173`	`"type": "action",`