create-cloudflare 0.0.0-e739b7fe → 0.0.0-e771fe990

package/templates/svelte/c3.ts

@@ -1,3 +1,4 @@
+import { existsSync } from "node:fs";
 import { platform } from "node:os";
 import { logRaw, updateStatus } from "@cloudflare/cli";
 import { blue, brandColor, dim } from "@cloudflare/cli/colors";
@@ -13,7 +14,7 @@ import type { C3Context, PackageJson } from "types";
 const { npm } = detectPackageManager();
 
 const generate = async (ctx: C3Context) => {
-	await runFrameworkGenerator(ctx, [ctx.project.name]);
+	await runFrameworkGenerator(ctx, ["create", ctx.project.name]);
 
 	logRaw("");
 };
@@ -28,6 +29,7 @@ const configure = async (ctx: C3Context) => {
 	});
 
 	updateSvelteConfig();
+	updatePlaywrightConfig(usesTypescript(ctx));
 	updateTypeDefinitions(ctx);
 };
 
@@ -49,6 +51,34 @@ const updateSvelteConfig = () => {
 	});
 };
 
+const updatePlaywrightConfig = (shouldUseTypescript: boolean) => {
+	const filePath = `playwright.config.${shouldUseTypescript ? "ts" : "js"}`;
+	if (!existsSync(filePath)) {
+		return;
+	}
+
+	updateStatus(`Changing webServer port in ${blue(filePath)}`);
+
+	transformFile(filePath, {
+		visitObjectExpression: function (n) {
+			const portProp = n.node.properties.find((prop) => {
+				if (!("key" in prop) || !("name" in prop.key)) {
+					return false;
+				}
+
+				return prop.key.name === "port";
+			});
+
+			if (!portProp || !("value" in portProp) || !("value" in portProp.value)) {
+				return this.traverse(n);
+			}
+
+			portProp.value.value = 8788;
+			return false;
+		},
+	});
+};
+
 const updateTypeDefinitions = (ctx: C3Context) => {
 	if (!usesTypescript(ctx)) {
 		return;
@@ -69,21 +99,21 @@ const updateTypeDefinitions = (ctx: C3Context) => {
 					b.tsInterfaceBody([
 						b.tsPropertySignature(
 							b.identifier("env"),
-							b.tsTypeAnnotation(b.tsTypeReference(b.identifier("Env")))
+							b.tsTypeAnnotation(b.tsTypeReference(b.identifier("Env"))),
 						),
 						b.tsPropertySignature(
 							b.identifier("cf"),
 							b.tsTypeAnnotation(
-								b.tsTypeReference(b.identifier("CfProperties"))
-							)
+								b.tsTypeReference(b.identifier("CfProperties")),
+							),
 						),
 						b.tsPropertySignature(
 							b.identifier("ctx"),
 							b.tsTypeAnnotation(
-								b.tsTypeReference(b.identifier("ExecutionContext"))
-							)
+								b.tsTypeReference(b.identifier("ExecutionContext")),
+							),
 						),
-					])
+					]),
 				);
 
 				moduleBlock.body.unshift(platformInterface);
