Support `wrangler.json` #2409

penalosa · 2022-12-14T01:33:33Z

What this PR solves / how to test:

This PR adds wrangler.json (which is JSONC) support! It doesn't add support for converting TOML to JSON, or change the format init generates. To test, create a normal worker, and convert the generated wrangler.toml file to wrangler.json (ether by hand, or by using something like toml2json). All the property names are the same between TOML and JSONC.

Associated docs issues/PR: #7166

Author has included the following, where applicable:

Tests
Changeset

Reviewer has performed the following, where applicable:

Checked for inclusion of relevant tests
Checked for inclusion of a relevant changeset
Checked for creation of associated docs updates
Manually pulled down the changes and spot-tested

Fixes #2376.

changeset-bot · 2022-12-14T01:33:36Z

🦋 Changeset detected

Latest commit: e06c4db

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

This PR includes changesets to release 1 package

Name	Type
wrangler	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

github-actions · 2022-12-14T01:35:57Z

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/runs/3990523105/npm-package-wrangler-2409

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

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

Or you can use npx with this latest build directly:

npx https://prerelease-registry.devprod.cloudflare.dev/runs/3990523105/npm-package-wrangler-2409 dev path/to/script.js

Additional artifacts:

npm install https://prerelease-registry.devprod.cloudflare.dev/runs/3990523105/npm-package-cloudflare-pages-shared-2409

codecov · 2022-12-14T02:13:37Z

Codecov Report

Merging #2409 (e06c4db) into main (e6c9c5c) will decrease coverage by 0.10%.
The diff coverage is 77.59%.

@@            Coverage Diff             @@
##             main    #2409      +/-   ##
==========================================
- Coverage   73.32%   73.23%   -0.10%     
==========================================
  Files         159      159              
  Lines        9800     9847      +47     
  Branches     2583     2622      +39     
==========================================
+ Hits         7186     7211      +25     
- Misses       2614     2636      +22

Impacted Files	Coverage Δ
packages/wrangler/src/d1/create.tsx	`33.33% <0.00%> (ø)`
packages/wrangler/src/d1/list.tsx	`29.62% <0.00%> (-1.14%)`	⬇️
packages/wrangler/src/docs/index.ts	`27.27% <0.00%> (-1.30%)`	⬇️
packages/wrangler/src/d1/index.ts	`84.61% <33.33%> (ø)`
packages/wrangler/src/api/dev.ts	`60.21% <47.36%> (-8.88%)`	⬇️
packages/wrangler/src/d1/backups.tsx	`26.58% <50.00%> (ø)`
packages/wrangler/src/d1/delete.ts	`34.78% <50.00%> (ø)`
packages/wrangler/src/d1/execute.tsx	`16.93% <50.00%> (ø)`
packages/wrangler/src/d1/migrations/create.tsx	`35.48% <50.00%> (ø)`
packages/wrangler/src/d1/migrations/list.tsx	`35.48% <50.00%> (ø)`
... and 37 more

JacobMGEvans · 2022-12-16T14:43:43Z

I'm excited.

JacobMGEvans

I'm not seeing any significant issues, is there anything else we are waiting on before this can go in?

Edit: Please add a changeset 😄

packages/wrangler/src/config/index.ts

penalosa · 2022-12-16T16:14:43Z

@JacobMGEvans it's waiting on docs and a command line flag to enable, which I need to implement (and a changeset). Will get to those soon!

admah · 2023-01-04T20:12:54Z

@penalosa are there docs on this yet?

JacobMGEvans

Thought we were gonna use JSON5?

Edit: I probably am just remembering things wrong, been awhile since the discussion lol

packages/wrangler/src/parse.ts

JacobMGEvans

Nothing else is blocking or outstanding on my end. Looks awesome!!

packages/wrangler/src/__tests__/parse.test.ts

mrbbot

Nice! 🎉 Added some comments... 🙂 I also think JSON config should probably have camelCase keys, but given this is experimental I guess we could change that later? Would probably be a bit of a pain though.

packages/wrangler/scripts/bundle.ts

packages/wrangler/src/__tests__/d1.test.ts

packages/wrangler/src/config/index.ts

packages/wrangler/src/parse.ts

JacobMGEvans

For the Types refactoring commit d84dfcf: How much of this is in regard to the JSON configuration support and how much could be its own separate refactoring effort?

JacobMGEvans

