@tui-sandbox/library 11.2.1 → 11.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "11.2.1",
+  "version": "11.3.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/mikavilpas/tui-sandbox"

package/src/browser/neovim-client.ts

@@ -6,6 +6,7 @@ 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"
@@ -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/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.