create-cloudflare 0.0.0-df15eb020 → 0.0.0-dfacbd46a

package/templates/next/workers/c3.ts

@@ -0,0 +1,74 @@
+import { brandColor, dim } from "@cloudflare/cli/colors";
+import { spinner } from "@cloudflare/cli/interactive";
+import { runFrameworkGenerator } from "frameworks/index";
+import { readFile, usesTypescript, writeFile } from "helpers/files";
+import { installPackages } from "helpers/packages";
+import type { TemplateConfig } from "../../../src/templates";
+import type { C3Context } from "types";
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [ctx.project.name]);
+};
+
+const configure = async (ctx: C3Context) => {
+	const packages = [
+		"@opennextjs/cloudflare@0.5.x",
+		"@cloudflare/workers-types",
+	];
+	await installPackages(packages, {
+		dev: true,
+		startText: "Adding the Cloudflare adapter",
+		doneText: `${brandColor(`installed`)} ${dim(packages.join(", "))}`,
+	});
+
+	const usesTs = usesTypescript(ctx);
+
+	updateNextConfig(usesTs);
+};
+
+const updateNextConfig = (usesTs: boolean) => {
+	const s = spinner();
+
+	const configFile = `next.config.${usesTs ? "ts" : "mjs"}`;
+	s.start(`Updating \`${configFile}\``);
+
+	const configContent = readFile(configFile);
+
+	const updatedConfigFile =
+		configContent +
+		`
+		// added by create cloudflare to enable calling \`getCloudflareContext()\` in \`next dev\`
+		import { initOpenNextCloudflareForDev } from '@opennextjs/cloudflare';
+		initOpenNextCloudflareForDev();
+		`.replace(/\n\t*/g, "\n");
+
+	writeFile(configFile, updatedConfigFile);
+
+	s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
+};
+
+export default {
+	configVersion: 1,
+	id: "next",
+	frameworkCli: "create-next-app",
+	frameworkCliPinnedVersion: "~15.2.2",
+	platform: "workers",
+	displayName: "Next.js (using Node.js compat + Workers Assets)",
+	path: "templates/next/workers",
+	copyFiles: {
+		path: "./templates",
+	},
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			deploy: `opennextjs-cloudflare && wrangler deploy`,
+			preview: `opennextjs-cloudflare && wrangler dev`,
+			"cf-typegen": `wrangler types --env-interface CloudflareEnv cloudflare-env.d.ts`,
+		},
+	}),
+	devScript: "dev",
+	previewScript: "preview",
+	deployScript: "deploy",
+	compatibilityFlags: ["nodejs_compat"],
+} as TemplateConfig;

package/templates/next/workers/templates/cloudflare-env.d.ts

@@ -0,0 +1,5 @@
+// Generated by Wrangler
+// by running `wrangler types --env-interface CloudflareEnv cloudflare-env.d.ts`
+
+interface CloudflareEnv {
+}

package/templates/next/workers/templates/open-next.config.ts

@@ -0,0 +1,6 @@
+import { defineCloudflareConfig } from "@opennextjs/cloudflare";
+import kvIncrementalCache from "@opennextjs/cloudflare/kv-cache";
+
+export default defineCloudflareConfig({
+  incrementalCache: kvIncrementalCache,
+});

package/templates/next/workers/templates/wrangler.jsonc

@@ -0,0 +1,12 @@
+{
+  "name": "<app-name>",
+  "main": ".open-next/worker.js",
+  "compatibility_date": "2024-09-26",
+  "compatibility_flags": [
+    "nodejs_compat"
+  ],
+  "assets": {
+    "binding": "ASSETS",
+    "directory": ".open-next/assets"
+  }
+}

package/templates/nuxt/c3.ts

