env: Ignore \$schema key in environment config parsing (#62626)

* env: Ignore `\$schema` key in environment config parsing * Add changelog Co-authored-by: t-hamano <wildworks@git.wordpress.org> Co-authored-by: sirreal <jonsurrell@git.wordpress.org>
WordPress · Jun 25, 2024 · 4bffbc7 · 4bffbc7
1 parent c0bbeb2
commit 4bffbc7
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 0 deletions.
diff --git a/packages/env/CHANGELOG.md b/packages/env/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Enhancement
+
+-   Ignore `$schema` key in environment config parsing ([#62626](https://github.com/WordPress/gutenberg/pull/62626)).
+
 ## 10.0.0 (2024-05-31)
 
 ### Breaking Changes

diff --git a/packages/env/lib/config/parse-config.js b/packages/env/lib/config/parse-config.js
@@ -407,6 +407,11 @@ async function parseEnvironmentConfig(
 			continue;
 		}
 
+		// The $schema key is a special key that is used to validate the configuration.
+		if ( key === '$schema' ) {
+			continue;
+		}
+
 		// We should also check root-only options for the root config
 		// because these aren't part of the above defaults but are
 		// configuration options that we will parse.

diff --git a/packages/env/lib/config/test/parse-config.js b/packages/env/lib/config/test/parse-config.js
@@ -253,6 +253,26 @@ describe( 'parseConfig', () => {
 		} );
 	} );
 
+	it( 'should ignore `$schema` key', async () => {
+		readRawConfigFile.mockImplementation( async ( configFile ) => {
+			if ( configFile === '/test/gutenberg/.wp-env.json' ) {
+				return {
+					$schema: 'test',
+				};
+			}
+
+			if ( configFile === '/test/gutenberg/.wp-env.override.json' ) {
+				return {};
+			}
+
+			throw new Error( 'Invalid File: ' + configFile );
+		} );
+
+		const parsed = await parseConfig( '/test/gutenberg', '/cache' );
+
+		expect( parsed ).toEqual( DEFAULT_CONFIG );
+	} );
+
 	it( 'should override with environment variables', async () => {
 		process.env.WP_ENV_PORT = 123;
 		process.env.WP_ENV_TESTS_PORT = 456;