npm - @tui-sandbox/library - Versions diffs - 7.3.0 → 7.5.0 - Mend

@tui-sandbox/library 7.3.0 → 7.5.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 (25) hide show

package/CHANGELOG.md +14 -0
package/dist/browser/assets/{index-DUKWG3jG.js → index-CWXBquay.js} +7 -7
package/dist/browser/index.html +1 -1
package/dist/src/client/terminal-client.js +3 -12
package/dist/src/scripts/tui.js +8 -5
package/dist/src/server/cypress-support/contents.js +14 -4
package/dist/src/server/cypress-support/contents.test.js +14 -4
package/dist/src/server/neovim/environment/createTempDir.d.ts +2 -2
package/dist/src/server/neovim/index.d.ts +3 -3
package/dist/src/server/neovim/index.js +3 -0
package/dist/src/server/server.d.ts +6 -2
package/dist/src/server/server.js +7 -3
package/dist/src/server/types.d.ts +2 -2
package/dist/src/server/updateTestdirectorySchemaFile.d.ts +6 -2
package/dist/tsconfig.tsbuildinfo +1 -1
package/package.json +11 -11
package/src/client/terminal-client.ts +3 -12
package/src/scripts/tui.ts +8 -5
package/src/server/cypress-support/contents.test.ts +14 -4
package/src/server/cypress-support/contents.ts +14 -4
package/src/server/neovim/environment/createTempDir.ts +2 -2
package/src/server/neovim/index.ts +6 -3
package/src/server/server.ts +9 -5
package/src/server/types.ts +2 -2
package/src/server/updateTestdirectorySchemaFile.ts +7 -2

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-DUKWG3jG.js"></script>
+    <script type="module" crossorigin src="/assets/index-CWXBquay.js"></script>
     <link rel="stylesheet" crossorigin href="/assets/index-D6fBrqAi.css">
   </head>
   <body>

package/dist/src/client/terminal-client.js CHANGED Viewed

@@ -72,23 +72,14 @@ export class TerminalClient {
     }
     async runBlockingShellCommand(input) {
         await this.ready;
-        return this.trpc.neovim.runBlockingShellCommand.mutate({
-            ...input,
-            tabId: this.tabId,
-        });
+        return this.trpc.neovim.runBlockingShellCommand.mutate({ ...input, tabId: this.tabId });
     }
     async runLuaCode(input) {
         await this.ready;
-        return this.trpc.neovim.runLuaCode.mutate({
-            luaCode: input.luaCode,
-            tabId: this.tabId,
-        });
+        return this.trpc.neovim.runLuaCode.mutate({ ...input, tabId: this.tabId });
     }
     async runExCommand(input) {
         await this.ready;
-        return this.trpc.neovim.runExCommand.mutate({
-            command: input.command,
-            tabId: this.tabId,
-        });
+        return this.trpc.neovim.runExCommand.mutate({ ...input, tabId: this.tabId });
     }
 }

package/dist/src/scripts/tui.js CHANGED Viewed

@@ -65,8 +65,11 @@ const outputFileName = "MyTestDirectory.ts";
  * cwd of the script itself. */
 const cwd = process.cwd();
 const config = {
-    testEnvironmentPath: path.join(cwd, "test-environment/"),
-    outputFilePath: path.join(cwd, outputFileName),
+    directories: {
+        testEnvironmentPath: path.join(cwd, "test-environment/"),
+        outputFilePath: path.join(cwd, outputFileName),
+    },
+    port: process.env["PORT"] ? parseInt(process.env["PORT"]) : 3000,
 };
 // the arguments passed to this script start at index 2
 const args = process.argv.slice(2);
@@ -80,11 +83,11 @@ if (args[0] === "neovim") {
         const env_1 = { stack: [], error: void 0, hasError: false };
         try {
             // automatically dispose of the neovim instance when done
-            const app = __addDisposableResource(env_1, new NeovimApplication(config.testEnvironmentPath), true);
+            const app = __addDisposableResource(env_1, new NeovimApplication(config.directories.testEnvironmentPath), true);
             app.events.on("stdout", data => {
                 console.log(`  neovim output: ${data}`);
             });
-            const testDirectory = await prepareNewTestDirectory(config);
+            const testDirectory = await prepareNewTestDirectory(config.directories);
             await app.startNextAndKillCurrent(testDirectory, { filename: "empty.txt", headlessCmd: command }, { cols: 80, rows: 24 });
             await app.application.untilExit();
         }
@@ -110,7 +113,7 @@ try {
         cypressSupportDirectoryPath: path.join(cwd, "cypress", "support"),
         supportFileName: "tui-sandbox.ts",
     });
