@tui-sandbox/library 5.1.2 → 6.0.0

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [6.0.0](https://github.com/mikavilpas/tui-sandbox/compare/library-v5.1.2...library-v6.0.0) (2024-11-17)
+
+
+### ⚠ BREAKING CHANGES
+
+* this changes the way that cypress support bindings are generated. Previously, you had to manually create a file in your cypress/support directory. Now, the file is automatically generated for you when you run `tui start`.
+
+### Features
+
+* automatically generate cypress support bindings on startup ([48cc416](https://github.com/mikavilpas/tui-sandbox/commit/48cc416dff628edbc850be4f31e7317c8a686217))
+
 ## [5.1.2](https://github.com/mikavilpas/tui-sandbox/compare/library-v5.1.1...library-v5.1.2) (2024-11-15)
 
 

package/dist/src/scripts/tui.js

@@ -1,6 +1,7 @@
 import { stat } from "node:fs/promises";
 import path from "node:path";
-import { startTestServer } from "../server/index.js";
+import { createCypressSupportFile } from "../server/cypress-support/createCypressSupportFile.js";
+import { startTestServer, updateTestdirectorySchemaFile } from "../server/index.js";
 //
 // This is the main entrypoint to tui-sandbox
 //
@@ -9,16 +10,23 @@ const args = process.argv.slice(2);
 if (args[0] !== "start") {
     throw new Error(`Usage: tui start`);
 }
+const outputFileName = "MyTestDirectory.ts";
 /** The cwd in the user's directory when they are running this script. Not the
  * cwd of the script itself. */
 const cwd = process.cwd();
-console.log(`🚀 Starting test server in ${cwd}`);
-await stat(path.join(cwd, "MyTestDirectory.ts"));
+console.log(`🚀 Starting test server in ${cwd} - this should be the root of your integration-tests directory 🤞🏻`);
+await stat(path.join(cwd, outputFileName));
 try {
-    await startTestServer({
+    const config = {
         testEnvironmentPath: path.join(cwd, "test-environment/"),
-        outputFilePath: path.join(cwd, "MyTestDirectory.ts"),
+        outputFilePath: path.join(cwd, outputFileName),
+    };
+    await createCypressSupportFile({
+        cypressSupportDirectoryPath: path.join(cwd, "cypress", "support"),
+        supportFileName: "tui-sandbox.ts",
     });
+    await updateTestdirectorySchemaFile(config);
+    await startTestServer(config);
 }
 catch (e) {
     console.error(e);

package/dist/src/server/TestServer.d.ts

@@ -1,10 +1,9 @@
 import type { AnyTRPCRouter } from "@trpc/server";
-import type { TestServerConfig } from "./updateTestdirectorySchemaFile.js";
 export type TestServerSettings = {
     port: number;
 };
 export declare class TestServer {
     private readonly settings;
     constructor(settings: TestServerSettings);
-    startAndRun(appRouter: AnyTRPCRouter, config: TestServerConfig): Promise<void>;
+    startAndRun(appRouter: AnyTRPCRouter): Promise<void>;
 }

package/dist/src/server/TestServer.js

@@ -5,7 +5,6 @@ import express from "express";
 import { accessSync } from "fs";
 import path from "path";
 import { fileURLToPath } from "url";
-import { updateTestdirectorySchemaFile } from "./updateTestdirectorySchemaFile.js";
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = path.dirname(__filename);
 export class TestServer {
@@ -13,9 +12,8 @@ export class TestServer {
     constructor(settings) {
         this.settings = settings;
     }
-    async startAndRun(appRouter, config) {
+    async startAndRun(appRouter) {
         console.log("🚀 Server starting");
-        await updateTestdirectorySchemaFile(config);
         const app = express();
         app.use("/trpc", trpcExpress.createExpressMiddleware({
             router: appRouter,

package/dist/src/server/cypress-support/contents.d.ts

@@ -0,0 +1 @@
+export declare function createCypressSupportFileContents(): Promise<string>;

package/dist/src/server/cypress-support/contents.js

@@ -0,0 +1,60 @@
+import { format, resolveConfig } from "prettier";
+import { fileURLToPath } from "url";
+const __filename = fileURLToPath(import.meta.url);
+export async function createCypressSupportFileContents() {
+    // this is the interface of tui-sandbox as far as cypress in the user's
+    // application is concerned
+    let text = ` 
+/// <reference types="cypress" />
+//
+// This file is autogenerated by tui-sandbox. Do not edit it directly.
+//
+import type { OverrideProperties } from "type-fest"
+import type { StartNeovimGenericArguments } from "@tui-sandbox/library/dist/src/server/types"
+import type { MyTestDirectory, MyTestDirectoryFile } from "../../MyTestDirectory"
+
+export type NeovimContext = {
+  contents: MyTestDirectory
+  rootPathAbsolute: string
+}
+
+declare global {
+  interface Window {
+    startNeovim(startArguments?: MyStartNeovimServerArguments): Promise<NeovimContext>
+  }
+}
+
+type MyStartNeovimServerArguments = OverrideProperties<
+  StartNeovimGenericArguments,
+  {
+    filename?: MyTestDirectoryFile | { openInVerticalSplits: MyTestDirectoryFile[] }
+    // NOTE: right now you need to make sure the config-modifications directory exists in your test directory
+    startupScriptModifications?: Array<keyof MyTestDirectory["config-modifications"]["contents"]>
+  }
+>
+
+Cypress.Commands.add("startNeovim", (startArguments?: MyStartNeovimServerArguments) => {
+  cy.window().then(async win => {
+    return await win.startNeovim(startArguments)
+  })
+})
+
+Cypress.Commands.add("typeIntoTerminal", (text: string, options?: Partial<Cypress.TypeOptions>) => {
+  // the syntax for keys is described here:
+  // https://docs.cypress.io/api/commands/type
+  cy.get("textarea").focus().type(text, options)
+})
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      startNeovim(args?: MyStartNeovimServerArguments): Chainable<NeovimContext>
+      typeIntoTerminal(text: string, options?: Partial<Cypress.TypeOptions>): Chainable<void>
+    }
+  }
+}
+`;
+    const options = await resolveConfig(__filename);
+    text = await format(text, { ...options, parser: "typescript" });
+    return text;
+}

package/dist/src/server/cypress-support/contents.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/server/cypress-support/contents.test.js

@@ -0,0 +1,55 @@
+import { createCypressSupportFileContents } from "./contents.js";
+it("should return the expected contents", async () => {
+    // this test is to help track breaking changes with releases
+    expect(await createCypressSupportFileContents()).toMatchInlineSnapshot(`
+    "/// <reference types="cypress" />
+    //
+    // This file is autogenerated by tui-sandbox. Do not edit it directly.
+    //
+    import type { StartNeovimGenericArguments } from "@tui-sandbox/library/dist/src/server/types"
+    import type { OverrideProperties } from "type-fest"
+    import type { MyTestDirectory, MyTestDirectoryFile } from "../../MyTestDirectory"
+
+    export type NeovimContext = {
+      contents: MyTestDirectory
+      rootPathAbsolute: string
+    }
+
+    declare global {
+      interface Window {
+        startNeovim(startArguments?: MyStartNeovimServerArguments): Promise<NeovimContext>
+      }
+    }
+
+    type MyStartNeovimServerArguments = OverrideProperties<
+      StartNeovimGenericArguments,
+      {
+        filename?: MyTestDirectoryFile | { openInVerticalSplits: MyTestDirectoryFile[] }
+        // NOTE: right now you need to make sure the config-modifications directory exists in your test directory
+        startupScriptModifications?: Array<keyof MyTestDirectory["config-modifications"]["contents"]>
+      }
+    >
+
+    Cypress.Commands.add("startNeovim", (startArguments?: MyStartNeovimServerArguments) => {
+      cy.window().then(async win => {
+        return await win.startNeovim(startArguments)
+      })
+    })
+
+    Cypress.Commands.add("typeIntoTerminal", (text: string, options?: Partial<Cypress.TypeOptions>) => {
+      // the syntax for keys is described here:
+      // https://docs.cypress.io/api/commands/type
+      cy.get("textarea").focus().type(text, options)
+    })
+
+    declare global {
+      namespace Cypress {
+        interface Chainable {
+          startNeovim(args?: MyStartNeovimServerArguments): Chainable<NeovimContext>
+          typeIntoTerminal(text: string, options?: Partial<Cypress.TypeOptions>): Chainable<void>
+        }
+      }
+    }
+    "
+  `);
+});

package/dist/src/server/cypress-support/createCypressSupportFile.d.ts

@@ -0,0 +1,11 @@
+export type CreateCypressSupportFileArgs = {
+    cypressSupportDirectoryPath: string;
+    supportFileName: string;
+};
+export type CreateCypressSupportFileResult = "updated" | "did-nothing";
+/**
+ * This is the interface of tui-sandbox as far as cypress in the user's
+ * application is concerned. It needs to be checked for changes once per
+ * tui-sandbox version.
+ */
+export declare function createCypressSupportFile({ cypressSupportDirectoryPath, supportFileName, }: CreateCypressSupportFileArgs): Promise<CreateCypressSupportFileResult>;

package/dist/src/server/cypress-support/createCypressSupportFile.js

@@ -0,0 +1,29 @@
+import { readFileSync, writeFileSync } from "fs";
+import path from "path";
+import { createCypressSupportFileContents } from "./contents.js";
+/**
+ * This is the interface of tui-sandbox as far as cypress in the user's
+ * application is concerned. It needs to be checked for changes once per
+ * tui-sandbox version.
+ */
+export async function createCypressSupportFile({ cypressSupportDirectoryPath, supportFileName, }) {
+    const text = await createCypressSupportFileContents();
+    let oldSchema = "";
+    const outputFilePath = path.join(cypressSupportDirectoryPath, supportFileName);
+    try {
+        oldSchema = readFileSync(outputFilePath, "utf-8");
+    }
+    catch (error) {
+        console.log(`No existing cypress support file found at ${outputFilePath}, creating a new one`);
+    }
+    if (oldSchema !== text) {
+        // it's important to not write the file if the schema hasn't changed
+        // because file watchers will trigger on file changes and we don't want to
+        // trigger a build if the schema hasn't changed
+        writeFileSync(outputFilePath, text);
+        return "updated";
+    }
+    else {
+        return "did-nothing";
+    }
+}

package/dist/src/server/cypress-support/createCypressSupportFile.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/server/cypress-support/createCypressSupportFile.test.js

@@ -0,0 +1,35 @@
+import { readFileSync, writeFileSync } from "fs";
+import { createCypressSupportFileContents } from "./contents.js";
+import { createCypressSupportFile } from "./createCypressSupportFile.js";
+vi.mock("fs");
+vi.mock("./contents.ts");
+const mocked = {
+    readFileSync: vi.mocked(readFileSync),
+    writeFileSync: vi.mocked(writeFileSync),
+    createCypressSupportFileContents: vi.mocked(createCypressSupportFileContents),
+};
+describe("createCypressSupportFileContents", () => {
+    it("should update the file if the schema has changed", async () => {
+        mocked.readFileSync.mockImplementationOnce(() => "");
+        mocked.writeFileSync.mockImplementationOnce(() => {
+            //
+        });
+        const result = await createCypressSupportFile({
+            cypressSupportDirectoryPath: "cypress/support",
+            supportFileName: "tui-sandbox.ts",
+        });
+        expect(result).toBe("updated");
+    });
+    it("should not update the file if the schema has not changed", async () => {
+        mocked.readFileSync.mockImplementationOnce(() => "contents");
+        mocked.writeFileSync.mockImplementationOnce(() => {
+            //
+        });
+        mocked.createCypressSupportFileContents.mockImplementationOnce(async () => "contents");
+        const result = await createCypressSupportFile({
+            cypressSupportDirectoryPath: "cypress/support",
+            supportFileName: "tui-sandbox.ts",
+        });
+        expect(result).toBe("did-nothing");
+    });
+});

package/dist/src/server/server.d.ts

@@ -44,7 +44,7 @@ export declare function createAppRouter(config: TestServerConfig): Promise<impor
                     tabId: string;
                 };
             };
-            output: AsyncGenerator<string, void, unknown>;
+            output: AsyncIterable<string, void, unknown>;
         }>;
         sendStdin: import("@trpc/server").TRPCMutationProcedure<{
             input: {

package/dist/src/server/server.js

@@ -102,7 +102,7 @@ export async function startTestServer(config) {
         port: 3000,
     });
     const appRouter = await createAppRouter(config);
-    await testServer.startAndRun(appRouter, config);
+    await testServer.startAndRun(appRouter);
     return testServer;
 }
 var autocleanup;