@tui-sandbox/library 11.2.1 → 11.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "11.2.1",
+  "version": "11.3.1",
   "repository": {
     "type": "git",
     "url": "https://github.com/mikavilpas/tui-sandbox"
@@ -14,19 +14,17 @@
     "@catppuccin/palette": "1.7.1",
     "@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",
-    "command-exists": "1.2.9",
     "cors": "2.8.5",
     "dree": "5.1.5",
     "express": "5.1.0",
     "neovim": "5.3.0",
     "node-pty": "1.0.0",
     "prettier": "3.6.2",
-    "tsx": "4.20.3",
     "type-fest": "4.41.0",
-    "winston": "3.17.0"
+    "winston": "3.17.0",
+    "zod": "4.0.14"
   },
   "devDependencies": {
     "@types/command-exists": "1.2.3",
@@ -34,9 +32,9 @@
     "@types/express": "5.0.3",
     "@types/node": "24.1.0",
     "nodemon": "3.1.10",
+    "tsx": "4.20.3",
     "vite": "7.0.6",
-    "vitest": "3.2.4",
-    "zod": "4.0.14"
+    "vitest": "3.2.4"
   },
   "peerDependencies": {
     "cypress": "^13 || ^14",

package/src/browser/neovim-client.ts

@@ -1,11 +1,12 @@
 import type { Terminal } from "@xterm/xterm"
 import { TerminalClient as NeovimTerminalClient } from "../client/index.js"
+import type { TuiTerminalApi } from "../client/startTerminal.js"
 import { TerminalTerminalClient } from "../client/terminal-terminal-client.js"
-import type { TuiTerminalApi } from "../client/websocket-client.js"
 import type {
   ExCommandClientInput,
   LuaCodeClientInput,
   PollLuaCodeClientInput,
+  RunLuaFileClientInput,
 } from "../server/applications/neovim/neovimRouter.js"
 import type { StartTerminalGenericArguments } from "../server/applications/terminal/TerminalTestApplication.js"
 import type { BlockingCommandClientInput } from "../server/blockingCommandInputSchema.js"
@@ -31,6 +32,7 @@ const terminalClient = new Lazy(() => new TerminalTerminalClient(app))
 export type GenericNeovimBrowserApi = {
   runBlockingShellCommand(input: BlockingCommandClientInput): Promise<BlockingShellCommandOutput>
   runLuaCode(input: LuaCodeClientInput): Promise<RunLuaCodeOutput>
+  doFile(input: RunLuaFileClientInput): Promise<RunLuaCodeOutput>
   waitForLuaCode(input: PollLuaCodeClientInput): Promise<RunLuaCodeOutput>
   runExCommand(input: ExCommandClientInput): Promise<RunExCommandOutput>
   dir: TestDirectory
@@ -54,6 +56,9 @@ window.startNeovim = async function (startArgs?: StartNeovimGenericArguments): P
     runLuaCode(input) {
       return neovim.runLuaCode(input)
     },
+    doFile(input) {
+      return neovim.doFile(input)
+    },
     waitForLuaCode(input) {
       return neovim.waitForLuaCode(input)
     },

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

@@ -5,6 +5,7 @@ import type {
   ExCommandClientInput,
   LuaCodeClientInput,
   PollLuaCodeClientInput,
+  RunLuaFileClientInput,
 } from "../server/applications/neovim/neovimRouter.js"
 import type { BlockingCommandClientInput } from "../server/blockingCommandInputSchema.js"
 import type { AppRouter } from "../server/server.js"
@@ -15,8 +16,8 @@ import type {
   StartNeovimGenericArguments,
   TestDirectory,
 } from "../server/types.js"
+import { getTabId, startTerminal } from "./startTerminal.js"
 import "./style.css"
-import { getTabId, startTerminal } from "./websocket-client.js"
 
 /** Manages the terminal state in the browser as well as the (browser's)
  * connection to the server side terminal application api. */
@@ -108,6 +109,15 @@ export class NeovimTerminalClient {
     return this.trpc.neovim.runLuaCode.mutate({ ...input, tabId: this.tabId })
   }
 
+  public async doFile(input: RunLuaFileClientInput): Promise<RunExCommandOutput> {
+    await this.ready
+    return this.trpc.neovim.runExCommand.mutate({
+      ...input,
+      tabId: this.tabId,
+      command: `lua dofile("${input.luaFile}")`,
+    })
+  }
+
   public async waitForLuaCode(input: PollLuaCodeClientInput): Promise<RunLuaCodeOutput> {
     await this.ready
     try {

package/src/client/terminal-config.ts

@@ -1,5 +1,5 @@
 import type { Terminal } from "@xterm/xterm"
-import type { TuiTerminalApi } from "./websocket-client.js"
+import type { TuiTerminalApi } from "./startTerminal.js"
 
 /** DA1—Primary Device Attributes
  * In this DA exchange, the host asks for the terminal's architectural class and basic attributes.

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

@@ -5,10 +5,10 @@ import type { StartTerminalBrowserArguments } from "../browser/neovim-client.js"
 import type { BlockingCommandClientInput } from "../server/blockingCommandInputSchema.js"
 import type { AppRouter } from "../server/server.js"
 import type { BlockingShellCommandOutput, TestDirectory } from "../server/types.js"
+import type { TuiTerminalApi } from "./startTerminal.js"
+import { getTabId, startTerminal } from "./startTerminal.js"
 import "./style.css"
 import { supportDA1 } from "./terminal-config.js"
-import type { TuiTerminalApi } from "./websocket-client.js"
-import { getTabId, startTerminal } from "./websocket-client.js"
 
 /** Manages the terminal state in the browser as well as the (browser's)
  * connection to the server side terminal application api. */

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

@@ -26,6 +26,14 @@ const exCommandInputSchema = z.object({
 export type ExCommandClientInput = Except<ExCommandInput, "tabId">
 export type ExCommandInput = z.infer<typeof exCommandInputSchema>
 
+const runLuaFileInputSchema = z.object({
+  tabId: tabIdSchema,
+  luaFile: z.string(),
+  log: z.boolean().optional(),
+})
+export type RunLuaFileInput = z.output<typeof runLuaFileInputSchema>
+export type RunLuaFileClientInput = Except<RunLuaFileInput, "tabId">
+
 // let trpc infer the type as that is what it is designed to do
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export function createNeovimRouter(config: DirectoriesConfig) {

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

@@ -28,6 +28,7 @@ import type {
   ExCommandClientInput,
   LuaCodeClientInput,
   PollLuaCodeClientInput,
+  RunLuaFileClientInput,
 } from "@tui-sandbox/library/src/server/applications/neovim/neovimRouter"
 import type { StartTerminalGenericArguments } from "@tui-sandbox/library/src/server/applications/terminal/TerminalTestApplication"
 import type { BlockingCommandClientInput } from "@tui-sandbox/library/src/server/blockingCommandInputSchema"
@@ -61,6 +62,13 @@ export type NeovimContext = {
    * finish before returning. Requires neovim to be running. */
   runLuaCode(input: LuaCodeClientInput): Cypress.Chainable<RunLuaCodeOutput>
 
+  /** Runs a Lua file in neovim after it has started. Can be used to keep
+   * complex lua logic in a separate file, still being able to run it after
+   * startup. This way additional tools like lua LSP servers, linters, etc. can
+   * be used to ensure the code is correct.
+   */
+  doFile(input: MyRunLuaFileClientInput): Cypress.Chainable<RunExCommandOutput>
+
   /**
    * Like runLuaCode, but waits until the given code (maybe using lua's return
    * assert()) does not raise an error, and returns the first successful result.
@@ -90,6 +98,8 @@ export type MyStartNeovimServerArguments = OverrideProperties<
   }
 >
 
+export type MyRunLuaFileClientInput = OverrideProperties<RunLuaFileClientInput, { luaFile: MyTestDirectoryFile }>
+
 Cypress.Commands.add("startNeovim", (startArguments?: MyStartNeovimServerArguments) => {
   cy.window().then(async win => {
     const underlyingNeovim: GenericNeovimBrowserApi = await win.startNeovim(
@@ -103,6 +113,7 @@ Cypress.Commands.add("startNeovim", (startArguments?: MyStartNeovimServerArgumen
       nvim_runExCommand: underlyingNeovim.runExCommand,
       nvim_runLuaCode: underlyingNeovim.runLuaCode,
       nvim_waitForLuaCode: underlyingNeovim.waitForLuaCode,
+      nvim_doFile: underlyingNeovim.doFile,
     })
 
     const api: NeovimContext = {
@@ -115,6 +126,9 @@ Cypress.Commands.add("startNeovim", (startArguments?: MyStartNeovimServerArgumen
       runLuaCode(input) {
         return cy.nvim_runLuaCode(input)
       },
+      doFile(input) {
+        return cy.nvim_doFile(input)
+      },
       waitForLuaCode(input) {
         return cy.nvim_waitForLuaCode(input)
       },
@@ -201,6 +215,7 @@ declare global {
       nvim_runBlockingShellCommand(input: MyBlockingCommandClientInput): Chainable<BlockingShellCommandOutput>
 
       nvim_runLuaCode(input: LuaCodeClientInput): Chainable<RunLuaCodeOutput>
+      nvim_doFile(input: MyRunLuaFileClientInput): Chainable<RunExCommandOutput>
       nvim_waitForLuaCode(input: PollLuaCodeClientInput): Chainable<RunLuaCodeOutput>
 
       /** Run an ex command in neovim.

package/dist/src/client/websocket-client.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"websocket-client.js","sourceRoot":"","sources":["../../../src/client/websocket-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAA;AACvC,OAAO,4BAA4B,CAAA;AACnC,OAAO,KAAK,CAAC,MAAM,KAAK,CAAA;AAExB,OAAO,aAAa,CAAA;AACpB,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AAM5D,MAAM,UAAU,aAAa,CAAC,GAAgB,EAAE,GAAmB;IACjE,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC;QAC5B,WAAW,EAAE,KAAK;QAClB,UAAU,EAAE,IAAI;QAChB,QAAQ,EAAE,EAAE;KACb,CAAC,CAAA;IAEF,MAAM,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAA;IACvC,QAAQ,CAAC,OAAO,CAAC,KAAK,GAAG;QACvB,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG;QAC3B,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG;QACvB,WAAW,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG;QAChC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG;QACrB,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG;QAC3B,UAAU,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG;QAC1B,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG;QAC5B,YAAY,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG;QAC/B,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG;QACvB,IAAI,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG;QACpB,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG;QAC3B,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG;QACvB,OAAO,EAAE,MAAM,CAAC,QAAQ,CAAC,GAAG;QAC5B,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG;QACnB,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG;QACtB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG;KAC1B,CAAA;IAED,4EAA4E;IAC5E,oBAAoB;IACpB,MAAM,QAAQ,GAAG,IAAI,QAAQ,EAAE,CAAA;IAC/B,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;IAC5B,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAClB,QAAQ,CAAC,GAAG,EAAE,CAAA;IAEd,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,GAAG,EAAE;QACrC,QAAQ,CAAC,GAAG,EAAE,CAAA;IAChB,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;QACrB,IAAqB,CAAA;QACrB,gDAAgD;QAChD,EAAE;QACF,wEAAwE;QACxE,0DAA0D;QAE1D,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,oCAAoC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC9E,CAAC;QAED,MAAM,UAAU,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAA;QAC3C,IAAI,UAAU,EAAE,CAAC;YACf,GAAG,CAAC,YAAY,CAAC,UAAU,CAAC,CAAA;QAC9B,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QACrB,GAAG,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;IACvB,CAAC,CAAC,CAAA;IAEF,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED;uDACuD;AACvD,MAAM,UAAU,QAAQ;IACtB,0EAA0E;IAC1E,YAAY;IACZ,IAAI,KAAK,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAA;IACtE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;QAClC,cAAc,CAAC,OAAO,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;IACxC,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,CAAA;AAClB,CAAC"}

package/dist/src/server/utilities/applicationAvailable.d.ts

@@ -1 +0,0 @@
-export declare function applicationAvailable(command: string): Promise<string | null>;

package/dist/src/server/utilities/applicationAvailable.js

@@ -1,5 +0,0 @@
-import commandExists from "command-exists";
-export async function applicationAvailable(command) {
-    return commandExists(command);
-}
-//# sourceMappingURL=applicationAvailable.js.map

package/dist/src/server/utilities/applicationAvailable.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"applicationAvailable.js","sourceRoot":"","sources":["../../../../src/server/utilities/applicationAvailable.ts"],"names":[],"mappings":"AAAA,OAAO,aAAa,MAAM,gBAAgB,CAAA;AAE1C,MAAM,CAAC,KAAK,UAAU,oBAAoB,CAAC,OAAe;IACxD,OAAO,aAAa,CAAC,OAAO,CAAC,CAAA;AAC/B,CAAC"}

package/dist/src/server/utilities/applicationAvailable.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/src/server/utilities/applicationAvailable.test.js

@@ -1,13 +0,0 @@
-import { applicationAvailable } from "./applicationAvailable.js";
-describe("sanity checks for mocking", () => {
-    // because it makes no sense to mock the actual implementation if we don't
-    // know what it does in the current version, we better check what it's
-    // expected to do
-    it("can find neovim using the actual implementation", async () => {
-        await expect(applicationAvailable("nvim")).resolves.toBe("nvim");
-    });
-    it("complains when a nonexistent command is checked", async () => {
-        await expect(applicationAvailable("thisCommandDoesNotExist")).rejects.toBe(null);
-    });
-});
-//# sourceMappingURL=applicationAvailable.test.js.map

package/dist/src/server/utilities/applicationAvailable.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"applicationAvailable.test.js","sourceRoot":"","sources":["../../../../src/server/utilities/applicationAvailable.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAEhE,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACzC,0EAA0E;IAC1E,sEAAsE;IACtE,iBAAiB;IACjB,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,MAAM,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;IAClE,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,MAAM,CAAC,oBAAoB,CAAC,yBAAyB,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAClF,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/src/server/utilities/applicationAvailable.test.ts

@@ -1,14 +0,0 @@
-import { applicationAvailable } from "./applicationAvailable.js"
-
-describe("sanity checks for mocking", () => {
-  // because it makes no sense to mock the actual implementation if we don't
-  // know what it does in the current version, we better check what it's
-  // expected to do
-  it("can find neovim using the actual implementation", async () => {
-    await expect(applicationAvailable("nvim")).resolves.toBe("nvim")
-  })
-
-  it("complains when a nonexistent command is checked", async () => {
-    await expect(applicationAvailable("thisCommandDoesNotExist")).rejects.toBe(null)
-  })
-})

package/src/server/utilities/applicationAvailable.ts

@@ -1,5 +0,0 @@
-import commandExists from "command-exists"
-
-export async function applicationAvailable(command: string): Promise<string | null> {
-  return commandExists(command)
-}