Added voice command to migrate Cursorless snippet to community format

cursorless-talon/src/actions/generate_snippet.py

@@ -15,6 +15,13 @@
 
 @mod.action_class
 class Actions:
+    def private_cursorless_migrate_snippets():
+        """Migrate snippets from Cursorless to community format"""
+        actions.user.private_cursorless_run_rpc_command_no_wait(
+            "cursorless.migrateSnippets",
+            str(get_directory_path()),
+        )
+
     def private_cursorless_generate_snippet_action(target: CursorlessExplicitTarget):  # pyright: ignore [reportGeneralTypeIssues]
         """Generate a snippet from the given target"""
         actions.user.private_cursorless_command_no_wait(

cursorless-talon/src/cursorless.talon

@@ -47,3 +47,6 @@ tutorial resume: user.private_cursorless_tutorial_resume()
 tutorial (list | close): user.private_cursorless_tutorial_list()
 tutorial <number_small>:
     user.private_cursorless_tutorial_start_by_number(number_small)
+
+{user.cursorless_homophone} migrate snippets:
+    user.private_cursorless_migrate_snippets()

packages/common/src/cursorlessCommandIds.ts

@@ -38,6 +38,7 @@ export const cursorlessCommandIds = [
   "cursorless.keyboard.targeted.targetHat",
   "cursorless.keyboard.targeted.targetScope",
   "cursorless.keyboard.targeted.targetSelection",
+  "cursorless.migrateSnippets",
   "cursorless.pauseRecording",
   "cursorless.recomputeDecorationStyles",
   "cursorless.recordTestCase",
@@ -164,4 +165,7 @@ export const cursorlessCommandDescriptions: Record<
   ["cursorless.keyboard.redoTarget"]: new HiddenCommand(
     "Redo keyboard targeting changes",
   ),
+  ["cursorless.migrateSnippets"]: new HiddenCommand(
+    "Migrate snippets from the old Cursorless format to the new community format",
+  ),
 };

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.1.0",
+    "talon-snippets": "1.2.0",
     "uuid": "^10.0.0",
     "zod": "3.23.8"
   },

packages/cursorless-neovim/src/registerCommands.ts

