create-cloudflare 0.0.0-ee91efcc → 0.0.0-eec2a7074

package/templates-experimental/nuxt/c3.ts

@@ -0,0 +1,135 @@
+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,
+		gitFlag,
+	]);
+
+	writeFile("./.node-version", "17");
+
+	logRaw(""); // newline
+};
+
+const configure = async (ctx: C3Context) => {
+	const packages = ["nitro-cloudflare-dev", "nitropack"];
+
+	// 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-preset"),
+			),
+		]),
+	);
+
+	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: "workers",
+	displayName: "Nuxt",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates-experimental/nuxt",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			deploy: `${npm} run build && wrangler deploy`,
+			preview: `${npm} run build && wrangler dev`,
+			"cf-typegen": `wrangler types`,
+		},
+	}),
+	devScript: "dev",
+	deployScript: "deploy",
+	previewScript: "preview",
+};
+export default config;

package/templates-experimental/nuxt/templates/cloudflare-preset/nitro.config.ts

@@ -0,0 +1,27 @@
+import { type NitroPreset } from "nitropack";
+
+export default <NitroPreset>{
+	extends: "cloudflare",
+	exportConditions: ["workerd"],
+	output: {
+		dir: "{{ rootDir }}/dist",
+		publicDir: "{{ output.dir }}/public",
+		serverDir: "{{ output.dir }}/worker",
+	},
+	commands: {
+		preview: "npx wrangler dev",
+		deploy: "npx wrangler deploy",
+	},
+	wasm: {
+		lazy: false,
+		esmImport: true,
+	},
+	rollupConfig: {
+		output: {
+			entryFileNames: "index.js",
+			format: "esm",
+			exports: "named",
+			inlineDynamicImports: false,
+		},
+	},
+};

package/templates-experimental/nuxt/templates/env.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="WORKERS_TYPES_ENTRYPOINT" />
+
+declare module "h3" {
+  interface H3EventContext {
+    cf: CfProperties;
+    cloudflare: {
+      request: Request;
+      env: Env;
+      context: ExecutionContext;
+    };
+  }
+}
+
+export {};

package/templates-experimental/nuxt/templates/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/nuxt/templates/wrangler.toml

