test(tanstack-addon): prevent working tree mutation and assert template drift in compile tests

Author: yamcodes

apps/www/content/docs/frameworks/tanstack-start.mdx

@@ -31,15 +31,17 @@ Generate a new TanStack Start project with the ArkEnv add-on:
 npx @tanstack/cli create my-app --add-ons https://arkenv.js.org/tanstack/info.json
 ```
 
-The CLI prompts you with configuration choices:
+By default, the add-on scaffolds with **ArkType** (`@arkenv/core`) and includes the interactive demo route at `/demo/arkenv`.
+
+Configuration options supported by the add-on:
 
 - **Validator Engine**:
   - **ArkType** (default) — installs `@arkenv/core` and `arktype`
   - **Zod** — installs `@arkenv/standard` and `zod`
   - **Valibot** — installs `@arkenv/standard` and `valibot`
 - **Interactive Demo Route**:
   - **Include `/demo/arkenv`** (default) — scaffolds an interactive secret leak test showcasing server-only isolation in the browser
-  - **Skip demo route** — scaffolds only the schema definition and plugin configuration
+  - **Skip demo route** — scaffolds only the schema definition and plugin configuration (automatically skipped when creating a project with `--no-examples` or the `blank` preset)
 
 The add-on automatically:
 

packages/tanstack-addon/scripts/build.ts

@@ -43,9 +43,7 @@ function gatherFilesRecursively(
 	return result;
 }
 
-export function buildAddon() {
-	console.log("Building @arkenv/tanstack-addon...");
-
+export function compileAddon() {
 	const infoPath = join(addonDir, "info.json");
 	const packageTemplatePath = join(addonDir, "package.json.ejs");
 
@@ -61,13 +59,15 @@ export function buildAddon() {
 
 	const files = gatherFilesRecursively(assetsDir, assetsDir);
 
-	const compiled = {
+	return {
 		...info,
 		packageTemplate,
 		files,
 		deletedFiles: [],
 	};
+}
 
+export function writeAddon(compiled = compileAddon()) {
 	// Ensure distDir exists
 	mkdirSync(distDir, { recursive: true });
 	const compiledJson = JSON.stringify(compiled, null, 2);
@@ -80,7 +80,10 @@ export function buildAddon() {
 	mkdirSync(docsPublicDir, { recursive: true });
 	writeFileSync(join(docsPublicDir, "info.json"), compiledJson);
 	writeFileSync(join(docsPublicDir, "add-on.json"), compiledJson);
-	writeFileSync(join(docsPublicDir, "package.json.ejs"), packageTemplate);
+	writeFileSync(
+		join(docsPublicDir, "package.json.ejs"),
+		compiled.packageTemplate,
+	);
 
 	// Copy assets directory recursively to apps/www/public/tanstack/assets
 	const targetAssetsDir = join(docsPublicDir, "assets");
@@ -89,12 +92,17 @@ export function buildAddon() {
 	cpSync(assetsDir, targetAssetsDir, { recursive: true });
 
 	console.log(
-		`Successfully compiled ${Object.keys(files).length} asset files into:`,
+		`Successfully compiled ${Object.keys(compiled.files).length} asset files into:`,
 	);
 	console.log(` - ${join(distDir, "info.json")}`);
 	console.log(` - ${join(docsPublicDir, "info.json")}`);
 	console.log(` - ${targetAssetsDir}`);
+}
 
+export function buildAddon() {
+	console.log("Building @arkenv/tanstack-addon...");
+	const compiled = compileAddon();
+	writeAddon(compiled);
 	return compiled;
 }
 

packages/tanstack-addon/tests/compile.test.ts

@@ -3,16 +3,16 @@ import { dirname, resolve } from "node:path";
 import { fileURLToPath } from "node:url";
 import { AddOnCompiledSchema } from "@tanstack/create";
 import { describe, expect, it } from "vitest";
-import { buildAddon } from "../scripts/build";
+import { compileAddon } from "../scripts/build";
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 const packageRoot = resolve(__dirname, "..");
 const repoRoot = resolve(packageRoot, "../..");
 
 describe("TanStack Add-on Compilation", () => {
-	it("compiles a schema-valid add-on bundle", () => {
-		const compiled = buildAddon();
+	it("compiles a schema-valid add-on bundle in memory without disk side-effects", () => {
+		const compiled = compileAddon();
 
 		// Validate against TanStack CLI's AddOnCompiledSchema
 		const parsed = AddOnCompiledSchema.safeParse(compiled);
@@ -57,7 +57,9 @@ describe("TanStack Add-on Compilation", () => {
 		expect(compiled.options?.demo.default).toBe("true");
 	});
 
-	it("mirrors compiled files and assets to apps/www/public/tanstack", () => {
+	it("ensures committed public bundles match source templates without drift", () => {
+		const freshCompiled = compileAddon();
+
 		const publicInfo = resolve(repoRoot, "apps/www/public/tanstack/info.json");
 		const publicAddon = resolve(
 			repoRoot,
@@ -69,8 +71,10 @@ describe("TanStack Add-on Compilation", () => {
 		expect(existsSync(publicAddon)).toBe(true);
 		expect(existsSync(publicAssets)).toBe(true);
 
-		const content = JSON.parse(readFileSync(publicInfo, "utf-8"));
-		expect(content.id).toBe("arkenv");
-		expect(content.files["src/env.ts.ejs"]).toBeDefined();
+		const committedInfo = JSON.parse(readFileSync(publicInfo, "utf-8"));
+		const committedAddon = JSON.parse(readFileSync(publicAddon, "utf-8"));
+
+		expect(committedInfo).toEqual(freshCompiled);
+		expect(committedAddon).toEqual(freshCompiled);
 	});
 });