Generate Examples -- Continued

packages/cursorless-engine/src/index.ts

@@ -16,3 +16,4 @@ export * from "./testUtil/plainObjectToTarget";
 export * from "./util/getPartialTargetDescriptors";
 export * from "./util/getPrimitiveTargets";
 export * from "./util/grammarHelpers";
+export * from "./scripts/transformRecordedTests/transformations/upgrade";

packages/cursorless-org/package.json

@@ -13,7 +13,9 @@
     "clean": "rm -rf ./out tsconfig.tsbuildinfo ./dist ./build"
   },
   "dependencies": {
+    "@cursorless/common": "workspace:*",
     "@cursorless/cheatsheet": "workspace:*",
+    "@cursorless/test-case-component": "workspace:*",
     "@mdx-js/loader": "3.0.1",
     "@mdx-js/react": "3.0.1",
     "@next/mdx": "14.2.15",
@@ -24,6 +26,7 @@
   },
   "devDependencies": {
     "@svgr/webpack": "8.1.0",
+    "@types/js-yaml": "^4.0.9",
     "@types/mdx": "2.0.13",
     "@types/node": "20.16.0",
     "@types/react": "18.3.11",

packages/cursorless-org/src/pages/allowList.tsx

@@ -0,0 +1,88 @@
+export const testSelectedFiles = [
+  "bringAirAndBatAndCapToAfterItemEach.yml",
+  "bringAirToEndOfAir.yml", // Shiki intersect error
+  "bringArgMadeAfterLook.yml",
+  "carveLineHarp.yml",
+  "chuckBlockAir.yml",
+  "chuckBlockAirUntilBatt.yml",
+  "chuckBlockAirUntilBatt.yml",
+  "chuckBlockBatt.yml",
+  "chuckBlockBatt2.yml", // Shiki intersect error
+  "chuckBlockBattUntilAir.yml",
+  "chuckFine.yml",
+  "chuckLineFine.yml",
+  "chuckLineFineBetweenRisk.yml",
+  "clearBlockFine.yml",
+  "clearFine.yml",
+  "clearLineFine.yml",
+  "cutFine.yml",
+  "puffVest.yml",
+
+  "bringAirAfterAir.yml",
+  "bringAirBeforeAir.yml",
+  "bringAirToEndOfAir.yml",
+  "bringAirToStartOfAir.yml",
+  "bringFineAfterLineVest.yml",
+  "callFineOnBatt.yml",
+  "cloneHarp2.yml",
+  "cloneUpHarp2.yml",
+  "customHarp.yml",
+  "drinkLine.yml",
+  "giveBat2.yml",
+  "giveDot.yml",
+  "giveDot2.yml",
+  "giveEndOfDot.yml",
+  "giveStartOfDot.yml",
+  "joinAir.yml",
+  "joinAir2.yml",
+  "joinAir3.yml",
+  "joinAir4.yml",
+  "joinBatPastEach.yml",
+  "joinTokenBattPastEach.yml",
+  "pasteAfterLineSpunAndAfterBlockLookAndBeforeLineSpun.yml",
+  "pasteAfterLineTrapAndAfterBlockTrap.yml",
+  "placeHelloAfterAir.yml",
+  "placeHelloToFine.yml",
+  "pourLine.yml",
+  "scoutAir.yml",
+  "scoutAllAir.yml",
+  "sortEveryItem.yml",
+  "sortEveryItem2.yml",
+  "_bringLineHarpAndWhale.yml",
+  "cloneArgue.yml",
+  "cloneHarp.yml",
+  "cloneToken.yml",
+  "cloneToken2.yml",
+  "cloneUpHarp.yml",
+  "pasteAfterArgueBat.yml",
+  "chuckBlockBatt2.yml",
+  "appendPostWhale.yml",
+  "appendPreWhale.yml",
+  "bringAirAndBatAndCap.yml",
+  "bringArgueFineAndZip.yml",
+  "bringVest.yml",
+  "cloneArgue2.yml",
+  "cloneToken3.yml",
+  "cloneToken4.yml",
+  "cloneUpArgue2.yml",
+  "cloneUpToken3.yml",
+  "cloneUpToken4.yml",
+  "dedentLine.yml",
+  "flashToken.yml",
+  "indentLine.yml",
+  "joinBlock.yml",
+  "joinFile.yml",
+  "joinLineThis.yml",
+  "joinThreeTokens.yml",
+  "joinTwoLines.yml",
+  "moveEveryArgMade.yml",
+  "moveVest.yml",
+  "parseTreeFile.yml",
+  "postVest.yml",
+  "preeVest.yml",
+  "roundWrapVest.yml",
+  "swapWithVest.yml",
+  "voidWrapAir.yml",
+  "dropToken.yml",
+  "floatToken.yml",
+];

packages/cursorless-org/src/pages/component-sheet.tsx

@@ -0,0 +1,105 @@
+import * as yaml from "js-yaml";
+import fs from "fs";
+import path from "path";
+import Head from "next/head";
+
+import { loadTestCaseFixture } from "@cursorless/test-case-component";
+import { TestCaseComponentPage } from "@cursorless/test-case-component";
+import type { TestCaseFixture } from "@cursorless/common";
+import { testSelectedFiles } from "./allowList";
+
+import { cheatsheetBodyClasses } from "@cursorless/cheatsheet";
+
+const fixturesDir = path.join("../", "../", "data", "fixtures", "recorded");
+
+async function loadYamlFiles(dir: string, selectedFiles?: string[]) {
+  const directoryPath = path.join(process.cwd(), dir);
+  const files = fs.readdirSync(directoryPath);
+  const data: any[] = [];
+
+  files.forEach((file) => {
+    if (
+      path.extname(file) === ".yml" &&
+      (!selectedFiles || selectedFiles.includes(file))
+    ) {
+      try {
+        const filePath = path.join(directoryPath, file);
+        const fileContents = fs.readFileSync(filePath, "utf8");
+        const yamlData: any = yaml.load(fileContents);
+        yamlData.filename = file;
+        data.push(yamlData);
+      } catch {
+        console.error("File load failure", file);
+      }
+    }
+  });
+
+  return data;
+}
+
+// See https://github.com/vercel/next.js/discussions/12325#discussioncomment-1116108
+export async function getStaticProps() {
+  const itemsDirActions = path.join(fixturesDir, "actions");
+  const itemsDirDecorations = path.join(fixturesDir, "decorations");
+  const itemsDirInsertEmptyLines = path.join(
+    fixturesDir,
+    "actions/insertEmptyLines",
+  );
+
+  const dataActions = await loadYamlFiles(itemsDirActions, testSelectedFiles);
+  const dataInsertEmptyLines = await loadYamlFiles(
+    itemsDirInsertEmptyLines,
+    testSelectedFiles,
+  );
+
+  const dataDecorations = await loadYamlFiles(
+    itemsDirDecorations,
+    testSelectedFiles,
+  );
+
+  const data_errors: any[] = [];
+
+  const data = (
+    await Promise.all(
+      [...dataActions, ...dataDecorations, ...dataInsertEmptyLines].map(
+        async (val) => {
+          try {
+            const fixture = await loadTestCaseFixture(val);
+            return { ...fixture, raw: val };
+          } catch (err) {
+            console.error(err);
+            data_errors.push(val);
+            return null;
+          }
+        },
+      ),
+    )
+  ).filter((test) => test !== undefined);
+
+  if (data_errors.length > 0) {
+    console.error("data errors:", data_errors);
+  }
+
+  return { props: { data, bodyClasses: cheatsheetBodyClasses } };
+}
+
+export type TestCaseComponentProps = TestCaseFixture & {
+  filename: string;
+  raw: TestCaseFixture;
+  before: string;
+  during: string;
+  after: string;
+};
+
+export function App({ data }: { data: TestCaseComponentProps[] }) {
+  return (
+    <>
+      <Head>
+        <title>Cursorless Test Case Component Page</title>
+      </Head>
+      <TestCaseComponentPage data={data} />
+    </>
+  );
+}
+
+export default App;

packages/cursorless-org/tsconfig.json

@@ -23,6 +23,12 @@
   "references": [
     {
       "path": "../cheatsheet"
+    },
+    {
+      "path": "../cursorless-engine"
+    },
+    {
+      "path": "../test-case-component"
     }
   ],
   "exclude": ["node_modules"]

packages/cursorless-vscode/package.json

@@ -1261,7 +1261,9 @@
     "clean": "rm -rf ./out tsconfig.tsbuildinfo ./dist ./build"
   },
   "devDependencies": {
-    "@types/fs-extra": "11.0.4",
+    "@types/chai": "^4.3.14",
+    "@types/fs-extra": "^11.0.4",
+    "@types/glob": "^8.1.0",
     "@types/js-yaml": "^4.0.9",
     "@types/lodash-es": "4.17.12",
     "@types/nearley": "2.11.5",

packages/test-case-component/jest.config.ts

@@ -0,0 +1,8 @@
+import type { Config } from "jest";
+
+const config: Config = {
+  preset: "ts-jest",
+  testEnvironment: "jsdom",
+};
+
+export default config;

packages/test-case-component/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@cursorless/test-case-component",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "Component for displaying results of test cases in cursorless-vscode-e2e",
+  "main": "./out/index.js",
+  "scripts": {
+    "build": "my-ts-node src/buildDictionary.ts",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "compile:tsc": "tsc --build",
+    "compile:esbuild": "esbuild ./src/index.ts --sourcemap --format=esm --bundle --packages=external --outfile=./out/index.js",
+    "compile": "pnpm compile:tsc && pnpm compile:esbuild",
+    "watch:tsc": "pnpm compile:tsc --watch",
+    "watch:esbuild": "pnpm compile:esbuild --watch",
+    "watch": "pnpm run --filter @cursorless/test-case-component --parallel '/^watch:.*/'",
+    "clean": "rm -rf ./out tsconfig.tsbuildinfo ./dist ./build"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@cursorless/common": "workspace:*",
+    "@cursorless/node-common": "workspace:*",
+    "escape-goat": "4.0.0",
+    "fs-extra": "11.2.0",
+    "js-yaml": "^4.1.0",
+    "prettier": "3.2.5",
+    "react": "^18.2.0",
+    "tsx": "3.12.7",
+    "yaml": "2.2.1"
+  },
+  "types": "./out/index.d.ts",
+  "exports": {
+    ".": {
+      "cursorless:bundler": "./src/index.ts",
+      "default": "./out/index.js"
+    }
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/jest": "29.5.12",
+    "@types/react": "18.2.71",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "shiki": "^3.2.2",
+    "ts-jest": "29.1.2"
+  }
+}

