wp-env: Add --config option for custom config files #75087
Conversation
This file contains hidden or 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
youknowriad
requested review from
ObliviousHarmony and
t-hamano
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
youknowriad
added
[Tool] Env
|
Size Change: 0 B Total Size: 3 MB ℹ️ View Unchanged
|
Add a global --config (-c) option to wp-env that allows specifying a custom configuration file path instead of using the default .wp-env.json. This enables running multiple parallel environments from the same directory. - Each config file gets isolated Docker containers via MD5-hashed work directory - Override files are derived from custom config names (e.g., staging.json → staging.override.json) - All commands (start, stop, clean, destroy, logs, run, status) support the option - Maintain full backward compatibility when flag is not provided Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
The -c alias conflicts with flags commonly passed to container commands (e.g., `phpunit -c phpunit.xml.dist`). Since wp-env passes through arguments to containers, the global -c option was intercepting these flags and trying to parse them as wp-env config files. Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
youknowriad
force-pushed
the
wp-env-config-options
branch
from
632fb79 to
038bcff
Compare
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.
What?
Add a global
--configoption to wp-env that allows specifying a custom configuration file path instead of using the default.wp-env.json. This enables running multiple parallel environments from the same directory.Why?
Previously, wp-env could only use
.wp-env.jsonfrom the current directory, making it impossible to run multiple environments from the same folder. This feature enables developers to manage different environment configurations (staging, testing, etc.) with separate containers and data.How?
--configglobal CLI option via yargsstaging.json→staging.override.json)Testing Instructions
.wp-env.jsonandstaging.jsonwp-env startWP_ENV_PORT=8890 WP_ENV_TESTS_PORT=8891 wp-env start --config=staging.jsondocker psshould show separate container setswp-env statusandwp-env status --config=staging.jsonwp-env stop --config=staging.jsonwp-env status