Skip to content

Commit 04e139f

Browse files
meyerToriLindsay
andauthored
Add mentions of wrangler.jsonc (#18488)
Co-authored-by: ToriLindsay <[email protected]>
1 parent 2cd2846 commit 04e139f

File tree

4 files changed

+6
-4
lines changed

4 files changed

+6
-4
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ If we require more information to address your pull request, the `more-informati
3535

3636
## Wrangler config
3737

38-
If you're adding a code snippet to the docs that represents a Wrangler config file (`wrangler.toml` or `wrangler.json`) make sure you wrap it with the `<WranglerConfig>` component, which ensure it's rendered as both JSON and TOML e.g.
38+
If you're adding a code snippet to the docs that represents a Wrangler config file (`wrangler.toml`, `wrangler.json`, or `wrangler.jsonc`) make sure you wrap it with the `<WranglerConfig>` component, which ensure it's rendered as both JSON and TOML e.g.
3939

4040
````
4141

src/content/docs/workers/wrangler/api.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ const platform = await getPlatformProxy(options);
258258

259259
- `experimentalJsonConfig` boolean
260260

261-
If `true`, allows the utility to read a JSON config file (for example, `wrangler.json`).
261+
If `true`, allows the utility to read a JSON config file (for example, `wrangler.json` or `wrangler.jsonc`).
262262

263263
- `persist` boolean | `{ path: string }`
264264

src/content/docs/workers/wrangler/configuration.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ description: Use a configuration file to customize the
1111

1212
import { Render, Type, MetaInfo } from "~/components";
1313

14-
Wrangler optionally uses a `wrangler.json`/`wrangler.toml` file to customize the development and deployment setup for a Worker.
14+
Wrangler optionally uses a `wrangler.json`/`wrangler.jsonc`/`wrangler.toml` file to customize the development and deployment setup for a Worker.
1515

1616
:::note
1717

18-
As of Wrangler v3.91.0, Wrangler supports both JSON (`wrangler.json`) and TOML (`wrangler.toml`) for its configuration file. Prior to that version, only `wrangler.toml` was supported. The format of Wrangler's configuration file is exactly the same across both languages, except that the syntax is `JSON` rather than `TOML`. Throughout this page and the rest of Cloudflare's documentation config snippets are provided as both JSON and TOML.
18+
As of Wrangler v3.91.0 Wrangler supports both JSON (`wrangler.json` or `wrangler.jsonc`) and TOML (`wrangler.toml`) for its configuration file. Prior to that version, only `wrangler.toml` was supported. The format of Wrangler's configuration file is exactly the same across both languages, except that the syntax is `JSON` rather than `TOML`. Throughout this page and the rest of Cloudflare's documentation config snippets are provided as both JSON and TOML.
1919

2020
:::
2121

src/content/partials/workers/wrangler-commands/global-flags.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,5 @@ The following global flags work on every command:
1212
- Show version number.
1313
- `--config` <Type text="string" /> (not supported by Pages)
1414
- Path to `.toml` configuration file.
15+
- `--experimental-json-config` <Type text="boolean" /> (not supported by Pages)
16+
- ⚠️ This is an experimental command. Read configuration from a `wrangler.json` or `wrangler.jsonc` file, instead of `wrangler.toml`. In this case the config file is parsed as [JSONC](https://code.visualstudio.com/docs/languages/json#_json-with-comments).

0 commit comments

Comments
 (0)