Added proper find in document implementation (#2143)

Learned of the existence of vscode command `editor.actions.findWithArgs`
microsoft/vscode#200453

Exists in v1.66

https://github.com/microsoft/vscode/blob/release/1.66/src/vs/editor/contrib/find/browser/findModel.ts#L58

Fixes #1878

## 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)
- [x] I have not broken the cheatsheet

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

Author: AndreasArvidsson

cursorless-talon/src/actions/actions.py

@@ -49,7 +49,6 @@
 ]
 
 callback_actions: dict[str, Callable[[CursorlessTarget], None]] = {
-    "findInDocument": actions.user.private_cursorless_find,
     "nextHomophone": cursorless_homophones_action,
 }
 

cursorless-talon/src/actions/find.py

@@ -1,7 +1,4 @@
-from talon import Context, actions, app
-
-from ..actions.get_text import cursorless_get_text_action
-from ..targets.target_types import CursorlessTarget
+from talon import Context, actions
 
 ctx = Context()
 
@@ -14,17 +11,6 @@
 
 @ctx.action_class("user")
 class Actions:
-    def private_cursorless_find(target: CursorlessTarget):
-        """Find text of target in editor"""
-        texts = cursorless_get_text_action(target, ensure_single_target=True)
-        search_text = texts[0]
-        if len(search_text) > 200:
-            search_text = search_text[:200]
-            app.notify("Search text is longer than 200 characters; truncating")
-        actions.user.private_cursorless_run_rpc_command_no_wait("actions.find")
-        actions.sleep("50ms")
-        actions.insert(search_text)
-
     def private_cursorless_show_settings_in_ide():
         """Show Cursorless-specific settings in ide"""
         actions.user.private_cursorless_run_rpc_command_no_wait(

cursorless-talon/src/apps/cursorless_vscode.py

@@ -36,6 +36,7 @@
       "reference": "showReferences",
       "rename": "rename",
       "reverse": "reverseTargets",
+      "scout": "findInDocument",
       "scout all": "findInWorkspace",
       "shuffle": "randomizeTargets",
       "snippet make": "generateSnippet",
@@ -45,7 +46,6 @@
       "unfold": "unfoldRegion"
     },
     "callback_action": {
-      "scout": "findInDocument",
       "phones": "nextHomophone"
     },
     "paste_action": { "paste": "pasteFromClipboard" },

cursorless-talon/src/spoken_forms.json

@@ -135,6 +135,10 @@ export default class PassthroughIDEBase implements IDE {
     return this.original.workspaceFolders;
   }
 
+  public findInDocument(query: string, editor?: TextEditor): Promise<void> {
+    return this.original.findInDocument(query, editor);
+  }
+
   public findInWorkspace(query: string): Promise<void> {
     return this.original.findInWorkspace(query);
   }

packages/common/src/ide/PassthroughIDEBase.ts

@@ -85,6 +85,10 @@ export default class FakeIDE implements IDE {
     throw Error("Not implemented");
   }
 
+  public findInDocument(_query: string, _editor: TextEditor): Promise<void> {
+    throw Error("Not implemented");
+  }
+
   public findInWorkspace(_query: string): Promise<void> {
     throw Error("Not implemented");
   }

packages/common/src/ide/fake/FakeIDE.ts

@@ -94,6 +94,13 @@ export interface IDE {
     listener: (event: TextDocumentChangeEvent) => void,
   ): Disposable;
 
+  /**
+   * Find occurrences of query string in the active document.
+   * @param query The string query to search for
+   * @param editor The editor to search in. If not provided, uses the active editor.
+   */
+  findInDocument(query: string, editor?: TextEditor): Promise<void>;
+
   /**
    * Find occurrences of query string in all files in the workspace
    * @param query The string query to search for

packages/common/src/ide/types/ide.types.ts

@@ -17,6 +17,7 @@ const simpleActionNames = [
   "editNewLineBefore",
   "experimental.setInstanceReference",
   "extractVariable",
+  "findInDocument",
   "findInWorkspace",
   "foldRegion",
   "followLink",

packages/common/src/types/command/ActionDescriptor.ts

@@ -11,7 +11,7 @@ import Deselect from "./Deselect";
 import { EditNew } from "./EditNew";
 import { EditNewAfter, EditNewBefore } from "./EditNewLineAction";
 import ExecuteCommand from "./ExecuteCommand";
-import { FindInWorkspace } from "./Find";
+import { FindInDocument, FindInWorkspace } from "./Find";
 import FollowLink from "./FollowLink";
 import GenerateSnippet from "./GenerateSnippet";
 import GetTargets from "./GetTargets";
@@ -89,6 +89,7 @@ export class Actions implements ActionRecord {
   );
   executeCommand = new ExecuteCommand(this.rangeUpdater);
   extractVariable = new ExtractVariable(this.rangeUpdater);
+  findInDocument = new FindInDocument(this);
   findInWorkspace = new FindInWorkspace(this);
   foldRegion = new Fold(this.rangeUpdater);
   followLink = new FollowLink(this);

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

@@ -3,9 +3,9 @@ import { ide } from "../singletons/ide.singleton";
 import { Target } from "../typings/target.types";
 import { ensureSingleTarget } from "../util/targetUtils";
 import { Actions } from "./Actions";
-import { SimpleAction, ActionReturnValue } from "./actions.types";
+import { ActionReturnValue, SimpleAction } from "./actions.types";
 
-export class FindInWorkspace implements SimpleAction {
+abstract class Find implements SimpleAction {
   constructor(private actions: Actions) {
     this.run = this.run.bind(this);
   }
@@ -29,8 +29,22 @@ export class FindInWorkspace implements SimpleAction {
       query = text;
     }
 
-    await ide().findInWorkspace(query);
+    await this.find(query);
 
     return { thatTargets };
   }
+
+  protected abstract find(query: string): Promise<void>;
+}
+
+export class FindInDocument extends Find {
+  protected find(query: string): Promise<void> {
+    return ide().findInDocument(query);
+  }
+}
+
+export class FindInWorkspace extends Find {
+  protected find(query: string): Promise<void> {
+    return ide().findInWorkspace(query);
+  }
 }