Public get text action

cursorless-talon-dev/src/cursorless_test.talon

@@ -7,10 +7,16 @@ test api command <user.cursorless_target>:
     user.cursorless_command("setSelection", cursorless_target)
 test api command bring <user.cursorless_target>:
     user.cursorless_command("replaceWithTarget", cursorless_target)
+test api get text <user.cursorless_target>:
+    user.cursorless_get_text(cursorless_target)
+test api get text list <user.cursorless_target>:
+    user.cursorless_get_text_list(cursorless_target)
+
 test api insert <user.word> <user.cursorless_destination>:
     user.cursorless_insert(cursorless_destination, word)
 test api insert <user.word> and <user.word> <user.cursorless_destination>:
     user.cursorless_insert(cursorless_destination, word_list)
+
 test api insert snippet:
     user.cursorless_insert_snippet("Hello, $foo!  My name is $bar!")
 test api insert snippet <user.cursorless_destination> :

cursorless-talon/src/actions/get_text.py

@@ -1,24 +1,48 @@
-from typing import Optional
-
-from talon import actions
+from talon import Module, actions
 
 from ..targets.target_types import CursorlessTarget
 
+mod = Module()
+
+
+@mod.action_class
+class Actions:
+    def cursorless_get_text(
+        target: CursorlessTarget,
+        hide_decorations: bool = False,
+    ) -> str:
+        """Get target text"""
+        return cursorless_get_text(
+            target,
+            hide_decorations=hide_decorations,
+            ensure_single_target=True,
+        )[0]
 
-def cursorless_get_text_action(
+    def cursorless_get_text_list(
+        target: CursorlessTarget,
+        hide_decorations: bool = False,
+    ) -> list[str]:
+        """Get texts for multiple targets"""
+        return cursorless_get_text(
+            target,
+            hide_decorations=hide_decorations,
+            ensure_single_target=False,
+        )
+
+
+def cursorless_get_text(
     target: CursorlessTarget,
     *,
-    show_decorations: Optional[bool] = None,
-    ensure_single_target: Optional[bool] = None,
+    hide_decorations: bool,
+    ensure_single_target: bool,
 ) -> list[str]:
     """Get target texts"""
     options: dict[str, bool] = {}
 
-    if show_decorations is not None:
-        options["showDecorations"] = show_decorations
-
-    if ensure_single_target is not None:
-        options["ensureSingleTarget"] = ensure_single_target
+    if hide_decorations:
+        options["showDecorations"] = False
+    if ensure_single_target:
+        options["ensureSingleTarget"] = True
 
     return actions.user.private_cursorless_command_get(
         {

cursorless-talon/src/actions/homophones.py

@@ -3,13 +3,12 @@
 from talon import actions, app
 
 from ..targets.target_types import CursorlessTarget, PrimitiveDestination
-from .get_text import cursorless_get_text_action
 from .replace import cursorless_replace_action
 
 
 def cursorless_homophones_action(target: CursorlessTarget):
     """Replaced target with next homophone"""
-    texts = cursorless_get_text_action(target, show_decorations=False)
+    texts = actions.user.cursorless_get_text_list(target, True)
     try:
         updated_texts = list(map(get_next_homophone, texts))
     except LookupError as e:

cursorless-talon/src/actions/reformat.py

@@ -1,7 +1,6 @@
 from talon import Module, actions
 
 from ..targets.target_types import CursorlessTarget, PrimitiveDestination
-from .get_text import cursorless_get_text_action
 from .replace import cursorless_replace_action
 
 mod = Module()
@@ -13,7 +12,7 @@
 class Actions:
     def private_cursorless_reformat(target: CursorlessTarget, formatters: str):
         """Execute Cursorless reformat action. Reformat target with formatter"""
-        texts = cursorless_get_text_action(target, show_decorations=False)
+        texts = actions.user.cursorless_get_text_list(target, True)
         updated_texts = [actions.user.reformat_text(text, formatters) for text in texts]
         destination = PrimitiveDestination("to", target)
         cursorless_replace_action(destination, updated_texts)

cursorless-talon/src/apps/cursorless_vscode.py

@@ -1,6 +1,5 @@
 from talon import Context, actions, app
 
-from ..actions.get_text import cursorless_get_text_action
 from ..targets.target_types import CursorlessTarget
 
 ctx = Context()
@@ -16,8 +15,7 @@
 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]
+        search_text = actions.user.cursorless_get_text(target)
         if len(search_text) > 200:
             search_text = search_text[:200]
             app.notify("Search text is longer than 200 characters; truncating")

docs/user/customization.md

@@ -117,6 +117,10 @@ Cursorless exposes a couple talon actions and captures that you can use to defin
 - `user.cursorless_ide_command(command_id: str, target: cursorless_target)`:
   Performs a built-in IDE command on the given target
   eg: `user.cursorless_ide_command("editor.action.addCommentLine", cursorless_target)`
+- `user.cursorless_get_text(target: CursorlessTarget, hide_decorations: bool = False) -> str`
+  Get text from target
+- `user.cursorless_get_text_list(target: CursorlessTarget, hide_decorations: bool = False) -> list[str]`
+  Get texts from multiple targets
 - `user.cursorless_insert(destination: CursorlessDestination, text: Union[str, List[str]])`:
   Insert text at destination.
   eg: `user.cursorless_insert(cursorless_destination, "hello")`

packages/cursorless-engine/src/test/fixtures/talonApi.fixture.ts

@@ -96,6 +96,18 @@ const parseTreeAction: ActionDescriptor = {
   name: "private.showParseTree",
   target: decoratedPrimitiveTarget("a"),
 };
+const getTextAction: ActionDescriptor = {
+  name: "getText",
+  options: {
+    ensureSingleTarget: true,
+  },
+  target: decoratedPrimitiveTarget("a"),
+};
+const getTextListAction: ActionDescriptor = {
+  name: "getText",
+  options: {},
+  target: decoratedPrimitiveTarget("a"),
+};
 
 /**
  * These test our Talon api using dummy spoken forms defined in
@@ -121,6 +133,8 @@ export const talonApiFixture = [
     wrapWithSnippetByNameAction,
   ),
   spokenFormTest("parse tree air", parseTreeAction),
+  spokenFormTest("test api get text air", getTextAction),
+  spokenFormTest("test api get text list air", getTextListAction),
 ];
 
 function decoratedPrimitiveTarget(