@@ -97,27 +127,25 @@ const updateTypeDefinitions = (ctx: C3Context) => {
 const config: TemplateConfig = {
 	configVersion: 1,
 	id: "svelte",
-	displayName: "Svelte",
+	frameworkCli: "sv",
+	displayName: "SvelteKit",
 	platform: "pages",
 	copyFiles: {
-		variants: {
-			js: { path: "./js" },
-			ts: { path: "./ts" },
-		},
+		path: "./templates",
 	},
 	generate,
 	configure,
 	transformPackageJson: async (original: PackageJson, ctx: C3Context) => {
 		let scripts: Record<string, string> = {
-			preview: `${npm} run build && wrangler pages dev .svelte-kit/cloudflare`,
-			deploy: `${npm} run build && wrangler pages deploy .svelte-kit/cloudflare`,
+			preview: `${npm} run build && wrangler pages dev`,
+			deploy: `${npm} run build && wrangler pages deploy`,
 		};
 
 		if (usesTypescript(ctx)) {
 			const mv = platform() === "win32" ? "move" : "mv";
 			scripts = {
 				...scripts,
-				"build-cf-types": `wrangler types && ${mv} worker-configuration.d.ts src/`,
+				"cf-typegen": `wrangler types && ${mv} worker-configuration.d.ts src/`,
 			};
 		}
 

package/templates/svelte/{ts → templates}/wrangler.toml

@@ -1,9 +1,20 @@
+#:schema node_modules/wrangler/config-schema.json
 name = "<TBD>"
 compatibility_date = "<TBD>"
+pages_build_output_dir = ".svelte-kit/cloudflare"
+
+# Automatically place your workloads in an optimal location to minimize latency.
+# If you are running back-end logic in a Pages Function, running it closer to your back-end infrastructure
+# rather than the end user may result in better performance.
+# Docs: https://developers.cloudflare.com/pages/functions/smart-placement/#smart-placement
+# [placement]
+# mode = "smart"
 
 # Variable bindings. These are arbitrary, plaintext strings (similar to environment variables)
+# Docs:
+# - https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
 # Note: Use secrets to store sensitive data.
-# Docs: https://developers.cloudflare.com/pages/functions/bindings/#environment-variables
+# - https://developers.cloudflare.com/pages/functions/bindings/#secrets
 # [vars]
 # MY_VARIABLE = "production_value"
 
@@ -49,4 +60,26 @@ compatibility_date = "<TBD>"
 # Docs: https://developers.cloudflare.com/pages/functions/bindings/#service-bindings
 # [[services]]
 # binding = "MY_SERVICE"
-# service = "my-service"
+# service = "my-service"
+
+# To use different bindings for preview and production environments, follow the examples below.
+# When using environment-specific overrides for bindings, ALL bindings must be specified on a per-environment basis.
+# Docs: https://developers.cloudflare.com/pages/functions/wrangler-configuration#environment-specific-overrides
+
+######## PREVIEW environment config ########
+
+# [env.preview.vars]
+# API_KEY = "xyz789"
+
+# [[env.preview.kv_namespaces]]
+# binding = "MY_KV_NAMESPACE"
+# id = "<PREVIEW_NAMESPACE_ID>"
+
+######## PRODUCTION environment config ########
+
+# [env.production.vars]
+# API_KEY = "abc123"
+
+# [[env.production.kv_namespaces]]
+# binding = "MY_KV_NAMESPACE"
+# id = "<PRODUCTION_NAMESPACE_ID>"

package/templates/vue/c3.ts

@@ -12,6 +12,7 @@ const generate = async (ctx: C3Context) => {
 const config: TemplateConfig = {
 	configVersion: 1,
 	id: "vue",
+	frameworkCli: "create-vue",
 	displayName: "Vue",
 	platform: "pages",
 	generate,

package/templates-experimental/angular/c3.ts

@@ -0,0 +1,112 @@
+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 "frameworks/index";
+import { readFile, readJSON, writeFile } from "helpers/files";
+import { detectPackageManager } from "helpers/packageManagers";
+import { installPackages } from "helpers/packages";
+import type { TemplateConfig } from "../../src/templates";
+import type { C3Context } from "types";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [
+		ctx.project.name,
+		"--ssr",
+		"--server-routing" /** Dev Preview API */,
+	]);
+	logRaw("");
+};
+
+const configure = async (ctx: C3Context) => {
+	updateAngularJson(ctx);
+	await updateAppCode();
+	await installCFWorker();
+};
+
+async function installCFWorker() {
+	await installPackages(["xhr2"], {
+		dev: true,
+		startText: "Installing additional dependencies",
+		doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
+	});
+}
+async function updateAppCode() {
+	const s = spinner();
+	s.start(`Updating application code`);
+
+	// Update an app config file to:
+	// - add the `provideHttpClient(withFetch())` call to enable `fetch` usage in `HttpClient`
+	const appConfigPath = "src/app/app.config.ts";
+	const appConfig = readFile(resolve(appConfigPath));
+	const newAppConfig =
+		"import { provideHttpClient, withFetch } from '@angular/common/http';\n" +
+		appConfig.replace(
+			"providers: [",
+			"providers: [provideHttpClient(withFetch()), ",
+		);
+	writeFile(resolve(appConfigPath), newAppConfig);
+	s.stop(`${brandColor(`updated`)} ${dim(appConfigPath)}`);
+
+	// Update an app server routes file to:
+	const appServerRoutesPath = "src/app/app.routes.server.ts";
+	const appRoutes = readFile(resolve(appServerRoutesPath));
+	const newAppRoutes = appRoutes.replace(
+		"RenderMode.Prerender",
+		"RenderMode.Server",
+	);
+	writeFile(resolve(appServerRoutesPath), newAppRoutes);
+	s.stop(`${brandColor(`updated`)} ${dim(appServerRoutesPath)}`);
+
+	// Remove unwanted dependencies
+	s.start(`Updating package.json`);
+	const packageJsonPath = resolve("package.json");
+	const packageManifest = readJSON(packageJsonPath);
+
+	delete packageManifest["dependencies"]["express"];
+	delete packageManifest["devDependencies"]["@types/express"];
+
+	writeFile(packageJsonPath, JSON.stringify(packageManifest, null, 2));
+	s.stop(`${brandColor(`updated`)} ${dim(`\`package.json\``)}`);
+}
+
+function updateAngularJson(ctx: C3Context) {
+	const s = spinner();
+	s.start(`Updating angular.json config`);
+	const angularJson = readJSON(resolve("angular.json"));
+	// Update builder
+	const architectSection = angularJson.projects[ctx.project.name].architect;
+	architectSection.build.options.outputPath = "dist";
+	architectSection.build.options.outputMode = "server";
+	architectSection.build.options.ssr.experimentalPlatform = "neutral";
+
+	writeFile(resolve("angular.json"), JSON.stringify(angularJson, null, 2));
+	s.stop(`${brandColor(`updated`)} ${dim(`\`angular.json\``)}`);
+}
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "angular",
+	frameworkCli: "@angular/create",
+	displayName: "Angular",
+	platform: "workers",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates-experimental/angular",
+	devScript: "start",
+	deployScript: "deploy",
+	previewScript: "start",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			start: `${npm} run build && wrangler dev`,
+			build: `ng build`,
+			deploy: `${npm} run build && wrangler deploy`,
+		},
+	}),
+};
+export default config;

package/templates-experimental/angular/templates/src/server.ts

@@ -0,0 +1,15 @@
+import { AngularAppEngine, createRequestHandler } from '@angular/ssr';
+
+const angularApp = new AngularAppEngine();
+
+/**
+ * This is a request handler used by the Angular CLI (dev-server and during build).
+ */
+export const reqHandler = createRequestHandler(async (req) => {
+	const res = await angularApp.handle(req);
+
+	return res ?? new Response('Page not found.', { status: 404 });
+});
+
+
+export default { fetch: reqHandler };

package/templates-experimental/angular/templates/wrangler.toml

@@ -0,0 +1,11 @@
+#:schema node_modules/wrangler/config-schema.json
+name = "<TBD>"
+compatibility_date = "<TBD>"
+main = "./dist/server/server.mjs"
+assets = { directory = "./dist/browser", binding = "ASSETS" }
+
+# Workers Logs
+# Docs: https://developers.cloudflare.com/workers/observability/logs/workers-logs/
+# Configuration: https://developers.cloudflare.com/workers/observability/logs/workers-logs/#enable-workers-logs
+[observability]
+enabled = true

package/templates-experimental/astro/c3.ts

@@ -0,0 +1,98 @@
+import { logRaw, updateStatus } from "@cloudflare/cli";
+import { blue, brandColor, dim } from "@cloudflare/cli/colors";
+import { runFrameworkGenerator } from "frameworks/index";
+import { transformFile } from "helpers/codemod";
+import { runCommand } from "helpers/command";
+import { usesTypescript } from "helpers/files";
+import { detectPackageManager } from "helpers/packageManagers";
+import * as recast from "recast";
+import type { TemplateConfig } from "../../src/templates";
+import type { C3Context, PackageJson } from "types";
+
+const { npx } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [ctx.project.name, "--no-install"]);
+
+	logRaw(""); // newline
+};
+
+const configure = async () => {
+	await runCommand([npx, "astro", "add", "cloudflare", "-y"], {
+		silent: true,
+		startText: "Installing adapter",
+		doneText: `${brandColor("installed")} ${dim(
+			`via \`${npx} astro add cloudflare\``,
+		)}`,
+	});
+
+	updateAstroConfig();
+};
+
+const updateAstroConfig = () => {
+	const filePath = "astro.config.mjs";
+
+	updateStatus(`Updating configuration in ${blue(filePath)}`);
+
+	transformFile(filePath, {
+		visitCallExpression: function (n) {
+			const callee = n.node.callee as recast.types.namedTypes.Identifier;
+			if (callee.name !== "cloudflare") {
+				return this.traverse(n);
+			}
+
+			const b = recast.types.builders;
+			n.node.arguments = [
+				b.objectExpression([
+					b.objectProperty(
+						b.identifier("platformProxy"),
+						b.objectExpression([
+							b.objectProperty(b.identifier("enabled"), b.booleanLiteral(true)),
+						]),
+					),
+				]),
+			];
+
+			return false;
+		},
+	});
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "astro",
+	frameworkCli: "create-astro",
+	platform: "workers",
+	displayName: "Astro",
+	copyFiles: {
+		async selectVariant(ctx) {
+			// Note: this `selectVariant` function should not be needed
+			//       this is just a quick workaround until
+			//       https://github.com/cloudflare/workers-sdk/issues/7495
+			//       is resolved
+			return usesTypescript(ctx) ? "ts" : "js";
+		},
+		variants: {
+			js: {
+				path: "./templates/js",
+			},
+			ts: {
+				path: "./templates/ts",
+			},
+		},
+	},
+	devScript: "dev",
+	deployScript: "deploy",
+	previewScript: "preview",
+	path: "templates-experimental/astro",
+	generate,
+	configure,
+	transformPackageJson: async (pkgJson: PackageJson, ctx: C3Context) => ({
+		scripts: {
+			deploy: `astro build && wrangler deploy`,
+			preview: `astro build && wrangler dev`,
+			...(usesTypescript(ctx) && { "cf-typegen": `wrangler types` }),
+		},
+	}),
+};
+export default config;

package/templates-experimental/astro/templates/js/public/.assetsignore

@@ -0,0 +1,4 @@
+_worker.js
+_routes.json
+_headers
+_redirects

package/templates-experimental/astro/templates/js/wrangler.toml

@@ -0,0 +1,12 @@
+#:schema node_modules/wrangler/config-schema.json
+name = "<TBD>"
+compatibility_date = "<TBD>"
+compatibility_flags = ["nodejs_compat_v2"]
+main = "./dist/_worker.js/index.js"
+assets = { directory = "./dist", binding = "ASSETS" }
+
+# Workers Logs
+# Docs: https://developers.cloudflare.com/workers/observability/logs/workers-logs/
+# Configuration: https://developers.cloudflare.com/workers/observability/logs/workers-logs/#enable-workers-logs
+[observability]
+enabled = true

package/templates-experimental/astro/templates/ts/public/.assetsignore

@@ -0,0 +1,4 @@
+_worker.js
+_routes.json
+_headers
+_redirects

package/templates-experimental/astro/templates/ts/src/env.d.ts

@@ -0,0 +1,5 @@
+type Runtime = import("@astrojs/cloudflare").Runtime<Env>;
+
+declare namespace App {
+	interface Locals extends Runtime {}
+}

package/templates-experimental/astro/templates/ts/worker-configuration.d.ts

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

package/templates-experimental/astro/templates/ts/wrangler.toml

@@ -0,0 +1,12 @@
+#:schema node_modules/wrangler/config-schema.json
+name = "<TBD>"
+compatibility_date = "<TBD>"
+compatibility_flags = ["nodejs_compat"]
+main = "./dist/_worker.js/index.js"
+assets = { directory = "./dist", binding = "ASSETS" }
+
+# Workers Logs
+# Docs: https://developers.cloudflare.com/workers/observability/logs/workers-logs/
+# Configuration: https://developers.cloudflare.com/workers/observability/logs/workers-logs/#enable-workers-logs
+[observability]
+enabled = true

package/templates-experimental/docusaurus/c3.ts

@@ -0,0 +1,32 @@
+import { runFrameworkGenerator } from "frameworks/index";
+import { detectPackageManager } from "helpers/packageManagers";
+import type { TemplateConfig } from "../../src/templates";
+import type { C3Context } from "types";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, [ctx.project.name, "classic"]);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "docusaurus",
+	frameworkCli: "create-docusaurus",
+	platform: "workers",
+	displayName: "Docusaurus",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates-experimental/docusaurus",
+	generate,
+	transformPackageJson: async () => ({
+		scripts: {
+			deploy: `${npm} run build && wrangler deploy`,
+			preview: `${npm} run build && wrangler dev`,
+		},
+	}),
+	devScript: "start",
+	deployScript: "deploy",
+};
+export default config;

package/templates-experimental/docusaurus/templates/wrangler.toml

@@ -0,0 +1,10 @@
+#:schema node_modules/wrangler/config-schema.json
+name = "<TBD>"
+compatibility_date = "<TBD>"
+assets = { directory = "./build" }
+
+# Workers Logs
+# Docs: https://developers.cloudflare.com/workers/observability/logs/workers-logs/
+# Configuration: https://developers.cloudflare.com/workers/observability/logs/workers-logs/#enable-workers-logs
+[observability]
+enabled = true

package/templates-experimental/gatsby/c3.ts

@@ -0,0 +1,53 @@
+import { inputPrompt } from "@cloudflare/cli/interactive";
+import { runFrameworkGenerator } from "frameworks/index";
+import { detectPackageManager } from "helpers/packageManagers";
+import type { TemplateConfig } from "../../src/templates";
+import type { C3Context } from "types";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	const defaultTemplate = "https://github.com/gatsbyjs/gatsby-starter-blog";
+
+	const useTemplate = await inputPrompt({
+		type: "confirm",
+		question: "Would you like to use a template?",
+		label: "template",
+		defaultValue: true,
+	});
+
+	let templateUrl = "";
+	if (useTemplate) {
+		templateUrl = await inputPrompt({
+			type: "text",
+			question: `Please specify the url of the template you'd like to use`,
+			label: "template",
+			defaultValue: defaultTemplate,
+		});
+	}
+
+	await runFrameworkGenerator(ctx, ["new", ctx.project.name, templateUrl]);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "gatsby",
+	frameworkCli: "gatsby",
+	platform: "workers",
+	displayName: "Gatsby",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates-experimental/gatsby",
+	generate,
+	transformPackageJson: async () => ({
+		scripts: {
+			deploy: `${npm} run build && wrangler deploy`,
+			preview: `${npm} run build && wrangler dev`,
+		},
+	}),
+	devScript: "develop",
+	deployScript: "deploy",
+	previewScript: "preview",
+};
+export default config;

