output wrangler.jsonc in c3 #8024

emily-shen · 2025-02-04T14:37:58Z

Fixes #7948
Fixes #8030

Generates wrangler.jsonc instead of wrangler.json, which supports comments
Add a vscode setting that lets vscode know that wrangler.json can have comments
use tabs in wrangler.jsonc

Tests
- TODO (before merge)
- Tests included
- Tests not necessary because:
E2E Tests CI Job required? (Use "e2e" label or ask maintainer to run separately)
- I don't know
- Required
- Not required because: no wrangler changes. (c3 tests will run without this being ticked)
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s): [wrangler] replace mentions of wrangler.json with wrangler.json(c) cloudflare-docs#19764
- Documentation not necessary because:

changeset-bot · 2025-02-04T14:38:03Z

🦋 Changeset detected

Latest commit: 320847d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
create-cloudflare	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2025-02-04T14:46:06Z

A wrangler prerelease is available for testing. You can install this latest build in your project with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-wrangler-8024

You can reference the automatically updated head of this PR with:

npm install --save-dev https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/prs/8024/npm-package-wrangler-8024

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-wrangler-8024 dev path/to/script.js

Additional artifacts:

cloudflare-workers-bindings-extension:

wget https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-cloudflare-workers-bindings-extension-8024 -O ./cloudflare-workers-bindings-extension.0.0.0-v40878168e.vsix && code --install-extension ./cloudflare-workers-bindings-extension.0.0.0-v40878168e.vsix

create-cloudflare:

npx https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-create-cloudflare-8024 --no-auto-update

@cloudflare/kv-asset-handler:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-cloudflare-kv-asset-handler-8024

miniflare:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-miniflare-8024

@cloudflare/pages-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-cloudflare-pages-shared-8024

@cloudflare/unenv-preset:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-cloudflare-unenv-preset-8024

@cloudflare/vite-plugin:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-cloudflare-vite-plugin-8024

@cloudflare/vitest-pool-workers:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-cloudflare-vitest-pool-workers-8024

@cloudflare/workers-editor-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-cloudflare-workers-editor-shared-8024

@cloudflare/workers-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-cloudflare-workers-shared-8024

@cloudflare/workflows-shared:

npm install https://prerelease-registry.devprod.cloudflare.dev/workers-sdk/runs/13265352200/npm-package-cloudflare-workflows-shared-8024

Note that these links will no longer work once the GitHub Actions artifact expires.

[email protected] includes the following runtime dependencies:

Package	Constraint	Resolved
`miniflare`	workspace:*	3.20250129.0
`workerd`	1.20250204.0	1.20250204.0
`workerd --version`	1.20250204.0	2025-02-04

Please ensure constraints are pinned, and miniflare/workerd minor versions match.

packages/create-cloudflare/src/wrangler/config.ts

vicb · 2025-02-06T09:40:18Z

Are we planning to update the docs site to use .jsonc insteaf of .json?

emily-shen · 2025-02-06T11:38:47Z

Are we planning to update the docs site to use .jsonc insteaf of .json?

cloudflare/cloudflare-docs#19764

vicb · 2025-02-10T14:13:56Z

packages/create-cloudflare/e2e-tests/cli.test.ts

@@ -238,6 +238,14 @@ describe.skipIf(experimental || frameworkToTest || isQuarantineMode())(
 					`Cloning template from: cloudflare/templates/multiplayer-globe-template`,
 				);
 				expect(output).toContain(`template cloned and validated`);
+				expect(readFileSync(`${project.path}/.vscode/settings.json`, "utf8"))


super nit: should this use JSON.parse(...) so that we don't depend on the exact format which we don't really care about?

vicb · 2025-02-10T14:15:38Z

packages/create-cloudflare/e2e-tests/frameworks.test.ts

