@tui-sandbox/library 9.1.3 → 9.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tui-sandbox/library",
-  "version": "9.1.3",
+  "version": "9.1.5",
   "license": "MIT",
   "type": "module",
   "bin": {

package/src/scripts/tui.ts

@@ -5,7 +5,7 @@ import type { TestServerConfig } from "../server/index.js"
 import { startTestServer, updateTestdirectorySchemaFile } from "../server/index.js"
 import type { StdoutOrStderrMessage } from "../server/neovim/NeovimApplication.js"
 import { NeovimApplication } from "../server/neovim/NeovimApplication.js"
-import { prepareNewTestDirectory } from "../server/neovim/index.js"
+import { prepareNewTestDirectory } from "../server/neovim/prepareNewTestDirectory.js"
 
 //
 // This is the main entrypoint to tui-sandbox

package/src/server/dirtree/index.test.ts

@@ -159,4 +159,37 @@ describe("dirtree", () => {
       export type MyTestDirectoryFile = z.infer<typeof testDirectoryFiles>"
     `)
   })
+
+  it("creates an empty schema when the directory cannot be read", async () => {
+    const tree = getDirectoryTree("nonexistent")
+    const result = await buildSchemaForDirectoryTree(tree, "MyDirectoryTree")
+    expect(result).toMatchInlineSnapshot(`
+      "
+      // Note: This file is autogenerated. Do not edit it directly.
+      //
+      // Describes the contents of the test directory, which is a blueprint for
+      // files and directories. Tests can create a unique, safe environment for
+      // interacting with the contents of such a directory.
+      //
+      // Having strong typing for the test directory contents ensures that tests can
+      // be written with confidence that the files and directories they expect are
+      // actually found. Otherwise the tests are brittle and can break easily.
+
+      import { z } from "zod"
+
+      export const MyDirectoryTreeSchema = z.object({
+        type: z.literal("directory"),
+        name: z.literal("root"),
+        contents: z.object({}),
+      })
+
+      export const MyDirectoryTreeContentsSchema = MyDirectoryTreeSchema.shape.contents
+      export type MyDirectoryTreeContentsSchemaType = z.infer<typeof MyDirectoryTreeSchema>
+
+      export type MyDirectoryTree = MyDirectoryTreeContentsSchemaType["contents"]
+
+      export const testDirectoryFiles = z.enum([])
+      export type MyTestDirectoryFile = z.infer<typeof testDirectoryFiles>"
+    `)
+  })
 })

package/src/server/dirtree/index.ts

@@ -1,11 +1,10 @@
-import assert from "assert"
 import type { Dree } from "dree"
 import { scan, Type } from "dree"
 import { format, resolveConfig } from "prettier"
 import { fileURLToPath } from "url"
 import { jsonToZod } from "./json-to-zod.js"
 
-type TreeResult = { dree: Dree; allFiles: Dree[] }
+type TreeResult = { dree: Dree | undefined; allFiles: Dree[] }
 
 /** Convert a directory tree to a TypeScript type. This is useful for testing
  * as the initial state of the test directory is fully known in tests. */
@@ -25,9 +24,9 @@ export function getDirectoryTree(path: string): TreeResult {
     dir => {
       allFiles.push(dir)
     }
-  )
+  ) as Dree | null // https://github.com/euberdeveloper/dree/pull/51
 
-  return { dree: result, allFiles }
+  return { dree: result ?? undefined, allFiles }
 }
 
 type FileNode = {
@@ -42,7 +41,11 @@ type DirectoryNode = {
 
 type TreeNode = FileNode | DirectoryNode
 
-export function convertDree(root: Dree): TreeNode {
+export function convertDree(root: Dree | undefined): TreeNode {
+  if (!root) {
+    return { type: Type.DIRECTORY, name: "root", contents: {} }
+  }
+
   if (root.type === Type.FILE) {
     return {
       name: root.name,
@@ -63,10 +66,9 @@ export function convertDree(root: Dree): TreeNode {
 }
 
 export async function buildSchemaForDirectoryTree(result: TreeResult, name: string): Promise<string> {
-  const root = result.dree
-  assert(root.type === Type.DIRECTORY)
-  const node = convertDree(root)
-  const schema = (await jsonToZod(node, `${name}Schema`)).split("\n")
+  const root = convertDree(result.dree)
+
+  const schema = (await jsonToZod(root, `${name}Schema`)).split("\n")
 
   const lines = `
 // Note: This file is autogenerated. Do not edit it directly.

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

@@ -1,7 +1,7 @@
 import assert from "assert"
 import { execSync } from "child_process"
 import { Type } from "dree"
-import { constants, readdirSync } from "fs"
+import { constants, readdirSync, statSync } from "fs"
 import { access, mkdir, mkdtemp } from "fs/promises"
 import path from "path"
 import { convertDree, getDirectoryTree } from "../../dirtree/index.js"
@@ -11,6 +11,8 @@ import { updateTestdirectorySchemaFile } from "../../updateTestdirectorySchemaFi
 
 export async function createTempDir(config: DirectoriesConfig): Promise<TestDirectory> {
   try {
+    // before calling this function, the testEnvironmentPath should already exist
+    statSync(config.testEnvironmentPath)
     const dir = await createUniqueDirectory(config.testEnvironmentPath)
 
     readdirSync(config.testEnvironmentPath).forEach(entry => {
@@ -58,6 +60,6 @@ export async function removeTestDirectories(testEnvironmentPath: string): Promis
     await access(testdirs, constants.F_OK)
     execSync(`rm -rf ${testdirs}/*`)
   } catch (e) {
-    console.log("Could not remove test directories, maybe they don't exist yet", e)
+    console.debug("Could not remove test directories, maybe they don't exist yet", e)
   }
 }

package/src/server/neovim/index.ts

@@ -16,9 +16,9 @@ import type { DirectoriesConfig } from "../updateTestdirectorySchemaFile.js"
 import { convertEventEmitterToAsyncGenerator } from "../utilities/generator.js"
 import { Lazy } from "../utilities/Lazy.js"
 import type { TabId } from "../utilities/tabId.js"
-import { createTempDir, removeTestDirectories } from "./environment/createTempDir.js"
 import type { StdoutOrStderrMessage, TerminalDimensions } from "./NeovimApplication.js"
 import { NeovimApplication } from "./NeovimApplication.js"
+import { prepareNewTestDirectory } from "./prepareNewTestDirectory.js"
 
 const neovims = new Map<TabId["tabId"], NeovimApplication>()
 const resources: Lazy<AsyncDisposableStack> = new Lazy(() => {
@@ -97,12 +97,6 @@ export async function start(
   return testDirectory
 }
 
-export async function prepareNewTestDirectory(config: DirectoriesConfig): Promise<TestDirectory> {
-  await removeTestDirectories(config.testEnvironmentPath)
-  const testDirectory = await createTempDir(config)
-  return testDirectory
-}
-
 export async function sendStdin(options: { tabId: TabId; data: string }): Promise<void> {
   const neovim = neovims.get(options.tabId.tabId)
   assert(

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

@@ -0,0 +1,24 @@
+import { rm } from "fs/promises"
+import path from "path"
+import { prepareNewTestDirectory } from "./prepareNewTestDirectory.js"
+
+describe("prepareNewTestDirectory when the testEnvironmentPath does not exist", () => {
+  it("should be able to create a new test directory", async () => {
+    // this happens when starting a new project, and the directory structure
+    // has not been created yet
+    const testEnvironmentPath = "/tmp/test"
+    const testDirectory = await prepareNewTestDirectory({
+      outputFilePath: path.join(testEnvironmentPath, "foo.ts"),
+      testEnvironmentPath,
+    })
+
+    try {
+      expect(testDirectory.contents).toEqual({})
+      expect(testDirectory.testEnvironmentPath).toEqual("/tmp/test")
+    } finally {
+      // for safety, only remove inside /tmp
+      assert(testEnvironmentPath.startsWith("/tmp/"))
+      await rm(testEnvironmentPath, { recursive: true })
+    }
+  })
+})

package/src/server/neovim/prepareNewTestDirectory.ts

@@ -0,0 +1,18 @@
+import { access, mkdir } from "fs/promises"
+import type { TestDirectory } from "../types.js"
+import type { DirectoriesConfig } from "../updateTestdirectorySchemaFile.js"
+import { createTempDir, removeTestDirectories } from "./environment/createTempDir.js"
+
+export async function prepareNewTestDirectory(config: DirectoriesConfig): Promise<TestDirectory> {
+  try {
+    // if the directory does not exist, create it
+    await access(config.testEnvironmentPath)
+  } catch {
+    console.log(`Creating testEnvironmentPath directory at ${config.testEnvironmentPath}`)
+    await mkdir(config.testEnvironmentPath, { recursive: true })
+  }
+
+  await removeTestDirectories(config.testEnvironmentPath)
+  const testDirectory = await createTempDir(config)
+  return testDirectory
+}

package/src/server/terminal/index.ts

@@ -1,7 +1,7 @@
 import assert from "assert"
 import "core-js/proposals/async-explicit-resource-management.js"
-import { prepareNewTestDirectory } from "../neovim/index.js"
 import type { TerminalDimensions } from "../neovim/NeovimApplication.js"
+import { prepareNewTestDirectory } from "../neovim/prepareNewTestDirectory.js"
 import type { DirectoriesConfig } from "../updateTestdirectorySchemaFile.js"
 import { convertEventEmitterToAsyncGenerator } from "../utilities/generator.js"
 import { Lazy } from "../utilities/Lazy.js"