package/templates-experimental/gatsby/templates/wrangler.toml

@@ -0,0 +1,10 @@
+#:schema node_modules/wrangler/config-schema.json
+name = "<TBD>"
+compatibility_date = "<TBD>"
+assets = { directory = "./public" }
+
+# Workers Logs
+# Docs: https://developers.cloudflare.com/workers/observability/logs/workers-logs/
+# Configuration: https://developers.cloudflare.com/workers/observability/logs/workers-logs/#enable-workers-logs
+[observability]
+enabled = true

package/templates-experimental/hello-world-assets-only/c3.ts

@@ -0,0 +1,15 @@
+import type { TemplateConfig } from "../../src/templates";
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "hello-world-assets-only",
+	path: "templates-experimental/hello-world-assets-only",
+	displayName: "Hello World - Assets-only",
+	description: "Get started with a basic Worker that only serves static assets",
+	platform: "workers",
+	copyFiles: {
+		path: "./templates",
+	},
+};
+
+export default config;

package/templates-experimental/hello-world-assets-only/templates/package.json

@@ -0,0 +1,13 @@
+{
+	"name": "<TBD>",
+	"version": "0.0.0",
+	"private": true,
+	"scripts": {
+		"deploy": "wrangler deploy",
+		"dev": "wrangler dev",
+		"start": "wrangler dev"
+	},
+	"devDependencies": {
+		"wrangler": "^3.78.5"
+	}
+}