@@ -88,6 +88,7 @@ export async function registerCommands(
     ["cursorless.showQuickPick"]: dummyCommandHandler,
     ["cursorless.showDocumentation"]: dummyCommandHandler,
     ["cursorless.showInstallationDependencies"]: dummyCommandHandler,
+    ["cursorless.migrateSnippets"]: dummyCommandHandler,
     ["cursorless.private.logQuickActions"]: dummyCommandHandler,
 
     // Hats

packages/cursorless-org-docs/src/docs/user/experimental/snippets.md

@@ -19,6 +19,10 @@ Note that this line will also disable any Cursorless snippets defined in your Cu
 
 Cursorless has its own experimental snippet engine that allows you to both insert snippets and wrap targets with snippets. Cursorless ships with a few built-in snippets, but users can also use their own snippets.
 
+## Migrate Cursorless snippet to community
+
+Say `"Cursorless migrate snippets"` to convert your existing experimental Cursorless snippet json files to the new community snippet format.
+
 ## Using snippets
 
 ### Wrapping a target with snippets

packages/cursorless-vscode/package.json

@@ -238,6 +238,11 @@
         "command": "cursorless.keyboard.redoTarget",
         "title": "Cursorless: Redo keyboard targeting changes",
         "enablement": "false"
+      },
+      {
+        "command": "cursorless.migrateSnippets",
+        "title": "Cursorless: Migrate snippets from the old Cursorless format to the new community format",
+        "enablement": "false"
       }
     ],
     "colors": [
@@ -1284,6 +1289,7 @@
     "lodash-es": "^4.17.21",
     "nearley": "2.20.1",
     "semver": "^7.6.3",
+    "talon-snippets": "1.2.0",
     "tinycolor2": "1.6.0",
     "trie-search": "2.0.0",
     "uuid": "^10.0.0",

packages/cursorless-vscode/src/VscodeSnippets.ts

@@ -77,7 +77,7 @@ export class VscodeSnippets implements Snippets {
   async init() {
     const extensionPath = this.ide.assetsRoot;
     const snippetsDir = join(extensionPath, "cursorless-snippets");
-    const snippetFiles = await getSnippetPaths(snippetsDir);
+    const snippetFiles = await this.getSnippetPaths(snippetsDir);
     this.coreSnippets = mergeStrict(
       ...(await Promise.all(
         snippetFiles.map(async (path) =>
@@ -115,7 +115,7 @@ export class VscodeSnippets implements Snippets {
     let snippetFiles: string[];
     try {
       snippetFiles = this.userSnippetsDir
-        ? await getSnippetPaths(this.userSnippetsDir)
+        ? await this.getSnippetPaths(this.userSnippetsDir)
         : [];
     } catch (err) {
       if (this.directoryErrorMessage?.directory !== this.userSnippetsDir) {
@@ -244,24 +244,31 @@ export class VscodeSnippets implements Snippets {
         return join(directory, `${snippetName}.snippet`);
       }
 
-      const userSnippetsDir = this.ide.configuration.getOwnConfiguration(
-        "experimental.snippetsDir",
+      return join(
+        this.getUserDirectoryStrict(),
+        `${snippetName}.cursorless-snippets`,
       );
-
-      if (!userSnippetsDir) {
-        throw new Error("User snippets dir not configured.");
-      }
-
-      return join(userSnippetsDir, `${snippetName}.cursorless-snippets`);
     })();
 
     await touch(path);
     return this.ide.openTextDocument(path);
   }
-}
 
-function getSnippetPaths(snippetsDir: string) {
-  return walkFiles(snippetsDir, CURSORLESS_SNIPPETS_SUFFIX);
+  getUserDirectoryStrict() {
+    const userSnippetsDir = this.ide.configuration.getOwnConfiguration(
+      "experimental.snippetsDir",
+    );
+
+    if (!userSnippetsDir) {
+      throw new Error("User snippets dir not configured.");
+    }
+
+    return userSnippetsDir;
+  }
+
+  getSnippetPaths(snippetsDir: string) {
+    return walkFiles(snippetsDir, CURSORLESS_SNIPPETS_SUFFIX);
+  }
 }
 
 async function touch(path: string) {

packages/cursorless-vscode/src/extension.ts

@@ -194,6 +194,7 @@ export async function activate(
     vscodeTutorial,
     installationDependencies,
     storedTargets,
+    snippets,
   );
 
   void new ReleaseNotes(vscodeApi, context, normalizedIde.messages).maybeShow();

packages/cursorless-vscode/src/migrateSnippets.ts

@@ -0,0 +1,109 @@
+import type {
+  SnippetMap,
+  SnippetVariable as SnippetVariableLegacy,
+} from "@cursorless/common";
+import * as fs from "node:fs/promises";
+import * as path from "node:path";
+import {
+  serializeSnippetFile,
+  type SnippetDocument,
+  type SnippetVariable,
+} from "talon-snippets";
+import * as vscode from "vscode";
+import type { VscodeSnippets } from "./VscodeSnippets";
+
+export async function migrateSnippets(
+  snippets: VscodeSnippets,
+  targetDirectory: string,
+) {
+  const userSnippetsDir = snippets.getUserDirectoryStrict();
+  const files = await snippets.getSnippetPaths(userSnippetsDir);
+
+  for (const file of files) {
+    await migrateFile(targetDirectory, file);
+  }
+
+  await vscode.window.showInformationMessage(
+    `${files.length} snippet files migrated successfully!`,
+  );
+}
+
+async function migrateFile(targetDirectory: string, filePath: string) {
+  const fileName = path.basename(filePath, ".cursorless-snippets");
+  const snippetFile = await readLegacyFile(filePath);
+  const communitySnippetFile: SnippetDocument[] = [];
+
+  for (const snippetName in snippetFile) {
+    const snippet = snippetFile[snippetName];
+
+    communitySnippetFile.push({
+      name: snippetName,
+      variables: parseVariables(snippet.variables),
+      insertionScopes: snippet.insertionScopeTypes,
+      description: snippet.description,
+    });
+
+    for (const def of snippet.definitions) {
+      communitySnippetFile.push({
+        body: def.body.map((line) => line.replaceAll("\t", "    ")),
+        languages: def.scope?.langIds,
+        variables: parseVariables(def.variables),
+        // SKIP: def.scope?.scopeTypes
+        // SKIP: def.scope?.excludeDescendantScopeTypes
+      });
+    }
+  }
+
+  let destinationPath = path.join(targetDirectory, `${fileName}.snippet`);
+  if (await fileExists(destinationPath)) {
+    destinationPath = path.join(
+      targetDirectory,
+      `${fileName}_CONFLICT.snippet`,
+    );
+  }
+  await writeCommunityFile(communitySnippetFile, destinationPath);
+}
+
+function parseVariables(
+  variables?: Record<string, SnippetVariableLegacy>,
+): SnippetVariable[] {
+  return Object.entries(variables ?? {}).map(
+    ([name, variable]): SnippetVariable => {
+      return {
+        name,
+        wrapperScope: variable.wrapperScopeType,
+        insertionFormatters: variable.formatter
+          ? [variable.formatter]
+          : undefined,
+        // SKIP: variable.description
+      };
+    },
+  );
+}
+
+async function fileExists(filePath: string): Promise<boolean> {
+  try {
+    await fs.access(filePath);
+    return true;
+  } catch (_e) {
+    return false;
+  }
+}
+
+async function readLegacyFile(filePath: string): Promise<SnippetMap> {
+  const content = await fs.readFile(filePath, "utf8");
+  if (content.length === 0) {
+    return {};
+  }
+  return JSON.parse(content);
+}
+
+async function writeCommunityFile(
+  snippetFile: SnippetDocument[],
+  filePath: string,
+) {
+  const snippetText = serializeSnippetFile(snippetFile);
+  const file = await fs.open(filePath, "w");
+  await file.write(snippetText);
+  await file.close();
+}

packages/cursorless-vscode/src/registerCommands.ts

@@ -19,12 +19,14 @@ import type {
 import * as vscode from "vscode";
 import type { InstallationDependencies } from "./InstallationDependencies";
 import type { ScopeVisualizer } from "./ScopeVisualizerCommandApi";
+import type { VscodeSnippets } from "./VscodeSnippets";
 import type { VscodeTutorial } from "./VscodeTutorial";
 import { showDocumentation, showQuickPick } from "./commands";
 import type { VscodeIDE } from "./ide/vscode/VscodeIDE";
 import type { VscodeHats } from "./ide/vscode/hats/VscodeHats";
 import type { KeyboardCommands } from "./keyboard/KeyboardCommands";
 import { logQuickActions } from "./logQuickActions";
+import { migrateSnippets } from "./migrateSnippets";
 
 export function registerCommands(
   extensionContext: vscode.ExtensionContext,
@@ -39,6 +41,7 @@ export function registerCommands(
   tutorial: VscodeTutorial,
   installationDependencies: InstallationDependencies,
   storedTargets: StoredTargetMap,
+  snippets: VscodeSnippets,
 ): void {
   const runCommandWrapper = async (run: () => Promise<unknown>) => {
     try {
@@ -86,6 +89,8 @@ export function registerCommands(
     ["cursorless.showDocumentation"]: showDocumentation,
     ["cursorless.showInstallationDependencies"]: installationDependencies.show,
 
+    ["cursorless.migrateSnippets"]: (dir) => migrateSnippets(snippets, dir),
+
     ["cursorless.private.logQuickActions"]: logQuickActions,
 
     // Hats