Output `.json` by default in C3 #7676

penalosa · 2025-01-06T14:28:33Z

Fixes DEVX-1491

Generate all new projects from C3 with a wrangler.json file (cc @dario-piotrowicz), as well as simplifying the included comments (cc @vicb I know you had thoughts around this).

I did the TOML -> JSON conversion by running (in packages/create-cloudflare):

for file in **/wrangler.toml; do       
    (toml2json "$file" | jq '{ name: .name, main: .main, compatibility_date: .compatibility_date } + .') > "${file%.toml}.json"
done

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: C3 E2E will run without the label
Public documentation
- TODO (before merge)
- Cloudflare docs PR(s): Update some C3 docs to mention wrangler.json cloudflare-docs#19125
- Documentation not necessary because:

changeset-bot · 2025-01-06T14:28:37Z

🦋 Changeset detected

Latest commit: f1d26e5

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	Patch

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

packages/create-cloudflare/templates-experimental/astro/templates/js/wrangler.json

vicb

I am 💯 to drop the clutter in the config file.

It might still be valuable to add a comment with a link to the binding config

What we discussed with @irvinebroque was to drop the 100+ lines of comments for a few lines with a link to the docs and check if it impacts binding creation (from the metrics we have).

My opinion is that the verbosity we had would only turn down users.

🙏

penalosa · 2025-01-06T14:40:01Z

Generated files should look roughly like this:

// For more details on how to configure Wrangler, refer to:
// https://developers.cloudflare.com/workers/wrangler/configuration/
{
	"name": "test",
	"main": "src/index.ts",
	"compatibility_date": "2024-01-17",
	"$schema": "node_modules/wrangler/config-schema.json"
}

Does that seem like a sufficient level of commenting?

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

vicb · 2025-01-06T14:45:25Z

Generated files should look roughly like this:

// For more details on how to configure Wrangler, refer to:
// https://developers.cloudflare.com/workers/wrangler/configuration/
{
	"name": "test",
	"main": "src/index.ts",
	"compatibility_date": "2024-01-17",
	"$schema": "node_modules/wrangler/config-schema.json"
}

Does that seem like a sufficient level of commenting?

We should probably find a middle ground.

I would be nice to list a few bindings that are either common or appealing to the users (KV, D1, R2, AI, ASSETS) but I would say no more than a couple lines. @irvinebroque might have some ideas.

github-actions · 2025-01-06T14:51:48Z

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/12714540652/npm-package-wrangler-7676

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

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

Or you can use npx with this latest build directly:

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

Additional artifacts:

cloudflare-workers-bindings-extension:

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

create-cloudflare:

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

@cloudflare/kv-asset-handler:

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

miniflare:

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

@cloudflare/pages-shared:

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

@cloudflare/unenv-preset:

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

@cloudflare/vitest-pool-workers:

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

@cloudflare/workers-editor-shared:

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

@cloudflare/workers-shared:

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

@cloudflare/workflows-shared:

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

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.20241230.1
`workerd`	1.20241230.0	1.20241230.0
`workerd --version`	1.20241230.0	2024-12-30

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

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

...te-cloudflare/templates-experimental/hello-world-durable-object-with-assets/js/wrangler.json

packages/create-cloudflare/templates-experimental/astro/templates/js/wrangler.toml

packages/create-cloudflare/templates/svelte/templates/wrangler.toml

packages/create-cloudflare/src/cli.ts

dario-piotrowicz · 2025-01-06T16:08:08Z

Nit:

Could you update this comment as well?

- * configuration value for wrangler.toml.
+ * configuration value for a wrangler config file

(or something like that)

dario-piotrowicz

Overall looks good to me 🙂

although I agree with @emily-shen that the ordering of fields seems less logical than before, I think that ideally we should update it (to make it as clear and intuitive as possible for users)

Also as I discussed with @vicb and @penalosa I am not really a fan of .json files containing comments and would personally strongly prefer either getting rid of comments (and include them in the readme file for example) or use the .jsonc extension instead. But if everyone else is happy with the .json extension I'll live with it 🙂

packages/create-cloudflare/templates-experimental/next/templates/wrangler.json

irvinebroque · 2025-01-07T16:38:44Z

