create-cloudflare 0.0.0-e7ea6005c → 0.0.0-e7fce2523

package/templates/svelte/c3.ts

@@ -1,131 +1,9 @@
-import { platform } from "node:os";
-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 { 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, PackageJson } from "types";
+import pages from "./pages/c3";
+import workers from "./workers/c3";
+import type { MultiPlatformTemplateConfig } from "../../src/templates";
 
-const { npm } = detectPackageManager();
-
-const generate = async (ctx: C3Context) => {
-	await runFrameworkGenerator(ctx, [ctx.project.name]);
-
-	logRaw("");
-};
-
-const configure = async (ctx: C3Context) => {
-	// Install the adapter
-	const pkg = `@sveltejs/adapter-cloudflare`;
-	await installPackages([pkg], {
-		dev: true,
-		startText: "Adding the Cloudflare Pages adapter",
-		doneText: `${brandColor(`installed`)} ${dim(pkg)}`,
-	});
-
-	updateSvelteConfig();
-	updateTypeDefinitions(ctx);
-};
-
-const updateSvelteConfig = () => {
-	// All we need to do is change the import statement in svelte.config.js
-	updateStatus(`Changing adapter in ${blue("svelte.config.js")}`);
-
-	transformFile("svelte.config.js", {
-		visitImportDeclaration: function (n) {
-			// importSource is the `x` in `import y from "x"`
-			const importSource = n.value.source;
-			if (importSource.value === "@sveltejs/adapter-auto") {
-				importSource.value = "@sveltejs/adapter-cloudflare";
-			}
-
-			// stop traversing this node
-			return false;
-		},
-	});
-};
-
-const updateTypeDefinitions = (ctx: C3Context) => {
-	if (!usesTypescript(ctx)) {
-		return;
-	}
-
-	updateStatus(`Updating global type definitions in ${blue("app.d.ts")}`);
-
-	const b = recast.types.builders;
-
-	transformFile("src/app.d.ts", {
-		visitTSModuleDeclaration(n) {
-			if (n.value.id.name === "App" && n.node.body) {
-				const moduleBlock = n.node
-					.body as recast.types.namedTypes.TSModuleBlock;
-
-				const platformInterface = b.tsInterfaceDeclaration(
-					b.identifier("Platform"),
-					b.tsInterfaceBody([
-						b.tsPropertySignature(
-							b.identifier("env"),
-							b.tsTypeAnnotation(b.tsTypeReference(b.identifier("Env"))),
-						),
-						b.tsPropertySignature(
-							b.identifier("cf"),
-							b.tsTypeAnnotation(
-								b.tsTypeReference(b.identifier("CfProperties")),
-							),
-						),
-						b.tsPropertySignature(
-							b.identifier("ctx"),
-							b.tsTypeAnnotation(
-								b.tsTypeReference(b.identifier("ExecutionContext")),
-							),
-						),
-					]),
-				);
-
-				moduleBlock.body.unshift(platformInterface);
-			}
-
-			this.traverse(n);
-		},
-	});
-};
-
-const config: TemplateConfig = {
-	configVersion: 1,
-	id: "svelte",
-	frameworkCli: "create-svelte",
-	displayName: "Svelte",
-	platform: "pages",
-	copyFiles: {
-		variants: {
-			js: { path: "./js" },
-			ts: { path: "./ts" },
-		},
-	},
-	generate,
-	configure,
-	transformPackageJson: async (original: PackageJson, ctx: C3Context) => {
-		let scripts: Record<string, string> = {
-			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,
-				"cf-typegen": `wrangler types && ${mv} worker-configuration.d.ts src/`,
-			};
-		}
-
-		return { scripts };
-	},
-	devScript: "dev",
-	deployScript: "deploy",
-	previewScript: "preview",
+const config: MultiPlatformTemplateConfig = {
+	displayName: "SvelteKit",
+	platformVariants: { pages, workers },
 };
 export default config;

package/templates/svelte/pages/c3.ts

