Skip to content

[C3] Enable source maps in Worker starter templates #16195

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
irvinebroque wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

[C3] Enable source maps in Worker starter templates #16195

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09ed684
feat: enable Worker source maps by default
irvinebroque Oct 10, 2026
bade207
[C3] Limit source map changes to starter templates
irvinebroque Oct 10, 2026
15a5098
[C3] Trim source map coverage to the config regression
irvinebroque Oct 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/source-maps-starters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
"create-cloudflare": patch
---

Enable source maps in JavaScript and TypeScript Worker starter templates

New Worker starters explicitly enable source map uploads so production stack traces and profiles can resolve to original source. Cloudflare Vite starters also explicitly generate external maps for their Worker environments, without enabling browser source maps.

Preserve explicit source map upload opt-outs when updating a generated Wrangler configuration. Existing Wrangler and Vite plugin defaults are unchanged; custom build tools must still emit external maps for Wrangler to upload.
16 changes: 16 additions & 0 deletions packages/create-cloudflare/src/wrangler/__tests__/config.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,22 @@ describe("update wrangler config", () => {
);
});

test("preserves an explicit source map opt-out in JSON config", async ({
expect,
}) => {
vi.mocked(existsSync).mockImplementation((file) =>
String(file).endsWith(".jsonc")
);
vi.mocked(readFile).mockReturnValue(
'{"main":"src/index.ts","upload_source_maps":false}'
);
await updateWranglerConfig(ctx);
const output = vi
.mocked(writeFile)
.mock.calls.find(([file]) => String(file).endsWith(".jsonc"));
expect(output?.[1]).toContain('"upload_source_maps": false');
});

