Move shouldUpgradeFixtures to common (#1711)

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

packages/common/src/index.ts

@@ -58,6 +58,7 @@ export * from "./testUtil/testConstants";
 export * from "./testUtil/getFixturePaths";
 export * from "./testUtil/getCursorlessRepoRoot";
 export * from "./testUtil/serialize";
+export * from "./testUtil/shouldUpdateFixtures";
 export * from "./testUtil/TestCaseSnapshot";
 export * from "./testUtil/serializeTestFixture";
 export * from "./util/typeUtils";

packages/cursorless-vscode-e2e/src/shouldUpdateFixtures.ts renamed to packages/common/src/testUtil/shouldUpdateFixtures.ts

@@ -2,6 +2,6 @@
  * Used to check weather the update fixtures launch config was used.
  * @returns `true` if developer used to the update fixtures launch config
  */
-export default function shouldUpdateFixtures() {
+export function shouldUpdateFixtures() {
   return process.env.CURSORLESS_TEST_UPDATE_FIXTURES === "true";
 }

packages/cursorless-vscode-e2e/src/endToEndTestSetup.ts

@@ -1,8 +1,7 @@
-import { IDE, sleep, SpyIDE } from "@cursorless/common";
+import { IDE, shouldUpdateFixtures, sleep, SpyIDE } from "@cursorless/common";
 import { getCursorlessApi } from "@cursorless/vscode-common";
 import { Context } from "mocha";
 import * as sinon from "sinon";
-import shouldUpdateFixtures from "./shouldUpdateFixtures";
 
 /**
  * The number of times the current test has been retried. Will be 0 the first

packages/cursorless-vscode-e2e/src/suite/recorded.vscode.test.ts

@@ -3,6 +3,7 @@ import {
   ExcludableSnapshotField,
   extractTargetedMarks,
   getRecordedTestPaths,
+  getRecordedTestsDirPath,
   HatStability,
   marksToPlainObject,
   omitByDeep,
@@ -13,6 +14,7 @@ import {
   SelectionPlainObject,
   SerializedMarks,
   serializeTestFixture,
+  shouldUpdateFixtures,
   splitKey,
   SpyIDE,
   spyIDERecordedValuesToPlainObject,
@@ -26,14 +28,14 @@ import {
   runCursorlessCommand,
 } from "@cursorless/vscode-common";
 import { assert } from "chai";
-import { promises as fsp } from "fs";
 import * as yaml from "js-yaml";
-import { isUndefined } from "lodash";
+import { promises as fsp } from "node:fs";
+import * as path from "node:path";
 import * as vscode from "vscode";
 import asyncSafety from "../asyncSafety";
 import { endToEndTestSetup, sleepWithBackoff } from "../endToEndTestSetup";
-import shouldUpdateFixtures from "../shouldUpdateFixtures";
 import { setupFake } from "./setupFake";
+import { isUndefined } from "lodash";
 
 function createPosition(position: PositionPlainObject) {
   return new vscode.Position(position.line, position.character);
@@ -55,10 +57,12 @@ suite("recorded test cases", async function () {
     setupFake(ide, HatStability.stable);
   });
 
-  getRecordedTestPaths().forEach((path) =>
+  const relativeDir = path.dirname(getRecordedTestsDirPath());
+
+  getRecordedTestPaths().forEach((testPath) =>
     test(
-      path.split(".")[0],
-      asyncSafety(() => runTest(path, getSpy()!)),
+      path.relative(relativeDir, testPath.split(".")[0]),
+      asyncSafety(() => runTest(testPath, getSpy()!)),
     ),
   );
 });