It is looking great, really looking forward to JSON support myself. A few questions, and concerns.

packages/wrangler/src/index.ts

packages/wrangler/src/dispatch-namespace.ts

packages/wrangler/src/dev.tsx

packages/wrangler/src/config/index.ts

penalosa · 2023-01-13T13:27:29Z

For the Types refactoring commit d84dfcf: How much of this is in regard to the JSON configuration support and how much could be its own separate refactoring effort?

Some of it is separate, but a lot of it is related to the improved typing of the readConfig function (to support the JSON configuration flag). This function is used everywhere, and so a change to it's types required a lot of changes across the codebase (because it's parameters were typed as unknown before, which let callers of readConfig have a lot of flexibility in what they passed—I'm pretty sure it was always the right thing, but it was rarely typed correctly)

JacobMGEvans · 2023-01-13T15:03:08Z

For the Types refactoring commit d84dfcf: How much of this is in regard to the JSON configuration support and how much could be its own separate refactoring effort?

Some of it is separate, but a lot of it is related to the improved typing of the readConfig function (to support the JSON configuration flag). This function is used everywhere, and so a change to it's types required a lot of changes across the codebase (because it's parameters were typed as unknown before, which let callers of readConfig have a lot of flexibility in what they passed—I'm pretty sure it was always the right thing, but it was rarely typed correctly)

Thank you for connecting the type changes to the JSON changes, that definitely makes sense with the additional context. The type change look amazing too!

penalosa · 2023-01-13T15:07:58Z

Is there any particular reason for if - else if rather than if - else

