Move node dependencies out of commons and engine (#2500)

This is all about getting node out of commons. A lot of our file system
interaction had to do with running tests and reading/writing test
fixtures so I created a separate node test package.

To avoid circular dependencies I had to move a bunch of types from the
engine to commons. This make it so we now have changes in imports in a
bunch of different files. Most of the changes are quite mechanical or
boilerplate. The only actual new code is the two storage providers to
`ScopeTestRecorder` and `TestCaseRecorder`. The latter one is quite
lacking in implementation. This is just about unblocking cursorless
everywhere. A better abstraction is something we can workshop together.

And before you ask: no I can't split this into smaller pr. It feels like
a small miracle that I could solve all of the circular dependency
problems I had already :)

I wonder if we in a follow up want to move everything test related to
the test package? Generally I prefer to have test as close to the source
code as possible but in this case it's getting problematic to keeping
track of all the dependencies. If we had a test package we could make
sure that a lot of the dependencies only existed in that package and we
could add lint rules preventing them in the other packages.

## 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

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
Co-authored-by: Pokey Rule <755842+pokey@users.noreply.github.com>

Author: 3 people

packages/common/package.json

@@ -17,21 +17,16 @@
   "license": "MIT",
   "dependencies": {
     "lodash-es": "^4.17.21",
-    "pathe": "^1.1.2",
     "vscode-uri": "^3.0.8"
   },
   "devDependencies": {
-    "@types/chai": "^4.3.14",
     "@types/js-yaml": "^4.0.9",
     "@types/lodash-es": "4.17.0",
     "@types/mocha": "^10.0.6",
-    "@types/sinon": "^17.0.3",
-    "chai": "^5.1.0",
     "cross-spawn": "7.0.3",
     "fast-check": "3.17.0",
     "js-yaml": "^4.1.0",
-    "mocha": "^10.3.0",
-    "sinon": "^17.0.1"
+    "mocha": "^10.3.0"
   },
   "types": "./out/index.d.ts",
   "exports": {

packages/common/src/ide/normalized/NormalizedIDE.ts

@@ -1,4 +1,3 @@
-import { getFixturePath } from "../../index";
 import { GeneralizedRange } from "../../types/GeneralizedRange";
 import { TextEditor } from "../../types/TextEditor";
 import FakeConfiguration from "../fake/FakeConfiguration";
@@ -17,6 +16,7 @@ export class NormalizedIDE extends PassthroughIDEBase {
     original: IDE,
     public fakeIde: FakeIDE,
     private isSilent: boolean,
+    private cursorlessSnippetsDir: string,
   ) {
     super(original);
 
@@ -46,7 +46,7 @@ export class NormalizedIDE extends PassthroughIDEBase {
       hatStability: this.configuration.getOwnConfiguration(
         "experimental.hatStability",
       ),
-      snippetsDir: getFixturePath("cursorless-snippets"),
+      snippetsDir: this.cursorlessSnippetsDir,
       keyboardTargetFollowsSelection: false,
     });
   }

packages/common/src/index.ts

@@ -10,8 +10,6 @@ export * from "./util";
 export * from "./ide/util/messages";
 export { getKey, splitKey } from "./util/splitKey";
 export { hrtimeBigintToSeconds } from "./util/timeUtils";
-export * from "./util/walkSync";
-export * from "./util/walkAsync";
 export * from "./util/disposableFrom";
 export * from "./util/camelCaseToAllDown";
 export { Notifier } from "./util/Notifier";
@@ -47,11 +45,16 @@ export * from "./types/TextEditorEdit";
 export * from "./types/TextEditorOptions";
 export * from "./types/TextLine";
 export * from "./types/Token";
+export * from "./types/SpokenFormType";
 export * from "./types/HatTokenMap";
 export * from "./types/ScopeProvider";
 export * from "./types/SpokenForm";
 export * from "./types/commandHistory";
+export * from "./types/TalonSpokenForms";
+export * from "./types/TestHelpers";
+export * from "./types/TreeSitter";
 export * from "./util/textFormatters";
