@tui-sandbox/library 11.3.2 → 11.4.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "11.3.2",
+  "version": "11.4.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/mikavilpas/tui-sandbox"
@@ -18,6 +18,7 @@
     "@xterm/addon-unicode11": "0.8.0",
     "@xterm/xterm": "5.5.0",
     "cors": "2.8.5",
+    "cypress": "14.5.3",
     "dree": "5.1.5",
     "express": "5.1.0",
     "neovim": "5.3.0",

package/src/client/MyNeovimConfigModification.test.ts

@@ -1,3 +1,4 @@
+import { assertType, it } from "vitest"
 import * as z from "zod"
 import type { MyNeovimConfigModification } from "./MyNeovimConfigModification.js"
 

package/src/client/color-utilities.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from "vitest"
 import type { RgbColor } from "./color-utilities.js"
 import { rgbify } from "./color-utilities.js"
 

package/src/client/cypress-assertions.ts

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+
+/** Problem: cypress provides the `contains` method, but it only checks the
+ * first match on the page.
+ *
+ * Solution: we need to check all elements on the page and filter them
+ * by the text we are looking for. Then we can check if the background
+ * color of the element is the same as the one we are looking for.
+ *
+ * Limitation: text spanning multiple lines will not be detected.
+ */
+export function textIsVisibleWithColor(text: string, color: string): Cypress.Chainable<JQuery> {
+  return cy.get("div.xterm-rows span").and($spans => {
+    const matching = $spans.filter((_, el) => !!el.textContent.includes(text))
+
+    const colors = matching.map((_, el) => {
+      return window.getComputedStyle(el).color
+    })
+
+    expect(JSON.stringify(colors.toArray())).to.contain(color)
+  })
+}
+
+/** Like `textIsVisibleWithColor`, but checks the background color instead
+ * of the text color.
+ */
+export function textIsVisibleWithBackgroundColor(text: string, color: string): Cypress.Chainable<JQuery> {
+  return cy.get("div.xterm-rows span").and($spans => {
+    const matching = $spans.filter((_, el) => !!el.textContent.includes(text))
+
+    const colors = matching.map((_, el) => {
+      return window.getComputedStyle(el).backgroundColor
+    })
+
+    expect(JSON.stringify(colors.toArray())).to.contain(color)
+  })
+}

package/src/client/index.ts

@@ -1,5 +1,6 @@
 // This is the public client api. Semantic versioning will be applied to this.
 
 export { rgbify } from "./color-utilities.js"
+export { textIsVisibleWithBackgroundColor, textIsVisibleWithColor } from "./cypress-assertions.js"
 export { NeovimTerminalClient as TerminalClient } from "./neovim-terminal-client.js"
 export { TerminalTerminalClient } from "./terminal-terminal-client.js"

package/src/scripts/parseArguments.test.ts

@@ -0,0 +1,23 @@
+import { describe, expect, it } from "vitest"
+import { parseArguments } from "./parseArguments.js"
+
+it(`can parse "neovim prepare"`, async () => {
+  expect(await parseArguments(["neovim", "prepare"])).toEqual({ action: "neovim prepare" })
+  expect(await parseArguments(["neovim", "prepare", "foo"])).toBeUndefined()
+})
+
+describe("neovim exec", () => {
+  it(`can parse "neovim exec <command>"`, async () => {
+    expect(await parseArguments(["neovim", "exec", "foo"])).toEqual({ action: "neovim exec", command: "foo" })
+  })
+
+  it(`only allows one argument`, async () => {
+    expect(await parseArguments(["neovim", "exec"])).toBeUndefined()
+    expect(await parseArguments(["neovim", "exec", "foo", "bar"])).toBeUndefined()
+  })
+})
+
+it(`can parse "start"`, async () => {
+  expect(await parseArguments(["start"])).toEqual({ action: "start" })
+  expect(await parseArguments(["start", "foo"])).toBeUndefined()
+})

package/src/scripts/parseArguments.ts

