Support insertSnippet action (#304)

* Support insertSnippet action

Handle action modifiers before positional modifiers

* Fixes from Andreas PR review session

* Tweaks from PR feedback

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Make halt overridable

* Clean up snippet error handling

* Throw error if multiple snippet definitions match a context

* Improve comment

* Update comment

* Cleanup

* More cleanup

* Add doc string

* Support cascading scope types for snippets

* Update doc string

* Removed duplicate test

* Restructure tests

* At link to issue

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

Author: pokey

src/actions/actions.py

@@ -86,6 +86,7 @@ def vscode_command_no_wait(command_id: str, target: dict, command_options: dict
     "swap_action": {"swap": "swapTargets"},
     "move_bring_action": {"bring": "replaceWithTarget", "move": "moveToTarget"},
     "wrap_action": {"wrap": "wrapWithPairedDelimiter", "repack": "rewrap"},
+    "insert_snippet_action": {"snippet": "insertSnippet"},
     "reformat_action": {"format": "applyFormatter"},
 }
 

src/actions/wrap.py

@@ -1,35 +1,12 @@
 from typing import Any
 
-from talon import Context, Module, actions, app
+from talon import Module, actions
 
-from ..csv_overrides import init_csv_and_watch_changes
 from ..paired_delimiter import paired_delimiters_map
 
 mod = Module()
 
-mod.tag(
-    "cursorless_experimental_snippets",
-    desc="tag for enabling experimental snippet support",
-)
-
 mod.list("cursorless_wrap_action", desc="Cursorless wrap action")
-mod.list("cursorless_wrapper_snippet", desc="Cursorless wrapper snippet")
-
-experimental_snippets_ctx = Context()
-experimental_snippets_ctx.matches = r"""
-tag: user.cursorless_experimental_snippets
-"""
-
-
-# NOTE: Please do not change these dicts.  Use the CSVs for customization.
-# See https://www.cursorless.org/docs/user/customization/
-wrapper_snippets = {
-    "else": "ifElseStatement.alternative",
-    "if else": "ifElseStatement.consequence",
-    "if": "ifStatement.consequence",
-    "try": "tryCatchStatement.body",
-    "link": "link.text",
-}
 
 
 @mod.capture(
@@ -72,18 +49,3 @@ def cursorless_wrap(action_type: str, targets: dict, cursorless_wrapper: dict):
         actions.user.cursorless_single_target_command_with_arg_list(
             action, targets, cursorless_wrapper["extra_args"]
         )
-
-
-def on_ready():
-    init_csv_and_watch_changes(
-        "experimental/wrapper_snippets",
-        {
-            "wrapper_snippet": wrapper_snippets,
-        },
-        allow_unknown_values=True,
-        default_list_name="wrapper_snippet",
-        ctx=experimental_snippets_ctx,
-    )
-
-
-app.register("ready", on_ready)

src/command.py

@@ -2,6 +2,8 @@
 
 from talon import Module, actions, speech_system
 
+from .primitive_target import IMPLICIT_TARGET
+
 mod = Module()
 
 last_phrase = None
@@ -47,17 +49,7 @@ def cursorless_single_target_command_no_wait(
         )
 
     def cursorless_single_target_command_with_arg_list(
-        action: str, target: str, args: list[Any]
-    ):
-        """Execute single-target cursorless command with argument list"""
-        actions.user.cursorless_single_target_command(
-            action,
-            target,
-            *args,
-        )
-
-    def cursorless_single_target_command_with_arg_list(
-        action: str, target: str, args: list[Any]
+        action: str, target: dict, args: list[Any]
     ):
         """Execute single-target cursorless command with argument list"""
         actions.user.cursorless_single_target_command(
@@ -83,12 +75,23 @@ def cursorless_single_target_command_get(
             ),
         )
 
+    def cursorless_implicit_target_command(
+        action: str,
+        arg1: Any = NotSet,
+        arg2: Any = NotSet,
+        arg3: Any = NotSet,
+    ):
+        """Execute cursorless command with implicit target"""
+        actions.user.cursorless_single_target_command(
+            action, IMPLICIT_TARGET, arg1, arg2, arg3
+        )
+
     def cursorless_multiple_target_command(
         action: str,
         targets: list[dict],
-        arg1: any = NotSet,
-        arg2: any = NotSet,
-        arg3: any = NotSet,
+        arg1: Any = NotSet,
+        arg2: Any = NotSet,
+        arg3: Any = NotSet,
     ):
         """Execute multi-target cursorless command"""
         actions.user.vscode_with_plugin_and_wait(
@@ -103,9 +106,9 @@ def cursorless_multiple_target_command(
     def cursorless_multiple_target_command_no_wait(
         action: str,
         targets: list[dict],
-        arg1: any = NotSet,
-        arg2: any = NotSet,
-        arg3: any = NotSet,
+        arg1: Any = NotSet,
+        arg2: Any = NotSet,
+        arg3: Any = NotSet,
     ):
         """Execute multi-target cursorless command"""
         actions.user.vscode_with_plugin(

src/cursorless-snippets.talon

@@ -0,0 +1,12 @@
+app: vscode
+tag: user.cursorless_experimental_snippets
+-
+
+{user.cursorless_insert_snippet_action} <user.cursorless_insertion_snippet>:
+    user.cursorless_implicit_target_command(cursorless_insert_snippet_action, cursorless_insertion_snippet)
+
+{user.cursorless_insert_snippet_action} <user.cursorless_insertion_snippet> <user.cursorless_positional_target>:
+    user.cursorless_single_target_command(cursorless_insert_snippet_action, cursorless_positional_target, cursorless_insertion_snippet)
+
+{user.cursorless_insert_snippet_action} {user.cursorless_insertion_snippet_single_phrase} <user.text> [{user.cursorless_phrase_terminator}]:
+    user.cursorless_insert_snippet_with_phrase(cursorless_insert_snippet_action, cursorless_insertion_snippet_single_phrase, text)

src/snippets.py

@@ -0,0 +1,119 @@
+from talon import Context, Module, actions, app
+
+from .csv_overrides import init_csv_and_watch_changes
+
+mod = Module()
+mod.list("cursorless_insert_snippet_action", desc="Cursorless insert snippet action")
+
+mod.tag(
+    "cursorless_experimental_snippets",
+    desc="tag for enabling experimental snippet support",
+)
+
+mod.list("cursorless_wrapper_snippet", desc="Cursorless wrapper snippet")
+mod.list(
+    "cursorless_insertion_snippet_no_phrase",
+    desc="Cursorless insertion snippets that don't accept a phrase",
+)
+mod.list(
+    "cursorless_insertion_snippet_single_phrase",
+    desc="Cursorless insertion snippet that can accept a single phrase",
+)
+mod.list("cursorless_phrase_terminator", "Contains term used to terminate a phrase")
+
+
+@mod.capture(
+    rule="{user.cursorless_insertion_snippet_no_phrase} | {user.cursorless_insertion_snippet_single_phrase}"
+)
+def cursorless_insertion_snippet(m) -> str:
+    try:
+        return m.cursorless_insertion_snippet_no_phrase
+    except AttributeError:
+        pass
+
+    return m.cursorless_insertion_snippet_single_phrase.split(".")[0]
+
+
+experimental_snippets_ctx = Context()
+experimental_snippets_ctx.matches = r"""
+tag: user.cursorless_experimental_snippets
+"""
+
+
+# NOTE: Please do not change these dicts.  Use the CSVs for customization.
+# See https://www.cursorless.org/docs/user/customization/
+wrapper_snippets = {
+    "else": "ifElseStatement.alternative",
+    "funk": "functionDeclaration.body",
+    "if else": "ifElseStatement.consequence",
+    "if": "ifStatement.consequence",
+    "try": "tryCatchStatement.body",
+    "link": "link.text",
+}
+
+# NOTE: Please do not change these dicts.  Use the CSVs for customization.
+# See https://www.cursorless.org/docs/user/customization/
+insertion_snippets_no_phrase = {
+    "if": "ifStatement",
+    "if else": "ifElseStatement",
+    "try": "tryCatchStatement",
+}
+
+# NOTE: Please do not change these dicts.  Use the CSVs for customization.
+# See https://www.cursorless.org/docs/user/customization/
+insertion_snippets_single_phrase = {
+    "funk": "functionDeclaration.name",
+    "link": "link.text",
+}
+
+
+@mod.action_class
+class Actions:
+    def cursorless_insert_snippet_with_phrase(
+        action: str, snippet_description: str, text: str
+    ):
+        """Perform cursorless wrap action"""
+        snippet_name, snippet_variable = snippet_description.split(".")
+        actions.user.cursorless_implicit_target_command(
+            action, snippet_name, {snippet_variable: text}
+        )
+
+
+def on_ready():
+    init_csv_and_watch_changes(
+        "experimental/wrapper_snippets",
+        {
+            "wrapper_snippet": wrapper_snippets,
+        },
+        allow_unknown_values=True,
+        default_list_name="wrapper_snippet",
+        ctx=experimental_snippets_ctx,
+    )
+    init_csv_and_watch_changes(
+        "experimental/insertion_snippets",
+        {
+            "insertion_snippet_no_phrase": insertion_snippets_no_phrase,
+        },
+        allow_unknown_values=True,
+        default_list_name="insertion_snippet_no_phrase",
+        ctx=experimental_snippets_ctx,
+    )
+    init_csv_and_watch_changes(
+        "experimental/insertion_snippets_single_phrase",
+        {
+            "insertion_snippet_single_phrase": insertion_snippets_single_phrase,
+        },
+        allow_unknown_values=True,
+        default_list_name="insertion_snippet_single_phrase",
+        ctx=experimental_snippets_ctx,
+    )
+    init_csv_and_watch_changes(
+        "experimental/miscellaneous",
+        {
+            "phrase_terminator": {"over": "phraseTerminator"},
+        },
+        ctx=experimental_snippets_ctx,
+    )
+
+
+app.register("ready", on_ready)