npm - @tui-sandbox/library - Versions diffs - 7.7.1 → 8.0.0 - Mend

@tui-sandbox/library 7.7.1 → 8.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/CHANGELOG.md +16 -0
package/dist/browser/assets/{index-DpW-bZpc.js → index-_30KjjEK.js} +6 -6
package/dist/browser/index.html +1 -1
package/dist/src/browser/neovim-client.d.ts +7 -4
package/dist/src/browser/neovim-client.js +13 -10
package/dist/src/server/cypress-support/contents.js +57 -36
package/dist/tsconfig.tsbuildinfo +1 -1
package/package.json +1 -1
package/src/browser/neovim-client.ts +22 -19
package/src/server/cypress-support/contents.ts +57 -36

package/dist/browser/index.html CHANGED Viewed

@@ -3,7 +3,7 @@
   <head>
     <meta charset="UTF-8" />
     <title>tui-sandbox integration tests</title>
-    <script type="module" crossorigin src="/assets/index-DpW-bZpc.js"></script>
+    <script type="module" crossorigin src="/assets/index-_30KjjEK.js"></script>
     <link rel="stylesheet" crossorigin href="/assets/index-D6fBrqAi.css">
   </head>
   <body>

package/dist/src/browser/neovim-client.d.ts CHANGED Viewed

@@ -1,10 +1,13 @@
 import type { BlockingCommandClientInput, ExCommandClientInput, LuaCodeClientInput } from "../server/server.js";
 import type { BlockingShellCommandOutput, RunExCommandOutput, RunLuaCodeOutput, StartNeovimGenericArguments, TestDirectory } from "../server/types.js";
+export type GenericNeovimBrowserApi = {
+    runBlockingShellCommand(input: BlockingCommandClientInput): Promise<BlockingShellCommandOutput>;
+    runLuaCode(input: LuaCodeClientInput): Promise<RunLuaCodeOutput>;
+    runExCommand(input: ExCommandClientInput): Promise<RunExCommandOutput>;
+    dir: TestDirectory;
+};
 declare global {
     interface Window {
-        startNeovim(startArguments?: StartNeovimGenericArguments): Promise<TestDirectory>;
-        runBlockingShellCommand(input: BlockingCommandClientInput): Promise<BlockingShellCommandOutput>;
-        runLuaCode(input: LuaCodeClientInput): Promise<RunLuaCodeOutput>;
-        runExCommand(input: ExCommandClientInput): Promise<RunExCommandOutput>;
+        startNeovim(startArguments?: StartNeovimGenericArguments): Promise<GenericNeovimBrowserApi>;
     }
 }

package/dist/src/browser/neovim-client.js CHANGED Viewed

@@ -11,14 +11,17 @@ window.startNeovim = async function (startArgs) {
         filename: startArgs?.filename ?? "initial-file.txt",
         startupScriptModifications: startArgs?.startupScriptModifications ?? [],
     });
-    return testDirectory;
-};
-window.runBlockingShellCommand = async function (input) {
-    return client.runBlockingShellCommand(input);
-};
-window.runLuaCode = async function (input) {
-    return client.runLuaCode(input);
-};
-window.runExCommand = async function (input) {
-    return client.runExCommand(input);
+    const neovimBrowserApi = {
+        runBlockingShellCommand(input) {
+            return client.runBlockingShellCommand(input);
+        },
+        runLuaCode(input) {
+            return client.runLuaCode(input);
+        },
+        runExCommand(input) {
+            return client.runExCommand(input);
+        },
+        dir: testDirectory,
+    };
+    return neovimBrowserApi;
 };

package/dist/src/server/cypress-support/contents.js CHANGED Viewed

@@ -21,17 +21,30 @@ import type {
   TestDirectory,
 } from "@tui-sandbox/library/dist/src/server/types"
 import type { OverrideProperties } from "type-fest"
+import type { GenericNeovimBrowserApi } from "../../../library/src/browser/neovim-client.ts"
 import type { MyTestDirectory, MyTestDirectoryFile } from "../../MyTestDirectory"
