@tui-sandbox/library 4.1.0 → 4.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "license": "MIT",
   "type": "module",
   "bin": {
@@ -8,8 +8,8 @@
   },
   "dependencies": {
     "@catppuccin/palette": "1.7.1",
-    "@trpc/client": "11.0.0-rc.630",
-    "@trpc/server": "11.0.0-rc.630",
+    "@trpc/client": "11.0.0-rc.633",
+    "@trpc/server": "11.0.0-rc.633",
     "@xterm/addon-attach": "0.11.0",
     "@xterm/addon-fit": "0.10.0",
     "@xterm/xterm": "5.5.0",
@@ -34,7 +34,7 @@
     "@types/node": "22.9.0",
     "nodemon": "3.1.7",
     "vite": "5.4.11",
-    "vitest": "2.1.4"
+    "vitest": "2.1.5"
   },
   "scripts": {
     "build": "concurrently --names 'vite,tsc' 'vite build' 'tsc' --prefix-colors blue,green",

package/src/browser/neovim-client.ts

@@ -12,6 +12,7 @@ const client = new NeovimClient(app)
 /** Entrypoint for the test runner (cypress) */
 window.startNeovim = async function (startArgs?: StartNeovimGenericArguments): Promise<TestDirectory> {
   const testDirectory = await client.startNeovim({
+    additionalEnvironmentVariables: startArgs?.additionalEnvironmentVariables,
     filename: startArgs?.filename ?? "initial-file.txt",
     startupScriptModifications: startArgs?.startupScriptModifications ?? [],
   })

package/src/client/neovim-client.ts

@@ -1,7 +1,6 @@
 import { createTRPCClient, httpBatchLink, splitLink, unstable_httpSubscriptionLink } from "@trpc/client"
 import type { Terminal } from "@xterm/xterm"
 import "@xterm/xterm/css/xterm.css"
-import type { Except } from "type-fest"
 import type { StartNeovimGenericArguments } from "../server/neovim/NeovimApplication.ts"
 import type { AppRouter } from "../server/server.ts"
 import type { TestDirectory } from "../server/types.ts"
@@ -66,12 +65,13 @@ export class NeovimClient {
     })
   }
 
-  public async startNeovim(args: Except<StartNeovimGenericArguments, "terminalDimensions">): Promise<TestDirectory> {
+  public async startNeovim(args: StartNeovimGenericArguments): Promise<TestDirectory> {
     await this.ready
 
     const testDirectory = await this.trpc.neovim.start.mutate({
       startNeovimArguments: {
-        ...args,
+        filename: args.filename,
+        additionalEnvironmentVariables: args.additionalEnvironmentVariables,
         terminalDimensions: {
           cols: this.terminal.cols,
           rows: this.terminal.rows,

package/src/server/neovim/NeovimApplication.ts

@@ -59,11 +59,16 @@ Run "nvim -V1 -v" for more info
 export type StdoutMessage = "stdout"
 
 export type StartNeovimGenericArguments = {
-  terminalDimensions: { cols: number; rows: number }
   filename: string | { openInVerticalSplits: string[] }
   startupScriptModifications?: string[]
+
+  /** Additions to the environment variables for the Neovim process. These
+   * override any already existing environment variables. */
+  additionalEnvironmentVariables?: Record<string, string> | undefined
 }
 
+export type TerminalDimensions = { cols: number; rows: number }
+
 type ResettableState = {
   testDirectory: TestDirectory
   socketPath: string
@@ -86,7 +91,8 @@ export class NeovimApplication {
    */
   public async startNextAndKillCurrent(
     testDirectory: TestDirectory,
-    startArgs: StartNeovimGenericArguments
+    startArgs: StartNeovimGenericArguments,
+    terminalDimensions: TerminalDimensions
   ): Promise<void> {
     await this[Symbol.asyncDispose]()
     assert(
@@ -129,13 +135,14 @@ export class NeovimApplication {
     const stdout = this.events
 
     await this.application.startNextAndKillCurrent(async () => {
+      const env = { ...process.env, ...startArgs.additionalEnvironmentVariables }
       return TerminalApplication.start({
         command: "nvim",
         args: neovimArguments,
 
         cwd: this.testEnvironmentPath,
-        env: process.env,
-        dimensions: startArgs.terminalDimensions,
+        env: env,
+        dimensions: terminalDimensions,
 
         onStdoutOrStderr(data) {
           data satisfies string

package/src/server/neovim/index.ts

@@ -4,7 +4,7 @@ import type { TestServerConfig } from "../updateTestdirectorySchemaFile.js"
 import { convertEventEmitterToAsyncGenerator } from "../utilities/generator.js"
 import type { TabId } from "../utilities/tabId.js"
 import { createTempDir } from "./environment/createTempDir.js"
-import type { StartNeovimGenericArguments } from "./NeovimApplication.js"
+import type { StartNeovimGenericArguments, TerminalDimensions } from "./NeovimApplication.js"
 import { NeovimApplication } from "./NeovimApplication.js"
 
 const neovims = new Map<TabId["tabId"], NeovimApplication>()
@@ -34,6 +34,7 @@ export async function onStdout(
 
 export async function start(
   options: StartNeovimGenericArguments,
+  terminalDimensions: TerminalDimensions,
   tabId: TabId,
   config: TestServerConfig
 ): Promise<TestDirectory> {
@@ -41,7 +42,7 @@ export async function start(
   assert(neovim, `Neovim instance not found for client id ${tabId.tabId}`)
 
   const testDirectory = await createTempDir(config)
-  await neovim.startNextAndKillCurrent(testDirectory, options)
+  await neovim.startNextAndKillCurrent(testDirectory, options, terminalDimensions)
 
   return testDirectory
 }

package/src/server/server.ts

@@ -41,11 +41,17 @@ export async function createAppRouter(config: TestServerConfig) {
                 cols: z.number(),
                 rows: z.number(),
               }),
+              additionalEnvironmentVariables: z.record(z.string()).optional(),
             }),
           })
         )
         .mutation(options => {
-          return neovim.start(options.input.startNeovimArguments, options.input.tabId, config)
+          return neovim.start(
+            options.input.startNeovimArguments,
+            options.input.startNeovimArguments.terminalDimensions,
+            options.input.tabId,
+            config
+          )
         }),
       onStdout: trpc.procedure.input(z.object({ client: tabIdSchema })).subscription(options => {
         return neovim.onStdout(options.input, options.signal, config.testEnvironmentPath)