@tui-sandbox/library 10.6.1 → 10.7.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "10.6.1",
+  "version": "10.7.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/mikavilpas/tui-sandbox"
@@ -12,8 +12,8 @@
   },
   "dependencies": {
     "@catppuccin/palette": "1.7.1",
-    "@trpc/client": "11.4.2",
-    "@trpc/server": "11.4.2",
+    "@trpc/client": "11.4.3",
+    "@trpc/server": "11.4.3",
     "@xterm/addon-attach": "0.11.0",
     "@xterm/addon-fit": "0.10.0",
     "@xterm/xterm": "5.5.0",
@@ -24,7 +24,7 @@
     "express": "5.1.0",
     "neovim": "5.3.0",
     "node-pty": "1.0.0",
-    "prettier": "3.6.1",
+    "prettier": "3.6.2",
     "tsx": "4.20.3",
     "type-fest": "4.41.0",
     "winston": "3.17.0"
@@ -33,7 +33,7 @@
     "@types/command-exists": "1.2.3",
     "@types/cors": "2.8.19",
     "@types/express": "5.0.3",
-    "@types/node": "24.0.4",
+    "@types/node": "24.0.6",
     "nodemon": "3.1.10",
     "vite": "7.0.0",
     "vitest": "3.2.4",

package/src/server/TestServer.ts

@@ -6,6 +6,7 @@ import express from "express"
 import { accessSync } from "fs"
 import path from "path"
 import { fileURLToPath } from "url"
+import { debuglog } from "util"
 
 export type TestServerSettings = {
   port: number
@@ -13,12 +14,13 @@ export type TestServerSettings = {
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
+const log = debuglog("tui-sandbox.TestServer")
 
 export class TestServer {
   public constructor(private readonly settings: TestServerSettings) {}
 
   public async startAndRun(appRouter: AnyTRPCRouter): Promise<void> {
-    console.log("🚀 Server starting")
+    log("🚀 Server starting")
 
     const app = express()
     app.use(
@@ -39,7 +41,7 @@ export class TestServer {
       } catch (e) {
         // This is normal when developing the tui-sandbox library locally. It
         // should always exist when using it as an npm package, however.
-        console.log(
+        console.warn(
           `⚠️ Warning: Looks like the tui-sandbox root contents directory is not accessible at: ${publicPath}`
         )
       }
@@ -55,16 +57,16 @@ export class TestServer {
 
     const server = app.listen(this.settings.port, "0.0.0.0")
 
-    console.log(`✅ Server listening on port ${this.settings.port}`)
+    console.info(`✅ Server listening on port ${this.settings.port}`)
 
     await Promise.race([once(process, "SIGTERM"), once(process, "SIGINT")])
-    console.log("😴 Shutting down...")
+    log("😴 Shutting down...")
     server.close(error => {
       if (error) {
         console.error("Error closing server", error)
         process.exit(1)
       }
-      console.log("Server closed")
+      log("Server closed")
       process.exit(0)
     })
   }

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

@@ -5,12 +5,15 @@ import { access } from "fs/promises"
 import type { NeovimClient as NeovimApiClient } from "neovim"
 import { tmpdir } from "os"
 import path, { join } from "path"
+import { debuglog } from "util"
 import type { TestDirectory, TestEnvironmentCommonEnvironmentVariables } from "../../types.js"
 import { DisposableSingleApplication } from "../../utilities/DisposableSingleApplication.js"
 import type { Lazy } from "../../utilities/Lazy.js"
 import { TerminalApplication } from "../../utilities/TerminalApplication.js"
 import { connectNeovimApi } from "./NeovimJavascriptApiClient.js"
 
+const log = debuglog("tui-sandbox-neovim-application")
+
 /*
 
 Usage:
@@ -170,7 +173,7 @@ export class NeovimApplication implements AsyncDisposable {
       client: connectNeovimApi(socketPath),
     }
 
-    console.log(`🚀 Started Neovim instance ${processId}`)
+    log(`🚀 Started Neovim instance ${processId}`)
   }
 
   public getEnvironmentVariables(
@@ -202,7 +205,9 @@ export class NeovimApplication implements AsyncDisposable {
 
     try {
       await access(this.state.socketPath)
-      console.warn(`Socket file ${this.state.socketPath} should have been removed by neovim when it exited.`)
+      // this is probably not dangerous, but I'm not sure why it sometimes
+      // happens. It's better to report it than to hide it.
+      log(`Socket file ${this.state.socketPath} should have been removed by neovim when it exited.`)
       return
     } catch (e) {
       // all good

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

@@ -4,6 +4,8 @@ import { attach } from "neovim"
 import { createLogger, format, transports } from "winston"
 import { Lazy } from "../../utilities/Lazy.js"
 
+// const log = debuglog("tui-sandbox.neovim.NeovimJavascriptApiClient")
+
 export type NeovimJavascriptApiClient = NeovimApiClient
 
 export type PollingInterval = 100
@@ -28,10 +30,10 @@ export function connectNeovimApi(socketPath: string): Lazy<Promise<NeovimJavascr
     for (let i = 0; i < 100; i++) {
       try {
         await access(socketPath)
-        // console.log(`socket file ${socketPath} created after at attempt ${i + 1}`)
+        // log(`socket file ${socketPath} created after at attempt ${i + 1}`)
         break
       } catch (e) {
-        // console.log(`polling for socket file ${socketPath} to be created (attempt ${i + 1})`)
+        // log(`polling for socket file ${socketPath} to be created (attempt ${i + 1})`)
         await new Promise(resolve => setTimeout(resolve, 100 satisfies PollingInterval))
       }
     }

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

@@ -2,6 +2,7 @@ import assert from "assert"
 import "core-js/proposals/async-explicit-resource-management.js"
 import { access } from "fs/promises"
 import path from "path"
+import { debuglog } from "util"
 import type { BlockingCommandInput } from "../../blockingCommandInputSchema.js"
 import type {
   BlockingShellCommandOutput,
@@ -26,6 +27,8 @@ const resources: Lazy<AsyncDisposableStack> = new Lazy(() => {
   return new AsyncDisposableStack()
 })
 
+const log = debuglog("tui-sandbox.neovim.api")
+
 export async function installDependencies(testEnvironmentPath: string, config: DirectoriesConfig): Promise<void> {
   await using app = new NeovimApplication(testEnvironmentPath)
   const testDirectory = await prepareNewTestDirectory(config)
@@ -33,12 +36,17 @@ export async function installDependencies(testEnvironmentPath: string, config: D
   try {
     await access(prepareFilePath)
   } catch (e) {
+    // show the output here because it's typically shown in the console before
+    // the tests start. It's also sensitive to outside changes.
+    //
+    // eslint-disable-next-line no-restricted-properties
     console.log(
       `Neovim prepareFilePath does not exist: ${prepareFilePath}. If you want to run a prepare script before starting the tests, create it.`
     )
     return
   }
 
+  // eslint-disable-next-line no-restricted-properties
   console.log(`🚀 Running Neovim prepareFilePath ${prepareFilePath}...`)
 
   let output = ""
@@ -53,7 +61,9 @@ export async function installDependencies(testEnvironmentPath: string, config: D
     { cols: 80, rows: 24 }
   )
   await app.application.untilExit()
+  // eslint-disable-next-line no-restricted-properties
   console.log(`🚀 Neovim installDependencies output:`)
+  // eslint-disable-next-line no-restricted-properties
   console.log(output)
 }
 
@@ -145,7 +155,7 @@ export async function runLuaCode(options: LuaCodeInput): Promise<RunLuaCodeOutpu
     throw new Error(`Neovim API not available for client id ${options.tabId.tabId}. Maybe it's not started yet?`)
   }
 
-  console.log(`Neovim ${neovim.application.processId()} running Lua code: ${options.luaCode}`)
+  log(`Neovim ${neovim.application.processId()} running Lua code: ${options.luaCode}`)
   try {
     const value = await api.lua(options.luaCode)
     return { value }
@@ -179,11 +189,11 @@ export async function waitForLuaCode(
     throw new Error(`Neovim API not available for client id ${options.tabId.tabId}. Maybe it's not started yet?`)
   }
 
-  console.log(`Neovim ${neovim.application.processId()} polling Lua code: ${options.luaAssertion}`)
+  log(`Neovim ${neovim.application.processId()} polling Lua code: ${options.luaAssertion}`)
 
   let running: boolean = true
   signal?.addEventListener("abort", () => {
-    console.log(`Polling Lua code: '${options.luaAssertion}' was aborted via signal`)
+    log(`Polling Lua code: '${options.luaAssertion}' was aborted via signal`)
     running = false
   })
 
@@ -205,7 +215,7 @@ export async function waitForLuaCode(
 
     try {
       const value = await api.lua(options.luaAssertion)
-      console.log(`Lua code assertion passed: ${options.luaAssertion} (iteration ${iteration})`)
+      log(`Lua code assertion passed: ${options.luaAssertion} (iteration ${iteration})`)
 
       return { value }
     } catch (e) {
@@ -236,11 +246,11 @@ export async function runExCommand(options: ExCommandInput): Promise<RunExComman
     throw new Error(`Neovim API not available for client id ${options.tabId.tabId}. Maybe it's not started yet?`)
   }
 
-  console.log(`Neovim ${neovim.application.processId()} running Ex command: ${options.command}`)
+  log(`Neovim ${neovim.application.processId()} running Ex command: ${options.command}`)
   try {
     const output = await api.commandOutput(options.command)
     if (options.log) {
-      console.log(`:${options.command} output: ${output}`)
+      console.info(`:${options.command} output: ${output}`)
     }
     return { value: output }
   } catch (e) {

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

@@ -4,11 +4,14 @@ import { Type } from "dree"
 import { constants, readdirSync, statSync } from "fs"
 import { access, mkdir, mkdtemp } from "fs/promises"
 import path from "path"
+import { debuglog } from "util"
 import { convertDree, getDirectoryTree } from "../../../dirtree/index.js"
 import type { TestDirectory } from "../../../types.js"
 import type { DirectoriesConfig } from "../../../updateTestdirectorySchemaFile.js"
 import { updateTestdirectorySchemaFile } from "../../../updateTestdirectorySchemaFile.js"
 
+const log = debuglog("tui-sandbox.createTempDir")
+
 export async function createTempDir(config: DirectoriesConfig): Promise<TestDirectory> {
   try {
     // before calling this function, the testEnvironmentPath should already exist
@@ -21,7 +24,7 @@ export async function createTempDir(config: DirectoriesConfig): Promise<TestDire
 
       execSync(`cp -R '${path.join(config.testEnvironmentPath, entry)}' ${dir}/`)
     })
-    console.log(`Created test directory at ${dir}`)
+    log(`Created test directory at ${dir}`)
 
     const tree = convertDree(getDirectoryTree(dir).dree)
     assert(tree.type === Type.DIRECTORY)

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

@@ -1,14 +1,17 @@
 import { access, mkdir } from "fs/promises"
+import { debuglog } from "util"
 import type { TestDirectory } from "../../types.js"
 import type { DirectoriesConfig } from "../../updateTestdirectorySchemaFile.js"
 import { createTempDir, removeTestDirectories } from "./environment/createTempDir.js"
 
+const log = debuglog("tui-sandbox.neovim.prepareNewTestDirectory")
+
 export async function prepareNewTestDirectory(config: DirectoriesConfig): Promise<TestDirectory> {
   try {
     // if the directory does not exist, create it
     await access(config.testEnvironmentPath)
   } catch {
-    console.log(`Creating testEnvironmentPath directory at ${config.testEnvironmentPath}`)
+    log(`Creating testEnvironmentPath directory at ${config.testEnvironmentPath}`)
     await mkdir(config.testEnvironmentPath, { recursive: true })
   }
 

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

@@ -2,11 +2,14 @@ import assert from "assert"
 import { exec } from "child_process"
 import EventEmitter from "events"
 import { join } from "path"
+import { debuglog } from "util"
 import type { TestDirectory, TestEnvironmentCommonEnvironmentVariables } from "../../types.js"
 import { DisposableSingleApplication } from "../../utilities/DisposableSingleApplication.js"
 import { TerminalApplication } from "../../utilities/TerminalApplication.js"
 import type { StdoutOrStderrMessage, TerminalDimensions } from "../neovim/NeovimApplication.js"
 
+const log = debuglog("tui-sandbox.terminal.TerminalTestApplication")
+
 type ResettableState = {
   testDirectory: TestDirectory
 }
@@ -70,7 +73,7 @@ export default class TerminalTestApplication implements AsyncDisposable {
 
     this.state = { testDirectory }
 
-    console.log(`🚀 Started Terminal instance ${processId}`)
+    log(`🚀 Started Terminal instance ${processId}`)
   }
 
   public getEnvironmentVariables(

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

@@ -1,10 +1,12 @@
 import { exec } from "child_process"
 import "core-js/proposals/async-explicit-resource-management.js"
 import { join } from "path"
-import util from "util"
+import util, { debuglog } from "util"
 import type { BlockingCommandInput } from "../../blockingCommandInputSchema.js"
 import type { BlockingShellCommandOutput, TestDirectory } from "../../types.js"
 
+const log = debuglog("tui-sandbox.terminal.runBlockingShellCommand")
+
 export async function executeBlockingShellCommand(
   testDirectory: TestDirectory,
   input: BlockingCommandInput,
@@ -30,7 +32,7 @@ export async function executeBlockingShellCommand(
       cwd,
       env,
     })
-    console.log(
+    log(
       `Successfully ran shell blockingCommand (${input.command}) in cwd: '${cwd}' with stdout: ${result.stdout}, stderr: ${result.stderr}`
     )
     return {

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

@@ -1,8 +1,11 @@
 import { readFileSync, writeFileSync } from "fs"
 import { mkdir, stat } from "fs/promises"
 import path from "path"
+import { debuglog } from "util"
 import { createCypressSupportFileContents } from "./contents.js"
 
+const log = debuglog("tui-sandbox.dirtree")
+
 export type CreateCypressSupportFileArgs = {
   cypressSupportDirectoryPath: string
   supportFileName: string
@@ -24,7 +27,7 @@ export async function createCypressSupportFile({
   try {
     await stat(configModificationsDirectoryPath)
   } catch (error) {
-    console.log(
+    console.info(
       `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, { recursive: true })
@@ -37,14 +40,14 @@ export async function createCypressSupportFile({
   try {
     oldSchema = readFileSync(outputFilePath, "utf-8")
   } catch (error) {
-    console.log(`No existing cypress support file found at ${outputFilePath}`)
+    console.warn(`No existing cypress support file found at ${outputFilePath}`)
   }
 
   if (oldSchema !== text) {
     // it's important to not write the file if the schema hasn't changed
     // because file watchers will trigger on file changes and we don't want to
     // trigger a build if the schema hasn't changed
-    console.log(`🪛 Writing cypress support file to ${outputFilePath}`)
+    log(`🪛 Writing cypress support file to ${outputFilePath}`)
     writeFileSync(outputFilePath, text)
     return "updated"
   } else {

package/src/server/dirtree/index.ts

@@ -3,8 +3,10 @@ import { scan, Type } from "dree"
 import { readlinkSync } from "fs"
 import { format, resolveConfig } from "prettier"
 import { fileURLToPath } from "url"
+import { debuglog } from "util"
 import { jsonToZod } from "./json-to-zod.js"
 
+const log = debuglog("tui-sandbox.dirtree")
 type TreeResult = { dree: Dree | undefined; allFiles: Dree[] }
 
 /** Convert a directory tree to a TypeScript type. This is useful for testing
@@ -117,7 +119,7 @@ export async function buildSchemaForDirectoryTree(result: TreeResult, name: stri
 const __filename = fileURLToPath(import.meta.url)
 
 export async function buildTestDirectorySchema(testDirectoryPath: string): Promise<string> {
-  console.log("Building schema for test directory", testDirectoryPath)
+  log("Building schema for test directory", testDirectoryPath)
   const dree = getDirectoryTree(testDirectoryPath)
   let text = await buildSchemaForDirectoryTree(dree, "MyTestDirectory")
 

package/src/server/updateTestdirectorySchemaFile.ts

@@ -1,6 +1,9 @@
 import { readFileSync, writeFileSync } from "fs"
+import { debuglog } from "util"
 import { buildTestDirectorySchema } from "./dirtree/index.js"
 
+const log = debuglog("tui-sandbox.updateTestdirectorySchemaFile")
+
 export type DirectoriesConfig = {
   testEnvironmentPath: string
   outputFilePath: string
@@ -23,7 +26,7 @@ export async function updateTestdirectorySchemaFile({
   try {
     oldSchema = readFileSync(outputFilePath, "utf-8")
   } catch (error) {
-    console.log("No existing schema file found, creating a new one")
+    log("No existing schema file found, creating a new one")
   }
 
   if (oldSchema !== newSchema) {

package/src/server/utilities/DisposableSingleApplication.ts

@@ -1,8 +1,11 @@
 import assert from "assert"
+import { debuglog } from "util"
 import type { ExitInfo, TerminalApplication } from "./TerminalApplication.js"
 
 export type StartableApplication = Pick<TerminalApplication, "write" | "processId" | "killAndWait" | "untilExit">
 
+const log = debuglog("tui-sandbox.DisposableSingleApplication")
+
 /** A testable application that can be started, killed, and given input. For a
  * single instance of this interface, only a single instance can be running at
  * a time.
@@ -40,7 +43,7 @@ export class DisposableSingleApplication implements AsyncDisposable {
     if (this.processId() === undefined) {
       return
     }
-    console.log(`Killing current application ${this.processId()}...`)
+    log(`Killing current application ${this.processId()}...`)
     await this.application?.killAndWait()
   }
 }

package/src/server/utilities/TerminalApplication.ts

@@ -4,8 +4,11 @@ import { createLogger, format, transports } from "winston"
 import type { ITerminalDimensions } from "@xterm/addon-fit"
 import type { IPty } from "node-pty"
 import pty from "node-pty"
+import { debuglog } from "util"
 import type { StartableApplication } from "./DisposableSingleApplication.js"
 
+const log = debuglog("tui-sandbox.TerminalApplication")
+
 export type ExitInfo = { exitCode: number; signal: number | undefined }
 
 // NOTE separating stdout and stderr is not supported by node-pty
@@ -55,7 +58,7 @@ export class TerminalApplication implements StartableApplication {
     env?: NodeJS.ProcessEnv
     dimensions: ITerminalDimensions
   }): TerminalApplication {
-    console.log(`Starting '${command}' with args '${args.join(" ")}' in cwd '${cwd}'`)
+    log(`Starting '${command}' with args '${args.join(" ")}' in cwd '${cwd}'`)
 
     const ptyProcess = pty.spawn(command, args, {
       name: "xterm-color",
@@ -66,7 +69,7 @@ export class TerminalApplication implements StartableApplication {
     })
     ptyProcess.onData(onStdoutOrStderr)
     ptyProcess.onExit(({ exitCode, signal }) => {
-      console.log(`Child process exited with code ${exitCode} and signal ${signal}`)
+      log(`Child process exited with code ${exitCode} and signal ${signal}`)
     })
 
     const processId = ptyProcess.pid
@@ -90,8 +93,8 @@ export class TerminalApplication implements StartableApplication {
   }
 
   public async killAndWait(): Promise<void> {
-    console.log(`💣 Killing process ${this.processId}`)
+    log(`💣 Killing process ${this.processId}`)
     this.subProcess.kill()
-    console.log(`💥 Killed process ${this.processId}`)
+    log(`💥 Killed process ${this.processId}`)
   }
 }