feat(test-utils): typed json and test name

Author: natemoo-re

.changeset/funny-steaks-bathe.md

@@ -0,0 +1,5 @@
+---
+"@bomb.sh/tools": patch
+---
+
+Allows strongly typed `.json` files in fixtures

.changeset/pink-hands-admire.md

@@ -0,0 +1,5 @@
+---
+"@bomb.sh/tools": patch
+---
+
+Use current test name as a prefix for tmpdir in fixture

src/test-utils.ts

@@ -3,42 +3,51 @@ import { mkdtemp, mkdir, writeFile, rm, readFile as fsReadFile } from "node:fs/p
 import { tmpdir } from "node:os";
 import { sep } from "node:path";
 import { fileURLToPath, pathToFileURL } from "node:url";
-import { onTestFinished } from "vitest";
+import { expect, onTestFinished } from "vitest";
 
 export interface Fixture {
-	root: URL;
-	resolve: (...segments: string[]) => URL;
-	readFile: (file: PathLike) => Promise<string>;
-	cleanup: () => Promise<void>;
+  root: URL;
+  resolve: (...segments: string[]) => URL;
+  readFile: (file: PathLike) => Promise<string>;
+  cleanup: () => Promise<void>;
 }
 
-export async function createFixture(files: Record<string, string>): Promise<Fixture> {
-	const root = new URL(`bsh-`, `file://${tmpdir()}/`);
-	const path = await mkdtemp(fileURLToPath(root));
-	const base = pathToFileURL(path + sep);
+type FileContent = string | Record<string, unknown> | unknown[];
 
-	for (const [name, content] of Object.entries(files)) {
-		const url = new URL(name, base);
-		const dir = new URL("./", url);
-		await mkdir(dir, { recursive: true });
-		if (name.endsWith(".json") && typeof content !== "string") {
-			await writeFile(url, JSON.stringify(content, null, 2), "utf8");
-		} else {
-			await writeFile(url, content, "utf8");
-		}
-	}
+export async function createFixture<const T extends Record<string, FileContent>>(files: {
+  [K in keyof T]: K extends `${string}.json` ? FileContent : string;
+}): Promise<Fixture> {
+  const raw = expect.getState().currentTestName ?? "bsh";
+  const prefix = raw
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, "-")
+    .replace(/^-|-$/g, "");
+  const root = new URL(`${prefix}-`, `file://${tmpdir()}/`);
+  const path = await mkdtemp(fileURLToPath(root));
+  const base = pathToFileURL(path + sep);
 
-	const cleanup = () => rm(path, { recursive: true, force: true });
-	onTestFinished(cleanup);
+  for (const [name, content] of Object.entries(files as Record<string, FileContent>)) {
+    const url = new URL(name, base);
+    const dir = new URL("./", url);
+    await mkdir(dir, { recursive: true });
+    if (name.endsWith(".json") && typeof content !== "string") {
+      await writeFile(url, JSON.stringify(content, null, 2), "utf8");
+    } else {
+      await writeFile(url, content as string, "utf8");
+    }
+  }
 
-	const resolve = (...segments: string[]) => new URL(`./${segments.join("/")}`, base);
-	const readFile = (file: PathLike) =>
-		fsReadFile(new URL(`./${file}`, base), { encoding: "utf-8" });
+  const cleanup = () => rm(path, { recursive: true, force: true });
+  onTestFinished(cleanup);
 
-	return {
-		root: pathToFileURL(path),
-		resolve,
-		readFile,
-		cleanup,
-	};
+  const resolve = (...segments: string[]) => new URL(`./${segments.join("/")}`, base);
+  const readFile = (file: PathLike) =>
+    fsReadFile(new URL(`./${file}`, base), { encoding: "utf-8" });
+
+  return {
+    root: pathToFileURL(path),
+    resolve,
+    readFile,
+    cleanup,
+  };
 }