refactor: simplify and document config.ts
#238
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: c1b5be5 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
threepointone
force-pushed
the
typed-config
branch
from
548ad8f
to
8276ff3
Compare
Electroid
reviewed
Jan 14, 2022
Electroid
reviewed
Jan 14, 2022
Electroid
reviewed
Jan 14, 2022
Electroid
reviewed
Jan 14, 2022
Electroid
reviewed
Jan 14, 2022
threepointone
force-pushed
the
typed-config
branch
from
8276ff3
to
7dc4927
Compare
|
should the decorators be annotated at the top of the file? |
threepointone
force-pushed
the
typed-config
branch
3 times, most recently
from
b06ed5b
to
e5fa75a
Compare
This PR cleans up the type definition for the configuration object, as well as commenting the hell out of it. There are no duplicate definitions, and I annotated what I could. - `@optional` means providing a value isn't mandatory - `@deprecated` means the field itself isn't necessary _anymore_ in `wrangler.toml` - `@breaking` means the deprecation/optionality is a breaking change from wrangler 1 - `@todo` means there's more work to be done (with details attached) - `@inherited` means the field is copied to all environments I also added a stub for the validation function that will be applied to config objects. In the next PR, I will flesh that function out.
threepointone
force-pushed
the
typed-config
branch
from
e5fa75a
to
c1b5be5
Compare
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR cleans up the type definition for the configuration object, as well as commenting the hell out of it. There are no duplicate definitions, and I annotated what I could.
@optionalmeans providing a value isn't mandatory@deprecatedmeans the field itself isn't necessary anymore inwrangler.toml@breakingmeans the deprecation/optionality is a breaking change from wrangler 1@todomeans there's more work to be done (with details attached)@inheritedmeans the field is copied to all environmentsI also added a stub for the validation function that will be applied to config objects. In the next PR, I will flesh that function out.
You should review this with split view, since the unified view doesn't really make sense here.