packages/test-case-component/src/components/TestCaseComponentPage.tsx

@@ -0,0 +1,45 @@
+import * as React from "react";
+import { ShikiComponent } from "./shikiComponent";
+import "../shiki.css";
+import "../styles.css";
+import type { TestCaseFixture } from "@cursorless/common";
+
+export type TestCaseComponentProps = TestCaseFixture & {
+  filename: string;
+  raw: TestCaseFixture;
+  before: string;
+  during: string;
+  after: string;
+};
+
+export function TestCaseComponentPage({
+  data,
+}: {
+  data: TestCaseComponentProps[];
+}) {
+  return (
+    <main className="dark:text-stone-100">
+      <h1 className="mb-1 mt-2 text-center text-2xl md:text-3xl xl:mt-4">
+        Test Component Sheet{" "}
+        <small className="block text-sm">
+          See the {/* <SmartLink to={"https://www.cursorless.org/docs/"}> */}
+          full documentation
+          {/* </SmartLink>{" "} */}
+          to learn more.
+        </small>
+      </h1>
+
+      {data.map((item: TestCaseComponentProps) => {
+        if (!item) {
+          return <p>Error: item is null</p>;
+        }
+        const { filename } = item;
+        if (filename) {
+          return <ShikiComponent data={item} key={item.filename} />;
+        } else {
+          return <></>;
+        }
+      })}
+    </main>
+  );
+}