More PR feedback

Author: pokey

packages/common/src/ide/types/FileSystem.types.ts

@@ -10,4 +10,15 @@ export interface FileSystem {
    * @returns A disposable to cancel the watcher
    */
   watchDir(path: string, onDidChange: PathChangeListener): Disposable;
+
+  /**
+   * The path to the directory that Cursorless talon uses to share its state
+   * with the Cursorless engine.
+   */
+  readonly cursorlessDir: string;
+
+  /**
+   * The path to the spoken forms JSON file.
+   */
+  readonly cursorlessTalonStateJsonPath: string;
 }

packages/cursorless-engine/src/api/CursorlessEngineApi.ts

@@ -12,7 +12,6 @@ export interface CursorlessEngine {
   storedTargets: StoredTargetMap;
   hatTokenMap: HatTokenMap;
   snippets: Snippets;
-  spokenFormsJsonPath: string;
   injectIde: (ide: IDE | undefined) => void;
   runIntegrationTests: () => Promise<void>;
 }

packages/cursorless-engine/src/cursorlessEngine.ts

@@ -99,7 +99,6 @@ export function createCursorlessEngine(
     storedTargets,
     hatTokenMap,
     snippets,
-    spokenFormsJsonPath: talonSpokenForms.spokenFormsPath,
     injectIde,
     runIntegrationTests: () =>
       runIntegrationTests(treeSitter, languageDefinitions),

packages/cursorless-engine/src/generateSpokenForm/CustomSpokenFormGeneratorImpl.ts

@@ -55,5 +55,7 @@ export class CustomSpokenFormGeneratorImpl
     return this.customSpokenForms.needsInitialTalonUpdate;
   }
 
-  dispose = this.disposer.dispose;
+  dispose() {
+    this.disposer.dispose();
+  }
 }

packages/cursorless-engine/src/nodeCommon/TalonSpokenFormsJsonReader.ts

@@ -1,7 +1,5 @@
-import { Disposer, FileSystem, Notifier, isTesting } from "@cursorless/common";
-import * as crypto from "crypto";
+import { Disposer, FileSystem, Notifier } from "@cursorless/common";
 import { mkdir, readFile } from "fs/promises";
-import * as os from "os";
 
 import * as path from "path";
 import {
@@ -20,20 +18,16 @@ const LATEST_SPOKEN_FORMS_JSON_VERSION = 0;
 export class TalonSpokenFormsJsonReader implements TalonSpokenForms {
   private disposer = new Disposer();
   private notifier = new Notifier();
-  public readonly spokenFormsPath;
+  private cursorlessTalonStateJsonPath;
 
   constructor(private fileSystem: FileSystem) {
-    const cursorlessDir = isTesting()
-      ? path.join(os.tmpdir(), crypto.randomBytes(16).toString("hex"))
-      : path.join(os.homedir(), ".cursorless");
-
-    this.spokenFormsPath = path.join(cursorlessDir, "state.json");
+    this.cursorlessTalonStateJsonPath = fileSystem.cursorlessTalonStateJsonPath;
 
     this.init();
   }
 
   private async init() {
-    const parentDir = path.dirname(this.spokenFormsPath);
+    const parentDir = path.dirname(this.cursorlessTalonStateJsonPath);
     await mkdir(parentDir, { recursive: true });
     this.disposer.push(
       this.fileSystem.watchDir(parentDir, () =>
@@ -52,11 +46,13 @@ export class TalonSpokenFormsJsonReader implements TalonSpokenForms {
   async getSpokenFormEntries(): Promise<SpokenFormEntry[]> {
     let payload: TalonSpokenFormsPayload;
     try {
-      payload = JSON.parse(await readFile(this.spokenFormsPath, "utf-8"));
+      payload = JSON.parse(
+        await readFile(this.cursorlessTalonStateJsonPath, "utf-8"),
+      );
     } catch (err) {
       if ((err as any)?.code === "ENOENT") {
         throw new NeedsInitialTalonUpdateError(
-          `Custom spoken forms file not found at ${this.spokenFormsPath}. Using default spoken forms.`,
+          `Custom spoken forms file not found at ${this.cursorlessTalonStateJsonPath}. Using default spoken forms.`,
         );
       }
 

packages/cursorless-engine/src/spokenForms/CustomSpokenForms.ts

@@ -125,7 +125,9 @@ export class CustomSpokenForms {
     }));
   }
 
-  dispose = this.disposer.dispose;
+  dispose() {
+    this.disposer.dispose();
+  }
 }
 
 function updateEntriesForType<T extends SpokenFormType>(

packages/cursorless-vscode/src/extension.ts

@@ -139,7 +139,15 @@ async function createVscodeIde(context: vscode.ExtensionContext) {
   );
   await hats.init();
 
-  return { vscodeIDE, hats, fileSystem: new VscodeFileSystem() };
+  // FIXME: Inject this from test harness. Would need to arrange to delay
+  // extension initialization, probably by returning a function from extension
+  // init that has parameters consisting of test configuration, and have that
+  // function do the actual initialization.
+  const cursorlessDir = isTesting()
+    ? path.join(os.tmpdir(), crypto.randomBytes(16).toString("hex"))
+    : path.join(os.homedir(), ".cursorless");
+
+  return { vscodeIDE, hats, fileSystem: new VscodeFileSystem(cursorlessDir) };
 }
 
 function createTreeSitter(parseTreeApi: ParseTreeApi): TreeSitter {

packages/cursorless-vscode/src/ide/vscode/VscodeFileSystem.ts

@@ -1,7 +1,14 @@
 import { Disposable, FileSystem, PathChangeListener } from "@cursorless/common";
 import { RelativePattern, workspace } from "vscode";
+import * as path from "path";
 
 export class VscodeFileSystem implements FileSystem {
+  constructor(public cursorlessDir: string) {}
+
+  public get cursorlessTalonStateJsonPath() {
+    return path.join(this.cursorlessDir, "state.json");
+  }
+
   watchDir(path: string, onDidChange: PathChangeListener): Disposable {
     // FIXME: Support globs?
     const watcher = workspace.createFileSystemWatcher(