@tui-sandbox/library 7.5.6 → 7.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "7.5.6",
+  "version": "7.7.0",
   "license": "MIT",
   "type": "module",
   "bin": {
@@ -8,13 +8,13 @@
   },
   "dependencies": {
     "@catppuccin/palette": "1.7.1",
-    "@trpc/client": "11.0.0-rc.682",
-    "@trpc/server": "11.0.0-rc.682",
+    "@trpc/client": "11.0.0-rc.695",
+    "@trpc/server": "11.0.0-rc.695",
     "@xterm/addon-attach": "0.11.0",
     "@xterm/addon-fit": "0.10.0",
     "@xterm/xterm": "5.5.0",
     "command-exists": "1.2.9",
-    "core-js": "3.39.0",
+    "core-js": "3.40.0",
     "cors": "2.8.5",
     "dree": "5.1.5",
     "express": "4.21.2",
@@ -22,7 +22,7 @@
     "node-pty": "1.0.0",
     "prettier": "3.4.2",
     "tsx": "4.19.2",
-    "type-fest": "4.31.0",
+    "type-fest": "4.32.0",
     "winston": "3.17.0",
     "zod": "3.24.1"
   },
@@ -31,9 +31,9 @@
     "@types/command-exists": "1.2.3",
     "@types/cors": "2.8.17",
     "@types/express": "5.0.0",
-    "@types/node": "22.10.2",
+    "@types/node": "22.10.5",
     "nodemon": "3.1.9",
-    "vite": "6.0.6",
+    "vite": "6.0.7",
     "vitest": "2.1.8"
   },
   "peerDependencies": {

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

@@ -36,6 +36,8 @@ declare global {
   }
 }
 
+/** Arguments for starting the neovim server. They are built based on your test
+ * environment in a type safe manner. */
 type MyStartNeovimServerArguments = OverrideProperties<
   StartNeovimGenericArguments,
   {

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

@@ -1,15 +1,19 @@
 import { readFileSync, writeFileSync } from "fs"
+import { mkdir, stat } from "fs/promises"
 import { createCypressSupportFileContents } from "./contents.js"
 import type { CreateCypressSupportFileResult } from "./createCypressSupportFile.js"
 import { createCypressSupportFile } from "./createCypressSupportFile.js"
 
 vi.mock("fs")
+vi.mock("fs/promises")
 vi.mock("./contents.ts")
 
 const mocked = {
   readFileSync: vi.mocked(readFileSync),
   writeFileSync: vi.mocked(writeFileSync),
   createCypressSupportFileContents: vi.mocked(createCypressSupportFileContents),
+  mkdir: vi.mocked(mkdir),
+  stat: vi.mocked(stat),
 }
 
 describe("createCypressSupportFileContents", () => {
@@ -41,4 +45,24 @@ describe("createCypressSupportFileContents", () => {
 
     expect(result).toBe("did-nothing" satisfies CreateCypressSupportFileResult)
   })
+
+  it("should create the config-modifications directory if it does not exist", async () => {
+    // This directory is required to exist so that a type safe schema of the
+    // neovimArguments can be built and used.
+    mocked.readFileSync.mockImplementationOnce(() => "")
+    mocked.writeFileSync.mockImplementationOnce(() => {
+      //
+    })
+    mocked.createCypressSupportFileContents.mockImplementationOnce(async () => "contents")
+    mocked.stat.mockRejectedValueOnce(new Error("ENOENT"))
+
+    const result = await createCypressSupportFile({
+      cypressSupportDirectoryPath: "cypress/support",
+      supportFileName: "tui-sandbox.ts",
+    })
+
+    expect(result).toBe("updated" satisfies CreateCypressSupportFileResult)
+    expect(mocked.mkdir).toHaveBeenCalledWith("cypress/support/config-modifications")
+    expect(mocked.mkdir).toHaveBeenCalledTimes(1)
+  })
 })

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

@@ -1,4 +1,5 @@
 import { readFileSync, writeFileSync } from "fs"
+import { mkdir, stat } from "fs/promises"
 import path from "path"
 import { createCypressSupportFileContents } from "./contents.js"
 
@@ -18,6 +19,17 @@ export async function createCypressSupportFile({
   cypressSupportDirectoryPath,
   supportFileName,
 }: CreateCypressSupportFileArgs): Promise<CreateCypressSupportFileResult> {
+  // create config-modifications directory if it doesn't exist
+  const configModificationsDirectoryPath = path.join(cypressSupportDirectoryPath, "config-modifications")
+  try {
+    await stat(configModificationsDirectoryPath)
+  } catch (error) {
+    console.log(
+      `Creating config-modifications directory at ${configModificationsDirectoryPath}. You can put Neovim startup scripts into this directory, and load them when starting your Neovim test.`
+    )
+    await mkdir(configModificationsDirectoryPath)
+  }
+
   const text = await createCypressSupportFileContents()
 
   let oldSchema = ""

package/src/server/dirtree/index.test.ts

@@ -59,6 +59,12 @@ describe("dirtree", () => {
                     extension: z.literal("lua"),
                     stem: z.literal("init."),
                   }),
+                  "prepare.lua": z.object({
+                    name: z.literal("prepare.lua"),
+                    type: z.literal("file"),
+                    extension: z.literal("lua"),
+                    stem: z.literal("prepare."),
+                  }),
                 }),
               }),
             }),
