Skip to content

Commit

Permalink
fix(create-cloudflare): Fix regression in C3's next template
Browse files Browse the repository at this point in the history
[#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
  • Loading branch information
CarmenPopoviciu committed Jan 15, 2025
1 parent dceb196 commit a4cfc21
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 13 deletions.
9 changes: 9 additions & 0 deletions .changeset/chilly-kings-retire.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
"create-cloudflare": patch
---

Fix regression in C3's `next` template

[#7676](https://github.com/cloudflare/workers-sdk/pull/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
4 changes: 2 additions & 2 deletions packages/create-cloudflare/templates/next/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,10 @@ In order to enable the example:
// KV Example:
```
and uncomment the commented lines below it (also uncomment the relevant imports).
- Do the same in the `wrangler.toml` file, where
- Do the same in the `wrangler.json` file, where
the comment is:
```
# KV Example:
// KV Example:
```
- If you're using TypeScript run the `cf-typegen` script to update the `env.d.ts` file:
```bash
Expand Down
22 changes: 11 additions & 11 deletions packages/create-cloudflare/templates/next/c3.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,27 +26,27 @@ const generate = async (ctx: C3Context) => {

await runFrameworkGenerator(ctx, [projectName]);

const wranglerToml = readFile(join(getTemplatePath(ctx), "wrangler.toml"));
const wranglerConfig = readFile(join(getTemplatePath(ctx), "wrangler.json"));

// Note: here we add `# KV Example:` to the toml file for the KV example, we don't actually
// include the comment in the template wrangler.toml file just so to keep it identical
// Note: here we add `// KV Example:` to the config file for the KV example, we don't actually
// include the comment in the template wrangler.json file just so to keep it identical
// and consistent with that of all the other frameworks
// (instead of making it a special case which needs extra care)
const newTomlContent = wranglerToml.replace(
/#\s+\[\[kv_namespaces\]\]\n#\s+binding\s+=\s+"MY_KV_NAMESPACE"\n#\s+id\s+=\s+"[a-zA-Z0-9]+?"/,
($1) => `# KV Example:\n${$1}`,
const newWranglerConfigContent = wranglerConfig.replace(
/\/\/\s+"kv_namespaces":\s+{\n\/\/\s+"binding":\s+"MY_KV_NAMESPACE",\n\/\/\s+"id":\s+"[a-zA-Z0-9]+?"\n\/\/\s+}/,
($1) => `// KV Example:\n${$1}`,
);

if (!/# KV Example/.test(newTomlContent)) {
if (!/\/\/ KV Example/.test(newWranglerConfigContent)) {
// This should never happen to users, it is a check mostly so that
// if the toml file is changed in a way that breaks the "KV Example" addition
// if the config file is changed in a way that breaks the "KV Example" addition
// the C3 Next.js e2e runs will fail with this
throw new Error("Failed to properly generate the wrangler.toml file");
throw new Error("Failed to properly generate the wrangler.json file");
}

writeFile(join(ctx.project.path, "wrangler.toml"), newTomlContent);
writeFile(join(ctx.project.path, "wrangler.json"), newWranglerConfigContent);

updateStatus("Created wrangler.toml file");
updateStatus("Created wrangler.json file");
};

const updateNextConfig = (usesTs: boolean) => {
Expand Down
9 changes: 9 additions & 0 deletions packages/create-cloudflare/templates/next/wrangler.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,13 @@
"nodejs_compat"
],
"pages_build_output_dir": ".vercel/output/static"

/**
* Bind a KV Namespace. Use KV as persistent storage for small key-value pairs.
* Docs: https://developers.cloudflare.com/pages/functions/bindings/#kv-namespaces
*/
// "kv_namespaces": {
// "binding": "MY_KV_NAMESPACE",
// "id": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
// }
}

0 comments on commit a4cfc21

Please sign in to comment.