test("placeholder replacement `<TBD>`", async ({ expect }) => {
const toml = [
`name = "<TBD>"`,
Expand Down
2 changes: 1 addition & 1 deletion packages/create-cloudflare/src/wrangler/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ export const updateWranglerConfig = async (ctx: C3Context) => {
wranglerJson = appendJSONProperty(
wranglerJson,
"upload_source_maps",
true
wranglerJson.upload_source_maps ?? true
);
wranglerJson = applyNodejsCompatFlags(wranglerJson, compatibilityDate);
}
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/analog/templates/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"name": "<WORKER_NAME>",
"compatibility_date": "<COMPATIBILITY_DATE>",
"main": "dist/analog/server/index.mjs",
"upload_source_maps": true,
"assets": {
"binding": "ASSETS",
"directory": "dist/analog/public",
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/angular/workers/templates/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "./dist/server/server.mjs",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"assets": {
"binding": "ASSETS",
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/common/js/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.js",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"observability": {
"enabled": true
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/common/ts/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.ts",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"observability": {
"enabled": true
Expand Down
1 change: 1 addition & 0 deletions ...ages/create-cloudflare/templates/hello-world-durable-object-with-assets/js/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.js",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"assets": {
// The path to the directory containing the `index.html` file to be served at `/`
Expand Down
1 change: 1 addition & 0 deletions ...ages/create-cloudflare/templates/hello-world-durable-object-with-assets/ts/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.ts",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"migrations": [
{
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/hello-world-durable-object/js/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.js",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"migrations": [
{
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/hello-world-durable-object/ts/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.ts",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"migrations": [
{
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/hello-world-with-assets/js/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.js",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"compatibility_flags": [
"global_fetch_strictly_public"
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/hello-world-with-assets/ts/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.ts",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"compatibility_flags": [
"global_fetch_strictly_public"
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/hello-world-workflows/js/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.js",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",

"observability": {
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/hello-world-workflows/ts/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.ts",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",

"observability": {
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/hello-world/js/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.js",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"observability": {
"enabled": true,
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/hello-world/ts/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.ts",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"observability": {
"enabled": true,
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/hono/workers/templates/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.ts",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"assets": {
"binding": "ASSETS",
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/nuxt/workers/templates/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "./.output/server/index.mjs",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"assets": {
"binding": "ASSETS",
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/openapi/ts/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.ts",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"observability": {
"enabled": true
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/queues/js/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.js",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"observability": {
"enabled": true
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/queues/ts/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.ts",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"observability": {
"enabled": true
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/qwik/workers/templates/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "./dist/_worker.js",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"compatibility_flags": [
"global_fetch_strictly_public"
Expand Down
3 changes: 3 additions & 0 deletions packages/create-cloudflare/templates/react-router/ts/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ export default defineConfig({
tailwindcss(),
reactRouter(),
],
environments: {
ssr: { build: { sourcemap: true } },
},
resolve: {
tsconfigPaths: true,
},
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/react-router/ts/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"name": "<WORKER_NAME>",
"compatibility_date": "<COMPATIBILITY_DATE>",
"main": "./workers/app.ts",
"upload_source_maps": true,
"vars": {
"VALUE_FROM_CLOUDFLARE": "Hello from Cloudflare"
}
Expand Down
44 changes: 41 additions & 3 deletions packages/create-cloudflare/templates/react/workers/c3.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,10 @@ import {
inputPrompt,
spinner,
} from "@cloudflare/cli-shared-helpers/interactive";
import { transformFile } from "@cloudflare/shared-ast-primitives";
import {
mergeObjectProperties,
transformFile,
} from "@cloudflare/shared-ast-primitives";
import { runFrameworkGenerator } from "frameworks/index";
import { readJSON, usesTypescript, writeJSON } from "helpers/files";
import { detectPackageManager } from "helpers/packageManagers";
Expand Down Expand Up @@ -72,7 +75,8 @@ function transformViteConfig(ctx: C3Context) {
// Add the imported plugin to the config
// ```
// defineConfig({
// plugins: [react(), cloudflare()],
// plugins: [react(), cloudflare({ viteEnvironment: { name: "worker" } })],
// environments: { worker: { build: { sourcemap: true } } },
// });
const callee = n.node.callee as types.namedTypes.Identifier;
if (callee.name !== "defineConfig") {
Expand All @@ -84,9 +88,43 @@ function transformViteConfig(ctx: C3Context) {
const pluginsProp = config.properties.find((prop) => isPluginsProp(prop));
assert(pluginsProp && t.ArrayExpression.check(pluginsProp.value));
pluginsProp.value.elements.push(
b.callExpression(b.identifier("cloudflare"), [])
b.callExpression(b.identifier("cloudflare"), [
b.objectExpression([
b.objectProperty(
b.identifier("viteEnvironment"),
b.objectExpression([
b.objectProperty(
b.identifier("name"),
b.stringLiteral("worker")
),
])
),
]),
])
);

mergeObjectProperties(config, [
b.objectProperty(
b.identifier("environments"),
b.objectExpression([
b.objectProperty(
b.identifier("worker"),
b.objectExpression([
b.objectProperty(
b.identifier("build"),
b.objectExpression([
b.objectProperty(
b.identifier("sourcemap"),
b.booleanLiteral(true)
),
])
),
])
),
])
),
]);

return false;
},
});
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/react/workers/js/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "worker/index.js",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"assets": { "not_found_handling": "single-page-application" },
"observability": {
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/react/workers/ts/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "worker/index.ts",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"assets": { "not_found_handling": "single-page-application" },
"observability": {
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/scheduled/js/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.js",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"observability": {
"enabled": true
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/scheduled/ts/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": "src/index.ts",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"observability": {
"enabled": true
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/solid/templates/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"compatibility_date": "<COMPATIBILITY_DATE>",
"upload_source_maps": true,
"observability": {
"enabled": true
}
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/svelte/workers/templates/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"name": "<WORKER_NAME>",
"main": ".svelte-kit/cloudflare/_worker.js",
"upload_source_maps": true,
"compatibility_date": "<COMPATIBILITY_DATE>",
"compatibility_flags": ["nodejs_als"],
"assets": {
Expand Down
5 changes: 4 additions & 1 deletion packages/create-cloudflare/templates/vue/workers/js/vite.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ export default defineConfig({
plugins: [
vue(),
vueDevTools(),
cloudflare()
cloudflare({ viteEnvironment: { name: "worker" } })
],
environments: {
worker: { build: { sourcemap: true } },
},
resolve: {
alias: {
'@': fileURLToPath(new URL('./src', import.meta.url))
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/vue/workers/js/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"name": "<WORKER_NAME>",
"compatibility_date": "<COMPATIBILITY_DATE>",
"main": "server/index.js",
"upload_source_maps": true,
"assets": {
"not_found_handling": "single-page-application",
},
Expand Down
5 changes: 4 additions & 1 deletion packages/create-cloudflare/templates/vue/workers/ts/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,11 @@ export default defineConfig({
plugins: [
vue(),
vueDevTools(),
cloudflare()
cloudflare({ viteEnvironment: { name: "worker" } })
],
environments: {
worker: { build: { sourcemap: true } },
},
resolve: {
alias: {
'@': fileURLToPath(new URL('./src', import.meta.url))
Expand Down
1 change: 1 addition & 0 deletions packages/create-cloudflare/templates/vue/workers/ts/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"name": "<WORKER_NAME>",
"compatibility_date": "<COMPATIBILITY_DATE>",
"main": "server/index.ts",
"upload_source_maps": true,
"assets": {
"not_found_handling": "single-page-application",
},
Expand Down
2 changes: 2 additions & 0 deletions packages/create-cloudflare/templates/waku/templates/waku.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ export default defineConfig({
include: ['hono/tiny'],
},
build: {
sourcemap: true,
rolldownOptions: {
platform: 'neutral',
},
Expand All @@ -22,6 +23,7 @@ export default defineConfig({
include: ['waku > rsc-html-stream/server'],
},
build: {
sourcemap: true,
rolldownOptions: {
platform: 'neutral',
},
Expand Down
Loading
Loading