@@ -0,0 +1,160 @@
+import { existsSync } from "node:fs";
+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 { 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, PackageJson } from "types";
+
+const { npm } = detectPackageManager();
+
+const generate = async (ctx: C3Context) => {
+	await runFrameworkGenerator(ctx, ["create", ctx.project.name]);
+
+	logRaw("");
+};
+
+const configure = async (ctx: C3Context) => {
+	// Install the adapter
+	const pkg = `@sveltejs/adapter-cloudflare`;
+	await installPackages([pkg], {
+		dev: true,
+		startText: "Adding the Cloudflare Pages adapter",
+		doneText: `${brandColor(`installed`)} ${dim(pkg)}`,
+	});
+
+	updateSvelteConfig();
+	updatePlaywrightConfig(usesTypescript(ctx));
+	updateTypeDefinitions(ctx);
+};
+
+const updateSvelteConfig = () => {
+	// All we need to do is change the import statement in svelte.config.js
+	updateStatus(`Changing adapter in ${blue("svelte.config.js")}`);
+
+	transformFile("svelte.config.js", {
+		visitImportDeclaration: function (n) {
+			// importSource is the `x` in `import y from "x"`
+			const importSource = n.value.source;
+			if (importSource.value === "@sveltejs/adapter-auto") {
+				importSource.value = "@sveltejs/adapter-cloudflare";
+			}
+
+			// stop traversing this node
+			return false;
+		},
+	});
+};
+
+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;
+	}
+
+	updateStatus(`Updating global type definitions in ${blue("app.d.ts")}`);
+
+	const b = recast.types.builders;
+
+	transformFile("src/app.d.ts", {
+		visitTSModuleDeclaration(n) {
+			if (n.value.id.name === "App" && n.node.body) {
+				const moduleBlock = n.node
+					.body as recast.types.namedTypes.TSModuleBlock;
+
+				const platformInterface = b.tsInterfaceDeclaration(
+					b.identifier("Platform"),
+					b.tsInterfaceBody([
+						b.tsPropertySignature(
+							b.identifier("env"),
+							b.tsTypeAnnotation(b.tsTypeReference(b.identifier("Env"))),
+						),
+						b.tsPropertySignature(
+							b.identifier("cf"),
+							b.tsTypeAnnotation(
+								b.tsTypeReference(b.identifier("CfProperties")),
+							),
+						),
+						b.tsPropertySignature(
+							b.identifier("ctx"),
+							b.tsTypeAnnotation(
+								b.tsTypeReference(b.identifier("ExecutionContext")),
+							),
+						),
+					]),
+				);
+
+				moduleBlock.body.unshift(platformInterface);
+			}
+
+			this.traverse(n);
+		},
+	});
+};
+
+const typesPath = "src/worker-configuration.d.ts";
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "svelte",
+	frameworkCli: "sv",
+	displayName: "SvelteKit",
+	platform: "pages",
+	hidden: true,
+	copyFiles: {
+		path: "./templates",
+	},
+	path: "templates/svelte/pages",
+	generate,
+	configure,
+	transformPackageJson: async (original: PackageJson, ctx: C3Context) => {
+		let scripts: Record<string, string> = {
+			preview: `${npm} run build && wrangler pages dev`,
+			deploy: `${npm} run build && wrangler pages deploy`,
+		};
+
+		if (usesTypescript(ctx)) {
+			scripts = {
+				...scripts,
+				"cf-typegen": `wrangler types ${typesPath}`,
+			};
+		}
+
+		return { scripts };
+	},
+	devScript: "dev",
+	deployScript: "deploy",
+	previewScript: "preview",
+	typesPath,
+};
+export default config;

package/templates/svelte/pages/templates/wrangler.jsonc

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

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

@@ -1,4 +1,3 @@
-import { platform } from "node:os";
 import { logRaw, updateStatus } from "@cloudflare/cli";
 import { blue, brandColor, dim } from "@cloudflare/cli/colors";
 import { runFrameworkGenerator } from "frameworks/index";
@@ -7,13 +6,13 @@ 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 { TemplateConfig } from "../../../src/templates";
 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("");
 };
@@ -23,7 +22,7 @@ const configure = async (ctx: C3Context) => {
 	const pkg = `@sveltejs/adapter-cloudflare`;
 	await installPackages([pkg], {
 		dev: true,
-		startText: "Adding the Cloudflare Pages adapter",
+		startText: "Adding the Cloudflare adapter",
 		doneText: `${brandColor(`installed`)} ${dim(pkg)}`,
 	});
 
@@ -94,19 +93,17 @@ const updateTypeDefinitions = (ctx: C3Context) => {
 	});
 };
 
