-
Notifications
You must be signed in to change notification settings - Fork 4.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Check .wp-env.json
For Unknown Options
#50642
Merged
ObliviousHarmony
merged 1 commit into
trunk
from
enhance/error-unknown-wp-env-config-options
May 17, 2023
Merged
Check .wp-env.json
For Unknown Options
#50642
ObliviousHarmony
merged 1 commit into
trunk
from
enhance/error-unknown-wp-env-config-options
May 17, 2023
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
Size Change: 0 B Total Size: 1.39 MB ℹ️ View Unchanged
|
noahtallen
approved these changes
May 17, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This tests well for me 👍
cbravobernal
added
the
[Type] Code Quality
Issues or PRs that relate to code quality
label
May 24, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
What?
This pull request checks that all given configuration options exist.
Why?
If a user misspells a configuration option or we remove one there is no communication to the user that the given option is doing nothing. If we provide clear error messaging that the option does not exist they can make adjustments accordingly.
How?
We separate the default environment configuration and use that to check whether or not a configuration option exists. There is also some handling for root-only options.
Testing Instructions
.wp-env.json
file with an invalid option and confirm it errors..wp-env.override.json
file with an invalid option and confirm it errors.env
) to either of the above files and confirm it errors.