@tui-sandbox/library 7.3.0 → 7.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "7.3.0",
+  "version": "7.5.0",
   "license": "MIT",
   "type": "module",
   "bin": {
@@ -8,8 +8,8 @@
   },
   "dependencies": {
     "@catppuccin/palette": "1.7.1",
-    "@trpc/client": "11.0.0-rc.648",
-    "@trpc/server": "11.0.0-rc.648",
+    "@trpc/client": "11.0.0-rc.666",
+    "@trpc/server": "11.0.0-rc.666",
     "@xterm/addon-attach": "0.11.0",
     "@xterm/addon-fit": "0.10.0",
     "@xterm/xterm": "5.5.0",
@@ -17,24 +17,24 @@
     "core-js": "3.39.0",
     "cors": "2.8.5",
     "dree": "5.1.5",
-    "express": "4.21.1",
+    "express": "4.21.2",
     "neovim": "5.3.0",
     "node-pty": "1.0.0",
-    "prettier": "3.4.1",
+    "prettier": "3.4.2",
     "tsx": "4.19.2",
-    "type-fest": "4.29.0",
+    "type-fest": "4.30.2",
     "winston": "3.17.0",
-    "zod": "3.23.8"
+    "zod": "3.24.1"
   },
   "devDependencies": {
     "@runtyping/zod": "2.1.1",
     "@types/command-exists": "1.2.3",
     "@types/cors": "2.8.17",
     "@types/express": "5.0.0",
-    "@types/node": "22.10.1",
-    "nodemon": "3.1.7",
-    "vite": "6.0.1",
-    "vitest": "2.1.6"
+    "@types/node": "22.10.2",
+    "nodemon": "3.1.9",
+    "vite": "6.0.5",
+    "vitest": "2.1.8"
   },
   "peerDependencies": {
     "cypress": "^13",

package/src/client/terminal-client.ts

@@ -98,25 +98,16 @@ export class TerminalClient {
 
   public async runBlockingShellCommand(input: BlockingCommandClientInput): Promise<BlockingShellCommandOutput> {
     await this.ready
-    return this.trpc.neovim.runBlockingShellCommand.mutate({
-      ...input,
-      tabId: this.tabId,
-    })
+    return this.trpc.neovim.runBlockingShellCommand.mutate({ ...input, tabId: this.tabId })
   }
 
   public async runLuaCode(input: LuaCodeClientInput): Promise<RunLuaCodeOutput> {
     await this.ready
-    return this.trpc.neovim.runLuaCode.mutate({
-      luaCode: input.luaCode,
-      tabId: this.tabId,
-    })
+    return this.trpc.neovim.runLuaCode.mutate({ ...input, tabId: this.tabId })
   }
 
   public async runExCommand(input: ExCommandClientInput): Promise<RunExCommandOutput> {
     await this.ready
-    return this.trpc.neovim.runExCommand.mutate({
-      command: input.command,
-      tabId: this.tabId,
-    })
+    return this.trpc.neovim.runExCommand.mutate({ ...input, tabId: this.tabId })
   }
 }

package/src/scripts/tui.ts

@@ -18,8 +18,11 @@ const outputFileName = "MyTestDirectory.ts"
  * cwd of the script itself. */
 const cwd = process.cwd()
 const config = {
-  testEnvironmentPath: path.join(cwd, "test-environment/"),
-  outputFilePath: path.join(cwd, outputFileName),
+  directories: {
+    testEnvironmentPath: path.join(cwd, "test-environment/"),
+    outputFilePath: path.join(cwd, outputFileName),
+  },
+  port: process.env["PORT"] ? parseInt(process.env["PORT"]) : 3000,
 } satisfies TestServerConfig
 
 // the arguments passed to this script start at index 2
@@ -35,11 +38,11 @@ if (args[0] === "neovim") {
 
   {
     // automatically dispose of the neovim instance when done
-    await using app = new NeovimApplication(config.testEnvironmentPath)
+    await using app = new NeovimApplication(config.directories.testEnvironmentPath)
     app.events.on("stdout" satisfies StdoutOrStderrMessage, data => {
       console.log(`  neovim output: ${data}`)
     })
-    const testDirectory = await prepareNewTestDirectory(config)
+    const testDirectory = await prepareNewTestDirectory(config.directories)
     await app.startNextAndKillCurrent(
       testDirectory,
       { filename: "empty.txt", headlessCmd: command },
@@ -62,7 +65,7 @@ try {
     cypressSupportDirectoryPath: path.join(cwd, "cypress", "support"),
     supportFileName: "tui-sandbox.ts",
   })
-  await updateTestdirectorySchemaFile(config)
+  await updateTestdirectorySchemaFile(config.directories)
   await startTestServer(config)
 } catch (e) {
   console.error(e)

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

@@ -17,14 +17,13 @@ it("should return the expected contents", async () => {
       RunExCommandOutput,
       RunLuaCodeOutput,
       StartNeovimGenericArguments,
+      TestDirectory,
     } from "@tui-sandbox/library/dist/src/server/types"
+    import assert from "assert"
     import type { OverrideProperties } from "type-fest"
     import type { MyTestDirectory, MyTestDirectoryFile } from "../../MyTestDirectory"
 
-    export type NeovimContext = {
-      contents: MyTestDirectory
-      rootPathAbsolute: string
-    }
+    export type NeovimContext = TestDirectory<MyTestDirectory>
 
     declare global {
       interface Window {
@@ -46,6 +45,7 @@ it("should return the expected contents", async () => {
 
     Cypress.Commands.add("startNeovim", (startArguments?: MyStartNeovimServerArguments) => {
       cy.window().then(async win => {
+        testWindow = win
         return await win.startNeovim(startArguments)
       })
     })
@@ -74,6 +74,13 @@ it("should return the expected contents", async () => {
       })
     })
 
+    let testWindow: Window | undefined
+
+    Cypress.on("fail", async () => {
+      assert(testWindow, "testWindow is not defined")
+      await testWindow.runExCommand({ command: "messages", log: true })
+    })
+
     before(function () {
       // disable Cypress's default behavior of logging all XMLHttpRequests and
       // fetches to the Command Log
@@ -96,6 +103,9 @@ it("should return the expected contents", async () => {
 
           runLuaCode(input: LuaCodeClientInput): Chainable<RunLuaCodeOutput>
 
+          /** Run an ex command in neovim.
+           * @example "echo expand('%:.')" current file, relative to the cwd
+           */
           runExCommand(input: ExCommandClientInput): Chainable<RunExCommandOutput>
         }
       }

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

@@ -20,14 +20,13 @@ import type {
   RunExCommandOutput,
   RunLuaCodeOutput,
   StartNeovimGenericArguments,
+  TestDirectory,
 } from "@tui-sandbox/library/dist/src/server/types"
+import assert from "assert"
 import type { OverrideProperties } from "type-fest"
 import type { MyTestDirectory, MyTestDirectoryFile } from "../../MyTestDirectory"
 
-export type NeovimContext = {
-  contents: MyTestDirectory
-  rootPathAbsolute: string
-}
+export type NeovimContext = TestDirectory<MyTestDirectory>
 
 declare global {
   interface Window {
@@ -49,6 +48,7 @@ type MyStartNeovimServerArguments = OverrideProperties<
 
 Cypress.Commands.add("startNeovim", (startArguments?: MyStartNeovimServerArguments) => {
   cy.window().then(async win => {
+    testWindow = win
     return await win.startNeovim(startArguments)
   })
 })
@@ -77,6 +77,13 @@ Cypress.Commands.add("runExCommand", (input: ExCommandClientInput) => {
   })
 })
 
+let testWindow: Window | undefined
+
+Cypress.on("fail", async () => {
+  assert(testWindow, "testWindow is not defined")
+  await testWindow.runExCommand({ command: "messages", log: true })
+})
+
 before(function () {
   // disable Cypress's default behavior of logging all XMLHttpRequests and
   // fetches to the Command Log
@@ -99,6 +106,9 @@ declare global {
 
       runLuaCode(input: LuaCodeClientInput): Chainable<RunLuaCodeOutput>
 
+      /** Run an ex command in neovim.
+       * @example "echo expand('%:.')" current file, relative to the cwd
+       */
       runExCommand(input: ExCommandClientInput): Chainable<RunExCommandOutput>
     }
   }

package/src/server/neovim/environment/createTempDir.ts

@@ -6,10 +6,10 @@ import { access, mkdir, mkdtemp } from "fs/promises"
 import path from "path"
 import { convertDree, getDirectoryTree } from "../../dirtree/index.js"
 import type { TestDirectory } from "../../types.js"
-import type { TestServerConfig } from "../../updateTestdirectorySchemaFile.js"
+import type { DirectoriesConfig } from "../../updateTestdirectorySchemaFile.js"
 import { updateTestdirectorySchemaFile } from "../../updateTestdirectorySchemaFile.js"
 
-export async function createTempDir(config: TestServerConfig): Promise<TestDirectory> {
+export async function createTempDir(config: DirectoriesConfig): Promise<TestDirectory> {
   try {
     const dir = await createUniqueDirectory(config.testEnvironmentPath)
 

package/src/server/neovim/index.ts

@@ -10,7 +10,7 @@ import type {
   StartNeovimGenericArguments,
   TestDirectory,
 } from "../types.js"
-import type { TestServerConfig } from "../updateTestdirectorySchemaFile.js"
+import type { DirectoriesConfig } from "../updateTestdirectorySchemaFile.js"
 import { convertEventEmitterToAsyncGenerator } from "../utilities/generator.js"
 import { Lazy } from "../utilities/Lazy.js"
 import type { TabId } from "../utilities/tabId.js"
@@ -53,7 +53,7 @@ export async function start(
   options: StartNeovimGenericArguments,
   terminalDimensions: TerminalDimensions,
   tabId: TabId,
-  config: TestServerConfig
+  config: DirectoriesConfig
 ): Promise<TestDirectory> {
   const neovim = neovims.get(tabId.tabId)
   assert(neovim, `Neovim instance not found for client id ${tabId.tabId}`)
@@ -64,7 +64,7 @@ export async function start(
   return testDirectory
 }
 
-export async function prepareNewTestDirectory(config: TestServerConfig): Promise<TestDirectory> {
+export async function prepareNewTestDirectory(config: DirectoriesConfig): Promise<TestDirectory> {
   await removeTestDirectories(config.testEnvironmentPath)
   const testDirectory = await createTempDir(config)
   return testDirectory
@@ -174,6 +174,9 @@ export async function runExCommand(options: ExCommandInput): Promise<RunExComman
   console.log(`Neovim ${neovim.application.processId()} running Ex command: ${options.command}`)
   try {
     const output = await api.commandOutput(options.command)
+    if (options.log) {
+      console.log(`Ex command output: ${output}`)
+    }
     return { value: output }
   } catch (e) {
     console.warn(`Error running Ex command: ${options.command}`, e)

package/src/server/server.ts

@@ -5,7 +5,7 @@ import { z } from "zod"
 import { trpc } from "./connection/trpc.js"
 import * as neovim from "./neovim/index.js"
 import { TestServer } from "./TestServer.js"
-import type { TestServerConfig } from "./updateTestdirectorySchemaFile.js"
+import type { DirectoriesConfig, TestServerConfig } from "./updateTestdirectorySchemaFile.js"
 import { applicationAvailable } from "./utilities/applicationAvailable.js"
 import { tabIdSchema } from "./utilities/tabId.js"
 
@@ -29,13 +29,17 @@ const luaCodeInputSchema = z.object({ tabId: tabIdSchema, luaCode: z.string() })
 export type LuaCodeClientInput = Except<LuaCodeInput, "tabId">
 export type LuaCodeInput = z.infer<typeof luaCodeInputSchema>
 
-const exCommandInputSchema = z.object({ tabId: tabIdSchema, command: z.string() })
+const exCommandInputSchema = z.object({
+  tabId: tabIdSchema,
+  command: z.string(),
+  log: z.boolean().optional(),
+})
 export type ExCommandClientInput = Except<ExCommandInput, "tabId">
 export type ExCommandInput = z.infer<typeof exCommandInputSchema>
 
 /** @private */
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-export async function createAppRouter(config: TestServerConfig) {
+export async function createAppRouter(config: DirectoriesConfig) {
   if (!(await applicationAvailable("nvim"))) {
     throw new Error("Neovim is not installed. Please install Neovim (nvim).")
   }
@@ -99,9 +103,9 @@ export type RouterInput = inferRouterInputs<AppRouter>
 
 export async function startTestServer(config: TestServerConfig): Promise<TestServer> {
   const testServer = new TestServer({
-    port: 3000,
+    port: config.port,
   })
-  const appRouter = await createAppRouter(config)
+  const appRouter = await createAppRouter(config.directories)
   await testServer.startAndRun(appRouter)
 
   return testServer

package/src/server/types.ts

@@ -8,7 +8,7 @@ import type { VimValue } from "neovim/lib/types/VimValue.js"
  * be written with confidence that the files and directories they expect are
  * actually found. Otherwise the tests are brittle and can break easily.
  */
-export type TestDirectory = {
+export type TestDirectory<TContents extends object = object> = {
   /** The path to the unique test directory (the root).
    *
    * @example /Users/mikavilpas/git/tui-sandbox/packages/integration-tests/test-environment/testdirs/dir-0199UZ
@@ -28,7 +28,7 @@ export type TestDirectory = {
    */
   testEnvironmentPathRelative: string
 
-  contents: object
+  contents: TContents
 }
 
 export type { StartNeovimGenericArguments } from "../server/neovim/NeovimApplication.js"

package/src/server/updateTestdirectorySchemaFile.ts

@@ -1,17 +1,22 @@
 import { readFileSync, writeFileSync } from "fs"
 import { buildTestDirectorySchema } from "./dirtree/index.js"
 
-export type TestServerConfig = {
+export type DirectoriesConfig = {
   testEnvironmentPath: string
   outputFilePath: string
 }
 
+export type TestServerConfig = {
+  directories: DirectoriesConfig
+  port: number
+}
+
 export type UpdateTestdirectorySchemaFileResult = "updated" | "did-nothing"
 
 export async function updateTestdirectorySchemaFile({
   testEnvironmentPath,
   outputFilePath,
-}: TestServerConfig): Promise<UpdateTestdirectorySchemaFileResult> {
+}: DirectoriesConfig): Promise<UpdateTestdirectorySchemaFileResult> {
   const newSchema: string = await buildTestDirectorySchema(testEnvironmentPath)
   let oldSchema = ""