Make assets field optional in the Worker config when using assets (#8545)

jamesopstad · web-flow · commit aadb49c5cda8 · 2025-03-20T00:26:54.000Z
diff --git a/.changeset/quiet-wombats-lead.md b/.changeset/quiet-wombats-lead.md
@@ -0,0 +1,5 @@
+---
+"@cloudflare/vite-plugin": patch
+---
+
+Make `assets` field optional in the Worker config when using assets. At build time, assets are included if there is a client build.
diff --git a/packages/vite-plugin-cloudflare/playground/react-spa/src/vite-env.d.ts b/packages/vite-plugin-cloudflare/playground/react-spa/src/vite-env.d.ts
diff --git a/packages/vite-plugin-cloudflare/playground/spa-with-api/src/vite-env.d.ts b/packages/vite-plugin-cloudflare/playground/spa-with-api/src/vite-env.d.ts
diff --git a/packages/vite-plugin-cloudflare/playground/static/__tests__/static.spec.ts b/packages/vite-plugin-cloudflare/playground/static/__tests__/static.spec.ts
@@ -0,0 +1,7 @@
+import { expect, test } from "vitest";
+import { page } from "../../__test-utils__";
+
+test("returns the correct home page", async () => {
+	const content = await page.textContent("h1");
+	expect(content).toBe("Vite + TypeScript");
+});
diff --git a/packages/vite-plugin-cloudflare/playground/static/__tests__/with-api/static.spec.ts b/packages/vite-plugin-cloudflare/playground/static/__tests__/with-api/static.spec.ts
@@ -0,0 +1,12 @@
+import { expect, test } from "vitest";
+import { getJsonResponse, page } from "../../../__test-utils__";
+
+test("returns the correct home page", async () => {
+	const content = await page.textContent("h1");
+	expect(content).toBe("Vite + TypeScript");
+});
+
+test("returns the correct response from the API", async () => {
+	const result = await getJsonResponse("/api/");
+	expect(result).toEqual({ name: "Cloudflare" });
+});
diff --git a/packages/vite-plugin-cloudflare/playground/static/api/index.ts b/packages/vite-plugin-cloudflare/playground/static/api/index.ts
@@ -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 new Response(null, { status: 404 });
+	},
+} satisfies ExportedHandler;
diff --git a/packages/vite-plugin-cloudflare/playground/static/index.html b/packages/vite-plugin-cloudflare/playground/static/index.html
@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<link rel="icon" type="image/svg+xml" href="/vite.svg" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<title>Vite + TS</title>
+	</head>
+	<body>
+		<div id="app"></div>
+		<script type="module" src="/src/main.ts"></script>
+	</body>
+</html>
diff --git a/packages/vite-plugin-cloudflare/playground/static/package.json b/packages/vite-plugin-cloudflare/playground/static/package.json
@@ -0,0 +1,22 @@
+{
+	"name": "@playground/static",
+	"private": true,
+	"type": "module",
+	"scripts": {
+		"build": "vite build --app",
+		"build:with-api": "vite build --app -c vite.config.with-api.ts",
+		"check:types": "tsc --build",
+		"dev": "vite dev",
+		"dev:with-api": "vite dev -c vite.config.with-api.ts",
+		"preview": "vite preview",
+		"preview:with-api": "vite preview -c vite.config.with-api.ts"
+	},
+	"devDependencies": {
+		"@cloudflare/vite-plugin": "workspace:*",
+		"@cloudflare/workers-tsconfig": "workspace:*",
+		"@cloudflare/workers-types": "^4.20250317.0",
+		"typescript": "catalog:default",
+		"vite": "catalog:vite-plugin",
+		"wrangler": "workspace:*"
+	}
+}
diff --git a/packages/vite-plugin-cloudflare/playground/static/public/vite.svg b/packages/vite-plugin-cloudflare/playground/static/public/vite.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>
diff --git a/packages/vite-plugin-cloudflare/playground/static/src/counter.ts b/packages/vite-plugin-cloudflare/playground/static/src/counter.ts
@@ -0,0 +1,9 @@
+export function setupCounter(element: HTMLButtonElement) {
+	let counter = 0;
+	const setCounter = (count: number) => {
+		counter = count;
+		element.innerHTML = `count is ${counter}`;
+	};
+	element.addEventListener("click", () => setCounter(counter + 1));
+	setCounter(0);
+}
diff --git a/packages/vite-plugin-cloudflare/playground/static/src/main.ts b/packages/vite-plugin-cloudflare/playground/static/src/main.ts
@@ -0,0 +1,24 @@
+import "./style.css";
+import viteLogo from "/vite.svg";
+import { setupCounter } from "./counter";
+import typescriptLogo from "./typescript.svg";
+
+document.querySelector<HTMLDivElement>("#app")!.innerHTML = `
+  <div>
+    <a href="https://vite.dev" target="_blank">
+      <img src="${viteLogo}" class="logo" alt="Vite logo" />
+    </a>
+    <a href="https://www.typescriptlang.org/" target="_blank">
+      <img src="${typescriptLogo}" class="logo vanilla" alt="TypeScript logo" />
+    </a>
+    <h1>Vite + TypeScript</h1>
+    <div class="card">
+      <button id="counter" type="button"></button>
+    </div>
+    <p class="read-the-docs">
+      Click on the Vite and TypeScript logos to learn more
+    </p>
+  </div>
+`;
+
+setupCounter(document.querySelector<HTMLButtonElement>("#counter")!);
diff --git a/packages/vite-plugin-cloudflare/playground/static/src/style.css b/packages/vite-plugin-cloudflare/playground/static/src/style.css
@@ -0,0 +1,96 @@
+:root {
+	font-family: system-ui, Avenir, Helvetica, Arial, sans-serif;
+	line-height: 1.5;
+	font-weight: 400;
+
+	color-scheme: light dark;
+	color: rgba(255, 255, 255, 0.87);
+	background-color: #242424;
+
+	font-synthesis: none;
+	text-rendering: optimizeLegibility;
+	-webkit-font-smoothing: antialiased;
+	-moz-osx-font-smoothing: grayscale;
+}
+
+a {
+	font-weight: 500;
+	color: #646cff;
+	text-decoration: inherit;
+}
+a:hover {
+	color: #535bf2;
+}
+
+body {
+	margin: 0;
+	display: flex;
+	place-items: center;
+	min-width: 320px;
+	min-height: 100vh;
+}
+
+h1 {
+	font-size: 3.2em;
+	line-height: 1.1;
+}
+
+#app {
+	max-width: 1280px;
+	margin: 0 auto;
+	padding: 2rem;
+	text-align: center;
+}
+
+.logo {
+	height: 6em;
+	padding: 1.5em;
+	will-change: filter;
+	transition: filter 300ms;
+}
+.logo:hover {
+	filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.vanilla:hover {
+	filter: drop-shadow(0 0 2em #3178c6aa);
+}
+
+.card {
+	padding: 2em;
+}
+
+.read-the-docs {
+	color: #888;
+}
+
+button {
+	border-radius: 8px;
+	border: 1px solid transparent;
+	padding: 0.6em 1.2em;
+	font-size: 1em;
+	font-weight: 500;
+	font-family: inherit;
+	background-color: #1a1a1a;
+	cursor: pointer;
+	transition: border-color 0.25s;
+}
+button:hover {
+	border-color: #646cff;
+}
+button:focus,
+button:focus-visible {
+	outline: 4px auto -webkit-focus-ring-color;
+}
+
+@media (prefers-color-scheme: light) {
+	:root {
+		color: #213547;
+		background-color: #ffffff;
+	}
+	a:hover {
+		color: #747bff;
+	}
+	button {
+		background-color: #f9f9f9;
+	}
+}
diff --git a/packages/vite-plugin-cloudflare/playground/static/src/typescript.svg b/packages/vite-plugin-cloudflare/playground/static/src/typescript.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="32" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path fill="#007ACC" d="M0 128v128h256V0H0z"></path><path fill="#FFF" d="m56.612 128.85l-.081 10.483h33.32v94.68h23.568v-94.68h33.321v-10.28c0-5.69-.122-10.444-.284-10.566c-.122-.162-20.4-.244-44.983-.203l-44.74.122l-.121 10.443Zm149.955-10.742c6.501 1.625 11.459 4.51 16.01 9.224c2.357 2.52 5.851 7.111 6.136 8.208c.08.325-11.053 7.802-17.798 11.988c-.244.162-1.22-.894-2.317-2.52c-3.291-4.795-6.745-6.867-12.028-7.233c-7.76-.528-12.759 3.535-12.718 10.321c0 1.992.284 3.17 1.097 4.795c1.707 3.536 4.876 5.649 14.832 9.956c18.326 7.883 26.168 13.084 31.045 20.48c5.445 8.249 6.664 21.415 2.966 31.208c-4.063 10.646-14.14 17.879-28.323 20.276c-4.388.772-14.79.65-19.504-.203c-10.28-1.828-20.033-6.908-26.047-13.572c-2.357-2.6-6.949-9.387-6.664-9.874c.122-.163 1.178-.813 2.356-1.504c1.138-.65 5.446-3.129 9.509-5.485l7.355-4.267l1.544 2.276c2.154 3.29 6.867 7.801 9.712 9.305c8.167 4.307 19.383 3.698 24.909-1.26c2.357-2.153 3.332-4.388 3.332-7.68c0-2.966-.366-4.266-1.91-6.501c-1.99-2.845-6.054-5.242-17.595-10.24c-13.206-5.69-18.895-9.224-24.096-14.832c-3.007-3.25-5.852-8.452-7.03-12.8c-.975-3.617-1.22-12.678-.447-16.335c2.723-12.76 12.353-21.659 26.25-24.3c4.51-.853 14.994-.528 19.424.569Z"></path></svg>
diff --git a/packages/vite-plugin-cloudflare/playground/static/tsconfig.client.json b/packages/vite-plugin-cloudflare/playground/static/tsconfig.client.json
@@ -0,0 +1,4 @@
+{
+	"extends": ["@cloudflare/workers-tsconfig/client.json"],
+	"include": ["src"]
+}
diff --git a/packages/vite-plugin-cloudflare/playground/static/tsconfig.json b/packages/vite-plugin-cloudflare/playground/static/tsconfig.json
@@ -0,0 +1,8 @@
+{
+	"files": [],
+	"references": [
+		{ "path": "./tsconfig.node.json" },
+		{ "path": "./tsconfig.client.json" },
+		{ "path": "./tsconfig.worker.json" }
+	]
+}
diff --git a/packages/vite-plugin-cloudflare/playground/static/tsconfig.node.json b/packages/vite-plugin-cloudflare/playground/static/tsconfig.node.json
@@ -0,0 +1,4 @@
+{
+	"extends": ["@cloudflare/workers-tsconfig/base.json"],
+	"include": ["vite.config.ts", "__tests__"]
+}
diff --git a/packages/vite-plugin-cloudflare/playground/static/tsconfig.worker.json b/packages/vite-plugin-cloudflare/playground/static/tsconfig.worker.json
@@ -0,0 +1,4 @@
+{
+	"extends": ["@cloudflare/workers-tsconfig/worker.json"],
+	"include": ["api"]
+}
diff --git a/packages/vite-plugin-cloudflare/playground/static/turbo.json b/packages/vite-plugin-cloudflare/playground/static/turbo.json
@@ -0,0 +1,9 @@
+{
+	"$schema": "http://turbo.build/schema.json",
+	"extends": ["//"],
+	"tasks": {
+		"build": {
+			"outputs": ["dist/**"]
+		}
+	}
+}
diff --git a/packages/vite-plugin-cloudflare/playground/static/vite.config.ts b/packages/vite-plugin-cloudflare/playground/static/vite.config.ts
@@ -0,0 +1,6 @@
+import { cloudflare } from "@cloudflare/vite-plugin";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+	plugins: [cloudflare({ persistState: false })],
+});
diff --git a/packages/vite-plugin-cloudflare/playground/static/vite.config.with-api.ts b/packages/vite-plugin-cloudflare/playground/static/vite.config.with-api.ts
@@ -0,0 +1,8 @@
+import { cloudflare } from "@cloudflare/vite-plugin";
+import { defineConfig } from "vite";
+
+export default defineConfig({
+	plugins: [
+		cloudflare({ configPath: "./wrangler.with-api.toml", persistState: false }),
+	],
+});
diff --git a/packages/vite-plugin-cloudflare/playground/static/wrangler.toml b/packages/vite-plugin-cloudflare/playground/static/wrangler.toml
@@ -0,0 +1,2 @@
+name = "static"
+compatibility_date = "2024-12-30"
diff --git a/packages/vite-plugin-cloudflare/playground/static/wrangler.with-api.toml b/packages/vite-plugin-cloudflare/playground/static/wrangler.with-api.toml
@@ -0,0 +1,3 @@
+name = "static-with-api"
+compatibility_date = "2024-12-30"
+main = './api/index.ts'
diff --git a/packages/vite-plugin-cloudflare/src/dev.ts b/packages/vite-plugin-cloudflare/src/dev.ts
diff --git a/packages/vite-plugin-cloudflare/src/index.ts b/packages/vite-plugin-cloudflare/src/index.ts
diff --git a/packages/vite-plugin-cloudflare/src/plugin-config.ts b/packages/vite-plugin-cloudflare/src/plugin-config.ts
diff --git a/packages/vite-plugin-cloudflare/src/utils.ts b/packages/vite-plugin-cloudflare/src/utils.ts
diff --git a/packages/vite-plugin-cloudflare/src/workers-configs.ts b/packages/vite-plugin-cloudflare/src/workers-configs.ts
diff --git a/packages/workers-tsconfig/client.json b/packages/workers-tsconfig/client.json
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@cloudflare/vite-plugin": patch
 +---
++
 +Make `assets` field optional in the Worker config when using assets. At build time, assets are included if there is a client build.