Clean up

Author: AndreasArvidsson

packages/common/src/types/snippet.types.ts

@@ -1,5 +1,7 @@
 import type { SimpleScopeTypeType } from "./command/PartialTargetDescriptor.types";
 
+// FIXME: Legacy snippets
+
 export interface SnippetScope {
   /**
    * VSCode language ids where this snippet definition should be active

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

@@ -4,7 +4,6 @@ import type {
   InsertSnippetArg,
   WrapWithSnippetArg,
 } from "@cursorless/common";
-import { compareSnippetDefinitions } from "./compareSnippetDefinitions";
 
 export function getPreferredSnippet(
   snippetDescription: InsertSnippetArg,
@@ -29,13 +28,11 @@ export function getPreferredSnippet(
     return snippetDescription;
   }
 
-  const filteredSnippets = filterSnippetDefinitions(
+  const preferredSnippet = tryToFindPreferredSnippet(
     snippetDescription.snippets,
     languageId,
     snippetDescription.fallbackLanguage,
   );
-  filteredSnippets.sort(compareSnippetDefinitions);
-  const preferredSnippet = filteredSnippets[0];
 
   if (preferredSnippet == null) {
     const languages = getUniqueLanguagesString(snippetDescription.snippets);
@@ -54,36 +51,53 @@ function getUniqueLanguagesString(snippets: CustomInsertSnippetArg[]): string {
   return Array.from(languages).sort().join(", ");
 }
 
-/**
- * Filter snippet definitions by language.
- * @param snippetDescriptions The snippets to filter
- * @returns The snippets that are relevant to the current language
- */
-function filterSnippetDefinitions<
+function tryToFindPreferredSnippet<
   T extends CustomInsertSnippetArg | CustomWrapWithSnippetArg,
 >(
   snippetDescriptions: T[],
   languageId: string,
   fallbackLanguage: string | undefined,
-): T[] {
+): T | undefined {
   // First try to find snippet matching language id
-  let snippets = snippetDescriptions.filter((snippetDescription) => {
-    return snippetDescription.languages?.includes(languageId);
-  });
+  let snippet = findSnippetWithFewestLanguages(
+    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);
-    });
+  if (snippet == null && fallbackLanguage != null) {
+    snippet = findSnippetWithFewestLanguages(
+      snippetDescriptions.filter((snippetDescription) => {
+        return snippetDescription.languages?.includes(fallbackLanguage);
+      }),
+    );
   }
 
-  // Finally use global snippets
-  if (snippets.length === 0) {
-    snippets = snippetDescriptions.filter((snippetDescription) => {
+  // Finally try to find global snippet
+  if (snippet == null) {
+    snippet = snippetDescriptions.find((snippetDescription) => {
       return snippetDescription.languages == null;
     });
   }
 
-  return snippets;
+  return snippet;
+}
+
+function findSnippetWithFewestLanguages<
+  T extends CustomInsertSnippetArg | CustomWrapWithSnippetArg,
+>(snippets: T[]): T | undefined {
+  if (snippets.length === 0) {
+    return undefined;
+  }
+
+  // Find the snippet with the fewest languages
+  return snippets.reduce((prev, curr) => {
+    if (prev.languages == null || curr.languages == null) {
+      throw Error(
+        "Snippet must have languages defined to find the one with the fewest languages",
+      );
+    }
+    return curr.languages.length < prev.languages.length ? curr : prev;
+  });
 }