@@ -0,0 +1,48 @@
+import assert from "assert"
+import * as z from "zod"
+
+export const parseArguments = async (args: string[]): Promise<ParseArgumentsResult | undefined> => {
+  {
+    // tui neovim prepare
+    const schema = z.tuple([z.literal("neovim"), z.literal("prepare")])
+    const prepareArguments = schema.safeParse(args)
+    if (prepareArguments.success) {
+      return {
+        action: "neovim prepare",
+      }
+    }
+  }
+
+  {
+    // tui neovim exec <command> [<args>...]
+    const schema = z.tuple([z.literal("neovim"), z.literal("exec"), z.string()])
+    const execArguments = schema.safeParse(args)
+    if (execArguments.success) {
+      const command = execArguments.data.at(2)
+      assert(command, "No command provided for neovim exec")
+      return {
+        action: "neovim exec",
+        command,
+      }
+    }
+  }
+
+  {
+    // tui start
+    const schema = z.tuple([z.literal("start")])
+    const result = schema.safeParse(args)
+    if (result.success) {
+      return {
+        action: "start",
+      }
+    }
+  }
+}
+
+export type ParseArgumentsResult =
+  | { action: "neovim prepare" }
+  | {
+      action: "neovim exec"
+      command: string
+    }
+  | { action: "start" }

package/src/scripts/tui.ts

@@ -1,4 +1,3 @@
-import assert from "node:assert"
 import path from "node:path"
 import { installDependencies } from "../server/applications/neovim/api.js"
 import type { StdoutOrStderrMessage } from "../server/applications/neovim/NeovimApplication.js"
@@ -7,6 +6,7 @@ import { prepareNewTestDirectory } from "../server/applications/neovim/prepareNe
 import { createCypressSupportFile } from "../server/cypress-support/createCypressSupportFile.js"
 import type { TestServerConfig } from "../server/index.js"
 import { startTestServer, updateTestdirectorySchemaFile } from "../server/index.js"
+import { parseArguments } from "./parseArguments.js"
 
 //
 // This is the main entrypoint to tui-sandbox