Here is roughly what I think we should put in default config:

Logs
Smart Placement

^ these are foundational, and part of configuring your Worker

Then explain/highlight bindings, with a link to a page that is a good jumping off point.

Then, env vars (+callout about secrets, which is important), static assets and service bindings — bindings that are fundamental to Workers, often day zero things. Important to keep service bindings here and loudly discoverable. The natural thing to do otherwise is to just make http requests between Workers, get confused, etc.

Below is TOML but JSONC would be equivalent

name = "my-worker"
main = "src/index.js"
compatibility_date = "2024-12-30"
compatibility_flags = ["nodejs_compat"]

# Workers Logs
# https://developers.cloudflare.com/workers/observability/logs/workers-logs/
[observability]
enabled = true

# Smart Placement
# Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
# [placement]
# mode = "smart"

###
# Bindings
# Bindings allow your Worker to interact with resources on the Cloudflare Developer Platform, including
# databases, object storage, AI inference, real-time communication and more.
# https://developers.cloudflare.com/workers/runtime-apis/bindings/
###

# Environment Variables
# https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
# [vars]
# MY_VARIABLE = "production_value"

# Note: Use secrets to store sensitive data.
# https://developers.cloudflare.com/workers/configuration/secrets/

# Static Assets
# https://developers.cloudflare.com/workers/static-assets/binding/
# [assets]
# directory = "./public/"
# binding = "ASSETS"

# Service Bindings (communicate between multiple Workers)
# https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
# [[services]]
# binding = "MY_SERVICE"
# service = "my-service"

@vicb @penalosa @nevikashah @korinne

Think there's a way to get this simpler while still highlighting right things.

vicb · 2025-01-09T14:21:21Z

In the blocks

# Service Bindings (communicate between multiple Workers)
# https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
# [[services]]
# binding = "MY_SERVICE"
# service = "my-service"

I think that the bottom half is kind of useless.

# [[services]]
# binding = "MY_SERVICE"
# service = "my-service"

I would rather trade it for 1 (one) line explaining what it enables.

penalosa · 2025-01-09T14:32:29Z

How does this look @irvinebroque? (for the DO hello world template):

/**
 * For more details on how to configure Wrangler, refer to:
 * https://developers.cloudflare.com/workers/wrangler/configuration/
 */
{
  "$schema": "node_modules/wrangler/config-schema.json",
  "compatibility_date": "2025-01-09",
  "main": "src/index.ts",
  "name": "tiny-grass-7ef3",
  "migrations": [
    {
      "new_classes": [
        "MyDurableObject"
      ],
      "tag": "v1"
    }
  ],
  "durable_objects": {
    "bindings": [
      {
        "class_name": "MyDurableObject",
        "name": "MY_DURABLE_OBJECT"
      }
    ]
  },
  "observability": {
    "enabled": true
  },
  /**
   * Smart Placement
   * Docs: https://developers.cloudflare.com/workers/configuration/smart-placement/#smart-placement
   */
  // "placement": { "mode": "smart" },

  /**
   * Bindings
   * Bindings allow your Worker to interact with resources on the Cloudflare Developer Platform, including
   * databases, object storage, AI inference, real-time communication and more.
   * https://developers.cloudflare.com/workers/runtime-apis/bindings/
   */

  /**
   * Environment Variables
   * https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
   */
  // "vars": {
  //   "MY_VARIABLE": "production_value"
  // },
  /**
   * Note: Use secrets to store sensitive data.
   * https://developers.cloudflare.com/workers/configuration/secrets/
   */

  /**
   * Static Assets
   * https://developers.cloudflare.com/workers/static-assets/binding/
   */
  // "assets": {
  //   "directory": "./public/",
  //   "binding": "ASSETS"
  // },

  /**
   * Service Bindings (communicate between multiple Workers)
   * https://developers.cloudflare.com/workers/wrangler/configuration/#service-bindings
   */
  // "services": [{
  //   "binding": "MY_SERVICE",
  //   "service": "my-service"
  // }]
}

irvinebroque · 2025-01-10T09:07:44Z

LGTM! (still getting used to JSONC)

vicb · 2025-01-10T09:36:58Z

LGTM! (still getting used to JSONC)