@@ -0,0 +1,11 @@
+#:schema node_modules/wrangler/config-schema.json
+name = "<TBD>"
+compatibility_date = "<TBD>"
+main = "./dist/worker/index.js"
+assets = { directory = "./dist/public", 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/qwik/c3.ts

@@ -0,0 +1,153 @@
+import { crash, endSection } from "@cloudflare/cli";
+import { brandColor } from "@cloudflare/cli/colors";
+import { spinner } from "@cloudflare/cli/interactive";
+import { runFrameworkGenerator } from "frameworks/index";
+import { loadTemplateSnippets, transformFile } from "helpers/codemod";
+import { quoteShellArgs, runCommand } from "helpers/command";
+import { removeFile, usesTypescript } from "helpers/files";
+import { detectPackageManager } from "helpers/packageManagers";
+import * as recast from "recast";
+import type { TemplateConfig } from "../../src/templates";
+import type { C3Context } from "types";
+
+const { npm, npx } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, ["playground", ctx.project.name]);
+};
+
+const configure = async (ctx: C3Context) => {
+	// Add the pages integration
+	const cmd = [npx, "qwik", "add", "cloudflare-pages"];
+	endSection(`Running ${quoteShellArgs(cmd)}`);
+	await runCommand(cmd);
+
+	// Remove the extraneous Pages files
+	removeFile("./public/_headers");
+	removeFile("./public/_redirects");
+	removeFile("./public/_routes.json");
+
+	addBindingsProxy(ctx);
+	populateCloudflareEnv();
+};
+
+const addBindingsProxy = (ctx: C3Context) => {
+	// Qwik only has a typescript template atm.
+	// This check is an extra precaution
+	if (!usesTypescript(ctx)) {
+		return;
+	}
+
+	const s = spinner();
+	s.start("Updating `vite.config.ts`");
+
+	const snippets = loadTemplateSnippets(ctx);
+	const b = recast.types.builders;
+
+	transformFile("vite.config.ts", {
+		// Insert the env declaration after the last import (but before the rest of the body)
+		visitProgram: function (n) {
+			const lastImportIndex = n.node.body.findLastIndex(
+				(t) => t.type === "ImportDeclaration",
+			);
+			const lastImport = n.get("body", lastImportIndex);
+			lastImport.insertAfter(...snippets.getPlatformProxyTs);
+
+			return this.traverse(n);
+		},
+		// Pass the `platform` object from the declaration to the `qwikCity` plugin
+		visitCallExpression: function (n) {
+			const callee = n.node.callee as recast.types.namedTypes.Identifier;
+			if (callee.name !== "qwikCity") {
+				return this.traverse(n);
+			}
+
+			// The config object passed to `qwikCity`
+			const configArgument = n.node.arguments[0] as
+				| recast.types.namedTypes.ObjectExpression
+				| undefined;
+
+			const platformPropery = b.objectProperty.from({
+				key: b.identifier("platform"),
+				value: b.identifier("platform"),
+				shorthand: true,
+			});
+
+			if (!configArgument) {
+				n.node.arguments = [b.objectExpression([platformPropery])];
+
+				return false;
+			}
+
+			if (configArgument.type !== "ObjectExpression") {
+				crash("Failed to update `vite.config.ts`");
+			}
+
+			// Add the `platform` object to the object
+			configArgument.properties.push(platformPropery);
+
+			return false;
+		},
+	});
+
+	s.stop(`${brandColor("updated")} \`vite.config.ts\``);
+};
+
+const populateCloudflareEnv = () => {
+	const entrypointPath = "src/entry.cloudflare-pages.tsx";
+
+	const s = spinner();
+	s.start(`Updating \`${entrypointPath}\``);
+
+	transformFile(entrypointPath, {
+		visitTSInterfaceDeclaration: function (n) {
+			const b = recast.types.builders;
+			const id = n.node.id as recast.types.namedTypes.Identifier;
+			if (id.name !== "QwikCityPlatform") {
+				this.traverse(n);
+			}
+
+			const newBody = [
+				["env", "Env"],
+				// Qwik doesn't supply `cf` to the platform object. Should they do so, uncomment this
+				// ["cf", "CfProperties"],
+			].map(([varName, type]) =>
+				b.tsPropertySignature(
+					b.identifier(varName),
+					b.tsTypeAnnotation(b.tsTypeReference(b.identifier(type))),
+				),
+			);
+
+			n.node.body.body = newBody;
+
+			return false;
+		},
+	});
+
+	s.stop(`${brandColor("updated")} \`${entrypointPath}\``);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "qwik",
+	frameworkCli: "create-qwik",
+	displayName: "Qwik",
+	platform: "workers",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates-experimental/qwik",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			deploy: `${npm} run build && wrangler deploy`,
+			preview: `${npm} run build && wrangler dev`,
+			"cf-typegen": `wrangler types`,
+		},
+	}),
+	devScript: "dev",
+	deployScript: "deploy",
+	previewScript: "preview",
+};
+export default config;

package/templates-experimental/qwik/snippets/getPlatformProxy.ts

@@ -0,0 +1,6 @@
+let platform = {};
+
+if(process.env.NODE_ENV === 'development') {
+  const { getPlatformProxy } = await import('wrangler');
+  platform = await getPlatformProxy();
+}

package/templates-experimental/qwik/templates/public/.assetsignore

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

package/templates-experimental/qwik/templates/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/qwik/templates/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"
+assets = { directory = "./dist", binding = "ASSET" }
+
+# 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/remix/c3.ts

@@ -0,0 +1,77 @@
+import { logRaw } from "@cloudflare/cli";
+import { brandColor, dim } from "@cloudflare/cli/colors";
+import { spinner } from "@cloudflare/cli/interactive";
+import { runFrameworkGenerator } from "frameworks/index";
+import { transformFile } from "helpers/codemod";
+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,
+		"--template",
+		"https://github.com/remix-run/remix/tree/main/templates/cloudflare",
+	]);
+
+	logRaw(""); // newline
+};
+
+const configure = async () => {
+	await installPackages(["wrangler@latest"], {
+		dev: true,
+		startText: "Updating the Wrangler version",
+		doneText: `${brandColor(`updated`)} ${dim("wrangler@latest")}`,
+	});
+
+	const typeDefsPath = "load-context.ts";
+
+	const s = spinner();
+	s.start(`Updating \`${typeDefsPath}\``);
+
+	// Remove the empty Env declaration from the template to allow the type from
+	// worker-configuration.d.ts to take over
+	transformFile(typeDefsPath, {
+		visitTSInterfaceDeclaration(n) {
+			if (n.node.id.type === "Identifier" && n.node.id.name !== "Env") {
+				return this.traverse(n);
+			}
+
+			// Removes the node
+			n.replace();
+			return false;
+		},
+	});
+
+	s.stop(`${brandColor("updated")} \`${dim(typeDefsPath)}\``);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "remix",
+	frameworkCli: "create-remix",
+	platform: "workers",
+	displayName: "Remix",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates-experimental/remix",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			build:
+				"remix vite:build && wrangler pages functions build --outdir build/worker",
+			deploy: `${npm} run build && wrangler deploy`,
+			preview: `${npm} run build && wrangler dev`,
+			"cf-typegen": `wrangler types`,
+		},
+	}),
+	devScript: "dev",
+	deployScript: "deploy",
+	previewScript: "preview",
+};
+export default config;