+export * from "./util/regex";
 export * from "./util/serializedMarksToTokenHats";
 export * from "./types/snippet.types";
 export * from "./testUtil/fromPlainObject";
@@ -61,18 +64,15 @@ export * from "./types/GeneralizedRange";
 export * from "./types/RangeOffsets";
 export * from "./util/omitByDeep";
 export * from "./util/range";
+export * from "./util/object";
 export * from "./util/uniqWithHash";
 export * from "./testUtil/testConstants";
-export * from "./testUtil/getFixturePaths";
-export * from "./testUtil/getCursorlessRepoRoot";
-export * from "./testUtil/runRecordedTest";
 export * from "./testUtil/serialize";
 export * from "./testUtil/shouldUpdateFixtures";
 export * from "./testUtil/TestCaseSnapshot";
 export * from "./testUtil/serializeTestFixture";
 export * from "./testUtil/getSnapshotForComparison";
 export * from "./testUtil/asyncSafety";
-export * from "./testUtil/getScopeTestPathsRecursively";
 export * from "./util/typeUtils";
 export * from "./ide/types/hatStyles.types";
 export * from "./errors";

packages/common/src/testUtil/getSnapshotForComparison.ts

@@ -1,10 +1,10 @@
 import { storedTargetKeys } from "../StoredTargetKey";
 import SpyIDE from "../ide/spy/SpyIDE";
 import { ReadOnlyHatMap } from "../types/HatTokenMap";
+import type { TestHelpers } from "../types/TestHelpers";
 import { marksToPlainObject } from "../util/toPlainObject";
 import { ExcludableSnapshotField, TestCaseSnapshot } from "./TestCaseSnapshot";
 import { extractTargetedMarks } from "./extractTargetedMarks";
-import { TestHelpers } from "./runRecordedTest";
 
 /**
  * Get the state of the editor to compare with the expected state of a test case

packages/cursorless-engine/src/spokenForms/SpokenFormType.ts renamed to packages/common/src/types/SpokenFormType.ts

@@ -1,8 +1,5 @@
 import { Notifier } from "@cursorless/common";
-import {
-  SpokenFormMapKeyTypes,
-  SpokenFormType,
-} from "../spokenForms/SpokenFormType";
+import { SpokenFormMapKeyTypes, SpokenFormType } from "./SpokenFormType";
 
 /**
  * Interface representing a communication mechanism whereby Talon can provide

packages/cursorless-engine/src/scopeProviders/TalonSpokenForms.ts renamed to packages/common/src/types/TalonSpokenForms.ts

@@ -0,0 +1,32 @@
+import type { FakeCommandServerApi } from "../FakeCommandServerApi";
+import type { IDE } from "../ide/types/ide.types";
+import type {
+  ExcludableSnapshotField,
+  ExtraSnapshotField,
+  TestCaseSnapshot,
+} from "../testUtil/TestCaseSnapshot";
+import type { SerializedMarks, TargetPlainObject } from "../util/toPlainObject";
+import type { HatTokenMap } from "./HatTokenMap";
+import type { TextEditor } from "./TextEditor";
+
+export interface TestHelpers {
+  hatTokenMap: HatTokenMap;
+
+  // FIXME: Remove this once we have a better way to get this function
+  // accessible from our tests
+  takeSnapshot(
+    excludeFields: ExcludableSnapshotField[],
+    extraFields: ExtraSnapshotField[],
+    editor: TextEditor,
+    ide: IDE,
+    marks: SerializedMarks | undefined,
+  ): Promise<TestCaseSnapshot>;
+
+  setStoredTarget(
+    editor: TextEditor,
+    key: string,
+    targets: TargetPlainObject[] | undefined,
+  ): void;
+
+  commandServerApi: FakeCommandServerApi;
+}

packages/common/src/types/TestHelpers.ts

@@ -10,6 +10,11 @@ export interface TextDocument {
    */
   readonly uri: URI;
 
+  /**
+   * The last portion of the uri.path.
+   */
+  readonly filename: string;
+
   /**
    * The identifier of the language associated with this document.
    */