-export type NeovimContext = TestDirectory<MyTestDirectory>
+/** The api that can be used in tests after a Neovim instance has been started. */
+export type NeovimContext = {
+  /** Types text into the terminal, making the terminal application receive
+   * the keystrokes as input. Requires neovim to be running. */
+  typeIntoTerminal(text: string, options?: Partial<Cypress.TypeOptions>): void
-declare global {
-  interface Window {
-    startNeovim(startArguments?: MyStartNeovimServerArguments): Promise<NeovimContext>
-    runBlockingShellCommand(input: BlockingCommandClientInput): Promise<BlockingShellCommandOutput>
-    runLuaCode(input: LuaCodeClientInput): Promise<RunLuaCodeOutput>
-    runExCommand(input: ExCommandClientInput): Promise<RunExCommandOutput>
-  }
+  /** Runs a shell command in a blocking manner, waiting for the command to
+   * finish before returning. Requires neovim to be running. */
+  runBlockingShellCommand(input: BlockingCommandClientInput): Cypress.Chainable<BlockingShellCommandOutput>
+  /** Runs a shell command in a blocking manner, waiting for the command to
+   * finish before returning. Requires neovim to be running. */
+  runLuaCode(input: LuaCodeClientInput): Cypress.Chainable<RunLuaCodeOutput>
+  /** Run an ex command in neovim.
+   * @example "echo expand('%:.')" current file, relative to the cwd
+   */
+  runExCommand(input: ExCommandClientInput): Cypress.Chainable<RunExCommandOutput>
+  /** The test directory, providing type-safe access to its file and directory structure */
+  dir: TestDirectory<MyTestDirectory>
 }
 /** Arguments for starting the neovim server. They are built based on your test
@@ -40,21 +53,41 @@ type MyStartNeovimServerArguments = OverrideProperties<
   StartNeovimGenericArguments,
   {
     filename?: MyTestDirectoryFile | { openInVerticalSplits: MyTestDirectoryFile[] }
-    // NOTE: right now you need to make sure the config-modifications directory exists in your test directory
     startupScriptModifications?: Array<keyof MyTestDirectory["config-modifications"]["contents"]>
   }
 >
 Cypress.Commands.add("startNeovim", (startArguments?: MyStartNeovimServerArguments) => {
   cy.window().then(async win => {
-    testWindow = win
-    return await win.startNeovim(startArguments)
-  })
-})
+    const underlyingNeovim: GenericNeovimBrowserApi = await win.startNeovim(
+      startArguments as StartNeovimGenericArguments
+    )
+    testNeovim = underlyingNeovim
+    // wrap everything so that Cypress can await all the commands
+    Cypress.Commands.addAll({
+      nvim_runBlockingShellCommand: underlyingNeovim.runBlockingShellCommand,
+      nvim_runExCommand: underlyingNeovim.runExCommand,
+      nvim_runLuaCode: underlyingNeovim.runLuaCode,
+    })
+    const api: NeovimContext = {
+      runBlockingShellCommand(input) {
+        return cy.nvim_runBlockingShellCommand(input)
+      },
+      runExCommand(input) {
+        return cy.nvim_runExCommand(input)
+      },
+      runLuaCode(input) {
+        return cy.nvim_runLuaCode(input)
+      },
+      typeIntoTerminal(text, options) {
+        cy.typeIntoTerminal(text, options)
+      },
+      dir: underlyingNeovim.dir as TestDirectory<MyTestDirectory>,
+    }
-Cypress.Commands.add("runBlockingShellCommand", (input: BlockingCommandClientInput) => {
-  cy.window().then(async win => {
-    return await win.runBlockingShellCommand(input)
+    return api
   })
 })
@@ -64,19 +97,7 @@ Cypress.Commands.add("typeIntoTerminal", (text: string, options?: Partial<Cypres
   cy.get("textarea").focus().type(text, options)
 })
-Cypress.Commands.add("runLuaCode", (input: LuaCodeClientInput) => {
-  cy.window().then(async win => {
-    return await win.runLuaCode(input)
-  })
-})
-Cypress.Commands.add("runExCommand", (input: ExCommandClientInput) => {
-  cy.window().then(async win => {
-    return await win.runExCommand(input)
-  })
-})
-let testWindow: Window | undefined
+let testNeovim: GenericNeovimBrowserApi | undefined
 before(function () {
   // disable Cypress's default behavior of logging all XMLHttpRequests and
@@ -96,31 +117,31 @@ declare global {
       /** Runs a shell command in a blocking manner, waiting for the command to
        * finish before returning. Requires neovim to be running. */
-      runBlockingShellCommand(input: BlockingCommandClientInput): Chainable<BlockingShellCommandOutput>
+      nvim_runBlockingShellCommand(input: BlockingCommandClientInput): Chainable<BlockingShellCommandOutput>
-      runLuaCode(input: LuaCodeClientInput): Chainable<RunLuaCodeOutput>
+      nvim_runLuaCode(input: LuaCodeClientInput): Chainable<RunLuaCodeOutput>
       /** Run an ex command in neovim.
        * @example "echo expand('%:.')" current file, relative to the cwd
        */
-      runExCommand(input: ExCommandClientInput): Chainable<RunExCommandOutput>
+      nvim_runExCommand(input: ExCommandClientInput): Chainable<RunExCommandOutput>
     }
   }
 }
 afterEach(async () => {
-  if (!testWindow) return
+  if (!testNeovim) return
   let timeoutId: NodeJS.Timeout | undefined = undefined
   const timeout = new Promise<void>((_, reject) => {
     timeoutId = setTimeout(() => {
-      Cypress.log({ name: "timeout when waiting for :messages to finish. Neovim might be stuck." })
-      reject(new Error("timeout when waiting for :messages to finish. Neovim might be stuck."))
+      Cypress.log({ name: "timeout when waiting for :messages to finish. Neovim might be stuck or showing a message." })
+      reject(new Error("timeout when waiting for :messages to finish. Neovim might be stuck or showing a message."))
     }, 5_000)
   })
   try {
-    await Promise.race([timeout, testWindow.runExCommand({ command: "messages" })])
+    await Promise.race([timeout, testNeovim.runExCommand({ command: "messages" })])
   } finally {
     clearTimeout(timeoutId) // Ensure the timeout is cleared
   }