@tui-sandbox/library 11.0.2 → 11.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "11.0.2",
+  "version": "11.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/mikavilpas/tui-sandbox"
@@ -32,11 +32,11 @@
     "@types/command-exists": "1.2.3",
     "@types/cors": "2.8.19",
     "@types/express": "5.0.3",
-    "@types/node": "24.0.10",
+    "@types/node": "24.1.0",
     "nodemon": "3.1.10",
-    "vite": "7.0.2",
+    "vite": "7.0.6",
     "vitest": "3.2.4",
-    "zod": "4.0.0-beta.20250505T195954"
+    "zod": "4.0.10"
   },
   "peerDependencies": {
     "cypress": "^13 || ^14",

package/src/browser/neovim-client.ts

@@ -10,6 +10,7 @@ import type {
 import type { StartTerminalGenericArguments } from "../server/applications/terminal/TerminalTestApplication.js"
 import type { BlockingCommandClientInput } from "../server/blockingCommandInputSchema.js"
 import type {
+  AllKeys,
   BlockingShellCommandOutput,
   RunExCommandOutput,
   RunLuaCodeOutput,
@@ -42,7 +43,9 @@ window.startNeovim = async function (startArgs?: StartNeovimGenericArguments): P
     additionalEnvironmentVariables: startArgs?.additionalEnvironmentVariables,
     filename: startArgs?.filename ?? "initial-file.txt",
     startupScriptModifications: startArgs?.startupScriptModifications ?? [],
-  })
+    headlessCmd: undefined,
+    NVIM_APPNAME: startArgs?.NVIM_APPNAME,
+  } satisfies AllKeys<StartNeovimGenericArguments>)
 
   const neovimBrowserApi: GenericNeovimBrowserApi = {
     runBlockingShellCommand(input: BlockingCommandClientInput): Promise<BlockingShellCommandOutput> {

package/src/client/MyNeovimConfigModification.test.ts

@@ -0,0 +1,24 @@
+import { z } from "zod"
+import type { MyNeovimConfigModification } from "./MyNeovimConfigModification.js"
+
+const testDirectoryFiles = z.enum([
+  "config-modifications/add_command_to_count_open_buffers.lua",
+  "config-modifications/add_command_to_update_buffer_after_timeout.lua",
+  "config-modifications/don't_crash_when_modification_contains_unescaped_characters\".lua",
+  "config-modifications/subdir/subdir-modification.lua",
+  "config-modifications/subdir",
+  "config-modifications",
+])
+type MyTestDirectoryFile = z.infer<typeof testDirectoryFiles>
+
+type result = MyNeovimConfigModification<MyTestDirectoryFile>
+
+it("returns config-modifications recursively", () => {
+  assertType<
+    | "add_command_to_count_open_buffers.lua"
+    | "add_command_to_update_buffer_after_timeout.lua"
+    | "don't_crash_when_modification_contains_unescaped_characters\".lua"
+    | "subdir/subdir-modification.lua"
+    | "subdir"
+  >(1 as unknown as result)
+})

package/src/client/MyNeovimConfigModification.ts

@@ -0,0 +1,8 @@
+/** Returns all the available Neovim config-modifications, recursively.
+ * @type T - the MyTestDirectoryFile type, which is generated by tui-sandbox
+ */
+export type MyNeovimConfigModification<T extends string> = T extends `config-modifications/${infer Rest}`
+  ? Rest extends ""
+    ? never
+    : Rest
+  : never

package/src/client/neovim-terminal-client.ts

@@ -86,10 +86,11 @@ export class NeovimTerminalClient {
         filename: args.filename,
         additionalEnvironmentVariables: args.additionalEnvironmentVariables,
         startupScriptModifications: args.startupScriptModifications,
-        terminalDimensions: {
-          cols: this.terminal.cols,
-          rows: this.terminal.rows,
-        },
+        NVIM_APPNAME: args.NVIM_APPNAME,
+      },
+      terminalDimensions: {
+        cols: this.terminal.cols,
+        rows: this.terminal.rows,
       },
       tabId: this.tabId,
     })

