Remove node references from Talon spoken form reader (#2480)

## Checklist

- [/] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [/] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [/] I have not broken the cheatsheet

Author: AndreasArvidsson

packages/cursorless-engine/src/cursorlessEngine.ts

@@ -1,25 +1,26 @@
 import {
   Command,
   CommandServerApi,
-  ensureCommandShape,
   FileSystem,
   Hats,
   IDE,
   ScopeProvider,
+  ensureCommandShape,
 } from "@cursorless/common";
+import { KeyboardTargetUpdater } from "./KeyboardTargetUpdater";
 import {
   CommandRunnerDecorator,
   CursorlessEngine,
 } from "./api/CursorlessEngineApi";
 import { Debug } from "./core/Debug";
 import { HatTokenMapImpl } from "./core/HatTokenMapImpl";
-import { KeyboardTargetUpdater } from "./KeyboardTargetUpdater";
 import type { Snippets } from "./core/Snippets";
 import { StoredTargetMap } from "./core/StoredTargets";
 import { RangeUpdater } from "./core/updateSelections/RangeUpdater";
+import { DisabledSnippets } from "./disabledComponents/DisabledSnippets";
+import { DisabledTalonSpokenForms } from "./disabledComponents/DisabledTalonSpokenForms";
 import { CustomSpokenFormGeneratorImpl } from "./generateSpokenForm/CustomSpokenFormGeneratorImpl";
 import { LanguageDefinitions } from "./languages/LanguageDefinitions";
-import { TalonSpokenFormsJsonReader } from "./nodeCommon/TalonSpokenFormsJsonReader";
 import { ModifierStageFactoryImpl } from "./processTargets/ModifierStageFactoryImpl";
 import { ScopeHandlerFactoryImpl } from "./processTargets/modifiers/scopeHandlers";
 import { runCommand } from "./runCommand";
@@ -29,16 +30,17 @@ import { ScopeRangeProvider } from "./scopeProviders/ScopeRangeProvider";
 import { ScopeRangeWatcher } from "./scopeProviders/ScopeRangeWatcher";
 import { ScopeSupportChecker } from "./scopeProviders/ScopeSupportChecker";
 import { ScopeSupportWatcher } from "./scopeProviders/ScopeSupportWatcher";
+import { type TalonSpokenForms } from "./scopeProviders/TalonSpokenForms";
 import { injectIde } from "./singletons/ide.singleton";
 import { TreeSitter } from "./typings/TreeSitter";
-import { DisabledSnippets } from "./disabledComponents/DisabledSnippets";
 
 export async function createCursorlessEngine(
   treeSitter: TreeSitter,
   ide: IDE,
   hats: Hats,
   commandServerApi: CommandServerApi | null,
   fileSystem: FileSystem,
+  talonSpokenForms: TalonSpokenForms | undefined,
   snippets: Snippets = new DisabledSnippets(),
 ): Promise<CursorlessEngine> {
   injectIde(ide);
@@ -62,10 +64,8 @@ export async function createCursorlessEngine(
   const languageDefinitions = new LanguageDefinitions(fileSystem, treeSitter);
   await languageDefinitions.init();
 
-  const talonSpokenForms = new TalonSpokenFormsJsonReader(fileSystem);
-
   const customSpokenFormGenerator = new CustomSpokenFormGeneratorImpl(
-    talonSpokenForms,
+    talonSpokenForms ?? new DisabledTalonSpokenForms(),
   );
 
   ide.disposeOnExit(

packages/cursorless-engine/src/disabledComponents/DisabledTalonSpokenForms.ts

@@ -0,0 +1,14 @@
+import type {
+  SpokenFormEntry,
+  TalonSpokenForms,
+} from "../scopeProviders/TalonSpokenForms";
+
+export class DisabledTalonSpokenForms implements TalonSpokenForms {
+  getSpokenFormEntries(): Promise<SpokenFormEntry[]> {
+    throw Error("Talon spoken forms are not implemented.");
+  }
+
+  onDidChange() {
+    return { dispose: () => {} };
+  }
+}

packages/cursorless-engine/src/index.ts

@@ -11,6 +11,7 @@ export * from "./CommandHistory";
 export * from "./CommandHistoryAnalyzer";
 export * from "./util/grammarHelpers";
 export * from "./ScopeTestRecorder";
+export * from "./scopeProviders/TalonSpokenForms";
 export * from "./core/Snippets";
 export * from "./core/mergeSnippets";
 export * from "./util/object";

packages/cursorless-engine/src/nodeCommon/README.md

@@ -17,7 +17,10 @@ import {
   TestCaseRecorder,
   TreeSitter,
 } from "@cursorless/cursorless-engine";
-import { FileSystemCommandHistoryStorage } from "@cursorless/file-system-common";
+import {
+  FileSystemCommandHistoryStorage,
+  FileSystemTalonSpokenForms,
+} from "@cursorless/file-system-common";
 import {
   CursorlessApi,
   getCommandServerApi,
@@ -84,6 +87,7 @@ export async function activate(
     : await getCommandServerApi();
 
   const treeSitter: TreeSitter = createTreeSitter(parseTreeApi);
+  const talonSpokenForms = new FileSystemTalonSpokenForms(fileSystem);
 
   const snippets = new VscodeSnippets(normalizedIde);
   void snippets.init();
@@ -103,6 +107,7 @@ export async function activate(
     hats,
     commandServerApi,
     fileSystem,
+    talonSpokenForms,
     snippets,
   );
 

packages/cursorless-vscode/src/extension.ts

@@ -25,6 +25,7 @@
   },
   "dependencies": {
     "@cursorless/common": "workspace:*",
+    "@cursorless/cursorless-engine": "workspace:*",
     "glob": "^10.3.10",
     "pathe": "^1.1.2"
   },

packages/file-system-common/package.json

@@ -1,12 +1,16 @@
-import { Disposable, FileSystem, Notifier } from "@cursorless/common";
+import {
+  Disposable,
+  FileSystem,
+  Notifier,
+  type Listener,
+} from "@cursorless/common";
 import { readFile } from "fs/promises";
-
-import * as path from "pathe";
 import {
   NeedsInitialTalonUpdateError,
   SpokenFormEntry,
   TalonSpokenForms,
-} from "../scopeProviders/TalonSpokenForms";
+} from "@cursorless/cursorless-engine";
+import * as path from "pathe";
 
 interface TalonSpokenFormsPayload {
   version: number;
@@ -15,7 +19,7 @@ interface TalonSpokenFormsPayload {
 
 const LATEST_SPOKEN_FORMS_JSON_VERSION = 0;
 
-export class TalonSpokenFormsJsonReader implements TalonSpokenForms {
+export class FileSystemTalonSpokenForms implements TalonSpokenForms {
   private disposable: Disposable;
   private notifier = new Notifier();
 
@@ -31,7 +35,9 @@ export class TalonSpokenFormsJsonReader implements TalonSpokenForms {
    * @param callback The callback to run when the scope ranges change
    * @returns A {@link Disposable} which will stop the callback from running
    */
-  onDidChange = this.notifier.registerListener;
+  onDidChange(listener: Listener) {
+    return this.notifier.registerListener(listener);
+  }
 
   async getSpokenFormEntries(): Promise<SpokenFormEntry[]> {
     let payload: TalonSpokenFormsPayload;

packages/cursorless-engine/src/nodeCommon/TalonSpokenFormsJsonReader.ts renamed to packages/file-system-common/src/FileSystemTalonSpokenForms.ts

@@ -1 +1,2 @@
+export * from "./FileSystemTalonSpokenForms";
 export * from "./FileSystemCommandHistoryStorage";

packages/file-system-common/src/index.ts

@@ -8,6 +8,9 @@
   "references": [
     {
       "path": "../common"
+    },
+    {
+      "path": "../cursorless-engine"
     }
   ]
 }