package/templates-experimental/remix/templates/public/.assetsignore

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

package/templates-experimental/remix/templates/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/remix/templates/wrangler.toml

@@ -0,0 +1,11 @@
+#:schema node_modules/wrangler/config-schema.json
+name = "<TBD>"
+compatibility_date = "<TBD>"
+main = "./build/worker/index.js"
+assets = { directory = "./build/client" }
+
+# 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/solid/c3.ts

@@ -0,0 +1,137 @@
+import { logRaw, updateStatus } from "@cloudflare/cli";
+import { blue, brandColor, dim } from "@cloudflare/cli/colors";
+import { runFrameworkGenerator } from "frameworks/index";
+import { mergeObjectProperties, transformFile } from "helpers/codemod";
+import { usesTypescript } 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 } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	// Run the create-solid command
+	// -s flag forces solid-start
+	await runFrameworkGenerator(ctx, ["-p", ctx.project.name, "-s"]);
+
+	logRaw("");
+};
+
+const configure = async (ctx: C3Context) => {
+	const packages = ["nitropack"];
+	await installPackages(packages, {
+		dev: true,
+		startText: "Installing nitro module `nitropack`",
+		doneText: `${brandColor("installed")} ${dim(`via \`${npm} install\``)}`,
+	});
+
+	usesTypescript(ctx);
+	const filePath = `app.config.${usesTypescript(ctx) ? "ts" : "js"}`;
+
+	updateStatus(`Updating configuration in ${blue(filePath)}`);
+
+	transformFile(filePath, {
+		visitCallExpression: function (n) {
+			const callee = n.node.callee as recast.types.namedTypes.Identifier;
+			if (callee.name !== "defineConfig") {
+				return this.traverse(n);
+			}
+
+			const b = recast.types.builders;
+			mergeObjectProperties(
+				n.node.arguments[0] as recast.types.namedTypes.ObjectExpression,
+				[
+					b.objectProperty(
+						b.identifier("server"),
+						b.objectExpression([
+							// preset: "cloudflare-pages"
+							b.objectProperty(
+								b.identifier("preset"),
+								b.stringLiteral("./cloudflare-pages"),
+							),
+							// output: {
+							// 	dir: "{{ rootDir }}/dist",
+							// 	publicDir: "{{ output.dir }}/public",
+							// 	serverDir: "{{ output.dir }}/worker",
+							// },
+							b.objectProperty(
+								b.identifier("output"),
+								b.objectExpression([
+									b.objectProperty(
+										b.identifier("dir"),
+										b.stringLiteral("{{ rootDir }}/dist"),
+									),
+									b.objectProperty(
+										b.identifier("publicDir"),
+										b.stringLiteral("{{ output.dir }}/public"),
+									),
+									b.objectProperty(
+										b.identifier("serverDir"),
+										b.stringLiteral("{{ output.dir }}/worker"),
+									),
+								]),
+							),
+							// rollupConfig: {
+							// 	external: ["node:async_hooks"],
+							// },
+							b.objectProperty(
+								b.identifier("rollupConfig"),
+								b.objectExpression([
+									b.objectProperty(
+										b.identifier("external"),
+										b.arrayExpression([b.stringLiteral("node:async_hooks")]),
+									),
+								]),
+							),
+							// hooks: {
+							// 	// Prevent the Pages preset from writing the _routes.json etc.
+							// 	compiled() {},
+							// },
+							b.objectProperty(
+								b.identifier("hooks"),
+								b.objectExpression([
+									b.objectMethod(
+										"method",
+										b.identifier("compiled"),
+										[],
+										b.blockStatement([]),
+										false,
+									),
+								]),
+							),
+						]),
+					),
+				],
+			);
+
+			return false;
+		},
+	});
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "solid",
+	frameworkCli: "create-solid",
+	displayName: "Solid",
+	platform: "workers",
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates-experimental/solid",
+	generate,
+	configure,
+	transformPackageJson: async () => ({
+		scripts: {
+			preview: `${npm} run build && npx wrangler dev`,
+			deploy: `${npm} run build && wrangler deploy`,
+		},
+	}),
+	compatibilityFlags: ["nodejs_compat"],
+	devScript: "dev",
+	deployScript: "deploy",
+	previewScript: "preview",
+};
+export default config;

package/templates-experimental/solid/templates/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/index.js"
+assets = { directory = "./dist/public", 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