package/src/scripts/tui.ts

@@ -30,8 +30,13 @@ const args = process.argv.slice(2)
 
 if (args[0] === "neovim") {
   if (args[1] === "prepare" && args.length === 2) {
-    console.log("🚀 Installing neovim dependencies...")
-    await installDependencies(config.directories.testEnvironmentPath, config.directories).catch((err: unknown) => {
+    const NVIM_APPNAME = process.env["NVIM_APPNAME"]
+    console.log(`🚀 Installing neovim dependencies${NVIM_APPNAME ? ` for NVIM_APPNAME=${NVIM_APPNAME}` : ""}...`)
+    await installDependencies(
+      config.directories.testEnvironmentPath,
+      process.env["NVIM_APPNAME"],
+      config.directories
+    ).catch((err: unknown) => {
       console.error("Error installing neovim dependencies", err)
       process.exit(1)
     })
@@ -54,7 +59,11 @@ if (args[0] === "neovim") {
     const testDirectory = await prepareNewTestDirectory(config.directories)
     await app.startNextAndKillCurrent(
       testDirectory,
-      { filename: "empty.txt", headlessCmd: command },
+      {
+        filename: "empty.txt",
+        headlessCmd: command,
+        NVIM_APPNAME: process.env["NVIM_APPNAME"],
+      },
       { cols: 80, rows: 24 }
     )
     await app.application.untilExit()

package/src/server/applications/neovim/NeovimApplication.ts

@@ -51,9 +51,9 @@ Options:
 
 See ":help startup-options" for all options.
 
-NVIM v0.11.0-dev-1589+g71507281fb
-Build type: RelWithDebInfo
-LuaJIT 2.1.1736781742
+NVIM v0.11.2
+Build type: Release
+LuaJIT 2.1.1741730670
 Run "nvim -V1 -v" for more info
 
 */
@@ -67,6 +67,19 @@ export type StartNeovimGenericArguments = {
   /** Executes the given command with --headless -c <command> -c qa */
   headlessCmd?: string
 
+  /**
+   * This variable controls the sub-directory that Nvim will read from (and
+   * auto-create) in each of the base directories.
+   *
+   * For example, setting $NVIM_APPNAME to "foo" before starting will cause
+   * Nvim to look for configuration files in $XDG_CONFIG_HOME/foo instead of
+   * $XDG_CONFIG_HOME/nvim. $NVIM_APPNAME must be a name, such as "foo", or a
+   * relative path, such as "foo/bar".
+   *
+   * https://neovim.io/doc/user/starting.html#_nvim_appname
+   */
+  NVIM_APPNAME?: string
+
   /** Additions to the environment variables for the Neovim process. These
    * override any already existing environment variables. */
   additionalEnvironmentVariables?: Record<string, string> | undefined
@@ -76,6 +89,7 @@ export type TerminalDimensions = { cols: number; rows: number }
 
 type ResettableState = {
   testDirectory: TestDirectory
+  NVIM_APPNAME: string | undefined
   socketPath: string
   client: Lazy<Promise<NeovimApiClient>>
 }
@@ -148,7 +162,11 @@ export class NeovimApplication implements AsyncDisposable {
     const stdout = this.events
 
     await this.application.startNextAndKillCurrent(async () => {
-      const env = this.getEnvironmentVariables(testDirectory, startArgs.additionalEnvironmentVariables)
+      const env = NeovimApplication.getEnvironmentVariables(
+        testDirectory,
+        startArgs.NVIM_APPNAME,
+        startArgs.additionalEnvironmentVariables
+      )
       return TerminalApplication.start({
         command: "nvim",
         args: neovimArguments,
@@ -170,30 +188,35 @@ export class NeovimApplication implements AsyncDisposable {
     this.state = {
       testDirectory,
       socketPath,
+      NVIM_APPNAME: startArgs.NVIM_APPNAME,
       client: connectNeovimApi(socketPath),
     }
 
-    log(`🚀 Started Neovim instance ${processId}`)
+    log(`🚀 Started Neovim instance ${processId} (NVIM_APPNAME: ${startArgs.NVIM_APPNAME})`)
   }
 
-  public getEnvironmentVariables(
+  public static getEnvironmentVariables(
     testDirectory: TestDirectory,
+    NVIM_APPNAME: string | undefined,
     additionalEnvironmentVariables?: Record<string, string>
   ): NodeJS.ProcessEnv {
     return {
       ...process.env,
-      HOME: testDirectory.rootPathAbsolute,
-
-      // this is needed so that neovim can load its configuration, emulating
-      // a common setup real neovim users have
-      XDG_CONFIG_HOME: join(testDirectory.rootPathAbsolute, ".config"),
-      // the data directory is where lazy.nvim stores its plugins. To prevent
-      // downloading a new set of plugins for each test, share the data
-      // directory.
-      XDG_DATA_HOME: join(testDirectory.testEnvironmentPath, ".repro", "data"),
+      ...({
+        HOME: testDirectory.rootPathAbsolute,
+
+        // this is needed so that neovim can load its configuration, emulating
+        // a common setup real neovim users have
+        XDG_CONFIG_HOME: join(testDirectory.rootPathAbsolute, ".config"),
+        // the data directory is where lazy.nvim stores its plugins. To prevent
+        // downloading a new set of plugins for each test, share the data
+        // directory.
+        XDG_DATA_HOME: join(testDirectory.testEnvironmentPath, ".repro", "data"),
+      } satisfies TestEnvironmentCommonEnvironmentVariables),
+      NVIM_APPNAME: NVIM_APPNAME ?? "nvim",
 
       ...additionalEnvironmentVariables,
-    } satisfies TestEnvironmentCommonEnvironmentVariables
+    }
   }
 
   async [Symbol.asyncDispose](): Promise<void> {

package/src/server/applications/neovim/api.ts

@@ -28,10 +28,14 @@ const resources: Lazy<AsyncDisposableStack> = new Lazy(() => {
 
 const log = debuglog("tui-sandbox.neovim.api")
 
-export async function installDependencies(testEnvironmentPath: string, config: DirectoriesConfig): Promise<void> {
+export async function installDependencies(
+  testEnvironmentPath: string,
+  NVIM_APPNAME: string | undefined,
+  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")
+  const prepareFilePath = path.join(testDirectory.rootPathAbsolute, ".config", NVIM_APPNAME ?? "nvim", "prepare.lua")
   try {
     await access(prepareFilePath)
   } catch (e) {
@@ -56,7 +60,11 @@ export async function installDependencies(testEnvironmentPath: string, config: D
   })
   await app.startNextAndKillCurrent(
     testDirectory,
-    { filename: "empty.txt", headlessCmd: `lua dofile("${prepareFilePath}")` },
+    {
+      filename: "empty.txt",
+      headlessCmd: `lua dofile("${prepareFilePath}")`,
+      NVIM_APPNAME,
+    },
     { cols: 80, rows: 24 }
   )
   await app.application.untilExit()
@@ -134,7 +142,7 @@ export async function runBlockingShellCommand(
   const testDirectory = neovim.state?.testDirectory
   assert(testDirectory, `Test directory not found for client id ${input.tabId.tabId}. Maybe neovim's not started yet?`)
 
-  const env = neovim.getEnvironmentVariables(testDirectory, input.envOverrides)
+  const env = NeovimApplication.getEnvironmentVariables(testDirectory, neovim.state?.NVIM_APPNAME, input.envOverrides)
   return executeBlockingShellCommand(testDirectory, input, signal, allowFailure, env)
 }
 

package/src/server/applications/neovim/neovimRouter.ts

@@ -42,18 +42,19 @@ export function createNeovimRouter(config: DirectoriesConfig) {
               }),
             ]),
             startupScriptModifications: z.array(z.string()).optional(),
-            terminalDimensions: z.object({
-              cols: z.number(),
-              rows: z.number(),
-            }),
             additionalEnvironmentVariables: z.record(z.string(), z.string()).optional(),
+            NVIM_APPNAME: z.string().optional().default("nvim"),
+          }),
+          terminalDimensions: z.object({
+            cols: z.number(),
+            rows: z.number(),
           }),
         })
       )
       .mutation(options => {
         return neovim.start(
           options.input.startNeovimArguments,
-          options.input.startNeovimArguments.terminalDimensions,
+          options.input.terminalDimensions,
           options.input.tabId,
           config
         )

package/src/server/blockingCommandInputSchema.test.ts

@@ -11,15 +11,13 @@ describe("blockingCommandInputSchema", () => {
     } satisfies Partial<BlockingCommandInput>)
 
     expect(fails.error).toMatchInlineSnapshot(`
-      ZodError {
-        "issues": [
-          {
-            "code": "custom",
-            "message": "Both cwd and cwdRelative provided. Please provide either but not both at the same time.",
-            "path": [],
-          },
-        ],
-      }
+      [ZodError: [
+        {
+          "code": "custom",
+          "path": [],
+          "message": "Both cwd and cwdRelative provided. Please provide either but not both at the same time."
+        }
+      ]]
     `)
   })
 })

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

@@ -23,6 +23,7 @@ import type {
   StartNeovimGenericArguments,
   TestDirectory,
 } from "@tui-sandbox/library/dist/src/server/types"
+import type { MyNeovimConfigModification } from "@tui-sandbox/library/src/client/MyNeovimConfigModification"
 import type {
   ExCommandClientInput,
   LuaCodeClientInput,
@@ -85,7 +86,7 @@ export type MyStartNeovimServerArguments = OverrideProperties<
   StartNeovimGenericArguments,
   {
     filename?: MyTestDirectoryFile | { openInVerticalSplits: MyTestDirectoryFile[] }
-    startupScriptModifications?: Array<keyof MyTestDirectory["config-modifications"]["contents"]>
+    startupScriptModifications?: Array<MyNeovimConfigModification<MyTestDirectoryFile>>
   }
 >
 

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

@@ -53,6 +53,14 @@ describe("dirtree", () => {
                   "prepare.lua": z.object({ name: z.literal("prepare.lua"), type: z.literal("file") }),
                 }),
               }),
+              nvim_alt: z.object({
+                name: z.literal("nvim_alt/"),
+                type: z.literal("directory"),
+                contents: z.object({
+                  "init.lua": z.object({ name: z.literal("init.lua"), type: z.literal("file") }),
+                  "prepare.lua": z.object({ name: z.literal("prepare.lua"), type: z.literal("file") }),
+                }),
+              }),
             }),
           }),
           "config-modifications": z.object({
@@ -71,6 +79,16 @@ describe("dirtree", () => {
                 name: z.literal("don't_crash_when_modification_contains_unescaped_characters\\".lua"),
                 type: z.literal("file"),
               }),
+              subdir: z.object({
+                name: z.literal("subdir/"),
+                type: z.literal("directory"),
+                contents: z.object({
+                  "subdir-modification.lua": z.object({
+                    name: z.literal("subdir-modification.lua"),
+                    type: z.literal("file"),
+                  }),
+                }),
+              }),
             }),
           }),
           "dir with spaces": z.object({
@@ -150,10 +168,15 @@ describe("dirtree", () => {
         ".config/nvim/init.lua",
         ".config/nvim/prepare.lua",
         ".config/nvim",
+        ".config/nvim_alt/init.lua",
+        ".config/nvim_alt/prepare.lua",
+        ".config/nvim_alt",
         ".config",
         "config-modifications/add_command_to_count_open_buffers.lua",
         "config-modifications/add_command_to_update_buffer_after_timeout.lua",
         "config-modifications/don't_crash_when_modification_contains_unescaped_characters\\".lua",
+        "config-modifications/subdir/subdir-modification.lua",
+        "config-modifications/subdir",
         "config-modifications",
         "dir with spaces/file1.txt",
         "dir with spaces/file2.txt",