Added fallback language to list snippets

Author: AndreasArvidsson

cursorless-talon/src/check_community_repo.py

@@ -8,6 +8,7 @@
 ]
 
 required_actions = [
+    "code.language",
     "user.homophones_get",
     "user.insert_snippet_by_name",
     "user.reformat_text",

cursorless-talon/src/snippets/snippet_types.py

@@ -62,6 +62,7 @@ def create(
 @dataclass
 class ListInsertionSnippet:
     type = "list"
+    fallbackLanguage: str | None
     substitutions: dict[str, str] | None
     snippets: list[CustomInsertionSnippet]
 
@@ -98,6 +99,7 @@ def create(snippet: CommunityWrapperSnippet):
 @dataclass
 class ListWrapperSnippet:
     type = "list"
+    fallbackLanguage: str | None
     snippets: list[CustomWrapperSnippet]
 
 

cursorless-talon/src/snippets/snippets.py

@@ -100,7 +100,7 @@ class UserActions:
     def insert_snippet_by_name(
         name: str,  # pyright: ignore [reportGeneralTypeIssues]
         # Don't add optional: we need to match the type in community
-        substitutions: dict[str, str] = None,
+        substitutions: dict[str, str] = None,  # type: ignore
     ):
         action = InsertSnippetAction(
             get_list_insertion_snippet(name, substitutions),

cursorless-talon/src/snippets/snippets_get.py

@@ -30,6 +30,7 @@ def get_list_insertion_snippet(
         raise
 
     return ListInsertionSnippet(
+        get_fallback_language(),
         substitutions,
         [CustomInsertionSnippet.create(s) for s in snippets],
     )
@@ -49,5 +50,13 @@ def get_list_wrapper_snippet(name: str) -> ListWrapperSnippet | CustomWrapperSni
         raise
 
     return ListWrapperSnippet(
+        get_fallback_language(),
         [CustomWrapperSnippet.create(s) for s in snippets],
     )
+
+
+def get_fallback_language():
+    language = actions.code.language()
+    if language and isinstance(language, str):
+        return language
+    return None

data/fixtures/recorded/actions/snippets/ifWrapAir.yml

@@ -0,0 +1,42 @@
+languageId: typescript
+command:
+  version: 6
+  spokenForm: if wrap air
+  action:
+    name: wrapWithSnippet
+    snippetDescription:
+      type: list
+      snippets:
+        - type: custom
+          body: "if ($1) {\n\t$0\n}"
+          variableName: "0"
+          languages: [c, cpp, csharp, java, javascript, typescript, javascriptreact, typescriptreact]
+    target:
+      type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: a}
+  usePrePhraseSnapshot: true
+spokenFormError: list wrap with snippet
+initialState:
+  documentContents: aaa
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  marks:
+    default.a:
+      start: {line: 0, character: 0}
+      end: {line: 0, character: 3}
+finalState:
+  documentContents: |-
+    if () {
+        aaa
+    }
+  selections:
+    - anchor: {line: 0, character: 4}
+      active: {line: 0, character: 4}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 0, character: 0}
+        end: {line: 2, character: 1}
+      isReversed: false
+      hasExplicitRange: true

data/fixtures/recorded/actions/snippets/ifWrapAir2.yml

@@ -0,0 +1,43 @@
+languageId: plaintext
+command:
+  version: 6
+  spokenForm: if wrap air
+  action:
+    name: wrapWithSnippet
+    snippetDescription:
+      type: list
+      fallbackLanguage: typescript
+      snippets:
+        - type: custom
+          body: "if ($1) {\n\t$0\n}"
+          variableName: "0"
+          languages: [c, cpp, csharp, java, javascript, typescript, javascriptreact, typescriptreact]
+    target:
+      type: primitive
+      mark: {type: decoratedSymbol, symbolColor: default, character: a}
+  usePrePhraseSnapshot: true
+spokenFormError: list wrap with snippet
+initialState:
+  documentContents: aaa
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  marks:
+    default.a:
+      start: {line: 0, character: 0}
+      end: {line: 0, character: 3}
+finalState:
+  documentContents: |-
+    if () {
+        aaa
+    }
+  selections:
+    - anchor: {line: 0, character: 4}
+      active: {line: 0, character: 4}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 0, character: 0}
+        end: {line: 2, character: 1}
+      isReversed: false
+      hasExplicitRange: true

data/fixtures/recorded/actions/snippets/snipIf2.yml

@@ -0,0 +1,49 @@
+languageId: plaintext
+command:
+  version: 7
+  spokenForm: snip if
+  action:
+    name: insertSnippet
+    snippetDescription:
+      type: list
+      fallbackLanguage: typescript
+      snippets:
+        - type: custom
+          body: "if ($1) {\n\t$0\n}"
+          scopeTypes:
+            - {type: statement}
+          languages: [c, cpp, csharp, java, javascript, typescript, javascriptreact, typescriptreact]
+        - type: custom
+          body: "if $1:\n\t$0"
+          scopeTypes:
+            - {type: statement}
+          languages: [python]
+        - type: custom
+          body: "if $1 then\n\t$0\nend"
+          scopeTypes:
+            - {type: statement}
+          languages: [lua]
+    destination: {type: implicit}
+  usePrePhraseSnapshot: false
+spokenFormError: list insertion snippet
+initialState:
+  documentContents: ""
+  selections:
+    - anchor: {line: 0, character: 0}
+      active: {line: 0, character: 0}
+  marks: {}
+finalState:
+  documentContents: |-
+    if () {
+        
+    }
+  selections:
+    - anchor: {line: 0, character: 4}
+      active: {line: 0, character: 4}
+  thatMark:
+    - type: UntypedTarget
+      contentRange:
+        start: {line: 0, character: 0}
+        end: {line: 2, character: 1}
+      isReversed: false
+      hasExplicitRange: true

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

@@ -161,6 +161,7 @@ export interface CustomInsertSnippetArg {
 
 interface ListInsertSnippetArg {
   type: "list";
+  fallbackLanguage?: string;
   substitutions?: Record<string, string>;
   snippets: CustomInsertSnippetArg[];
 }
@@ -192,6 +193,7 @@ export interface CustomWrapWithSnippetArg {
 
 interface ListWrapWithSnippetArg {
   type: "list";
+  fallbackLanguage?: string;
   snippets: CustomWrapWithSnippetArg[];
 }
 

packages/cursorless-engine/src/core/getPreferredSnippet.ts

@@ -32,6 +32,7 @@ export function getPreferredSnippet(
   const filteredSnippets = filterSnippetDefinitions(
     snippetDescription.snippets,
     languageId,
+    snippetDescription.fallbackLanguage,
   );
   filteredSnippets.sort(compareSnippetDefinitions);
   const preferredSnippet = filteredSnippets[0];
@@ -60,11 +61,29 @@ function getUniqueLanguagesString(snippets: CustomInsertSnippetArg[]): string {
  */
 function filterSnippetDefinitions<
   T extends CustomInsertSnippetArg | CustomWrapWithSnippetArg,
->(snippetDescriptions: T[], languageId: string): T[] {
-  return snippetDescriptions.filter((snippetDescription) => {
-    if (snippetDescription.languages == null) {
-      return true;
-    }
-    return snippetDescription.languages.includes(languageId);
+>(
+  snippetDescriptions: T[],
+  languageId: string,
+  fallbackLanguage: string | undefined,
+): T[] {
+  // First try to find snippet matching language id
+  let snippets = snippetDescriptions.filter((snippetDescription) => {
+    return snippetDescription.languages?.includes(languageId);
   });
+
+  // Secondly try to find snippet matching fallback language
+  if (snippets.length === 0 && fallbackLanguage != null) {
+    snippets = snippetDescriptions.filter((snippetDescription) => {
+      return snippetDescription.languages?.includes(fallbackLanguage);
+    });
+  }
+
+  // Finally use global snippets
+  if (snippets.length === 0) {
+    snippets = snippetDescriptions.filter((snippetDescription) => {
+      return snippetDescription.languages == null;
+    });
+  }
+
+  return snippets;
 }