@tui-sandbox/library 11.9.2 → 11.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "11.9.2",
+  "version": "11.11.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/mikavilpas/tui-sandbox"
@@ -12,8 +12,8 @@
   },
   "dependencies": {
     "@catppuccin/palette": "1.7.1",
-    "@trpc/client": "11.7.0",
-    "@trpc/server": "11.7.0",
+    "@trpc/client": "11.7.1",
+    "@trpc/server": "11.7.1",
     "@xterm/addon-fit": "0.10.0",
     "@xterm/addon-unicode11": "0.8.0",
     "@xterm/xterm": "5.5.0",
@@ -31,13 +31,13 @@
   "devDependencies": {
     "@types/command-exists": "1.2.3",
     "@types/cors": "2.8.19",
-    "@types/express": "5.0.4",
-    "@types/node": "24.9.1",
+    "@types/express": "5.0.5",
+    "@types/node": "24.9.2",
     "cypress": "15.5.0",
     "nodemon": "3.1.10",
     "type-fest": "5.1.0",
     "vite": "7.1.12",
-    "vitest": "4.0.3"
+    "vitest": "4.0.6"
   },
   "peerDependencies": {
     "cypress": "^13 || ^14 || ^15",

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

@@ -62,7 +62,7 @@ export class NeovimTerminalClient {
     // time to complete
     this.ready = new Promise<void>(resolve => {
       console.log("Subscribing to stdout")
-      trpc.neovim.initializeStdout.subscribe(
+      trpc.neovim.onStdout.subscribe(
         { client: tabId },
         {
           onStarted() {

package/src/scripts/resolveConfig.test.ts

@@ -22,6 +22,7 @@ it("loads a custom configuration file if it exists", async () => {
     directories: {
       testEnvironmentPath: "./test-environment2/",
       outputFilePath: "./output.ts",
+      latestSymlinkName: "latest",
     },
     integrations: { neovim: { NVIM_APPNAMEs: ["nvim", "nvim_2"] } },
     port: 12345,

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

@@ -204,14 +204,9 @@ export class NeovimApplication implements AsyncDisposable {
       ...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"),
+        TUI_SANDBOX_TEST_ENVIRONMENT_PATH: testDirectory.testEnvironmentPath,
       } satisfies TestEnvironmentCommonEnvironmentVariables),
       NVIM_APPNAME: NVIM_APPNAME ?? "nvim",
 

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

@@ -18,6 +18,7 @@ it("should create a temp dir with no contents", async () => {
     directories: {
       testEnvironmentPath: dir.path,
       outputFilePath: nodePath.join(dir.path, "MyTestDirectory.ts"),
+      latestSymlinkName: "latest",
     },
   } satisfies PartialDeep<TestServerConfig>)
 

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

@@ -1,7 +1,7 @@
 import assert from "assert"
 import { execSync } from "child_process"
 import { constants, readdirSync, statSync } from "fs"
-import { access, mkdir, mkdtemp } from "fs/promises"
+import { access, mkdir, mkdtemp, symlink } from "fs/promises"
 import path from "path"
 import { debuglog } from "util"
 import { convertDree, getDirectoryTree } from "../../../dirtree/index.js"
@@ -28,12 +28,16 @@ export async function createTempDir(config: TestServerConfig): Promise<TestDirec
     const tree = convertDree(getDirectoryTree(dir).dree)
     assert(tree.type === "directory")
 
-    await updateTestdirectorySchemaFile(config)
+    const [_, latestEnvironmentSymlink] = await Promise.all([
+      updateTestdirectorySchemaFile(config),
+      createLatestSymlink(config, dir),
+    ])
     return {
       rootPathAbsolute: dir,
       contents: tree.contents,
       testEnvironmentPath: config.directories.testEnvironmentPath,
       testEnvironmentPathRelative: path.relative(config.directories.testEnvironmentPath, dir),
+      latestEnvironmentSymlink,
     }
   } catch (err) {
     console.error(err)
@@ -56,6 +60,26 @@ async function createUniqueDirectory(testEnvironmentPath: string): Promise<strin
   return dir
 }
 
+async function createLatestSymlink(config: TestServerConfig, uniqueTestDirectory: string): Promise<string> {
+  const latestSymlinkPath = path.join(
+    config.directories.testEnvironmentPath,
+    "testdirs" satisfies TestDirsPath,
+    config.directories.latestSymlinkName
+  )
+  try {
+    await access(latestSymlinkPath, constants.F_OK)
+    // If it already exists, remove it
+    execSync(`rm -f '${latestSymlinkPath}'`)
+  } catch {
+    // It doesn't exist, that's fine
+  }
+
+  // recreate it
+  await symlink(uniqueTestDirectory, latestSymlinkPath, "junction")
+
+  return latestSymlinkPath
+}
+
 export async function removeTestDirectories(testEnvironmentPath: string): Promise<void> {
   try {
     const testdirs = path.join(testEnvironmentPath, "testdirs" satisfies TestDirsPath)

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

@@ -72,11 +72,8 @@ export function createNeovimRouter(config: TestServerConfig) {
           config
         )
       }),
-    onStdout: trpc.procedure.input(z.object({ client: tabIdSchema })).subscription(options => {
-      return neovim.initializeStdout(options.input, options.signal, config.directories.testEnvironmentPath)
-    }),
 
-    initializeStdout: trpc.procedure.input(z.object({ client: tabIdSchema })).subscription(options => {
+    onStdout: trpc.procedure.input(z.object({ client: tabIdSchema })).subscription(options => {
       return neovim.initializeStdout(options.input, options.signal, config.directories.testEnvironmentPath)
     }),
     sendStdin: trpc.procedure.input(z.object({ tabId: tabIdSchema, data: z.string() })).mutation(options => {

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

@@ -16,6 +16,7 @@ describe("prepareNewTestDirectory when the testEnvironmentPath does not exist",
       directories: {
         outputFilePath: path.join(testEnvironmentPath, "foo.ts"),
         testEnvironmentPath,
+        latestSymlinkName: "latest",
       },
     } satisfies PartialDeep<TestServerConfig>)
 

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

@@ -82,6 +82,7 @@ export default class TerminalTestApplication implements AsyncDisposable {
       HOME: testDirectory.rootPathAbsolute,
       XDG_CONFIG_HOME: join(testDirectory.rootPathAbsolute, ".config"),
       XDG_DATA_HOME: join(testDirectory.testEnvironmentPath, ".repro", "data"),
+      TUI_SANDBOX_TEST_ENVIRONMENT_PATH: testDirectory.testEnvironmentPath,
       ...additionalEnvironmentVariables,
     } satisfies TestEnvironmentCommonEnvironmentVariables
   }

package/src/server/config.ts

@@ -6,6 +6,7 @@ export const createDefaultConfig = (cwd: string, environment: NodeJS.ProcessEnv)
     directories: {
       testEnvironmentPath: path.join(cwd, "test-environment/"),
       outputFilePath: path.join(cwd, "MyTestDirectory.ts"),
+      latestSymlinkName: "latest",
     },
     port: environment["PORT"] ? parseInt(environment["PORT"]) : 3000,
     integrations: {

package/src/server/types.ts

@@ -29,6 +29,8 @@ export type TestDirectory<TContents extends Record<string, unknown> = Record<str
    */
   testEnvironmentPathRelative: string
 
+  latestEnvironmentSymlink: string
+
   contents: TContents
 }
 
@@ -36,6 +38,7 @@ export const serverTestDirectorySchema = z.object({
   rootPathAbsolute: z.string(),
   testEnvironmentPath: z.string(),
   testEnvironmentPathRelative: z.string(),
+  latestEnvironmentSymlink: z.string(),
   contents: z.record(z.string(), z.unknown()),
 })
 export type ServerTestDirectory = z.infer<typeof serverTestDirectorySchema>
@@ -43,14 +46,22 @@ export type ServerTestDirectory = z.infer<typeof serverTestDirectorySchema>
 export type TestEnvironmentCommonEnvironmentVariables = {
   HOME: string
 
-  // this is needed so that the application being tested can load its
-  // configuration, emulating a common setup real users have
+  /** This is needed so that the application being tested can load its
+   * configuration, emulating a common setup real users have
+   */
   XDG_CONFIG_HOME: string
 
-  // the data directory is where the application stores its data. To prevent
-  // downloading a new set of plugins/whatever for each test, share the data
-  // directory.
+  /** The data directory is where the application stores its data. To prevent
+   * downloading a new set of plugins/whatever for each test, share the data
+   * directory.
+   */
   XDG_DATA_HOME: string
+
+  /** The path to the test environment directory, which is the blueprint for
+   * the test directory.
+   * @example /Users/mikavilpas/git/tui-sandbox/packages/integration-tests/test-environment
+   * */
+  TUI_SANDBOX_TEST_ENVIRONMENT_PATH: string
 }
 
 export type { StartNeovimGenericArguments } from "./applications/neovim/NeovimApplication.js"

package/src/server/updateTestdirectorySchemaFile.ts

@@ -37,6 +37,7 @@ export const testServerConfigSchema = z.strictObject({
   directories: z.object({
     testEnvironmentPath: z.string(),
     outputFilePath: z.string(),
+    latestSymlinkName: z.string().optional().default("latest"),
   }),
   port: z.number().int().min(1).max(65535),
   integrations: z.strictObject({

package/vite.config.js

@@ -19,6 +19,7 @@ export default defineConfig({
     outDir: "./dist/browser/",
   },
   test: {
+    exclude: ["node_modules", "dist"],
     globals: true, // This will make describe, it, etc. available globally
     environment: "node",
     mockReset: true,