@@ -111,6 +117,24 @@ describe("dirtree", () => {
             extension: z.literal("txt"),
             stem: z.literal("initial-file."),
           }),
+          "lua-project": z.object({
+            name: z.literal("lua-project/"),
+            type: z.literal("directory"),
+            contents: z.object({
+              "config.lua": z.object({
+                name: z.literal("config.lua"),
+                type: z.literal("file"),
+                extension: z.literal("lua"),
+                stem: z.literal("config."),
+              }),
+              "init.lua": z.object({
+                name: z.literal("init.lua"),
+                type: z.literal("file"),
+                extension: z.literal("lua"),
+                stem: z.literal("init."),
+              }),
+            }),
+          }),
           "other-subdirectory": z.object({
             name: z.literal("other-subdirectory/"),
             type: z.literal("directory"),
@@ -176,6 +200,7 @@ describe("dirtree", () => {
       export const testDirectoryFiles = z.enum([
         ".config/.gitkeep",
         ".config/nvim/init.lua",
+        ".config/nvim/prepare.lua",
         ".config/nvim",
         ".config",
         "config-modifications/add_command_to_count_open_buffers.lua",
@@ -186,6 +211,9 @@ describe("dirtree", () => {
         "dir with spaces",
         "file.txt",
         "initial-file.txt",
+        "lua-project/config.lua",
+        "lua-project/init.lua",
+        "lua-project",
         "other-subdirectory/other-sub-file.txt",
         "other-subdirectory",
         "routes/posts.$postId/adjacent-file.txt",

package/src/server/neovim/index.ts

@@ -1,6 +1,8 @@
 import assert from "assert"
 import { exec } from "child_process"
 import "core-js/proposals/async-explicit-resource-management.js"
+import { access } from "fs/promises"
+import path from "path"
 import util from "util"
 import type { BlockingCommandInput, ExCommandInput, LuaCodeInput } from "../server.js"
 import type {
@@ -15,14 +17,40 @@ import { convertEventEmitterToAsyncGenerator } from "../utilities/generator.js"
 import { Lazy } from "../utilities/Lazy.js"
 import type { TabId } from "../utilities/tabId.js"
 import { createTempDir, removeTestDirectories } from "./environment/createTempDir.js"
-import type { TerminalDimensions } from "./NeovimApplication.js"
+import type { StdoutOrStderrMessage, TerminalDimensions } from "./NeovimApplication.js"
 import { NeovimApplication } from "./NeovimApplication.js"
 
 const neovims = new Map<TabId["tabId"], NeovimApplication>()
-export const resources: Lazy<AsyncDisposableStack> = new Lazy(() => {
+const resources: Lazy<AsyncDisposableStack> = new Lazy(() => {
   return new AsyncDisposableStack()
 })
 
+export async function installDependencies(testEnvironmentPath: string, config: DirectoriesConfig): Promise<void> {
+  await using app = new NeovimApplication(testEnvironmentPath)
+  const testDirectory = await prepareNewTestDirectory(config)
+  const prepareFilePath = path.join(testDirectory.rootPathAbsolute, ".config", "nvim", "prepare.lua")
+  try {
+    await access(prepareFilePath)
+  } catch (e) {
+    console.log(
+      `Neovim prepareFilePath does not exist: ${prepareFilePath}. If you want to run a prepare script before starting the tests, create it.`
+    )
+    return
+  }
+
+  console.log(`🚀 Running Neovim prepareFilePath ${prepareFilePath}...`)
+
+  app.events.on("stdout" satisfies StdoutOrStderrMessage, data => {
+    console.log(`  neovim output: ${data}`)
+  })
+  await app.startNextAndKillCurrent(
+    testDirectory,
+    { filename: "empty.txt", headlessCmd: `lua dofile("${prepareFilePath}")` },
+    { cols: 80, rows: 24 }
+  )
+  await app.application.untilExit()
+}
+
 export async function initializeStdout(
   options: { client: TabId },
   signal: AbortSignal | undefined,

package/src/server/server.ts

@@ -106,7 +106,12 @@ export async function startTestServer(config: TestServerConfig): Promise<TestSer
     port: config.port,
   })
   const appRouter = await createAppRouter(config.directories)
-  await testServer.startAndRun(appRouter)
+
+  await Promise.all([
+    // NOTE right now Neovim is always initialized
+    neovim.installDependencies(config.directories.testEnvironmentPath, config.directories),
+    testServer.startAndRun(appRouter),
+  ])
 
   return testServer
 }

package/src/server/utilities/timeout.ts

@@ -0,0 +1,3 @@
+export function timeout(ms: number): Promise<unknown> {
+  return new Promise((_, reject) => setTimeout(reject, ms))
+}