C3: Nuxt template dev improvements

.changeset/slimy-apples-reply.md

@@ -0,0 +1,7 @@
+---
+"create-cloudflare": patch
+---
+
+feature: Add `getBindingsProxy` support to `nuxt` template via `nitro-cloudflare-dev` module.
+
+The `nuxt` template now uses the default dev command from `create-nuxt` instead of using `wrangler paves dev` on build output in order to improve the developer workflow. `nitro-cloudflare-dev` is a nitro module that leverages `getBindingsProxy` and allows bindings to work in nitro commands.

packages/create-cloudflare/e2e-tests/fixtures/nuxt/server/routes/test.ts

@@ -0,0 +1,8 @@
+export default eventHandler(async (event) => {
+	if (!event.context.cloudflare) {
+		return { success: false };
+	}
+	const { TEST } = event.context.cloudflare.env;
+
+	return { value: TEST, success: true };
+});

packages/create-cloudflare/e2e-tests/fixtures/nuxt/wrangler.toml

@@ -0,0 +1,2 @@
+[vars]
+TEST = "C3_TEST"

packages/create-cloudflare/e2e-tests/fixtures/qwik/src/routes/test/index.ts

@@ -6,5 +6,5 @@ export const onGet: RequestHandler = async ({ platform, json }) => {
 		return;
 	}
 
-	json(200, { value: platform.env["TEST"], version: 1 });
+	json(200, { value: platform.env["TEST"], success: true });
 };

packages/create-cloudflare/e2e-tests/frameworks.test.ts

@@ -156,6 +156,16 @@ const frameworkTests: Record<string, FrameworkTestConfig> = {
 			route: "/",
 			expectedText: "Welcome to Nuxt!",
 		},
+		verifyDev: {
+			route: "/test",
+			expectedText: "C3_TEST",
+		},
+		verifyBuild: {
+			outputDir: "./dist",
+			script: "build",
+			route: "/test",
+			expectedText: "C3_TEST",
+		},
 	},
 	react: {
 		testCommitMessage: true,
@@ -422,7 +432,7 @@ const verifyDevScript = async (
 	);
 
 	// Wait a few seconds for dev server to spin up
-	await sleep(4000);
+	await sleep(7000);
 
 	// Make a request to the specified test route
 	const res = await fetch(`http://localhost:${TEST_PORT}${verifyDev.route}`);

packages/create-cloudflare/src/workers.ts

@@ -11,6 +11,11 @@ import type { C3Context } from "types";
 
 const { npm } = detectPackageManager();
 
+export const wranglerTomlExists = (ctx: C3Context) => {
+	const wranglerTomlPath = resolve(ctx.project.path, "wrangler.toml");
+	return existsSync(wranglerTomlPath);
+};
+
 export const readWranglerToml = (ctx: C3Context) => {
 	const wranglerTomlPath = resolve(ctx.project.path, "wrangler.toml");
 	return readFile(wranglerTomlPath);
@@ -26,7 +31,7 @@ export const writeWranglerToml = (ctx: C3Context, contents: string) => {
  * to the selected project name and adding the latest compatibility date.
  */
 export const updateWranglerToml = async (ctx: C3Context) => {
-	if (ctx.template.platform !== "workers") {
+	if (!wranglerTomlExists(ctx)) {
 		return;
 	}
 

packages/create-cloudflare/templates/nuxt/c3.ts

@@ -1,11 +1,11 @@
-import { readFileSync } from "node:fs";
-import { resolve } from "node:path";
 import { logRaw } from "@cloudflare/cli";
 import { brandColor, dim } from "@cloudflare/cli/colors";
 import { spinner } from "@cloudflare/cli/interactive";
-import { runFrameworkGenerator } from "helpers/command";
-import { compatDateFlag, writeFile } from "helpers/files";
+import { transformFile } from "helpers/codemod";
+import { installPackages, runFrameworkGenerator } from "helpers/command";
+import { writeFile } from "helpers/files";
 import { detectPackageManager } from "helpers/packages";
+import * as recast from "recast";
 import type { TemplateConfig } from "../../src/templates";
 import type { C3Context } from "types";
 
@@ -28,31 +28,71 @@ const generate = async (ctx: C3Context) => {
 };
 
 const configure = async () => {
-	const configFileName = "nuxt.config.ts";
-	const configFilePath = resolve(configFileName);
+	await installPackages(["nitro-cloudflare-dev"], {
+		dev: true,
+		startText: "Installing nitro module `nitro-cloudflare-dev`",
+		doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
+	});
+	updateNuxtConfig();
+};
+
+const updateNuxtConfig = () => {
 	const s = spinner();
-	s.start(`Updating \`${configFileName}\``);
-	// Add the cloudflare preset into the configuration file.
-	const originalConfigFile = readFileSync(configFilePath, "utf8");
-	const updatedConfigFile = originalConfigFile.replace(
-		"defineNuxtConfig({",
-		"defineNuxtConfig({\n  nitro: {\n    preset: 'cloudflare-pages'\n  },"
+
+	const configFile = "nuxt.config.ts";
+	s.start(`Updating \`${configFile}\``);
+
+	const b = recast.types.builders;
+
+	const presetDef = b.objectProperty(
+		b.identifier("nitro"),
+		b.objectExpression([
+			b.objectProperty(
+				b.identifier("preset"),
+				b.stringLiteral("cloudflare-pages")
+			),
+		])
+	);
+
+	const moduleDef = b.objectProperty(
+		b.identifier("modules"),
+		b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")])
 	);
-	writeFile(configFilePath, updatedConfigFile);
-	s.stop(`${brandColor(`updated`)} ${dim(`\`${configFileName}\``)}`);
+
+	transformFile(configFile, {
+		visitCallExpression: function (n) {
+			const callee = n.node.callee as recast.types.namedTypes.Identifier;
+			if (callee.name === "defineNuxtConfig") {
+				const obj = n.node
+					.arguments[0] as recast.types.namedTypes.ObjectExpression;
+
+				obj.properties.push(presetDef);
+				obj.properties.push(moduleDef);
+			}
+
+			return this.traverse(n);
+		},
+	});
+
+	s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
 };
 
 const config: TemplateConfig = {
 	configVersion: 1,
 	id: "nuxt",
 	platform: "pages",
+	copyFiles: {
+		path: "./templates",
+	},
 	displayName: "Nuxt",
+	devScript: "dev",
+	deployScript: "deploy",
 	generate,
 	configure,
 	transformPackageJson: async () => ({
 		scripts: {
-			"pages:dev": `wrangler pages dev ${await compatDateFlag()} --proxy 3000 -- ${npm} run dev`,
-			"pages:deploy": `${npm} run build && wrangler pages deploy ./dist`,
+			deploy: `${npm} run build && wrangler pages deploy ./dist`,
+			preview: `${npm} run build && wrangler pages dev ./dist`,
 		},
 	}),
 };

packages/create-cloudflare/templates/nuxt/templates/wrangler.toml

@@ -0,0 +1,2 @@
+name = "<TBD>"
+compatibility_date = "<TBD>"

packages/create-cloudflare/templates/qwik/c3.ts

@@ -79,6 +79,9 @@ const config: TemplateConfig = {
 	id: "qwik",
 	displayName: "Qwik",
 	platform: "pages",
+	copyFiles: {
+		path: "./templates",
+	},
 	devScript: "dev",
 	deployScript: "deploy",
 	generate,

packages/create-cloudflare/templates/qwik/templates/wrangler.toml

@@ -0,0 +1,2 @@
+name = "<TBD>"
+compatibility_date = "<TBD>"