@@ -28,8 +28,10 @@ const config = {
 // the arguments passed to this script start at index 2
 const args = process.argv.slice(2)
 
-if (args[0] === "neovim") {
-  if (args[1] === "prepare" && args.length === 2) {
+const command = await parseArguments(args)
+
+switch (command?.action) {
+  case "neovim prepare": {
     const NVIM_APPNAME = process.env["NVIM_APPNAME"]
     console.log(`🚀 Installing neovim dependencies${NVIM_APPNAME ? ` for NVIM_APPNAME=${NVIM_APPNAME}` : ""}...`)
     await installDependencies(
@@ -42,15 +44,7 @@ if (args[0] === "neovim") {
     })
     process.exit(0)
   }
-
-  if (!(args[1] === "exec" && args.length === 3)) {
-    showUsageAndExit()
-  }
-
-  const command = args[2]
-  assert(command, "No command provided")
-
-  {
+  case "neovim exec": {
     // automatically dispose of the neovim instance when done
     await using app = new NeovimApplication(config.directories.testEnvironmentPath)
     app.events.on("stdout" satisfies StdoutOrStderrMessage, data => {
@@ -61,41 +55,42 @@ if (args[0] === "neovim") {
       testDirectory,
       {
         filename: "empty.txt",
-        headlessCmd: command,
+        headlessCmd: command.command,
         NVIM_APPNAME: process.env["NVIM_APPNAME"],
       },
       { cols: 80, rows: 24 }
     )
     await app.application.untilExit()
+    break
   }
+  case "start": {
+    try {
+      await createCypressSupportFile({
+        cypressSupportDirectoryPath: path.join(cwd, "cypress", "support"),
+        supportFileName: "tui-sandbox.ts",
+      })
+    } catch (e) {
+      console.error("Failed to createCypressSupportFile", e)
+    }
 
-  process.exit(0)
-}
-
-if (args[0] !== "start") {
-  showUsageAndExit()
-}
-console.log(`🚀 Starting test server in ${cwd} - this should be the root of your integration-tests directory 🤞🏻`)
-
-try {
-  await createCypressSupportFile({
-    cypressSupportDirectoryPath: path.join(cwd, "cypress", "support"),
-    supportFileName: "tui-sandbox.ts",
-  })
-} catch (e) {
-  console.error("Failed to createCypressSupportFile", e)
-}
-
-try {
-  await updateTestdirectorySchemaFile(config.directories)
-} catch (e) {
-  console.error("Failed to updateTestdirectorySchemaFile", e)
-}
+    try {
+      await updateTestdirectorySchemaFile(config.directories)
+    } catch (e) {
+      console.error("Failed to updateTestdirectorySchemaFile", e)
+    }
 
-try {
-  await startTestServer(config)
-} catch (e) {
-  console.error("Failed to startTestServer", e)
+    try {
+      console.log(`🚀 Starting test server in ${cwd} - this should be the root of your integration-tests directory 🤞🏻`)
+      await startTestServer(config)
+    } catch (e) {
+      console.error("Failed to startTestServer", e)
+    }
+    break
+  }
+  default: {
+    command satisfies undefined
+    showUsageAndExit()
+  }
 }
 
 function showUsageAndExit() {
@@ -105,6 +100,7 @@ function showUsageAndExit() {
       `Usage (pick one):`,
       `    tui start`,
       `    tui neovim exec '<ex-command>'`,
+      `    tui neovim prepare`,
     ].join("\n")
   )
 

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

@@ -1,5 +1,6 @@
 import { access } from "fs/promises"
 import { attach } from "neovim"
+import { afterEach, beforeEach, expect, it, vi } from "vitest"
 import type { PollingInterval } from "./NeovimJavascriptApiClient.js"
 import { connectNeovimApi } from "./NeovimJavascriptApiClient.js"
 

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

@@ -1,6 +1,6 @@
 import fs from "fs"
 import nodePath from "path"
-import { expect, it } from "vitest"
+import { expect, it, vi } from "vitest"
 import type { TestDirsPath } from "./createTempDir.js"
 import { createTempDir } from "./createTempDir.js"
 

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

@@ -1,5 +1,6 @@
 import { rm } from "fs/promises"
 import path from "path"
+import { assert, describe, expect, it } from "vitest"
 import { prepareNewTestDirectory } from "./prepareNewTestDirectory.js"
 
 describe("prepareNewTestDirectory when the testEnvironmentPath does not exist", () => {

package/src/server/applications/terminal/runBlockingShellCommand.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from "vitest"
 import { getCwd } from "./runBlockingShellCommand.js"
 
 describe("getCwd", () => {

package/src/server/blockingCommandInputSchema.test.ts

@@ -1,3 +1,4 @@
+import { describe, expect, it } from "vitest"
 import { blockingCommandInputSchema, type BlockingCommandInput } from "./blockingCommandInputSchema.js"
 
 describe("blockingCommandInputSchema", () => {

package/src/server/cypress-support/createCypressSupportFile.test.ts

@@ -1,5 +1,6 @@
 import { readFileSync, writeFileSync } from "fs"
 import { mkdir, stat } from "fs/promises"
+import { describe, expect, it, vi } from "vitest"
 import { createCypressSupportFileContents } from "./contents.js"
 import type { CreateCypressSupportFileResult } from "./createCypressSupportFile.js"
 import { createCypressSupportFile } from "./createCypressSupportFile.js"

package/src/server/updateTestdirectorySchemaFile.test.ts

@@ -1,4 +1,5 @@
 import { readFileSync, writeFileSync } from "fs"
+import { describe, expect, it, vi } from "vitest"
 import { buildTestDirectorySchema } from "./dirtree/index.js"
 import type { UpdateTestdirectorySchemaFileResult } from "./updateTestdirectorySchemaFile.js"
 import { updateTestdirectorySchemaFile } from "./updateTestdirectorySchemaFile.js"

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

@@ -1,3 +1,4 @@
+import { describe, expect, it, vi } from "vitest"
 import type { StartableApplication } from "./DisposableSingleApplication.js"
 import { DisposableSingleApplication } from "./DisposableSingleApplication.js"
 import type { ExitInfo } from "./TerminalApplication.js"

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

@@ -1,4 +1,5 @@
 import { EventEmitter } from "stream"
+import { describe, expect, it } from "vitest"
 import { convertEventEmitterToAsyncGenerator } from "./generator.js"
 
 describe("when a listener is attached", () => {

package/tsconfig.json

@@ -13,7 +13,7 @@
     "allowJs": true,
     "outDir": "dist",
     "lib": ["ES2023", "ESNext.Disposable"],
-    "types": ["node", "vitest/globals"],
+    "types": ["node", "cypress"],
     "composite": true,
 
     /* Linting */