Pass snippets as argument to engine

AndreasArvidsson · AndreasArvidsson · commit 2e69df8b9b88 · 2024-07-09T22:25:41.000+02:00
diff --git a/packages/cursorless-engine/src/actions/Actions.ts b/packages/cursorless-engine/src/actions/Actions.ts
@@ -69,7 +69,7 @@ import { Decrement, Increment } from "./incrementDecrement";
 export class Actions implements ActionRecord {
   constructor(
     private treeSitter: TreeSitter,
-    private snippets: Snippets,
+    private snippets: Snippets | undefined,
     private rangeUpdater: RangeUpdater,
     private modifierStageFactory: ModifierStageFactory,
   ) {}
diff --git a/packages/cursorless-engine/src/actions/InsertSnippet.ts b/packages/cursorless-engine/src/actions/InsertSnippet.ts
@@ -31,7 +31,7 @@ export default class InsertSnippet {
 
   constructor(
     private rangeUpdater: RangeUpdater,
-    private snippets: Snippets,
+    private snippets: Snippets | undefined,
     private actions: Actions,
     private modifierStageFactory: ModifierStageFactory,
   ) {
@@ -56,6 +56,10 @@ export default class InsertSnippet {
 
   private getScopeTypes(snippetDescription: InsertSnippetArg): ScopeType[] {
     if (snippetDescription.type === "named") {
+      if (this.snippets == null) {
+        return [];
+      }
+
       const { name } = snippetDescription;
 
       const snippet = this.snippets.getSnippetStrict(name);
@@ -76,6 +80,10 @@ export default class InsertSnippet {
     targets: Target[],
   ) {
     if (snippetDescription.type === "named") {
+      if (this.snippets == null) {
+        throw Error("Named snippets are not enabled");
+      }
+
       const { name } = snippetDescription;
 
       const snippet = this.snippets.getSnippetStrict(name);
diff --git a/packages/cursorless-engine/src/actions/WrapWithSnippet.ts b/packages/cursorless-engine/src/actions/WrapWithSnippet.ts
@@ -19,7 +19,7 @@ export default class WrapWithSnippet {
 
   constructor(
     private rangeUpdater: RangeUpdater,
-    private snippets: Snippets,
+    private snippets: Snippets | undefined,
     private modifierStageFactory: ModifierStageFactory,
   ) {
     this.run = this.run.bind(this);
@@ -47,6 +47,10 @@ export default class WrapWithSnippet {
     snippetDescription: WrapWithSnippetArg,
   ): ScopeType | undefined {
     if (snippetDescription.type === "named") {
+      if (this.snippets == null) {
+        return undefined;
+      }
+
       const { name, variableName } = snippetDescription;
 
       const snippet = this.snippets.getSnippetStrict(name);
@@ -68,6 +72,10 @@ export default class WrapWithSnippet {
     targets: Target[],
   ): string {
     if (snippetDescription.type === "named") {
+      if (this.snippets == null) {
+        throw Error("Named snippets are not enabled");
+      }
+
       const { name } = snippetDescription;
 
       const snippet = this.snippets.getSnippetStrict(name);
diff --git a/packages/cursorless-engine/src/api/CursorlessEngineApi.ts b/packages/cursorless-engine/src/api/CursorlessEngineApi.ts
@@ -7,7 +7,6 @@ import type {
   ScopeProvider,
 } from "@cursorless/common";
 import type { CommandRunner } from "../CommandRunner";
-import type { Snippets } from "../core/Snippets";
 import type { StoredTargetMap } from "../core/StoredTargets";
 
 export interface CursorlessEngine {
@@ -16,7 +15,6 @@ export interface CursorlessEngine {
   customSpokenFormGenerator: CustomSpokenFormGenerator;
   storedTargets: StoredTargetMap;
   hatTokenMap: HatTokenMap;
-  snippets: Snippets;
   injectIde: (ide: IDE | undefined) => void;
   runIntegrationTests: () => Promise<void>;
   addCommandRunnerDecorator: (
diff --git a/packages/cursorless-engine/src/core/Snippets.ts b/packages/cursorless-engine/src/core/Snippets.ts
@@ -1,190 +1,12 @@
-import { showError, Snippet, SnippetMap, walkFiles } from "@cursorless/common";
-import { readFile, stat } from "fs/promises";
-import { max } from "lodash";
-import { join } from "path";
-import { ide } from "../singletons/ide.singleton";
-import { mergeStrict } from "../util/object";
-import { mergeSnippets } from "./mergeSnippets";
-
-const CURSORLESS_SNIPPETS_SUFFIX = ".cursorless-snippets";
-const SNIPPET_DIR_REFRESH_INTERVAL_MS = 1000;
-
-interface DirectoryErrorMessage {
-  directory: string;
-  errorMessage: string;
-}
+import { Snippet, SnippetMap } from "@cursorless/common";
 
 /**
  * Handles all cursorless snippets, including core, third-party and
  * user-defined.  Merges these collections and allows looking up snippets by
  * name.
  */
-export class Snippets {
-  private coreSnippets!: SnippetMap;
-  private thirdPartySnippets: Record<string, SnippetMap> = {};
-  private userSnippets!: SnippetMap[];
-
-  private mergedSnippets!: SnippetMap;
-
-  private userSnippetsDir?: string;
-
-  /**
-   * The maximum modification time of any snippet in user snippets dir.
-   *
-   * This variable will be set to -1 if no user snippets have yet been read or
-   * if the user snippets path has changed.
-   *
-   * This variable will be set to 0 if the user has no snippets dir configured and
-   * we've already set userSnippets to {}.
-   */
-  private maxSnippetMtimeMs: number = -1;
-
-  /**
-   * If the user has misconfigured their snippet dir, then we keep track of it
-   * so that we can show them the error message if we can't find a snippet
-   * later, and so that we don't show them the same error message every time
-   * we try to poll the directory.
-   */
-  private directoryErrorMessage: DirectoryErrorMessage | null | undefined =
-    null;
-
-  constructor() {
-    this.updateUserSnippetsPath();
-
-    this.updateUserSnippets = this.updateUserSnippets.bind(this);
-    this.registerThirdPartySnippets =
-      this.registerThirdPartySnippets.bind(this);
-
-    const timer = setInterval(
-      this.updateUserSnippets,
-      SNIPPET_DIR_REFRESH_INTERVAL_MS,
-    );
-
-    ide().disposeOnExit(
-      ide().configuration.onDidChangeConfiguration(() => {
-        if (this.updateUserSnippetsPath()) {
-          this.updateUserSnippets();
-        }
-      }),
-      {
-        dispose() {
-          clearInterval(timer);
-        },
-      },
-    );
-  }
-
-  async init() {
-    const extensionPath = ide().assetsRoot;
-    const snippetsDir = join(extensionPath, "cursorless-snippets");
-    const snippetFiles = await getSnippetPaths(snippetsDir);
-    this.coreSnippets = mergeStrict(
-      ...(await Promise.all(
-        snippetFiles.map(async (path) =>
-          JSON.parse(await readFile(path, "utf8")),
-        ),
-      )),
-    );
-    await this.updateUserSnippets();
-  }
-
-  /**
-   * Updates the userSnippetsDir field if it has change, returning a boolean
-   * indicating whether there was an update.  If there was an update, resets the
-   * maxSnippetMtime to -1 to ensure snippet update.
-   * @returns Boolean indicating whether path has changed
-   */
-  private updateUserSnippetsPath(): boolean {
-    const newUserSnippetsDir = ide().configuration.getOwnConfiguration(
-      "experimental.snippetsDir",
-    );
-
-    if (newUserSnippetsDir === this.userSnippetsDir) {
-      return false;
-    }
-
-    // Reset mtime to -1 so that next time we'll update the snippets
-    this.maxSnippetMtimeMs = -1;
-
-    this.userSnippetsDir = newUserSnippetsDir;
-
-    return true;
-  }
-
-  async updateUserSnippets() {
-    let snippetFiles: string[];
-    try {
-      snippetFiles = this.userSnippetsDir
-        ? await getSnippetPaths(this.userSnippetsDir)
-        : [];
-    } catch (err) {
-      if (this.directoryErrorMessage?.directory !== this.userSnippetsDir) {
-        // NB: We suppress error messages once we've shown it the first time
-        // because we poll the directory every second and want to make sure we
-        // don't show the same error message repeatedly
-        const errorMessage = `Error with cursorless snippets dir "${
-          this.userSnippetsDir
-        }": ${(err as Error).message}`;
-
-        showError(ide().messages, "snippetsDirError", errorMessage);
-
-        this.directoryErrorMessage = {
-          directory: this.userSnippetsDir!,
-          errorMessage,
-        };
-      }
-
-      this.userSnippets = [];
-      this.mergeSnippets();
-
-      return;
-    }
-
-    this.directoryErrorMessage = null;
-
-    const maxSnippetMtime =
-      max(
-        (await Promise.all(snippetFiles.map((file) => stat(file)))).map(
-          (stat) => stat.mtimeMs,
-        ),
-      ) ?? 0;
-
-    if (maxSnippetMtime <= this.maxSnippetMtimeMs) {
-      return;
-    }
-
-    this.maxSnippetMtimeMs = maxSnippetMtime;
-
-    this.userSnippets = await Promise.all(
-      snippetFiles.map(async (path) => {
-        try {
-          const content = await readFile(path, "utf8");
-
-          if (content.length === 0) {
-            // Gracefully handle an empty file
-            return {};
-          }
-
-          return JSON.parse(content);
-        } catch (err) {
-          showError(
-            ide().messages,
-            "snippetsFileError",
-            `Error with cursorless snippets file "${path}": ${
-              (err as Error).message
-            }`,
-          );
-
-          // We don't want snippets from all files to stop working if there is
-          // a parse error in one file, so we just effectively ignore this file
-          // once we've shown an error message
-          return {};
-        }
-      }),
-    );
-
-    this.mergeSnippets();
-  }
+export interface Snippets {
+  updateUserSnippets(): Promise<void>;
 
   /**
    * Allows extensions to register third-party snippets.  Calling this function
@@ -195,22 +17,7 @@ export class Snippets {
    * @param extensionId The id of the extension registering the snippets.
    * @param snippets The snippets to be registered.
    */
-  registerThirdPartySnippets(extensionId: string, snippets: SnippetMap) {
-    this.thirdPartySnippets[extensionId] = snippets;
-    this.mergeSnippets();
-  }
-
-  /**
-   * Merge core, third-party, and user snippets, with precedence user > third
-   * party > core.
-   */
-  private mergeSnippets() {
-    this.mergedSnippets = mergeSnippets(
-      this.coreSnippets,
-      this.thirdPartySnippets,
-      this.userSnippets,
-    );
-  }
+  registerThirdPartySnippets(extensionId: string, snippets: SnippetMap): void;
 
   /**
    * Looks in merged collection of snippets for a snippet with key
@@ -219,23 +26,5 @@ export class Snippets {
    * @param snippetName The name of the snippet to look up
    * @returns The named snippet
    */
-  getSnippetStrict(snippetName: string): Snippet {
-    const snippet = this.mergedSnippets[snippetName];
-
-    if (snippet == null) {
-      let errorMessage = `Couldn't find snippet ${snippetName}. `;
-
-      if (this.directoryErrorMessage != null) {
-        errorMessage += `This could be due to: ${this.directoryErrorMessage.errorMessage}.`;
-      }
-
-      throw Error(errorMessage);
-    }
-
-    return snippet;
-  }
-}
-
-function getSnippetPaths(snippetsDir: string) {
-  return walkFiles(snippetsDir, CURSORLESS_SNIPPETS_SUFFIX);
+  getSnippetStrict(snippetName: string): Snippet;
 }
diff --git a/packages/cursorless-engine/src/cursorlessEngine.ts b/packages/cursorless-engine/src/cursorlessEngine.ts
@@ -1,10 +1,10 @@
 import {
   Command,
   CommandServerApi,
+  ensureCommandShape,
   FileSystem,
   Hats,
   IDE,
-  ensureCommandShape,
   ScopeProvider,
 } from "@cursorless/common";
 import {
@@ -13,7 +13,8 @@ import {
 } from "./api/CursorlessEngineApi";
 import { Debug } from "./core/Debug";
 import { HatTokenMapImpl } from "./core/HatTokenMapImpl";
-import { Snippets } from "./core/Snippets";
+import { KeyboardTargetUpdater } from "./KeyboardTargetUpdater";
+import type { Snippets } from "./core/Snippets";
 import { StoredTargetMap } from "./core/StoredTargets";
 import { RangeUpdater } from "./core/updateSelections/RangeUpdater";
 import { CustomSpokenFormGeneratorImpl } from "./generateSpokenForm/CustomSpokenFormGeneratorImpl";
@@ -30,24 +31,21 @@ import { ScopeSupportChecker } from "./scopeProviders/ScopeSupportChecker";
 import { ScopeSupportWatcher } from "./scopeProviders/ScopeSupportWatcher";
 import { injectIde } from "./singletons/ide.singleton";
 import { TreeSitter } from "./typings/TreeSitter";
-import { KeyboardTargetUpdater } from "./KeyboardTargetUpdater";
 
 export async function createCursorlessEngine(
   treeSitter: TreeSitter,
   ide: IDE,
   hats: Hats,
   commandServerApi: CommandServerApi | null,
   fileSystem: FileSystem,
+  snippets: Snippets | undefined,
 ): Promise<CursorlessEngine> {
   injectIde(ide);
 
   const debug = new Debug(treeSitter);
 
   const rangeUpdater = new RangeUpdater();
 
-  const snippets = new Snippets();
-  snippets.init();
-
   const hatTokenMap = new HatTokenMapImpl(
     rangeUpdater,
     debug,
@@ -123,7 +121,6 @@ export async function createCursorlessEngine(
     customSpokenFormGenerator,
     storedTargets,
     hatTokenMap,
-    snippets,
     injectIde,
     runIntegrationTests: () =>
       runIntegrationTests(treeSitter, languageDefinitions),
diff --git a/packages/cursorless-engine/src/index.ts b/packages/cursorless-engine/src/index.ts
@@ -12,3 +12,6 @@ export * from "./CommandHistory";
 export * from "./CommandHistoryAnalyzer";
 export * from "./util/grammarHelpers";
 export * from "./ScopeTestRecorder";
+export * from "./core/Snippets";
+export * from "./core/mergeSnippets";
+export * from "./util/object";
diff --git a/packages/cursorless-engine/src/runCommand.ts b/packages/cursorless-engine/src/runCommand.ts
diff --git a/packages/cursorless-vscode/src/VscodeSnippets.ts b/packages/cursorless-vscode/src/VscodeSnippets.ts
diff --git a/packages/cursorless-vscode/src/extension.ts b/packages/cursorless-vscode/src/extension.ts
