Added spoken form generation test

Author: AndreasArvidsson

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

@@ -0,0 +1,66 @@
+import {
+  Command,
+  TestCaseFixtureLegacy,
+  getRecordedTestPaths,
+  getRecordedTestsDirPath,
+} from "@cursorless/common";
+import * as yaml from "js-yaml";
+import * as fs from "node:fs";
+import { promises as fsp } from "node:fs";
+import * as path from "node:path";
+import * as assert from "node:assert";
+import { canonicalizeSpokenFormTestCommand } from "../core/commandVersionUpgrades/canonicalizeSpokenFormTestCommand";
+
+suite.skip("Generate spoken forms", async function () {
+  const relativeDir = path.dirname(getRecordedTestsDirPath());
+
+  getRecordedTestPaths().forEach((testPath) =>
+    test(path.relative(relativeDir, testPath.split(".")[0]), () =>
+      runTest(testPath),
+    ),
+  );
+});
+
+async function runTest(file: string) {
+  const buffer = await fsp.readFile(file);
+  const fixture = yaml.load(buffer.toString()) as TestCaseFixtureLegacy;
+  const spokenFormCommand = canonicalizeSpokenFormTestCommand(fixture.command);
+
+  if (spokenFormCommand == null) {
+    return;
+  }
+
+  const suffix = getHatTokenMapSuffix(file, fixture.command);
+  const spokenForm = spokenFormCommand.spokenForm + suffix;
+
+  assert.equal(fixture.command.spokenForm, spokenForm);
+}
+
+function getHatTokenMapSuffix(file: string, command: Command): string {
+  if (command.spokenForm == null || !isHatTokenMapTest(file)) {
+    return "";
+  }
+
+  const originalComponents = command.spokenForm.split(" ");
+  if (
+    originalComponents.length > 2 &&
+    originalComponents[originalComponents.length - 2] === "take"
+  ) {
+    return (
+      " " + originalComponents.slice(originalComponents.length - 2).join(" ")
+    );
+  }
+
+  return "";
+}
+
+async function isHatTokenMapTest(file: string): Promise<boolean> {
+  const dir = path.dirname(file);
+  const configFile = path.join(dir, "config.json");
+  if (fs.existsSync(configFile)) {
+    const buffer = await fsp.readFile(file, { encoding: "utf-8" });
+    const config = JSON.parse(buffer);
+    return Boolean(config["isHatTokenMapTest"]);
+  }
+  return false;
+}