New snippet lib

Author: AndreasArvidsson

packages/cursorless-engine/package.json

@@ -30,7 +30,7 @@
     "lodash-es": "^4.17.21",
     "moo": "0.5.2",
     "nearley": "2.20.1",
-    "talon-snippets": "1.2.0",
+    "talon-snippets": "1.3.0",
     "uuid": "^10.0.0",
     "zod": "3.23.8"
   },

packages/cursorless-engine/src/actions/GenerateSnippet/GenerateSnippetCommunity.ts

@@ -7,10 +7,11 @@ import {
   type TextEditor,
 } from "@cursorless/common";
 import {
-  getHeaderSnippet,
   parseSnippetFile,
   serializeSnippetFile,
-  type SnippetDocument,
+  type Snippet,
+  type SnippetFile,
+  type SnippetHeader,
   type SnippetVariable,
 } from "talon-snippets";
 import type { Snippets } from "../../core/Snippets";
@@ -129,36 +130,35 @@ export default class GenerateSnippetCommunity {
     const snippetLines = constructSnippetBody(snippetBodyText, linePrefix);
 
     let editableEditor: EditableTextEditor;
-    let snippetDocuments: SnippetDocument[];
+    let snippetFile: SnippetFile = { snippets: [] };
 
     if (ide().runMode === "test") {
       // If we're testing, we just overwrite the current document
       editableEditor = ide().getEditableTextEditor(editor);
-      snippetDocuments = [];
     } else {
       // Otherwise, we create and open a new document for the snippet
       editableEditor = ide().getEditableTextEditor(
         await this.snippets.openNewSnippetFile(snippetName, directory),
       );
-      snippetDocuments = parseSnippetFile(editableEditor.document.getText());
+      snippetFile = parseSnippetFile(editableEditor.document.getText());
     }
 
     await editableEditor.setSelections([
       editableEditor.document.range.toSelection(false),
     ]);
 
-    const headerSnippet = getHeaderSnippet(snippetDocuments);
-
     /** The next placeholder index to use for the meta snippet */
     let currentPlaceholderIndex = 1;
 
+    const { header } = snippetFile;
+
     const phrases =
-      headerSnippet?.phrases != null
+      snippetFile.header?.phrases != null
         ? undefined
         : [`${PLACEHOLDER}${currentPlaceholderIndex++}`];
 
     const createVariable = (variable: Variable): SnippetVariable => {
-      const hasPhrase = headerSnippet?.variables?.some(
+      const hasPhrase = header?.variables?.some(
         (v) => v.name === variable.name && v.wrapperPhrases != null,
       );
       return {
@@ -169,22 +169,22 @@ export default class GenerateSnippetCommunity {
       };
     };
 
-    const snippet: SnippetDocument = {
-      name: headerSnippet?.name === snippetName ? undefined : snippetName,
+    const snippet: Snippet = {
+      name: header?.name === snippetName ? undefined : snippetName,
       phrases,
-      languages: getSnippetLanguages(editor, headerSnippet),
+      languages: getSnippetLanguages(editor, header),
       body: snippetLines,
       variables: variables.map(createVariable),
     };
 
-    snippetDocuments.push(snippet);
+    snippetFile.snippets.push(snippet);
 
     /**
      * This is the text of the meta-snippet in Textmate format that we will
      * insert into the new document where the user will fill out their snippet
      * definition
      */
-    const metaSnippetText = serializeSnippetFile(snippetDocuments)
+    const metaSnippetText = serializeSnippetFile(snippetFile)
       // Escape dollar signs in the snippet text so that they don't get used as
       // placeholders in the meta snippet
       .replace(/\$/g, "\\$")
@@ -205,7 +205,7 @@ export default class GenerateSnippetCommunity {
 
 function getSnippetLanguages(
   editor: TextEditor,
-  header: SnippetDocument | undefined,
+  header: SnippetHeader | undefined,
 ): string[] | undefined {
   if (header?.languages?.includes(editor.document.languageId)) {
     return undefined;

packages/cursorless-vscode/package.json

@@ -1289,7 +1289,7 @@
     "lodash-es": "^4.17.21",
     "nearley": "2.20.1",
     "semver": "^7.6.3",
-    "talon-snippets": "1.2.0",
+    "talon-snippets": "1.3.0",
     "tinycolor2": "1.6.0",
     "trie-search": "2.0.0",
     "uuid": "^10.0.0",

packages/cursorless-vscode/src/migrateSnippets.ts

@@ -6,7 +6,7 @@ import * as fs from "node:fs/promises";
 import * as path from "node:path";
 import {
   serializeSnippetFile,
-  type SnippetDocument,
+  type SnippetFile,
   type SnippetVariable,
 } from "talon-snippets";
 import * as vscode from "vscode";
@@ -31,20 +31,20 @@ export async function migrateSnippets(
 async function migrateFile(targetDirectory: string, filePath: string) {
   const fileName = path.basename(filePath, ".cursorless-snippets");
   const snippetFile = await readLegacyFile(filePath);
-  const communitySnippetFile: SnippetDocument[] = [];
+  const communitySnippetFile: SnippetFile = { snippets: [] };
 
   for (const snippetName in snippetFile) {
     const snippet = snippetFile[snippetName];
 
-    communitySnippetFile.push({
+    communitySnippetFile.header = {
       name: snippetName,
+      description: snippet.description,
       variables: parseVariables(snippet.variables),
       insertionScopes: snippet.insertionScopeTypes,
-      description: snippet.description,
-    });
+    };
 
     for (const def of snippet.definitions) {
-      communitySnippetFile.push({
+      communitySnippetFile.snippets.push({
         body: def.body.map((line) => line.replaceAll("\t", "    ")),
         languages: def.scope?.langIds,
         variables: parseVariables(def.variables),
@@ -98,10 +98,7 @@ async function readLegacyFile(filePath: string): Promise<SnippetMap> {
   return JSON.parse(content);
 }
 
-async function writeCommunityFile(
-  snippetFile: SnippetDocument[],
-  filePath: string,
-) {
+async function writeCommunityFile(snippetFile: SnippetFile, filePath: string) {
   const snippetText = serializeSnippetFile(snippetFile);
   const file = await fs.open(filePath, "w");
   await file.write(snippetText);