-    await updateTestdirectorySchemaFile(config);
+    await updateTestdirectorySchemaFile(config.directories);
     await startTestServer(config);
 }
 catch (e) {

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

@@ -18,14 +18,13 @@ import type {
   RunExCommandOutput,
   RunLuaCodeOutput,
   StartNeovimGenericArguments,
+  TestDirectory,
 } from "@tui-sandbox/library/dist/src/server/types"
+import assert from "assert"
 import type { OverrideProperties } from "type-fest"
 import type { MyTestDirectory, MyTestDirectoryFile } from "../../MyTestDirectory"
-export type NeovimContext = {
-  contents: MyTestDirectory
-  rootPathAbsolute: string
-}
+export type NeovimContext = TestDirectory<MyTestDirectory>
 declare global {
   interface Window {
@@ -47,6 +46,7 @@ type MyStartNeovimServerArguments = OverrideProperties<
 Cypress.Commands.add("startNeovim", (startArguments?: MyStartNeovimServerArguments) => {
   cy.window().then(async win => {
+    testWindow = win
     return await win.startNeovim(startArguments)
   })
 })
@@ -75,6 +75,13 @@ Cypress.Commands.add("runExCommand", (input: ExCommandClientInput) => {
   })
 })
+let testWindow: Window | undefined
+Cypress.on("fail", async () => {
+  assert(testWindow, "testWindow is not defined")
+  await testWindow.runExCommand({ command: "messages", log: true })
+})
 before(function () {
   // disable Cypress's default behavior of logging all XMLHttpRequests and
   // fetches to the Command Log
@@ -97,6 +104,9 @@ declare global {
       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>
     }
   }

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

@@ -16,14 +16,13 @@ it("should return the expected contents", async () => {
       RunExCommandOutput,
       RunLuaCodeOutput,
       StartNeovimGenericArguments,
+      TestDirectory,
     } from "@tui-sandbox/library/dist/src/server/types"
+    import assert from "assert"
     import type { OverrideProperties } from "type-fest"
     import type { MyTestDirectory, MyTestDirectoryFile } from "../../MyTestDirectory"
-    export type NeovimContext = {
-      contents: MyTestDirectory
-      rootPathAbsolute: string
-    }
+    export type NeovimContext = TestDirectory<MyTestDirectory>
     declare global {
       interface Window {
@@ -45,6 +44,7 @@ it("should return the expected contents", async () => {
     Cypress.Commands.add("startNeovim", (startArguments?: MyStartNeovimServerArguments) => {
       cy.window().then(async win => {
+        testWindow = win
         return await win.startNeovim(startArguments)
       })
     })
@@ -73,6 +73,13 @@ it("should return the expected contents", async () => {
       })
     })
+    let testWindow: Window | undefined
+    Cypress.on("fail", async () => {
+      assert(testWindow, "testWindow is not defined")
+      await testWindow.runExCommand({ command: "messages", log: true })
+    })
     before(function () {
       // disable Cypress's default behavior of logging all XMLHttpRequests and
       // fetches to the Command Log
@@ -95,6 +102,9 @@ it("should return the expected contents", async () => {
           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>
         }
       }

package/dist/src/server/neovim/environment/createTempDir.d.ts CHANGED Viewed

@@ -1,5 +1,5 @@
 import type { TestDirectory } from "../../types.js";
-import type { TestServerConfig } from "../../updateTestdirectorySchemaFile.js";
-export declare function createTempDir(config: TestServerConfig): Promise<TestDirectory>;
+import type { DirectoriesConfig } from "../../updateTestdirectorySchemaFile.js";
+export declare function createTempDir(config: DirectoriesConfig): Promise<TestDirectory>;
 export type TestDirsPath = "testdirs";
 export declare function removeTestDirectories(testEnvironmentPath: string): Promise<void>;

package/dist/src/server/neovim/index.d.ts CHANGED Viewed

@@ -1,7 +1,7 @@
 import "core-js/proposals/async-explicit-resource-management.js";
 import type { BlockingCommandInput, ExCommandInput, LuaCodeInput } from "../server.js";
 import type { BlockingShellCommandOutput, RunExCommandOutput, RunLuaCodeOutput, StartNeovimGenericArguments, TestDirectory } from "../types.js";
-import type { TestServerConfig } from "../updateTestdirectorySchemaFile.js";
+import type { DirectoriesConfig } from "../updateTestdirectorySchemaFile.js";
 import { Lazy } from "../utilities/Lazy.js";
 import type { TabId } from "../utilities/tabId.js";
 import type { TerminalDimensions } from "./NeovimApplication.js";
@@ -9,8 +9,8 @@ export declare const resources: Lazy<AsyncDisposableStack>;
 export declare function initializeStdout(options: {
     client: TabId;
 }, signal: AbortSignal | undefined, testEnvironmentPath: string): Promise<AsyncGenerator<string, void, unknown>>;
-export declare function start(options: StartNeovimGenericArguments, terminalDimensions: TerminalDimensions, tabId: TabId, config: TestServerConfig): Promise<TestDirectory>;
-export declare function prepareNewTestDirectory(config: TestServerConfig): Promise<TestDirectory>;
+export declare function start(options: StartNeovimGenericArguments, terminalDimensions: TerminalDimensions, tabId: TabId, config: DirectoriesConfig): Promise<TestDirectory>;
+export declare function prepareNewTestDirectory(config: DirectoriesConfig): Promise<TestDirectory>;
 export declare function sendStdin(options: {
     tabId: TabId;
     data: string;

package/dist/src/server/neovim/index.js CHANGED Viewed

@@ -110,6 +110,9 @@ export async function runExCommand(options) {
     console.log(`Neovim ${neovim.application.processId()} running Ex command: ${options.command}`);
     try {
         const output = await api.commandOutput(options.command);
+        if (options.log) {
+            console.log(`Ex command output: ${output}`);
+        }
         return { value: output };
     }
     catch (e) {

package/dist/src/server/server.d.ts CHANGED Viewed

@@ -3,7 +3,7 @@ import "core-js/proposals/async-explicit-resource-management.js";
 import type { Except } from "type-fest";
 import { z } from "zod";
 import { TestServer } from "./TestServer.js";
-import type { TestServerConfig } from "./updateTestdirectorySchemaFile.js";
+import type { DirectoriesConfig, TestServerConfig } from "./updateTestdirectorySchemaFile.js";
 declare const blockingCommandInputSchema: z.ZodObject<{
     command: z.ZodString;
     shell: z.ZodOptional<z.ZodString>;
@@ -75,21 +75,24 @@ declare const exCommandInputSchema: z.ZodObject<{
         tabId: string;
     }>;
     command: z.ZodString;
+    log: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     command: string;
     tabId: {
         tabId: string;
     };
+    log?: boolean | undefined;
 }, {
     command: string;
     tabId: {
         tabId: string;
     };
+    log?: boolean | undefined;
 }>;
 export type ExCommandClientInput = Except<ExCommandInput, "tabId">;
 export type ExCommandInput = z.infer<typeof exCommandInputSchema>;
 /** @private */
-export declare function createAppRouter(config: TestServerConfig): Promise<import("@trpc/server/unstable-core-do-not-import").BuiltRouter<{
+export declare function createAppRouter(config: DirectoriesConfig): Promise<import("@trpc/server/unstable-core-do-not-import").BuiltRouter<{
     ctx: object;
     meta: object;
     errorShape: import("@trpc/server/unstable-core-do-not-import").DefaultErrorShape;
@@ -167,6 +170,7 @@ export declare function createAppRouter(config: TestServerConfig): Promise<impor
                 tabId: {
                     tabId: string;
                 };
+                log?: boolean | undefined;
             };
             output: import("./types.js").RunExCommandOutput;
         }>;

package/dist/src/server/server.js CHANGED Viewed

@@ -17,7 +17,11 @@ const blockingCommandInputSchema = z.object({
     envOverrides: z.record(z.string()).optional(),
 });
 const luaCodeInputSchema = z.object({ tabId: tabIdSchema, luaCode: z.string() });
-const exCommandInputSchema = z.object({ tabId: tabIdSchema, command: z.string() });
+const exCommandInputSchema = z.object({
+    tabId: tabIdSchema,
+    command: z.string(),
+    log: z.boolean().optional(),
+});
 /** @private */
 // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export async function createAppRouter(config) {
@@ -68,9 +72,9 @@ export async function createAppRouter(config) {
 }
 export async function startTestServer(config) {
     const testServer = new TestServer({
-        port: 3000,
+        port: config.port,
     });
-    const appRouter = await createAppRouter(config);
+    const appRouter = await createAppRouter(config.directories);
     await testServer.startAndRun(appRouter);
     return testServer;
 }

package/dist/src/server/types.d.ts CHANGED Viewed

@@ -7,7 +7,7 @@ import type { VimValue } from "neovim/lib/types/VimValue.js";
  * be written with confidence that the files and directories they expect are
  * actually found. Otherwise the tests are brittle and can break easily.
  */
-export type TestDirectory = {
+export type TestDirectory<TContents extends object = object> = {
     /** The path to the unique test directory (the root).
      *
      * @example /Users/mikavilpas/git/tui-sandbox/packages/integration-tests/test-environment/testdirs/dir-0199UZ
@@ -24,7 +24,7 @@ export type TestDirectory = {
      * @example testdirs/dir-0199UZ/
      */
     testEnvironmentPathRelative: string;
-    contents: object;
+    contents: TContents;
 };
 export type { StartNeovimGenericArguments } from "../server/neovim/NeovimApplication.js";
 export type BlockingShellCommandOutput = {

package/dist/src/server/updateTestdirectorySchemaFile.d.ts CHANGED Viewed

@@ -1,6 +1,10 @@
-export type TestServerConfig = {
+export type DirectoriesConfig = {
     testEnvironmentPath: string;
     outputFilePath: string;
 };
+export type TestServerConfig = {
+    directories: DirectoriesConfig;
+    port: number;
+};
 export type UpdateTestdirectorySchemaFileResult = "updated" | "did-nothing";
-export declare function updateTestdirectorySchemaFile({ testEnvironmentPath, outputFilePath, }: TestServerConfig): Promise<UpdateTestdirectorySchemaFileResult>;
+export declare function updateTestdirectorySchemaFile({ testEnvironmentPath, outputFilePath, }: DirectoriesConfig): Promise<UpdateTestdirectorySchemaFileResult>;