@@ -1,134 +1,9 @@
-import { logRaw } from "@cloudflare/cli";
-import { brandColor, dim } from "@cloudflare/cli/colors";
-import { spinner } from "@cloudflare/cli/interactive";
-import { runFrameworkGenerator } from "frameworks/index";
-import { mergeObjectProperties, transformFile } from "helpers/codemod";
-import { getLatestTypesEntrypoint } from "helpers/compatDate";
-import { readFile, writeFile } from "helpers/files";
-import { detectPackageManager } from "helpers/packageManagers";
-import { installPackages } from "helpers/packages";
-import * as recast from "recast";
-import type { TemplateConfig } from "../../src/templates";
-import type { C3Context } from "types";
+import pages from "./pages/c3";
+import workers from "./workers/c3";
+import type { MultiPlatformTemplateConfig } from "../../src/templates";
 
-const { npm, name: pm } = detectPackageManager();
-
-const generate = async (ctx: C3Context) => {
-	const gitFlag = ctx.args.git ? `--gitInit` : `--no-gitInit`;
-
-	await runFrameworkGenerator(ctx, [
-		"init",
-		ctx.project.name,
-		"--packageManager",
-		npm,
-		gitFlag,
-	]);
-
-	writeFile("./.node-version", "18");
-
-	logRaw(""); // newline
-};
-
-const configure = async (ctx: C3Context) => {
-	const packages = ["nitro-cloudflare-dev"];
-
-	// When using pnpm, explicitly add h3 package so the H3Event type declaration can be updated.
-	// Package managers other than pnpm will hoist the dependency, as will pnpm with `--shamefully-hoist`
-	if (pm === "pnpm") {
-		packages.push("h3");
-	}
-
-	await installPackages(packages, {
-		dev: true,
-		startText: "Installing nitro module `nitro-cloudflare-dev`",
-		doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
-	});
-	updateNuxtConfig();
-
-	updateEnvTypes(ctx);
-};
-
-const updateEnvTypes = (ctx: C3Context) => {
-	const filepath = "env.d.ts";
-
-	const s = spinner();
-	s.start(`Updating ${filepath}`);
-
-	let file = readFile(filepath);
-
-	let typesEntrypoint = `@cloudflare/workers-types`;
-	const latestEntrypoint = getLatestTypesEntrypoint(ctx);
-	if (latestEntrypoint) {
-		typesEntrypoint += `/${latestEntrypoint}`;
-	}
-
-	// Replace placeholder with actual types entrypoint
-	file = file.replace("WORKERS_TYPES_ENTRYPOINT", typesEntrypoint);
-	writeFile("env.d.ts", file);
-
-	s.stop(`${brandColor(`updated`)} ${dim(`\`${filepath}\``)}`);
-};
-
-const updateNuxtConfig = () => {
-	const s = spinner();
-
-	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")]),
-	);
-
-	transformFile(configFile, {
-		visitCallExpression: function (n) {
-			const callee = n.node.callee as recast.types.namedTypes.Identifier;
-			if (callee.name === "defineNuxtConfig") {
-				mergeObjectProperties(
-					n.node.arguments[0] as recast.types.namedTypes.ObjectExpression,
-					[presetDef, moduleDef],
-				);
-			}
-
-			return this.traverse(n);
-		},
-	});
-
-	s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
-};
-
-const config: TemplateConfig = {
-	configVersion: 1,
-	id: "nuxt",
-	frameworkCli: "nuxi",
-	platform: "pages",
+const config: MultiPlatformTemplateConfig = {
 	displayName: "Nuxt",
-	copyFiles: {
-		path: "./templates",
-	},
-	generate,
-	configure,
-	transformPackageJson: async () => ({
-		scripts: {
-			deploy: `${npm} run build && wrangler pages deploy`,
-			preview: `${npm} run build && wrangler pages dev`,
-			"cf-typegen": `wrangler types`,
-		},
-	}),
-	devScript: "dev",
-	deployScript: "deploy",
-	previewScript: "preview",
+	platformVariants: { pages, workers },
 };
 export default config;

package/templates/nuxt/pages/c3.ts

@@ -0,0 +1,146 @@
+import { logRaw } from "@cloudflare/cli";
+import { brandColor, dim } from "@cloudflare/cli/colors";
+import { spinner } from "@cloudflare/cli/interactive";
+import { runFrameworkGenerator } from "frameworks/index";
+import { mergeObjectProperties, transformFile } from "helpers/codemod";
+import { getLatestTypesEntrypoint } from "helpers/compatDate";
+import { readFile, writeFile } from "helpers/files";
+import { detectPackageManager } from "helpers/packageManagers";
+import { installPackages } from "helpers/packages";
+import * as recast from "recast";
+import type { TemplateConfig } from "../../../src/templates";
+import type { C3Context } from "types";
+
+const { npm, name: pm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	const gitFlag = ctx.args.git ? `--gitInit` : `--no-gitInit`;
+
+	await runFrameworkGenerator(ctx, [
+		"init",
+		ctx.project.name,
+		"--packageManager",
+		npm,
+		"--no-install",
+		gitFlag,
+	]);
+
+	writeFile("./.node-version", "18");
+
+	logRaw(""); // newline
+};
+
+const configure = async (ctx: C3Context) => {
+	const packages = ["nitro-cloudflare-dev"];
+
+	// When using pnpm, explicitly add h3 package so the H3Event type declaration can be updated.
+	// Package managers other than pnpm will hoist the dependency, as will pnpm with `--shamefully-hoist`
+	if (pm === "pnpm") {
+		packages.push("h3");
+	}
+
+	await installPackages(packages, {
+		dev: true,
+		startText: "Installing nitro module `nitro-cloudflare-dev`",
+		doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
+	});
+	updateNuxtConfig();
+
+	updateEnvTypes(ctx);
+};
+
+const updateEnvTypes = (ctx: C3Context) => {
+	const filepath = "env.d.ts";
+
+	const s = spinner();
+	s.start(`Updating ${filepath}`);
+
+	let file = readFile(filepath);
+
+	let typesEntrypoint = `@cloudflare/workers-types`;
+	const latestEntrypoint = getLatestTypesEntrypoint(ctx);
+	if (latestEntrypoint) {
+		typesEntrypoint += `/${latestEntrypoint}`;
+	}
+
+	// Replace placeholder with actual types entrypoint
+	file = file.replace("WORKERS_TYPES_ENTRYPOINT", typesEntrypoint);
+	writeFile("env.d.ts", file);
+
+	s.stop(`${brandColor(`updated`)} ${dim(`\`${filepath}\``)}`);
+};
+
+const updateNuxtConfig = () => {
+	const s = spinner();
+
+	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"),
+			),
+			b.objectProperty(
+				b.identifier("cloudflare"),
+				b.objectExpression([
+					b.objectProperty(
+						b.identifier("deployConfig"),
+						b.booleanLiteral(true),
+					),
+					b.objectProperty(b.identifier("nodeCompat"), b.booleanLiteral(true)),
+				]),
+			),
+		]),
+	);
+
+	const moduleDef = b.objectProperty(
+		b.identifier("modules"),
+		b.arrayExpression([b.stringLiteral("nitro-cloudflare-dev")]),
+	);
+
+	transformFile(configFile, {
+		visitCallExpression: function (n) {
+			const callee = n.node.callee as recast.types.namedTypes.Identifier;
+			if (callee.name === "defineNuxtConfig") {
+				mergeObjectProperties(
+					n.node.arguments[0] as recast.types.namedTypes.ObjectExpression,
+					[presetDef, moduleDef],
+				);
+			}
+
+			return this.traverse(n);
+		},
+	});
+
+	s.stop(`${brandColor(`updated`)} ${dim(`\`${configFile}\``)}`);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "nuxt",
+	frameworkCli: "nuxi",
+	platform: "pages",
+	displayName: "Nuxt",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates/nuxt/pages",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			deploy: `${npm} run build && wrangler pages deploy`,
+			preview: `${npm} run build && wrangler pages dev`,
+			"cf-typegen": `wrangler types`,
+		},
+	}),
+	devScript: "dev",
+	deployScript: "deploy",
+	previewScript: "preview",
+};
+export default config;

package/templates/nuxt/pages/templates/worker-configuration.d.ts

@@ -0,0 +1,4 @@
+// Generated by Wrangler
+// After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
+interface Env {
+}

package/templates/nuxt/pages/templates/wrangler.jsonc

@@ -0,0 +1,5 @@
+{
+  "name": "<TBD>",
+  "compatibility_date": "<TBD>",
+  "pages_build_output_dir": "./dist"
+}

package/{templates-experimental/nuxt → templates/nuxt/workers}/c3.ts

@@ -8,7 +8,7 @@ import { readFile, writeFile } from "helpers/files";
 import { detectPackageManager } from "helpers/packageManagers";
 import { installPackages } from "helpers/packages";
 import * as recast from "recast";
-import type { TemplateConfig } from "../../src/templates";
+import type { TemplateConfig } from "../../../src/templates";
 import type { C3Context } from "types";
 
 const { npm, name: pm } = detectPackageManager();
@@ -21,6 +21,7 @@ const generate = async (ctx: C3Context) => {
 		ctx.project.name,
 		"--packageManager",
 		npm,
+		"--no-install",
 		gitFlag,
 	]);
 
@@ -84,6 +85,16 @@ const updateNuxtConfig = () => {
 				b.identifier("preset"),
 				b.stringLiteral("cloudflare_module"),
 			),
+			b.objectProperty(
+				b.identifier("cloudflare"),
+				b.objectExpression([
+					b.objectProperty(
+						b.identifier("deployConfig"),
+						b.booleanLiteral(true),
+					),
+					b.objectProperty(b.identifier("nodeCompat"), b.booleanLiteral(true)),
+				]),
+			),
 		]),
 	);
 
@@ -118,7 +129,7 @@ const config: TemplateConfig = {
 	copyFiles: {
 		path: "./templates",
 	},
-	path: "templates-experimental/nuxt",
+	path: "templates/nuxt/workers",
 	generate,
 	configure,
 	transformPackageJson: async () => ({

package/templates/nuxt/workers/templates/worker-configuration.d.ts

@@ -0,0 +1,4 @@
+// Generated by Wrangler
+// After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
+interface Env {
+}

package/templates/nuxt/workers/templates/wrangler.jsonc

@@ -0,0 +1,12 @@
+{
+  "name": "<TBD>",
+  "main": "./.output/server/index.mjs",
+  "compatibility_date": "<TBD>",
+  "assets": {
+    "binding": "ASSETS",
+    "directory": "./.output/public/"
+  },
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/openapi/c3.ts

@@ -1,4 +1,6 @@
-export default {
+import type { TemplateConfig } from "../../src/templates";
+
+const config: TemplateConfig = {
 	configVersion: 1,
 	id: "openapi",
 	displayName: "API starter (OpenAPI compliant)",
@@ -8,3 +10,5 @@ export default {
 		path: "./ts",
 	},
 };
+
+export default config;

package/templates/openapi/ts/package.json

@@ -16,6 +16,6 @@
 	"devDependencies": {
 		"@types/node": "20.8.3",
 		"@types/service-worker-mock": "^2.0.1",
-		"wrangler": "^3.60.3"
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/openapi/ts/worker-configuration.d.ts

@@ -1,4 +1,4 @@
 // Generated by Wrangler
-// After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
+// After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
 interface Env {
 }

package/templates/openapi/ts/wrangler.jsonc

@@ -0,0 +1,8 @@
+{
+  "name": "<TBD>",
+  "main": "src/index.ts",
+  "compatibility_date": "<TBD>",
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/pre-existing/c3.ts

@@ -6,6 +6,7 @@ import { processArgument } from "helpers/args";
 import { runCommand } from "helpers/command";
 import { detectPackageManager } from "helpers/packageManagers";
 import { chooseAccount, wranglerLogin } from "../../src/wrangler/accounts";
+import type { TemplateConfig } from "../../src/templates";
 import type { C3Context } from "types";
 
 export async function copyExistingWorkerFiles(ctx: C3Context) {
@@ -49,24 +50,25 @@ export async function copyExistingWorkerFiles(ctx: C3Context) {
 		},
 	);
 
-	// copy src/* files from the downloaded worker
+	// copy src/* files from the downloaded Worker
 	await cp(
 		join(tempdir, ctx.args.existingScript, "src"),
 		join(ctx.project.path, "src"),
 		{ recursive: true },
 	);
 
-	// copy wrangler.toml from the downloaded worker
+	// copy ./wrangler.toml from the downloaded Worker
 	await cp(
 		join(tempdir, ctx.args.existingScript, "wrangler.toml"),
 		join(ctx.project.path, "wrangler.toml"),
 	);
 }
 
-export default {
+const config: TemplateConfig = {
 	configVersion: 1,
 	id: "pre-existing",
 	displayName: "Pre-existing Worker (from Dashboard)",
+	description: "Fetch a Worker initialized from the Cloudflare dashboard.",
 	platform: "workers",
 	hidden: true,
 	copyFiles: {
@@ -79,6 +81,8 @@ export default {
 	}),
 };
 
+export default config;
+
 export interface ConfigureParams {
 	login: (ctx: C3Context) => Promise<boolean>;
 	chooseAccount: (ctx: C3Context) => Promise<void>;
@@ -96,7 +100,7 @@ export function buildConfigure(params: ConfigureParams) {
 		await params.chooseAccount(ctx);
 		await params.copyFiles(ctx);
 
-		// Force no-deploy since the worker is already deployed
+		// Force no-deploy since the Worker is already deployed
 		ctx.args.deploy = false;
 	};
 }

package/templates/pre-existing/js/package.json

@@ -8,6 +8,6 @@
 		"start": "wrangler dev"
 	},
 	"devDependencies": {
-		"wrangler": "^3.60.3"
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/queues/c3.ts

@@ -1,4 +1,6 @@
-export default {
+import type { TemplateConfig } from "../../src/templates";
+
+const config: TemplateConfig = {
 	configVersion: 1,
 	id: "queues",
 	displayName: "Queue consumer & producer Worker",
@@ -26,3 +28,5 @@ export default {
 		],
 	},
 };
+
+export default config;

package/templates/queues/js/package.json

@@ -8,6 +8,6 @@
 		"start": "wrangler dev"
 	},
 	"devDependencies": {
-		"wrangler": "^3.60.3"
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/queues/js/wrangler.jsonc

@@ -0,0 +1,21 @@
+{
+  "name": "<TBD>",
+  "main": "src/index.js",
+  "compatibility_date": "<TBD>",
+  "observability": {
+    "enabled": true
+  },
+  "queues": {
+    "consumers": [
+      {
+        "queue": "my-queue"
+      }
+    ],
+    "producers": [
+      {
+        "binding": "MY_QUEUE",
+        "queue": "my-queue"
+      }
+    ]
+  }
+}

package/templates/queues/ts/package.json

@@ -10,6 +10,6 @@
 	},
 	"devDependencies": {
 		"typescript": "^5.5.2",
-		"wrangler": "^3.60.3"
+		"wrangler": "^3.101.0"
 	}
 }

package/templates/queues/ts/src/index.ts

@@ -8,7 +8,7 @@
  * - Open a browser tab at http://localhost:8787/ to see your worker in action
  * - Run `npm run deploy` to publish your worker
  *
- * Bind resources to your worker in `wrangler.toml`. After adding bindings, a type definition for the
+ * Bind resources to your worker in `wrangler.jsonc`. After adding bindings, a type definition for the
  * `Env` object can be regenerated with `npm run cf-typegen`.
  *
  * Learn more at https://developers.cloudflare.com/workers/

package/templates/queues/ts/worker-configuration.d.ts

@@ -1,5 +1,5 @@
 // Generated by Wrangler
-// After adding bindings to `wrangler.toml`, regenerate this interface via `npm run cf-typegen`
+// After adding bindings to `wrangler.jsonc`, regenerate this interface via `npm run cf-typegen`
 interface Env {
 	MY_QUEUE: Queue;
 }

package/templates/queues/ts/wrangler.jsonc

@@ -0,0 +1,21 @@
+{
+  "name": "<TBD>",
+  "main": "src/index.ts",
+  "compatibility_date": "<TBD>",
+  "observability": {
+    "enabled": true
+  },
+  "queues": {
+    "consumers": [
+      {
+        "queue": "my-queue"
+      }
+    ],
+    "producers": [
+      {
+        "binding": "MY_QUEUE",
+        "queue": "my-queue"
+      }
+    ]
+  }
+}