Talon side spoken form tests (#1637)

- Fixes #449
- Fixes #1675

## Potential manual tests to add

For these, just bake payload and spoken form into `const`s in the test
itself

- [x] "slice past"
- [x] "two tokens forward"
- [x] "one token"
- [x] "take inside pair"

## Checklist

- [x] Handle if Talon was in sleep mode initially
- [x] Add deprecation warning if user says "to after"? I believe we
support this today, and some users are still saying that, as indicated
by slack questions from the past month. We could probably have this as
an alternate spoken form for "after" and show a warning if they use it
- [x] Stop using `generateSpokenForms` to check whether to run a test;
instead read `spokenFormError` field on recorded test
- [x] How do we actually want to launch this? Launch config in vscode
and then?
- [x] Add notifications when test start and stop
- [x] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [/] I have updated the
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [/] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs)
- [x] I have not broken the cheatsheet

---------

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

Author: 3 people

src/actions/swap.py

@@ -1,6 +1,6 @@
 from talon import Module
 
-from ..primitive_target import create_base_target
+from ..primitive_target import create_implicit_target
 
 mod = Module()
 
@@ -20,6 +20,6 @@ def cursorless_swap_targets(m) -> list[dict]:
     target_list = m.cursorless_target_list
 
     if len(target_list) == 1:
-        target_list = [create_base_target()] + target_list
+        target_list = [create_implicit_target()] + target_list
 
     return target_list

src/apps/cursorless_vscode.py

@@ -1,7 +1,6 @@
 from talon import Context, actions, app
 
 from ..actions.get_text import get_text
-from ..cursorless_command_server import run_rpc_command_no_wait
 
 ctx = Context()
 
@@ -21,12 +20,14 @@ def cursorless_private_run_find_action(target: dict):
         if len(search_text) > 200:
             search_text = search_text[:200]
             app.notify("Search text is longer than 200 characters; truncating")
-        run_rpc_command_no_wait("actions.find")
+        actions.user.private_cursorless_run_rpc_command_no_wait("actions.find")
         actions.sleep("50ms")
         actions.insert(search_text)
 
     def cursorless_show_settings_in_ide():
         """Show Cursorless-specific settings in ide"""
-        run_rpc_command_no_wait("workbench.action.openGlobalSettings")
+        actions.user.private_cursorless_run_rpc_command_no_wait(
+            "workbench.action.openGlobalSettings"
+        )
         actions.sleep("250ms")
         actions.insert("cursorless")

src/cheatsheet/cheat_sheet.py

@@ -1,9 +1,8 @@
 import webbrowser
 from pathlib import Path
 
-from talon import Context, Module, app
+from talon import Context, Module, actions, app
 
-from ..cursorless_command_server import run_rpc_command_and_wait
 from .get_list import get_list, get_lists
 from .sections.actions import get_actions
 from .sections.compound_targets import get_compound_targets
@@ -54,7 +53,7 @@ def cursorless_cheat_sheet_show_html():
 
         cheatsheet_out_dir.mkdir(parents=True, exist_ok=True)
         cheatsheet_out_path = cheatsheet_out_dir / cheatsheet_filename
