add vite + worker to vue experimental template (#8358)

* add worker to vue template

* add flags

* changeset

* fix js template

* Update tangy-parts-dig.md

* fix tests

* pr feedback

* fix test

Author: emily-shen

.changeset/tangy-parts-dig.md

@@ -0,0 +1,5 @@
+---
+"create-cloudflare": patch
+---
+
+feat: add Worker + Vite plugin to Vue experimental template

packages/create-cloudflare/e2e-tests/frameworks/framework-test-config-experimental.ts

@@ -203,17 +203,18 @@ export default function getFrameworkTestConfigExperimental() {
 			},
 		},
 		vue: {
+			argv: ["--ts"],
 			testCommitMessage: true,
 			unsupportedOSs: ["win32"],
 			verifyDeploy: {
 				route: "/",
 				expectedText: "Vite App",
 			},
 			verifyPreview: {
+				previewArgs: ["--host=127.0.0.1"],
 				route: "/",
 				expectedText: "Vite App",
 			},
-			flags: ["--ts"],
 		},
 	};
 }

packages/create-cloudflare/templates-experimental/vue/c3.ts

@@ -1,29 +1,94 @@
+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) => {
-	await runFrameworkGenerator(ctx, [ctx.project.name]);
+	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-experimental/vue",
 	copyFiles: {
-		path: "./templates",
+		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",
+			},
+		},
 	},
-	path: "templates-experimental/vue",
+	configure,
 	generate,
-	transformPackageJson: async () => ({
+	transformPackageJson: async (_, ctx) => ({
 		scripts: {
 			deploy: `${npm} run build && wrangler deploy`,
 			preview: `${npm} run build && wrangler dev`,
+			...(usesTypescript(ctx) && { "cf-typegen": `wrangler types` }),
 		},
 	}),
 	devScript: "dev",

packages/create-cloudflare/templates-experimental/vue/js/server/index.js

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

packages/create-cloudflare/templates-experimental/vue/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>

packages/create-cloudflare/templates-experimental/vue/js/src/components/HelloWorld.vue

@@ -0,0 +1,47 @@
+<script setup>
+defineProps({
+  msg: {
+    type: String,
+    required: true,
+  },
+})
+</script>
+
+<template>
+  <div class="greetings">
+    <h1 class="green">{{ msg }}</h1>
+    <h3>
+      You’ve successfully created a project with
+      <a href="https://vite.dev/" target="_blank" rel="noopener">Vite</a> +
+      <a href="https://vuejs.org/" target="_blank" rel="noopener">Vue 3</a> +
+      <a href="https://developers.cloudflare.com/workers/" target="_blank" rel="noopener"
+        >Cloudflare Workers</a
+      >. What's next?
+    </h3>
+  </div>
+</template>
+
+<style scoped>
+h1 {
+  font-weight: 500;
+  font-size: 2.6rem;
+  position: relative;
+  top: -10px;
+}
+
+h3 {
+  font-size: 1.2rem;
+}
+
+.greetings h1,
+.greetings h3 {
+  text-align: center;
+}
+
+@media (min-width: 1024px) {
+  .greetings h1,
+  .greetings h3 {
+    text-align: left;
+  }
+}
+</style>

packages/create-cloudflare/templates-experimental/vue/js/vite.config.js

@@ -0,0 +1,21 @@
+import { fileURLToPath, URL } from 'node:url'
+
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import vueDevTools from 'vite-plugin-vue-devtools'
+
+import { cloudflare } from "@cloudflare/vite-plugin"
+
+// https://vite.dev/config/
+export default defineConfig({
+	plugins: [
+		vue(),
+		vueDevTools(),
+		cloudflare()
+	],
+	resolve: {
+		alias: {
+			'@': fileURLToPath(new URL('./src', import.meta.url))
+		},
+	},
+})

packages/create-cloudflare/templates-experimental/vue/js/wrangler.jsonc

@@ -0,0 +1,12 @@
+{
+	"name": "<TBD>",
+	"compatibility_date": "<TBD>",
+	"main": "server/index.ts",
+	"assets": {
+		"not_found_handling": "single-page-application",
+		"binding": "ASSETS"
+	},
+	"observability": {
+		"enabled": true
+	}
+}

packages/create-cloudflare/templates-experimental/vue/templates/wrangler.jsonc

@@ -0,0 +1,13 @@
+export default {
+	fetch(request, env) {
+		const url = new URL(request.url);
+
+		if (url.pathname.startsWith("/api/")) {
+			return Response.json({
+				name: "Cloudflare",
+			});
+		}
+
+		return env.ASSETS.fetch(request);
+	},
+} satisfies ExportedHandler<Env>;