@tui-sandbox/library 11.8.6 → 11.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "11.8.6",
+  "version": "11.9.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/mikavilpas/tui-sandbox"
@@ -32,8 +32,8 @@
     "@types/command-exists": "1.2.3",
     "@types/cors": "2.8.19",
     "@types/express": "5.0.3",
-    "@types/node": "24.7.0",
-    "cypress": "15.3.0",
+    "@types/node": "24.7.1",
+    "cypress": "15.4.0",
     "nodemon": "3.1.10",
     "type-fest": "5.0.1",
     "vite": "7.1.9",

package/src/scripts/commands/commandTuiNeovimExec.ts

@@ -1,21 +1,34 @@
 import { NeovimApplication, type StdoutOrStderrMessage } from "../../server/applications/neovim/NeovimApplication.js"
 import { prepareNewTestDirectory } from "../../server/applications/neovim/prepareNewTestDirectory.js"
-import type { TestServerConfig } from "../../server/updateTestdirectorySchemaFile.js"
+import type { TestServerConfigMetadata } from "../../server/updateTestdirectorySchemaFile.js"
 import type { NeovimExec } from "../parseArguments.js"
 
-export async function commandTuiNeovimExec(command: NeovimExec, config: TestServerConfig): Promise<void> {
+export async function commandTuiNeovimExec(command: NeovimExec, config: TestServerConfigMetadata): Promise<void> {
   // automatically dispose of the neovim instance when done
-  await using app = new NeovimApplication(config.directories.testEnvironmentPath)
+  await using app = new NeovimApplication(config.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.config)
+  const NVIM_APPNAME = process.env["NVIM_APPNAME"]
+
+  if (NVIM_APPNAME && !config.config.integrations.neovim.NVIM_APPNAMEs.find(n => n === NVIM_APPNAME)) {
+    process.exitCode = 1
+    const message = `The NVIM_APPNAME environment variable is set to "${NVIM_APPNAME}", but only the following neovim configurations are known in the configuration file: ${JSON.stringify(
+      config.config.integrations.neovim.NVIM_APPNAMEs
+    )}. Please set NVIM_APPNAME to one of the configured names or unset it to use the default ("nvim"). Config file path: ${config.configFilePath}`
+
+    console.error(message)
+
+    return
+  }
+
   await app.startNextAndKillCurrent(
     testDirectory,
     {
       filename: "empty.txt",
       headlessCmd: command.command,
-      NVIM_APPNAME: process.env["NVIM_APPNAME"],
+      NVIM_APPNAME,
     },
     { cols: 80, rows: 24 }
   )

package/src/scripts/commands/commandTuiNeovimPrepare.ts

@@ -1,10 +1,10 @@
 import { installDependencies } from "../../server/applications/neovim/api.js"
-import type { TestServerConfig } from "../../server/updateTestdirectorySchemaFile.js"
+import type { TestServerConfigMetadata } from "../../server/updateTestdirectorySchemaFile.js"
 
-export async function commandTuiNeovimPrepare(config: TestServerConfig): Promise<void> {
+export async function commandTuiNeovimPrepare(config: TestServerConfigMetadata): Promise<void> {
   const NVIM_APPNAME = process.env["NVIM_APPNAME"]
   console.log(`🚀 Installing neovim dependencies${NVIM_APPNAME ? ` for NVIM_APPNAME=${NVIM_APPNAME}` : ""}...`)
-  await installDependencies(process.env["NVIM_APPNAME"], config).catch((err: unknown) => {
+  await installDependencies(process.env["NVIM_APPNAME"], config.config).catch((err: unknown) => {
     console.error("Error installing neovim dependencies", err)
     process.exit(1)
   })

package/src/scripts/commands/commandTuiStart.ts

@@ -1,16 +1,16 @@
 import path from "path"
 import { createCypressSupportFile } from "../../server/cypress-support/createCypressSupportFile.js"
 import { startTestServer } from "../../server/server.js"
-import type { TestServerConfig } from "../../server/updateTestdirectorySchemaFile.js"
+import type { TestServerConfig, TestServerConfigMetadata } from "../../server/updateTestdirectorySchemaFile.js"
 import { updateTestdirectorySchemaFile } from "../../server/updateTestdirectorySchemaFile.js"
 import { cwd } from "../tui.js"
 
-export async function commandTuiStart(config: TestServerConfig): Promise<void> {
-  await Promise.allSettled([updateSchemaFile(config), createSupportFile()])
+export async function commandTuiStart(config: TestServerConfigMetadata): Promise<void> {
+  await Promise.allSettled([updateSchemaFile(config.config), createSupportFile()])
 
   try {
     console.log(`🚀 Starting test server in ${cwd} - this should be the root of your integration-tests directory 🤞🏻`)
-    await startTestServer(config)
+    await startTestServer(config.config)
   } catch (e) {
     console.error("Failed to startTestServer", e)
   }

package/src/scripts/parseArguments.ts

@@ -3,7 +3,6 @@ import * as z from "zod"
 
 export const parseArguments = async (args: string[]): Promise<ParseArgumentsResult | undefined> => {
   {
-    // tui neovim prepare
     const schema = z.tuple([z.literal("neovim"), z.literal("prepare")])
     const prepareArguments = schema.safeParse(args)
     if (prepareArguments.success) {
@@ -14,7 +13,6 @@ export const parseArguments = async (args: string[]): Promise<ParseArgumentsResu
   }
 
   {
-    // tui neovim exec <command>
     const schema = z.tuple([z.literal("neovim"), z.literal("exec"), z.string()])
     const execArguments = schema.safeParse(args)
     if (execArguments.success) {
@@ -28,7 +26,6 @@ export const parseArguments = async (args: string[]): Promise<ParseArgumentsResu
   }
 
   {
-    // tui start
     const schema = z.tuple([z.literal("start")])
     const result = schema.safeParse(args)
     if (result.success) {
@@ -39,7 +36,6 @@ export const parseArguments = async (args: string[]): Promise<ParseArgumentsResu
   }
 
   {
-    // tui start
     const schema = z.tuple([z.literal("run")])
     const result = schema.safeParse(args)
     if (result.success) {

package/src/scripts/resolveConfig.test.ts

@@ -11,12 +11,13 @@ it("defaults to the default configuration if no config file is found", async ()
   const config = await resolveTuiConfig(__dirname)
   assert(!config.error)
   expect(config.id).toBe("no-config-found" satisfies ResolveTuiConfigResultSuccess["id"])
-  expect(testServerConfigSchema.safeParse(config.result).success).toBe(true)
+  expect(testServerConfigSchema.safeParse(config.result.config).success).toBe(true)
 })
 
 it("loads a custom configuration file if it exists", async () => {
   using dir = TempDirectory.create()
 
+  const filename = `${dir.path}/tui-sandbox.config.ts`
   const customConfig: TestServerConfig = {
     directories: {
       testEnvironmentPath: "./test-environment2/",
@@ -26,7 +27,6 @@ it("loads a custom configuration file if it exists", async () => {
     port: 12345,
   }
   {
-    const filename = `${dir.path}/tui-sandbox.config.ts`
     const contents = `export const config = ${JSON.stringify(customConfig)}`
     await writeFile(filename, contents)
   }
@@ -34,7 +34,10 @@ it("loads a custom configuration file if it exists", async () => {
   const config = await resolveTuiConfig(dir.path)
   expect(config).toStrictEqual({
     id: "custom-config",
-    result: customConfig,
+    result: {
+      config: customConfig,
+      configFilePath: filename,
+    },
   } satisfies ResolveTuiConfigResult)
 })
 

package/src/scripts/resolveTuiConfig.ts

@@ -4,13 +4,13 @@ import { pathToFileURL } from "url"
 import { debuglog } from "util"
 import * as z from "zod"
 import { createDefaultConfig } from "../server/config.js"
-import { type TestServerConfig, testServerConfigSchema } from "../server/updateTestdirectorySchemaFile.js"
+import { testServerConfigSchema, type TestServerConfigMetadata } from "../server/updateTestdirectorySchemaFile.js"
 
 const log = debuglog("tui-sandbox.resolveConfig")
 
 export type ResolveTuiConfigResultSuccess = {
   id: "default-config" | "custom-config" | "no-config-found"
-  result: TestServerConfig
+  result: TestServerConfigMetadata
   error?: never
 }
 export type ResolveTuiConfigResultError = {
@@ -37,7 +37,10 @@ export const resolveTuiConfig = async (cwd: string): Promise<ResolveTuiConfigRes
 
     return {
       id: "no-config-found",
-      result: defaultConfig,
+      result: {
+        config: defaultConfig,
+        configFilePath: url.pathname,
+      },
     }
   }
 
@@ -47,7 +50,10 @@ export const resolveTuiConfig = async (cwd: string): Promise<ResolveTuiConfigRes
   if (customConfig.success) {
     return {
       id: "custom-config",
-      result: customConfig.data.config,
+      result: {
+        config: customConfig.data.config,
+        configFilePath: url.pathname,
+      },
     }
   } else {
     return {

package/src/scripts/tui.ts

@@ -1,5 +1,5 @@
 import assert from "node:assert"
-import type { TestServerConfig } from "../server/updateTestdirectorySchemaFile.js"
+import type { TestServerConfigMetadata } from "../server/updateTestdirectorySchemaFile.js"
 import type { TestResultExitCode } from "./commands/commandRun.js"
 import { commandRun } from "./commands/commandRun.js"
 import { commandTuiNeovimExec } from "./commands/commandTuiNeovimExec.js"
@@ -32,7 +32,7 @@ if (configResult.error) {
 
 // the arguments passed to this script start at index 2
 const args = process.argv.slice(2)
-const config: TestServerConfig = configResult.result
+const config: TestServerConfigMetadata = configResult.result
 const command = await parseArguments(args)
 
 switch (command?.action) {

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

@@ -172,7 +172,7 @@ export class NeovimApplication implements AsyncDisposable {
         args: neovimArguments,
 
         cwd: this.testEnvironmentPath,
-        env: env,
+        env,
         dimensions: terminalDimensions,
 
         onStdoutOrStderr(data) {

package/src/server/applications/terminal/TerminalTestApplication.ts

@@ -52,7 +52,7 @@ export default class TerminalTestApplication implements AsyncDisposable {
         args: terminalArguments,
 
         cwd: testDirectory.rootPathAbsolute,
-        env: env,
+        env,
         dimensions: terminalDimensions,
 
         onStdoutOrStderr(data) {

package/src/server/applications/terminal/runBlockingShellCommand.ts

@@ -24,7 +24,7 @@ export async function executeBlockingShellCommand(
 
   try {
     const result = await execPromise(input.command, {
-      signal: signal,
+      signal,
       shell: input.shell,
       uid: input.uid,
       gid: input.gid,

package/src/server/updateTestdirectorySchemaFile.ts

@@ -9,6 +9,11 @@ export type DirectoriesConfig = TestServerConfig["directories"]
 
 export type TestServerConfig = z.output<typeof testServerConfigSchema>
 
+export type TestServerConfigMetadata = {
+  configFilePath: string
+  config: TestServerConfig
+}
+
 export type Dictionary = Record<string, string>
 
 export type CustomizeEnv = (env: Dictionary) => Promise<Dictionary>