[wp-env]: Add support to override core by the WP_ENV_CORE environ…

…ment variable. (#40407) * allow override `core` by the `WP_ENV_CORE` environment variable. * override coreSource
WordPress · Apr 19, 2022 · 53977c6 · 53977c6
1 parent 65e412f
commit 53977c6
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/packages/env/README.md b/packages/env/README.md
@@ -534,9 +534,9 @@ This is useful for plugin development.
 }
 ```
 
-#### Latest development WordPress + current directory as a plugin
+### Latest development WordPress + current directory as a plugin
 
-This is useful for plugin development when upstream Core changes need to be tested.
+This is useful for plugin development when upstream Core changes need to be tested. This can also be set via the environment variable `WP_ENV_CORE`.
 
 ```json
 {

diff --git a/packages/env/lib/config/config.js b/packages/env/lib/config/config.js
@@ -13,6 +13,7 @@ const detectDirectoryType = require( './detect-directory-type' );
 const { validateConfig, ValidationError } = require( './validate-config' );
 const readRawConfigFile = require( './read-raw-config-file' );
 const parseConfig = require( './parse-config' );
+const { includeTestsPath, parseSourceString } = parseConfig;
 const md5 = require( '../md5' );
 
 /**
@@ -256,6 +257,18 @@ function withOverrides( config ) {
 		getNumberFromEnvVariable( 'WP_ENV_TESTS_PORT' ) ||
 		config.env.tests.port;
 
+	// Override WordPress core with environment variable.
+	if ( process.env.WP_ENV_CORE ) {
+		const coreSource = includeTestsPath(
+			parseSourceString( process.env.WP_ENV_CORE, {
+				workDirectoryPath: config.workDirectoryPath,
+			} ),
+			{ workDirectoryPath: config.workDirectoryPath }
+		);
+		config.env.development.coreSource = coreSource;
+		config.env.tests.coreSource = coreSource;
+	}
+
 	// Override PHP version with environment variable.
 	config.env.development.phpVersion =
 		process.env.WP_ENV_PHP_VERSION || config.env.development.phpVersion;

diff --git a/packages/env/lib/config/parse-config.js b/packages/env/lib/config/parse-config.js
@@ -136,6 +136,7 @@ function parseSourceString( sourceString, { workDirectoryPath } ) {
 		`Invalid or unrecognized source: "${ sourceString }".`
 	);
 }
+module.exports.parseSourceString = parseSourceString;
 
 /**
  * Given a source object, returns a new source object with the testsPath
@@ -160,3 +161,4 @@ function includeTestsPath( source, { workDirectoryPath } ) {
 		),
 	};
 }
+module.exports.includeTestsPath = includeTestsPath;