@tui-sandbox/library 5.1.2 → 6.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "5.1.2",
+  "version": "6.0.0",
   "license": "MIT",
   "type": "module",
   "bin": {
@@ -8,8 +8,8 @@
   },
   "dependencies": {
     "@catppuccin/palette": "1.7.1",
-    "@trpc/client": "11.0.0-rc.633",
-    "@trpc/server": "11.0.0-rc.633",
+    "@trpc/client": "11.0.0-rc.638",
+    "@trpc/server": "11.0.0-rc.638",
     "@xterm/addon-attach": "0.11.0",
     "@xterm/addon-fit": "0.10.0",
     "@xterm/xterm": "5.5.0",
@@ -22,7 +22,7 @@
     "node-pty": "1.0.0",
     "prettier": "3.3.3",
     "tsx": "4.19.2",
-    "type-fest": "4.26.1",
+    "type-fest": "4.27.0",
     "winston": "3.17.0",
     "zod": "3.23.8"
   },
@@ -36,6 +36,10 @@
     "vite": "5.4.11",
     "vitest": "2.1.5"
   },
+  "peerDependencies": {
+    "cypress": "^13",
+    "type-fest": "4.27.0"
+  },
   "scripts": {
     "build": "concurrently --names 'vite,tsc' 'vite build' 'tsc' --prefix-colors blue,green",
     "dev": "concurrently --names 'client,server' 'pnpm dev:client' 'pnpm dev:server' --prefix-colors blue,green",

package/src/scripts/tui.ts

@@ -1,6 +1,8 @@
 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 type { TestServerConfig } from "../server/index.js"
+import { startTestServer, updateTestdirectorySchemaFile } from "../server/index.js"
 
 //
 // This is the main entrypoint to tui-sandbox
@@ -12,18 +14,25 @@ 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),
+  } satisfies TestServerConfig
+  await createCypressSupportFile({
+    cypressSupportDirectoryPath: path.join(cwd, "cypress", "support"),
+    supportFileName: "tui-sandbox.ts",
   })
+  await updateTestdirectorySchemaFile(config)
+  await startTestServer(config)
 } catch (e) {
   console.error(e)
 }

package/src/server/TestServer.ts

@@ -6,8 +6,6 @@ import express from "express"
 import { accessSync } from "fs"
 import path from "path"
 import { fileURLToPath } from "url"
-import type { TestServerConfig } from "./updateTestdirectorySchemaFile.js"
-import { updateTestdirectorySchemaFile } from "./updateTestdirectorySchemaFile.js"
 
 export type TestServerSettings = {
   port: number
@@ -19,11 +17,9 @@ const __dirname = path.dirname(__filename)
 export class TestServer {
   public constructor(private readonly settings: TestServerSettings) {}
 
-  public async startAndRun(appRouter: AnyTRPCRouter, config: TestServerConfig): Promise<void> {
+  public async startAndRun(appRouter: AnyTRPCRouter): Promise<void> {
     console.log("🚀 Server starting")
 
-    await updateTestdirectorySchemaFile(config)
-
     const app = express()
     app.use(
       "/trpc",

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

@@ -0,0 +1,56 @@
+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/src/server/cypress-support/contents.ts

@@ -0,0 +1,64 @@
+import { format, resolveConfig } from "prettier"
+import { fileURLToPath } from "url"
+
+const __filename = fileURLToPath(import.meta.url)
+
+export async function createCypressSupportFileContents(): Promise<string> {
+  // 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/src/server/cypress-support/createCypressSupportFile.test.ts

@@ -0,0 +1,44 @@
+import { readFileSync, writeFileSync } from "fs"
+import { createCypressSupportFileContents } from "./contents.js"
+import type { CreateCypressSupportFileResult } from "./createCypressSupportFile.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" satisfies CreateCypressSupportFileResult)
+  })
+
+  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" satisfies CreateCypressSupportFileResult)
+  })
+})

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

@@ -0,0 +1,40 @@
+import { readFileSync, writeFileSync } from "fs"
+import path from "path"
+import { createCypressSupportFileContents } from "./contents.js"
+
+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 async function createCypressSupportFile({
+  cypressSupportDirectoryPath,
+  supportFileName,
+}: CreateCypressSupportFileArgs): Promise<CreateCypressSupportFileResult> {
+  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/src/server/server.ts

@@ -73,7 +73,7 @@ export async function startTestServer(config: TestServerConfig): Promise<TestSer
     port: 3000,
   })
   const appRouter = await createAppRouter(config)
-  await testServer.startAndRun(appRouter, config)
+  await testServer.startAndRun(appRouter)
 
   return testServer
 }