I can't seem to reply to this inline 😅
No particular reason other than a slight readability benefit (it makes it clear what type of file we're looking for—I think .jsonc is also sometimes used for json with comments). Happy to go with if - else if you'd prefer

lrapoport-cf · 2023-01-17T16:46:05Z

@penalosa are there docs on this yet?

related discussion: cloudflare/cloudflare-docs#7278 (review) and cloudflare/cloudflare-docs#7278 (comment)

penalosa · 2023-01-20T02:31:49Z

@JacobMGEvans is there anything else outstanding in this PR that you're concerned about?

JacobMGEvans · 2023-01-20T02:33:17Z

@JacobMGEvans is there anything else outstanding in this PR that you're concerned about?

Nope, as I mentioned in the meeting I'm super onboard with getting this in. I appreciate you covering all my questions, concerns, and comments 😁

jrf0110 · 2023-01-20T20:57:04Z

packages/wrangler/src/yargs-types.ts

-	T extends (yargs: Argv<CommonYargsOptions>) => Argv
-> = T extends (yargs: Argv<CommonYargsOptions>) => Argv<infer P>
-	? ArgumentsCamelCase<P>
+export type StrictYargsOptionsToInterface<


Niiiiiice. ❤️

lrapoport-cf · 2023-01-23T18:21:58Z

@penalosa is there a docs PR to link in the description for this PR?

penalosa requested a review from a team as a code owner December 14, 2022 01:33

JacobMGEvans reviewed Dec 16, 2022

View reviewed changes

packages/wrangler/src/config/index.ts Show resolved Hide resolved

penalosa force-pushed the penalosa/json-config branch 2 times, most recently from e1f6aa1 to 9140713 Compare January 4, 2023 19:50

penalosa requested review from JacobMGEvans and a team January 4, 2023 19:53

JacobMGEvans reviewed Jan 5, 2023

View reviewed changes

packages/wrangler/src/parse.ts Outdated Show resolved Hide resolved

JacobMGEvans approved these changes Jan 5, 2023

View reviewed changes

packages/wrangler/src/__tests__/parse.test.ts Show resolved Hide resolved

mrbbot reviewed Jan 6, 2023

View reviewed changes

packages/wrangler/scripts/bundle.ts Show resolved Hide resolved

packages/wrangler/src/__tests__/d1.test.ts Outdated Show resolved Hide resolved

packages/wrangler/src/config/index.ts Outdated Show resolved Hide resolved

packages/wrangler/src/parse.ts Outdated Show resolved Hide resolved

penalosa requested a review from a team as a code owner January 10, 2023 13:26

JacobMGEvans suggested changes Jan 10, 2023

View reviewed changes

JacobMGEvans approved these changes Jan 20, 2023

View reviewed changes

jrf0110 reviewed Jan 20, 2023

View reviewed changes

penalosa force-pushed the penalosa/json-config branch from ae414d1 to 9df2e21 Compare January 23, 2023 17:18

penalosa added 2 commits January 23, 2023 17:25

Support JSONC config

f343745

lint

b8097e6

penalosa added 9 commits January 23, 2023 17:25

Snapshots

056ff34

Update snapshots

5b9fd63

Add tests

42905c5

Stricter types

65c815a

Fix typing in webpack plugin

8ad4697

Fix lint

621e6fb

Standardise on CommonYargsArgv

cccb04b

Fix types

182d916

Update snapshots

190102f

penalosa force-pushed the penalosa/json-config branch from 9df2e21 to 190102f Compare January 23, 2023 17:28

fix types

bfd1e88

penalosa added 5 commits January 23, 2023 18:40

Reduce indentation diff

3d52805

Revert bad merge

557965f

Remove format.ts

ad4025b

Ensure all options are passed

2b89143

Add changeset

e06c4db

penalosa merged commit 89d78c0 into main Jan 23, 2023

penalosa deleted the penalosa/json-config branch January 23, 2023 21:37

github-actions bot mentioned this pull request Jan 23, 2023

Version Packages #2595

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support `wrangler.json` #2409

Support `wrangler.json` #2409

penalosa commented Dec 14, 2022 •

edited

Loading

changeset-bot bot commented Dec 14, 2022 •

edited

Loading

github-actions bot commented Dec 14, 2022 •

edited

Loading

codecov bot commented Dec 14, 2022 •

edited

Loading

JacobMGEvans commented Dec 16, 2022

JacobMGEvans left a comment •

edited

Loading

penalosa commented Dec 16, 2022

admah commented Jan 4, 2023

JacobMGEvans left a comment •

edited

Loading

JacobMGEvans left a comment

mrbbot left a comment •

edited

Loading

JacobMGEvans left a comment •

edited

Loading

JacobMGEvans left a comment

penalosa commented Jan 13, 2023

JacobMGEvans commented Jan 13, 2023

penalosa commented Jan 13, 2023 •

edited

Loading

lrapoport-cf commented Jan 17, 2023

penalosa commented Jan 20, 2023

JacobMGEvans commented Jan 20, 2023

jrf0110 Jan 20, 2023

lrapoport-cf commented Jan 23, 2023 •

edited

Loading

Support wrangler.json #2409

Support wrangler.json #2409

Conversation

penalosa commented Dec 14, 2022 • edited Loading

changeset-bot bot commented Dec 14, 2022 • edited Loading

🦋 Changeset detected

github-actions bot commented Dec 14, 2022 • edited Loading

codecov bot commented Dec 14, 2022 • edited Loading

Codecov Report

JacobMGEvans commented Dec 16, 2022

JacobMGEvans left a comment • edited Loading

Choose a reason for hiding this comment

penalosa commented Dec 16, 2022

admah commented Jan 4, 2023

JacobMGEvans left a comment • edited Loading

Choose a reason for hiding this comment

JacobMGEvans left a comment

Choose a reason for hiding this comment

mrbbot left a comment • edited Loading

Choose a reason for hiding this comment

JacobMGEvans left a comment • edited Loading

Choose a reason for hiding this comment

JacobMGEvans left a comment

Choose a reason for hiding this comment

penalosa commented Jan 13, 2023

JacobMGEvans commented Jan 13, 2023

penalosa commented Jan 13, 2023 • edited Loading

lrapoport-cf commented Jan 17, 2023

penalosa commented Jan 20, 2023

JacobMGEvans commented Jan 20, 2023

jrf0110 Jan 20, 2023

Choose a reason for hiding this comment

lrapoport-cf commented Jan 23, 2023 • edited Loading

Support `wrangler.json` #2409

Support `wrangler.json` #2409

penalosa commented Dec 14, 2022 •

edited

Loading

changeset-bot bot commented Dec 14, 2022 •

edited

Loading

github-actions bot commented Dec 14, 2022 •

edited

Loading

codecov bot commented Dec 14, 2022 •

edited

Loading

JacobMGEvans left a comment •

edited

Loading

JacobMGEvans left a comment •

edited

Loading

mrbbot left a comment •

edited

Loading

JacobMGEvans left a comment •

edited

Loading

penalosa commented Jan 13, 2023 •

edited

Loading

lrapoport-cf commented Jan 23, 2023 •

edited

Loading