Use spoken forms for tree view

Author: pokey

cursorless-talon/src/csv_overrides.py

@@ -3,7 +3,7 @@
 from collections.abc import Container
 from datetime import datetime
 from pathlib import Path
-from typing import Optional
+from typing import Callable, Optional
 
 from talon import Context, Module, actions, app, fs
 
@@ -32,6 +32,9 @@
 """
 
 
+GetType = Callable[[str, str], str]
+
+
 def init_csv_and_watch_changes(
     filename: str,
     default_values: dict[str, dict[str, str]],
@@ -42,6 +45,7 @@ def init_csv_and_watch_changes(
     ctx: Context = Context(),
     no_update_file: bool = False,
     pluralize_lists: list[str] = [],
+    get_type: Optional[GetType] = None,
 ):
     """
     Initialize a cursorless settings csv, creating it if necessary, and watch
@@ -106,6 +110,7 @@ def on_watch(path, flags):
                 default_list_name,
                 pluralize_lists,
                 output_file_path,
+                get_type,
                 ctx,
             )
 
@@ -128,6 +133,7 @@ def on_watch(path, flags):
             default_list_name,
             pluralize_lists,
             output_file_path,
+            get_type,
             ctx,
         )
     else:
@@ -141,6 +147,7 @@ def on_watch(path, flags):
             default_list_name,
             pluralize_lists,
             output_file_path,
+            get_type,
             ctx,
         )
 
@@ -188,6 +195,7 @@ def update_dicts(
     default_list_name: Optional[str],
     pluralize_lists: list[str],
     output_file_path: Path,
+    get_type: Optional[GetType],
     ctx: Context,
 ):
     # Create map with all default values
@@ -214,29 +222,24 @@ def update_dicts(
 
     # Convert result map back to result list
     results = {res["list"]: {} for res in results_map.values()}
-    output_file_dict = {}
+    output_file_entries = []
     for obj in results_map.values():
         value = obj["value"]
         key = obj["key"]
-        if not is_removed(key):
-            for k in key.split("|"):
-                if value == "pasteFromClipboard" and k.endswith(" to"):
-                    # FIXME: This is a hack to work around the fact that the
-                    # spoken form of the `pasteFromClipboard` action used to be
-                    # "paste to", but now the spoken form is just "paste" and
-                    # the "to" is part of the positional target. Users who had
-                    # cursorless before this change would have "paste to" as
-                    # their spoken form and so would need to say "paste to to".
-                    k = k[:-3]
-                results[obj["list"]][k.strip()] = value
-                output_file_dict[value] = k.strip()
+        spoken_forms = list(get_spoken_forms(value, key))
+        for spoken_form in spoken_forms:
+            results[obj["list"]][spoken_form] = value
+        if get_type is not None and (entry_type := get_type(obj["list"], value)):
+            output_file_entries.append(
+                {"type": entry_type, "id": value, "spokenForms": spoken_forms}
+            )
 
     # Assign result to talon context list
     assign_lists_to_context(ctx, results, pluralize_lists)
 
     with open(output_file_path, "w") as out:
         try:
-            out.write(json.dumps(output_file_dict))
+            out.write(json.dumps({"version": 0, "entries": output_file_entries}))
         except Exception:
             error_message = f"Error writing spoken form json {output_file_path}"
             print(error_message)
@@ -256,6 +259,21 @@ def assign_lists_to_context(
             ctx.lists[list_plural_name] = {pluralize(k): v for k, v in dict.items()}
 
 
+def get_spoken_forms(id: str, spoken_form: str):
+    if not is_removed(spoken_form):
+        for k in spoken_form.split("|"):
+            if id == "pasteFromClipboard" and k.endswith(" to"):
+                # FIXME: This is a hack to work around the fact that the
+                # spoken form of the `pasteFromClipboard` action used to be
+                # "paste to", but now the spoken form is just "paste" and
+                # the "to" is part of the positional target. Users who had
+                # cursorless before this change would have "paste to" as
+                # their spoken form and so would need to say "paste to to".
+                k = k[:-3]
+
+            yield k.strip()
+
+
 def update_file(
     path: Path,
     headers: list[str],

cursorless-talon/src/spoken_forms.py

@@ -64,14 +64,15 @@ def update():
         handle_csv("target_connectives.csv"),
         handle_csv("modifiers.csv"),
         handle_csv("positions.csv"),
-        handle_csv("paired_delimiters.csv"),
         handle_csv("special_marks.csv"),
         handle_csv("scope_visualizer.csv"),
         handle_csv("experimental/experimental_actions.csv"),
         handle_csv("experimental/miscellaneous.csv"),
+        handle_csv("paired_delimiters.csv", get_type=lambda _1, _2: "pairedDelimiter"),
         handle_csv(
             "modifier_scope_types.csv",
             pluralize_lists=["scope_type"],
+            get_type=get_type,
         ),
         handle_csv(
             "experimental/wrapper_snippets.csv",
@@ -100,6 +101,7 @@ def update():
             allow_unknown_values=True,
             default_list_name="custom_regex_scope_type",
             pluralize_lists=["custom_regex_scope_type"],
+            get_type=lambda _1, _2: "customRegex",
         ),
         init_marks(
             spoken_forms["hat_styles.csv"]["hat_color"],
@@ -108,6 +110,10 @@ def update():
     ]
 
 
+def get_type(list_name: str, id: str):
+    return "simpleScopeTypeType" if list_name == "scope_type" else "pairedDelimiter"
+
+
 def on_watch(path, flags):
     if JSON_FILE.match(path):
         update()

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

@@ -0,0 +1,7 @@
+import { Disposable } from "./ide.types";
+
+export type PathChangeListener = () => void;
+
+export interface FileSystem {
+  watchDir(path: string, onDidChange: PathChangeListener): Disposable;
+}

packages/common/src/index.ts

@@ -30,6 +30,7 @@ export * from "./ide/types/Events";
 export * from "./ide/types/QuickPickOptions";
 export * from "./ide/types/events.types";
 export * from "./ide/types/Paths";
+export * from "./ide/types/FileSystem.types";
 export * from "./types/RangeExpansionBehavior";
 export * from "./types/InputBoxOptions";
 export * from "./types/Position";

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

@@ -80,7 +80,7 @@ export const simpleSurroundingPairNames = [
   "backtickQuotes",
   "curlyBrackets",
   "doubleQuotes",
-  "escapedDoubleQuomes",
+  "escapedDoubleQuotes",
   "escapedParentheses",
   "escapedSquareBrackets",
   "escapedSingleQuotes",
@@ -169,6 +169,12 @@ export const simpleScopeTypeTypes = [
   "command",
 ] as const;
 
+export function isSimpleScopeType(
+  scopeType: ScopeType,
+): scopeType is SimpleScopeType {
+  return simpleScopeTypeTypes.includes(scopeType.type as any);
+}
+
 export type SimpleScopeTypeType = (typeof simpleScopeTypeTypes)[number];
 
 export interface SimpleScopeType {