-        run_rpc_command_and_wait(
+        actions.user.private_cursorless_run_rpc_command_and_wait(
             "cursorless.showCheatsheet",
             {
                 "version": 0,
@@ -66,7 +65,7 @@ def cursorless_cheat_sheet_show_html():
 
     def cursorless_cheat_sheet_update_json():
         """Update default cursorless cheatsheet json (for developer use only)"""
-        run_rpc_command_and_wait(
+        actions.user.private_cursorless_run_rpc_command_and_wait(
             "cursorless.internal.updateCheatsheetDefaults",
             cursorless_cheat_sheet_get_json(),
         )

src/command.py

@@ -2,11 +2,6 @@
 
 from talon import Module, actions, speech_system
 
-from .cursorless_command_server import (
-    run_rpc_command_and_wait,
-    run_rpc_command_get,
-    run_rpc_command_no_wait,
-)
 from .primitive_target import create_implicit_target
 
 mod = Module()
@@ -73,7 +68,7 @@ def cursorless_single_target_command_get(
         arg3: Any = NotSet,
     ):
         """Execute single-target cursorless command and return result"""
-        return run_rpc_command_get(
+        return actions.user.private_cursorless_run_rpc_command_get(
             CURSORLESS_COMMAND_ID,
             construct_cursorless_command_argument(
                 action=action,
@@ -101,7 +96,7 @@ def cursorless_multiple_target_command(
         arg3: Any = NotSet,
     ):
         """Execute multi-target cursorless command"""
-        run_rpc_command_and_wait(
+        actions.user.private_cursorless_run_rpc_command_and_wait(
             CURSORLESS_COMMAND_ID,
             construct_cursorless_command_argument(
                 action=action,
@@ -118,7 +113,7 @@ def cursorless_multiple_target_command_no_wait(
         arg3: Any = NotSet,
     ):
         """Execute multi-target cursorless command"""
-        run_rpc_command_no_wait(
+        actions.user.private_cursorless_run_rpc_command_no_wait(
             CURSORLESS_COMMAND_ID,
             construct_cursorless_command_argument(
                 action=action,

src/csv_overrides.py

@@ -14,13 +14,22 @@
 
 
 mod = Module()
+mod.tag(
+    "cursorless_default_vocabulary",
+    desc="Use default cursorless vocabulary instead of user custom",
+)
 cursorless_settings_directory = mod.setting(
     "cursorless_settings_directory",
     type=str,
     default="cursorless-settings",
     desc="The directory to use for cursorless settings csvs relative to talon user directory",
 )
 
+default_ctx = Context()
+default_ctx.matches = r"""
+tag: user.cursorless_default_vocabulary
+"""
+
 
 def init_csv_and_watch_changes(
     filename: str,
@@ -68,6 +77,9 @@ def init_csv_and_watch_changes(
 
     file_path.parent.mkdir(parents=True, exist_ok=True)
 
+    check_for_duplicates(filename, default_values)
+    create_default_vocabulary_dicts(default_values, pluralize_lists)
+
     def on_watch(path, flags):
         if file_path.match(path):
             current_values, has_errors = read_file(
@@ -126,27 +138,49 @@ def unsubscribe():
     return unsubscribe
 
 
+def check_for_duplicates(filename, default_values):
+    results_map = {}
+    for list_name, dict in default_values.items():
+        for key, value in dict.items():
+            if value in results_map:
+                existing_list_name = results_map[value]["list"]
+                warning = f"WARNING ({filename}): Value `{value}` duplicated between lists '{existing_list_name}' and '{list_name}'"
+                print(warning)
+                app.notify(warning)
+
+
 def is_removed(value: str):
     return value.startswith("-")
 
 
+def create_default_vocabulary_dicts(
+    default_values: dict[str, dict], pluralize_lists: list[str]
+):
+    default_values_updated = {}
+    for key, value in default_values.items():
+        updated_dict = {}
+        for key2, value2 in value.items():
+            # Enable deactivated(prefixed with a `-`) items
+            active_key = key2[1:] if key2.startswith("-") else key2
+            if active_key:
+                updated_dict[active_key] = value2
+        default_values_updated[key] = updated_dict
+    assign_lists_to_context(default_ctx, default_values_updated, pluralize_lists)
+
+
 def update_dicts(
     default_values: dict[str, dict],
     current_values: dict,
     extra_ignored_values: list[str],
     allow_unknown_values: bool,
     default_list_name: Optional[str],
-    pluralize_lists: Optional[list[str]],
+    pluralize_lists: list[str],
     ctx: Context,
 ):
     # Create map with all default values
     results_map = {}
     for list_name, dict in default_values.items():
         for key, value in dict.items():
-            if value in results_map:
-                warning = f"WARNING: Duplicate value `{value}` in {list_name}.csv"
-                print(warning)
-                app.notify(warning)
             results_map[value] = {"key": key, "value": value, "list": list_name}
 
     # Update result with current values
@@ -183,6 +217,14 @@ def update_dicts(
                 results[obj["list"]][k.strip()] = value
 
     # Assign result to talon context list
+    assign_lists_to_context(ctx, results, pluralize_lists)
+
+
+def assign_lists_to_context(
+    ctx: Context,
+    results: dict,
+    pluralize_lists: list[str],
+):
     for list_name, dict in results.items():
         list_singular_name = get_cursorless_list_name(list_name)
         ctx.lists[list_singular_name] = dict

src/cursorless.talon

@@ -1,3 +1,5 @@
+mode: command
+mode: user.cursorless_spoken_form_test
 tag: user.cursorless
 -
 

src/cursorless_command_server.py

@@ -1,27 +1,35 @@
 from typing import Any
 
-from talon import actions
+from talon import Module, actions
 
+mod = Module()
 
-def run_rpc_command_no_wait(command_id: str, *args):
-    """Execute command via rpc."""
-    try:
-        actions.user.run_rpc_command(command_id, *args)
-    except KeyError:
-        actions.user.vscode_with_plugin(command_id, *args)
 
+@mod.action_class
+class Actions:
+    def private_cursorless_run_rpc_command_and_wait(
+        command_id: str, arg1: Any = None, arg2: Any = None
+    ):
+        """Execute command via rpc and wait for command to finish."""
+        try:
+            actions.user.run_rpc_command_and_wait(command_id, arg1, arg2)
+        except KeyError:
+            actions.user.vscode_with_plugin_and_wait(command_id, arg1, arg2)
 
-def run_rpc_command_and_wait(command_id: str, *args):
-    """Execute command via rpc and wait for command to finish."""
-    try:
-        actions.user.run_rpc_command_and_wait(command_id, *args)
-    except KeyError:
-        actions.user.vscode_with_plugin_and_wait(command_id, *args)
+    def private_cursorless_run_rpc_command_no_wait(
+        command_id: str, arg1: Any = None, arg2: Any = None
+    ):
+        """Execute command via rpc and DON'T wait."""
+        try:
+            actions.user.run_rpc_command(command_id, arg1, arg2)
+        except KeyError:
+            actions.user.vscode_with_plugin(command_id, arg1, arg2)
 
-
-def run_rpc_command_get(command_id: str, *args) -> Any:
-    """Execute command via rpc and return command output."""
-    try:
-        return actions.user.run_rpc_command_get(command_id, *args)
-    except KeyError:
-        return actions.user.vscode_get(command_id, *args)
+    def private_cursorless_run_rpc_command_get(
+        command_id: str, arg1: Any = None, arg2: Any = None
+    ) -> Any:
+        """Execute command via rpc and return command output."""
+        try:
+            return actions.user.run_rpc_command_get(command_id, arg1, arg2)
+        except KeyError:
+            return actions.user.vscode_get(command_id, arg1, arg2)

src/cursorless_snippets.talon

@@ -1,3 +1,5 @@
+mode: command
+mode: user.cursorless_spoken_form_test
 tag: user.cursorless
 -
 

src/scope_visualizer.py

@@ -1,7 +1,6 @@
-from talon import Module, app
+from talon import Module, actions, app
 
 from .csv_overrides import init_csv_and_watch_changes
-from .cursorless_command_server import run_rpc_command_no_wait
 
 mod = Module()
 mod.list("cursorless_show_scope_visualizer", desc="Show scope visualizer")
@@ -25,13 +24,15 @@ def private_cursorless_show_scope_visualizer(
         scope_type: dict, visualization_type: str
     ):
         """Shows scope visualizer"""
-        run_rpc_command_no_wait(
+        actions.user.private_cursorless_run_rpc_command_no_wait(
             "cursorless.showScopeVisualizer", scope_type, visualization_type
         )
 
     def private_cursorless_hide_scope_visualizer():
-        """Hides scope visualizer"""
-        run_rpc_command_no_wait("cursorless.hideScopeVisualizer")
+        """Hides scope visual_izer"""
+        actions.user.private_cursorless_run_rpc_command_no_wait(
+            "cursorless.hideScopeVisualizer"
+        )
 
 
 def on_ready():