package/templates-experimental/hello-world-assets-only/templates/public/index.html

@@ -0,0 +1,11 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<title>Hello, World!</title>
+	</head>
+	<body>
+		<h1 id="heading">Hello, World!</h1>
+	</body>
+</html>

package/templates-experimental/hello-world-assets-only/templates/wrangler.toml

@@ -0,0 +1,10 @@
+#:schema node_modules/wrangler/config-schema.json
+name = "<TBD>"
+compatibility_date = "<TBD>"
+assets = { directory = "./public" }
+
+# Workers Logs
+# Docs: https://developers.cloudflare.com/workers/observability/logs/workers-logs/
+# Configuration: https://developers.cloudflare.com/workers/observability/logs/workers-logs/#enable-workers-logs
+[observability]
+enabled = true

package/templates-experimental/hello-world-durable-object-with-assets/c3.ts

@@ -0,0 +1,23 @@
+import type { TemplateConfig } from "../../src/templates";
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "hello-world-durable-object-with-assets",
+	path: "templates-experimental/hello-world-durable-object-with-assets",
+	displayName: "Hello World - Worker Using Durable Objects with Assets",
+	description:
+		"Get started with a basic stateful app to build projects like real-time chats, collaborative apps, and multiplayer games, which hosts assets",
+	platform: "workers",
+	copyFiles: {
+		variants: {
+			js: {
+				path: "./js",
+			},
+			ts: {
+				path: "./ts",
+			},
+		},
+	},
+};
+
+export default config;

package/templates-experimental/hello-world-durable-object-with-assets/js/.editorconfig

@@ -0,0 +1,12 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = tab
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.yml]
+indent_style = space