@@ -772,21 +772,21 @@ const runCli = async (
 */
 const addTestVarsToWranglerToml = async (projectPath: string) => {
 	const wranglerTomlPath = join(projectPath, "wrangler.toml");
-	const wranglerJsonPath = join(projectPath, "wrangler.json");
+	const wranglerJsoncPath = join(projectPath, "wrangler.jsonc");
 	if (existsSync(wranglerTomlPath)) {
 		const wranglerToml = readToml(wranglerTomlPath);


super nit: should wranglerToml / wranglerJson be renamed to just config (they are neither Toml nor json)

vicb · 2025-02-10T14:16:55Z

packages/create-cloudflare/e2e-tests/workers.test.ts

-								expect(jsonPath).toExist();
-								const config = readJSON(jsonPath) as { main?: string };
+								expect(jsoncPath).toExist();
+								const config = readJSON(jsoncPath) as { main?: string };


super nit: don't we have the type for the config?

Not in C3, I don't think? It's defined in Wrangler, and right now there's no dependency between the two packages

vicb

Nice!

penalosa · 2025-02-11T11:08:10Z

.changeset/large-badgers-deny.md

+"create-cloudflare": minor
+---
+
+Output wrangler.jsonc instead of wrangler.json by default


Suggested change

Output wrangler.jsonc instead of wrangler.json by default

Output wrangler.jsonc instead of wrangler.json

This isn't configurable, so I don't think we should use "default" language

penalosa · 2025-02-11T11:09:28Z

packages/create-cloudflare/e2e-tests/workers.test.ts

-								expect(jsonPath).toExist();
-								const config = readJSON(jsonPath) as { main?: string };
+								expect(jsoncPath).toExist();
+								const config = readJSON(jsoncPath) as { main?: string };


Not in C3, I don't think? It's defined in Wrangler, and right now there's no dependency between the two packages

petebacondarwin · 2025-02-11T13:57:41Z

packages/create-cloudflare/src/wrangler/config.ts

+	const settingsPath = `${ctx.project.path}/.vscode/settings.json`;
+
+	// don't override a user's existing settings
+	// as this is just a quick stop gap we'll just not bother if the file exists


This is where the json-comment library is very nice!

penalosa reviewed Feb 4, 2025

View reviewed changes

packages/create-cloudflare/src/wrangler/config.ts Outdated Show resolved Hide resolved

emily-shen changed the title ~~add vscode file association setting for wrangler.json~~ output wrangler.jsonc in c3 Feb 5, 2025

emily-shen marked this pull request as ready for review February 5, 2025 15:54

emily-shen requested review from a team as code owners February 5, 2025 15:54

emily-shen mentioned this pull request Feb 5, 2025

[wrangler] replace mentions of wrangler.json with wrangler.json(c) cloudflare/cloudflare-docs#19764

Merged

emily-shen force-pushed the emily/json-squiggles branch from ce8efc4 to 29d29c5 Compare February 5, 2025 17:11

vicb reviewed Feb 6, 2025

View reviewed changes

packages/create-cloudflare/src/wrangler/config.ts Outdated Show resolved Hide resolved

emily-shen added 9 commits February 10, 2025 13:47

add vscode settings

75596b3

create directory

0562298

directory creation fixup

ee2e5ef

add test for vscode settings

3340a54

generate jsonc instead

a1c0938

use tabs

f444e2b

prettify (trailing commas?)

352389a

changeset

5fbab2d

always add vscode file association

e6d31c4

emily-shen force-pushed the emily/json-squiggles branch from 2c902d4 to e6d31c4 Compare February 10, 2025 13:49

vicb reviewed Feb 10, 2025

View reviewed changes

vicb approved these changes Feb 10, 2025

View reviewed changes

penalosa approved these changes Feb 11, 2025

View reviewed changes

petebacondarwin reviewed Feb 11, 2025

View reviewed changes

petebacondarwin approved these changes Feb 11, 2025

View reviewed changes

update test and changeset

320847d

emily-shen merged commit e8272b0 into main Feb 11, 2025
27 checks passed

emily-shen deleted the emily/json-squiggles branch February 11, 2025 15:07

workers-devprod mentioned this pull request Feb 11, 2025

Version Packages #8096

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

output wrangler.jsonc in c3 #8024

output wrangler.jsonc in c3 #8024

emily-shen commented Feb 4, 2025 •

edited

Loading

changeset-bot bot commented Feb 4, 2025 •

edited

Loading

github-actions bot commented Feb 4, 2025 •

edited

Loading

vicb commented Feb 6, 2025

emily-shen commented Feb 6, 2025

vicb Feb 10, 2025

vicb Feb 10, 2025

vicb Feb 10, 2025

penalosa Feb 11, 2025

vicb left a comment

penalosa Feb 11, 2025

penalosa Feb 11, 2025

petebacondarwin Feb 11, 2025

	Output wrangler.jsonc instead of wrangler.json by default
	Output wrangler.jsonc instead of wrangler.json

output wrangler.jsonc in c3 #8024

output wrangler.jsonc in c3 #8024

Conversation

emily-shen commented Feb 4, 2025 • edited Loading

changeset-bot bot commented Feb 4, 2025 • edited Loading

🦋 Changeset detected

github-actions bot commented Feb 4, 2025 • edited Loading

vicb commented Feb 6, 2025

emily-shen commented Feb 6, 2025

vicb Feb 10, 2025

Choose a reason for hiding this comment

vicb Feb 10, 2025

Choose a reason for hiding this comment

vicb Feb 10, 2025

Choose a reason for hiding this comment

penalosa Feb 11, 2025

Choose a reason for hiding this comment

vicb left a comment

Choose a reason for hiding this comment

penalosa Feb 11, 2025

Choose a reason for hiding this comment

penalosa Feb 11, 2025

Choose a reason for hiding this comment

petebacondarwin Feb 11, 2025

Choose a reason for hiding this comment

emily-shen commented Feb 4, 2025 •

edited

Loading

changeset-bot bot commented Feb 4, 2025 •

edited

Loading

github-actions bot commented Feb 4, 2025 •

edited

Loading