+const typesPath = "./src/worker-configuration.d.ts";
 const config: TemplateConfig = {
 	configVersion: 1,
 	id: "svelte",
-	frameworkCli: "create-svelte",
-	displayName: "Svelte",
+	frameworkCli: "sv",
+	displayName: "SvelteKit",
 	platform: "workers",
 	copyFiles: {
-		variants: {
-			js: { path: "./js" },
-			ts: { path: "./ts" },
-		},
+		path: "./templates",
 	},
-	path: "templates-experimental/svelte",
+	path: "templates/svelte/workers",
 	generate,
 	configure,
 	transformPackageJson: async (original: PackageJson, ctx: C3Context) => {
@@ -116,10 +113,9 @@ const config: TemplateConfig = {
 		};
 
 		if (usesTypescript(ctx)) {
-			const mv = platform() === "win32" ? "move" : "mv";
 			scripts = {
 				...scripts,
-				"cf-typegen": `wrangler types && ${mv} worker-configuration.d.ts src/`,
+				"cf-typegen": `wrangler types ${typesPath}`,
 			};
 		}
 
@@ -128,5 +124,6 @@ const config: TemplateConfig = {
 	devScript: "dev",
 	deployScript: "deploy",
 	previewScript: "preview",
+	typesPath,
 };
 export default config;

package/templates/svelte/workers/templates/static/.assetsignore

@@ -0,0 +1,2 @@
+_worker.js
+_routes.json

package/templates/svelte/workers/templates/wrangler.jsonc

@@ -0,0 +1,12 @@
+{
+  "name": "<TBD>",
+  "main": ".svelte-kit/cloudflare/_worker.js",
+  "compatibility_date": "<TBD>",
+  "assets": {
+    "binding": "ASSETS",
+    "directory": ".svelte-kit/cloudflare"
+  },
+  "observability": {
+    "enabled": true
+  }
+}

package/templates/vue/c3.ts

@@ -1,29 +1,9 @@
-import { runFrameworkGenerator } from "frameworks/index";
-import { detectPackageManager } from "helpers/packageManagers";
-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 } = detectPackageManager();
-
-const generate = async (ctx: C3Context) => {
-	await runFrameworkGenerator(ctx, [ctx.project.name]);
-};
-
-const config: TemplateConfig = {
-	configVersion: 1,
-	id: "vue",
-	frameworkCli: "create-vue",
+const config: MultiPlatformTemplateConfig = {
 	displayName: "Vue",
-	platform: "pages",
-	generate,
-	transformPackageJson: async () => ({
-		scripts: {
-			deploy: `${npm} run build && wrangler pages deploy ./dist`,
-			preview: `${npm} run build && wrangler pages dev ./dist`,
-		},
-	}),
-	devScript: "dev",
-	deployScript: "deploy",
-	previewScript: "preview",
+	platformVariants: { pages, workers },
 };
 export default config;

package/templates/vue/pages/c3.ts

@@ -0,0 +1,33 @@
+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]);
+};
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "vue",
+	frameworkCli: "create-vue",
+	displayName: "Vue",
+	platform: "pages",
+	hidden: true,
+	path: "templates/vue/pages",
+	copyFiles: { path: "./templates" },
+	generate,
+	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/vue/pages/templates/wrangler.jsonc

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

package/templates/vue/workers/c3.ts