What do you think of swapping

  // "assets": {
  //   "directory": "./public/",
  //   "binding": "ASSETS"
  // },

for a description of what the binding (i.e. static assets here) does?

IMO that would be more helpful

penalosa · 2025-01-10T11:58:38Z

@vicb IMO the example is more helpful—I could image just uncommenting the binding and starting to use it, wheread if this was just a description I'd still have to look up the syntax

vicb · 2025-01-10T12:23:10Z

@vicb IMO the example is more helpful—I could image just uncommenting the binding and starting to use it, wheread if this was just a description I'd still have to look up the syntax

Can't the schema helps with with that?
My point is that the templates are still huge with more ~~useless~~ inactive lines than actual config.

Anyway, this should not block this PR, we can tweak later if needed

edmundhung · 2025-01-10T17:43:22Z

packages/create-cloudflare/templates-experimental/remix/templates/wrangler.json

-{
-  "name": "<TBD>",
-  "main": "./server.ts",
-  "compatibility_date": "<TBD>",
-  "assets": {
-    "directory": "./build/client"
-  },
-  "observability": {
-    "enabled": true
-  }
-}


Will this remove the ability to update the name and compat date? FYI, the wrangler config from the remix template use custom build which works slightly different then what we are suggesting in c3. 🤔

Oh interesting, is it not valid for C3? In that case I'll change this to TOML so it keeps overwriting the remix one, but we should probably fix that upstream?

Added back in f1d26e5

petebacondarwin

Briefly perused the changes and they LGTM

* Output .json by default * Create young-apes-battle.md * Address comments * Add more comments * Add more comments * sort json config files * Enable trailing commas * fix e2e * fix e2e again * formatting * Always install latest Wrangler * Don't overwrite the wrangler config that remix already provides * fix unit tests * Add back remix .toml file