@@ -0,0 +1,98 @@
+import { logRaw } from "@cloudflare/cli";
+import { brandColor, dim } from "@cloudflare/cli/colors";
+import { inputPrompt, spinner } from "@cloudflare/cli/interactive";
+import { runFrameworkGenerator } from "frameworks/index";
+import { readJSON, usesTypescript, writeJSON } 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) => {
+	const lang =
+		ctx.args.lang ??
+		(await inputPrompt({
+			type: "select",
+			question: "Would you like to use TypeScript?",
+			label: "Language",
+			options: [
+				{ label: "TypeScript", value: "ts" },
+				{ label: "JavaScript", value: "js" },
+			],
+		}));
+	await runFrameworkGenerator(ctx, [
+		ctx.project.name,
+		"--router",
+		lang === "ts" ? "--ts" : "",
+	]);
+	logRaw("");
+};
+
+const configure = async (ctx: C3Context) => {
+	await installPackages(["@cloudflare/vite-plugin"], {
+		dev: true,
+		startText: "Installing the Cloudflare Vite plugin",
+		doneText: `${brandColor(`installed`)} ${dim("@cloudflare/vite-plugin")}`,
+	});
+
+	if (usesTypescript(ctx)) {
+		updateTsconfigJson();
+	}
+};
+
+function updateTsconfigJson() {
+	const s = spinner();
+	s.start(`Updating tsconfig.json config`);
+	// Add a reference to the extra tsconfig.worker.json file.
+	// ```
+	// "references": [ ..., { path: "./tsconfig.worker.json" } ]
+	// ```
+	const tsconfig = readJSON("tsconfig.json") as { references: object[] };
+	if (tsconfig && typeof tsconfig === "object") {
+		tsconfig.references ??= [];
+		tsconfig.references.push({ path: "./tsconfig.worker.json" });
+	}
+	writeJSON("tsconfig.json", tsconfig);
+	s.stop(`${brandColor(`updated`)} ${dim(`\`tsconfig.json\``)}`);
+}
+
+const config: TemplateConfig = {
+	configVersion: 1,
+	id: "vue",
+	frameworkCli: "create-vue",
+	platform: "workers",
+	displayName: "Vue",
+	path: "templates/vue/workers",
+	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: {
+			ts: {
+				path: "./ts",
+			},
+			js: {
+				path: "./js",
+			},
+		},
+	},
+	configure,
+	generate,
+	transformPackageJson: async (_, ctx) => ({
+		scripts: {
+			deploy: `${npm} run build && wrangler deploy`,
+			preview: `${npm} run build && wrangler dev`,
+			...(usesTypescript(ctx) && { "cf-typegen": `wrangler types` }),
+		},
+	}),
+	devScript: "dev",
+	deployScript: "deploy",
+	previewScript: "preview",
+};
+export default config;

package/templates/vue/workers/js/server/index.js

@@ -0,0 +1,13 @@
+export default {
+	fetch(request) {
+		const url = new URL(request.url);
+
+		if (url.pathname.startsWith("/api/")) {
+			return Response.json({
+				name: "Cloudflare",
+			});
+		}
+
+		return new Response(null, { status: 404 });
+	},
+};

package/templates/vue/workers/js/src/App.vue

@@ -0,0 +1,107 @@
+<script setup>
+import { RouterLink, RouterView } from 'vue-router'
+import HelloWorld from './components/HelloWorld.vue'
+import { ref } from 'vue'
+
+const name = ref('Unknown')
+
+const getName = async () => {
+  const res = await fetch('/api/')
+  const data = await res.json()
+  name.value = data.name
+}
+</script>
+
+<template>
+  <header>
+    <img alt="Vue logo" class="logo" src="@/assets/logo.svg" width="125" height="125" />
+
+    <div class="wrapper">
+      <HelloWorld msg="You did it!" />
+      <button class="green" @click="getName" aria-label="get name">
+        Name from API is: {{ name }}
+      </button>
+      <p>Edit <code>server/index.js</code> to change what the API gets</p>
+      <nav>
+        <RouterLink to="/">Home</RouterLink>
+        <RouterLink to="/about">About</RouterLink>
+      </nav>
+    </div>
+  </header>
+
+  <RouterView />
+</template>
+
+<style scoped>
+header {
+  line-height: 1.5;
+  max-height: 100vh;
+}
+
+.logo {
+  display: block;
+  margin: 0 auto 2rem;
+}
+
+nav {
+  width: 100%;
+  font-size: 12px;
+  text-align: center;
+  margin-top: 2rem;
+}
+
+nav a.router-link-exact-active {
+  color: var(--color-text);
+}
+
+nav a.router-link-exact-active:hover {
+  background-color: transparent;
+}
+
+nav a {
+  display: inline-block;
+  padding: 0 1rem;
+  border-left: 1px solid var(--color-border);
+}
+
+nav a:first-of-type {
+  border: 0;
+}
+
+button {
+  background-color: hsla(160, 100%, 37%, 1);
+  color: var(--color-background);
+  border: 0;
+  padding: 0.5rem 1rem;
+  border-radius: 0.25rem;
+  cursor: pointer;
+  margin: 1rem 0 0.5rem 0;
+}
+
+@media (min-width: 1024px) {
+  header {
+    display: flex;
+    place-items: center;
+    padding-right: calc(var(--section-gap) / 2);
+  }
+
+  .logo {
+    margin: 0 2rem 0 0;
+  }
+
+  header .wrapper {
+    display: flex;
+    place-items: flex-start;
+    flex-wrap: wrap;
+  }
+
+  nav {
+    text-align: left;
+    margin-left: -1rem;
+    font-size: 1rem;
+
+    padding: 1rem 0;
+    margin-top: 1rem;
+  }
+}
+</style>