[#7676](#7676) switched C3 templates to default to `wrangler.json` instead of `wrangler.toml`. Unfortunately, this unintendedly broke the `next` template, which was still attempting to read `wrangler.toml` specifically. This commit fixes the regression. Fixes #7770

* fix(create-cloudflare): Fix regression in C3's next template [#7676](#7676) switched C3 templates to default to `wrangler.json` instead of `wrangler.toml`. Unfortunately, this unintendedly broke the `next` template, which was still attempting to read `wrangler.toml` specifically. This commit fixes the regression. Fixes #7770 * further fixes of the regression PR * fix failing tests on windows

penalosa requested review from a team as code owners January 6, 2025 14:28

vicb reviewed Jan 6, 2025

View reviewed changes

packages/create-cloudflare/templates-experimental/astro/templates/js/wrangler.json Outdated Show resolved Hide resolved

vicb approved these changes Jan 6, 2025

View reviewed changes

vicb reviewed Jan 6, 2025

View reviewed changes

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

emily-shen reviewed Jan 6, 2025

View reviewed changes

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

...te-cloudflare/templates-experimental/hello-world-durable-object-with-assets/js/wrangler.json Show resolved Hide resolved

dario-piotrowicz reviewed Jan 6, 2025

View reviewed changes

packages/create-cloudflare/templates-experimental/astro/templates/js/wrangler.toml Show resolved Hide resolved

dario-piotrowicz reviewed Jan 6, 2025

View reviewed changes

packages/create-cloudflare/templates/svelte/templates/wrangler.toml Show resolved Hide resolved

dario-piotrowicz reviewed Jan 6, 2025

View reviewed changes

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

dario-piotrowicz reviewed Jan 7, 2025

View reviewed changes

packages/create-cloudflare/templates-experimental/next/templates/wrangler.json Show resolved Hide resolved

penalosa added 5 commits January 9, 2025 14:12

Output .json by default

012ba42

Create young-apes-battle.md

8787aea

Address comments

8ef81b9

Add more comments

98302e5

Add more comments

2677a9b

penalosa force-pushed the penalosa/c3-json-default branch from f48adac to 2677a9b Compare January 9, 2025 14:12

sort json config files

8730dd3

vicb mentioned this pull request Jan 10, 2025

Strip down wrangler.toml templates #6922

Closed

12 tasks

Enable trailing commas

e46065c

petebacondarwin approved these changes Jan 10, 2025

View reviewed changes

penalosa added 5 commits January 10, 2025 14:11

fix e2e

eb9b044

fix e2e again

9b9010c

formatting

6ef4b34

Always install latest Wrangler

0453a44

Don't overwrite the wrangler config that remix already provides

1bbf5f2

edmundhung reviewed Jan 10, 2025

View reviewed changes

penalosa added 2 commits January 10, 2025 17:44

fix unit tests

3358e34

Add back remix .toml file

f1d26e5

petebacondarwin approved these changes Jan 10, 2025

View reviewed changes

penalosa merged commit ab92f83 into main Jan 10, 2025
29 checks passed

penalosa deleted the penalosa/c3-json-default branch January 10, 2025 19:04

workers-devprod mentioned this pull request Jan 10, 2025

Version Packages #7716

Merged

This was referenced Jan 13, 2025

chore(c3): update Next version in the experimental template #7743

Merged

remove all references to wrangler.toml opennextjs/docs#48

Merged

Docs flarelabs-net/vite-plugin-cloudflare#119

Merged

tikot mentioned this pull request Jan 15, 2025

🐛 BUG: [email protected], Output the wrangler.json config format when running create-cloudflare. But when generating the next template, the wrangler.toml file will be read. #7770

Closed

CarmenPopoviciu mentioned this pull request Jan 15, 2025

fix(create-cloudflare): Fix regression in C3's next template #7774

Merged

9 tasks

workers-devprod mentioned this pull request Jan 16, 2025

Version Packages #7766

Merged

irvinebroque mentioned this pull request Jan 25, 2025

🐛 BUG: New Hono project from C3 creates wrangler.toml and wrangler.json #7905

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Output `.json` by default in C3 #7676

Output `.json` by default in C3 #7676

penalosa commented Jan 6, 2025 •

edited

Loading

changeset-bot bot commented Jan 6, 2025 •

edited

Loading

vicb left a comment

penalosa commented Jan 6, 2025

vicb commented Jan 6, 2025

github-actions bot commented Jan 6, 2025 •

edited

Loading

dario-piotrowicz commented Jan 6, 2025

dario-piotrowicz left a comment

irvinebroque commented Jan 7, 2025 •

edited

Loading

vicb commented Jan 9, 2025

penalosa commented Jan 9, 2025 •

edited

Loading

irvinebroque commented Jan 10, 2025

vicb commented Jan 10, 2025

penalosa commented Jan 10, 2025

vicb commented Jan 10, 2025

edmundhung Jan 10, 2025 •

edited

Loading

penalosa Jan 10, 2025

penalosa Jan 10, 2025

petebacondarwin left a comment

Output .json by default in C3 #7676

Output .json by default in C3 #7676

Conversation

penalosa commented Jan 6, 2025 • edited Loading

changeset-bot bot commented Jan 6, 2025 • edited Loading

🦋 Changeset detected

vicb left a comment

Choose a reason for hiding this comment

penalosa commented Jan 6, 2025

vicb commented Jan 6, 2025

github-actions bot commented Jan 6, 2025 • edited Loading

dario-piotrowicz commented Jan 6, 2025

dario-piotrowicz left a comment

Choose a reason for hiding this comment

irvinebroque commented Jan 7, 2025 • edited Loading

vicb commented Jan 9, 2025

penalosa commented Jan 9, 2025 • edited Loading

irvinebroque commented Jan 10, 2025

vicb commented Jan 10, 2025

penalosa commented Jan 10, 2025

vicb commented Jan 10, 2025

edmundhung Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

penalosa Jan 10, 2025

Choose a reason for hiding this comment

penalosa Jan 10, 2025

Choose a reason for hiding this comment

petebacondarwin left a comment

Choose a reason for hiding this comment

Output `.json` by default in C3 #7676

Output `.json` by default in C3 #7676

penalosa commented Jan 6, 2025 •

edited

Loading

changeset-bot bot commented Jan 6, 2025 •

edited

Loading

github-actions bot commented Jan 6, 2025 •

edited

Loading

irvinebroque commented Jan 7, 2025 •

edited

Loading

penalosa commented Jan 9, 2025 •

edited

Loading

edmundhung Jan 10, 2025 •

edited

Loading