@wordpress/env 5.16.0 → 6.0.0

package/README.md

@@ -18,9 +18,11 @@ The database credentials are: user `root`, password `password`. For a comprehens
 
 ## Prerequisites
 
-`wp-env` requires Docker to be installed. There are instructions available for installing Docker on [Windows](https://docs.docker.com/desktop/install/windows-install/), [macOS](https://docs.docker.com/docker-for-mac/install/), and [Linux](https://docs.docker.com/desktop/install/linux-install/).
+`wp-env` relies on a few commonly used developer tools:
 
-Node.js and npm are required. The latest LTS version of Node.js is used to develop `wp-env` and is recommended.
+-   **Docker**. `wp-env` is powered by Docker. There are instructions available for installing Docker on [Windows](https://docs.docker.com/desktop/install/windows-install/) (we recommend the WSL2 backend), [macOS](https://docs.docker.com/docker-for-mac/install/), and [Linux](https://docs.docker.com/desktop/install/linux-install/).
+-   **Node.js**. `wp-env` is written as a Node script. We recommend using a Node version manager like [nvm](https://github.com/nvm-sh/nvm) to install the latest LTS version. Alternatively, you can [download it directly here](https://nodejs.org/en/download).
+-   **git**. Git is used for downloading software from source control, such as WordPress, plugins, and themes. [You can find the installation instructions here.](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
 
 ## Installation
 
@@ -237,13 +239,13 @@ You should only have to translate `port` and `pathMappings` to the format used b
 
 ```json
 {
-  "name": "Listen for XDebug",
-  "type": "php",
-  "request": "launch",
-  "port": 9003,
-  "pathMappings": {
-    "/var/www/html/wp-content/plugins/gutenberg": "${workspaceFolder}/"
-  }
+	"name": "Listen for XDebug",
+	"type": "php",
+	"request": "launch",
+	"port": 9003,
+	"pathMappings": {
+		"/var/www/html/wp-content/plugins/gutenberg": "${workspaceFolder}/"
+	}
 }
 ```
 
@@ -313,22 +315,20 @@ Positionals:
 
 The run command can be used to open shell sessions or invoke WP-CLI commands.
 
-<div class="callout callout-alert">
-In some cases, `wp-env` may consume options that you are attempting to pass to
-the container. This happens with options that `wp-env` has already declared,
-such as `--debug`, `--help`, and `--version`. When this happens, you should fall
-back to using quotation marks; `wp-env` considers everything inside the
+<div class="callout callout-alert">In some cases, <code>wp-env</code> may consume options that you are attempting to pass to
+the container. This happens with options that <code>wp-env</code> has already declared,
+such as <code>--env-cwd</code>, <code>--debug</code>, <code>--help</code>, and <code>--version</code>. When this happens, you should fall
+back to using quotation marks; <code>wp-env</code> considers everything inside the
 quotation marks to be command argument.
 
-For example, to ask `WP-CLI` for its help text:
-
-```sh
-wp-env run cli "wp --help"
-```
-
-Without the quotation marks, `wp-env` will print its own help text instead of
+For example, to ask <code>WP-CLI</code> for its help text:
+<pre>sh
+<code class="language-sh">wp-env run cli "wp --help"</code></pre>
+	
+Without the quotation marks, <code>wp-env</code> will print its own help text instead of
 passing it to the container. If you experience any problems where the command
 is not being passed correctly, fall back to using quotation marks.
+
 </div>
 
 ```sh
@@ -349,6 +349,9 @@ Options:
   --help     Show help                                                 [boolean]
   --version  Show version number                                       [boolean]
   --debug    Enable debug output.                     [boolean] [default: false]
+  --env-cwd  The command's working directory inside of the container. Paths
+             without a leading slash are relative to the WordPress root.
+                                                         [string] [default: "."]
 ```
 
 For example:
@@ -465,7 +468,7 @@ You can customize the WordPress installation, plugins and themes that the develo
 | `"plugins"`    | `string[]`     | `[]`                                   | A list of plugins to install and activate in the environment.                                                                    |
 | `"themes"`     | `string[]`     | `[]`                                   | A list of themes to install in the environment.                                                                                  |
 | `"port"`       | `integer`      | `8888` (`8889` for the tests instance) | The primary port number to use for the installation. You'll access the instance through the port: 'http://localhost:8888'.       |
-| `"testsPort"`       | `integer`      | `8889` | The port number for the test site. You'll access the instance through the port: 'http://localhost:8889'.       |
+| `"testsPort"`  | `integer`      | `8889`                                 | The port number for the test site. You'll access the instance through the port: 'http://localhost:8889'.                         |
 | `"config"`     | `Object`       | See below.                             | Mapping of wp-config.php constants to their desired values.                                                                      |
 | `"mappings"`   | `Object`       | `"{}"`                                 | Mapping of WordPress directories to local directories to be mounted in the WordPress instance.                                   |
 
@@ -473,13 +476,13 @@ _Note: the port number environment variables (`WP_ENV_PORT` and `WP_ENV_TESTS_PO
 
 Several types of strings can be passed into the `core`, `plugins`, `themes`, and `mappings` fields.
 
-| Type              | Format                                       | Example(s)                                               |
-| ----------------- | -------------------------------------------- | -------------------------------------------------------- |
-| Relative path     | `.<path>\|~<path>`                           | `"./a/directory"`, `"../a/directory"`, `"~/a/directory"` |
-| Absolute path     | `/<path>\|<letter>:\<path>`                  | `"/a/directory"`, `"C:\\a\\directory"`                   |
+| Type              | Format                                       | Example(s)                                                                                                                         |
+| ----------------- | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| Relative path     | `.<path>\|~<path>`                           | `"./a/directory"`, `"../a/directory"`, `"~/a/directory"`                                                                           |
+| Absolute path     | `/<path>\|<letter>:\<path>`                  | `"/a/directory"`, `"C:\\a\\directory"`                                                                                             |
 | GitHub repository | `<owner>/<repo>[#<ref>]`                     | `"WordPress/WordPress"`, `"WordPress/gutenberg#trunk"`, if no branch is provided wp-env will fall back to the repos default branch |
-| SSH repository    | `ssh://user@host/<owner>/<repo>.git[#<ref>]` | `"ssh://git@github.com/WordPress/WordPress.git"`         |
-| ZIP File          | `http[s]://<host>/<path>.zip`                | `"https://wordpress.org/wordpress-5.4-beta2.zip"`        |
+| SSH repository    | `ssh://user@host/<owner>/<repo>.git[#<ref>]` | `"ssh://git@github.com/WordPress/WordPress.git"`                                                                                   |
+| ZIP File          | `http[s]://<host>/<path>.zip`                | `"https://wordpress.org/wordpress-5.4-beta2.zip"`                                                                                  |
 
 Remote sources will be downloaded into a temporary directory located in `~/.wp-env`.
 
@@ -487,22 +490,22 @@ Additionally, the key `env` is available to override any of the above options on
 
 ```json
 {
-  "plugins": ["."],
-  "config": {
-    "KEY_1": true,
-    "KEY_2": false
-  },
-  "env": {
-    "development": {
-      "themes": ["./one-theme"]
-    },
-    "tests": {
-      "config": {
-        "KEY_1": false
-      },
-      "port": 3000
-    }
-  }
+	"plugins": [ "." ],
+	"config": {
+		"KEY_1": true,
+		"KEY_2": false
+	},
+	"env": {
+		"development": {
+			"themes": [ "./one-theme" ]
+		},
+		"tests": {
+			"config": {
+				"KEY_1": false
+			},
+			"port": 3000
+		}
+	}
 }
 ```
 
@@ -545,8 +548,8 @@ This is useful for plugin development.
 
 ```json
 {
-  "core": null,
-  "plugins": ["."]
+	"core": null,
+	"plugins": [ "." ]
 }
 ```
 
@@ -556,8 +559,8 @@ This is useful for plugin development when upstream Core changes need to be test
 
 ```json
 {
-  "core": "WordPress/WordPress#master",
-  "plugins": ["."]
+	"core": "WordPress/WordPress#master",
+	"plugins": [ "." ]
 }
 ```
 
@@ -569,8 +572,8 @@ If you are running a _build_ of `wordpress-develop`, point `core` to the `build`
 
 ```json
 {
-  "core": "../wordpress-develop/build",
-  "plugins": ["."]
+	"core": "../wordpress-develop/build",
+	"plugins": [ "." ]
 }
 ```
 
@@ -578,8 +581,8 @@ If you are running `wordpress-develop` in a dev mode (e.g. the watch command `de
 
 ```json
 {
-  "core": "../wordpress-develop/src",
-  "plugins": ["."]
+	"core": "../wordpress-develop/src",
+	"plugins": [ "." ]
 }
 ```
 
@@ -589,9 +592,9 @@ This is useful for integration testing: that is, testing how old versions of Wor
 
 ```json
 {
-  "core": "WordPress/WordPress#5.2.0",
-  "plugins": ["WordPress/wp-lazy-loading", "WordPress/classic-editor"],
-  "themes": ["WordPress/theme-experiments"]
+	"core": "WordPress/WordPress#5.2.0",
+	"plugins": [ "WordPress/wp-lazy-loading", "WordPress/classic-editor" ],
+	"themes": [ "WordPress/theme-experiments" ]
 }
 ```
 
@@ -601,12 +604,12 @@ You can add mu-plugins via the mapping config. The mapping config also allows yo
 
 ```json
 {
-  "plugins": ["."],
-  "mappings": {
-    "wp-content/mu-plugins": "./path/to/local/mu-plugins",
-    "wp-content/themes": "./path/to/local/themes",
-    "wp-content/themes/specific-theme": "./path/to/local/theme-1"
-  }
+	"plugins": [ "." ],
+	"mappings": {
+		"wp-content/mu-plugins": "./path/to/local/mu-plugins",
+		"wp-content/themes": "./path/to/local/themes",
+		"wp-content/themes/specific-theme": "./path/to/local/theme-1"
+	}
 }
 ```
 
@@ -616,10 +619,10 @@ Since all plugins in the `plugins` key are activated by default, you should use
 
 ```json
 {
-  "plugins": ["."],
-  "mappings": {
-    "wp-content/plugins/my-test-plugin": "./path/to/test/plugin"
-  }
+	"plugins": [ "." ],
+	"mappings": {
+		"wp-content/plugins/my-test-plugin": "./path/to/test/plugin"
+	}
 }
 ```
 
@@ -629,12 +632,12 @@ If you need a plugin active in one environment but not the other, you can use `e
 
 ```json
 {
-  "plugins": ["."],
-  "env": {
-    "tests": {
-      "plugins": [".", "path/to/test/plugin"]
-    }
-  }
+	"plugins": [ "." ],
+	"env": {
+		"tests": {
+			"plugins": [ ".", "path/to/test/plugin" ]
+		}
+	}
 }
 ```
 
@@ -644,13 +647,13 @@ You can tell `wp-env` to use a custom port number so that your instance does not
 
 ```json
 {
-  "plugins": ["."],
-  "port": 4013,
-  "env": {
-    "tests": {
-      "port": 4012
-    }
-  }
+	"plugins": [ "." ],
+	"port": 4013,
+	"env": {
+		"tests": {
+			"port": 4012
+		}
+	}
 }
 ```
 
@@ -660,8 +663,8 @@ You can tell `wp-env` to use a specific PHP version for compatibility and testin
 
 ```json
 {
-  "phpVersion": "7.2",
-  "plugins": ["."]
+	"phpVersion": "7.2",
+	"plugins": [ "." ]
 }
 ```
 

package/lib/cli.js

@@ -174,6 +174,13 @@ module.exports = function cli() {
 		'run <container> [command..]',
 		'Runs an arbitrary command in one of the underlying Docker containers. The "container" param should reference one of the underlying Docker services like "development", "tests", or "cli". To run a wp-cli command, use the "cli" or "tests-cli" service. You can also use this command to open shell sessions like bash and the WordPress shell in the WordPress instance. For example, `wp-env run cli bash` will open bash in the development WordPress instance. When using long commands with arguments and quotation marks, you need to wrap the "command" param in quotation marks. For example: `wp-env run tests-cli "wp post create --post_type=page --post_title=\'Test\'"` will create a post on the tests WordPress instance.',
 		( args ) => {
+			args.option( 'env-cwd', {
+				type: 'string',
+				requiresArg: true,
+				default: '.',
+				describe:
+					"The command's working directory inside of the container. Paths without a leading slash are relative to the WordPress root.",
+			} );
 			args.positional( 'container', {
 				type: 'string',
 				describe: 'The container to run the command on.',

package/lib/commands/run.js

@@ -2,6 +2,7 @@
  * External dependencies
  */
 const { spawn } = require( 'child_process' );
+const path = require( 'path' );
 
 /**
  * Internal dependencies
@@ -18,10 +19,17 @@ const initConfig = require( '../init-config' );
  * @param {Object}   options
  * @param {string}   options.container The Docker container to run the command on.
  * @param {string[]} options.command   The command to run.
+ * @param {string}   options.envCwd    The working directory for the command to be executed from.
  * @param {Object}   options.spinner   A CLI spinner which indicates progress.
  * @param {boolean}  options.debug     True if debug mode is enabled.
  */
-module.exports = async function run( { container, command, spinner, debug } ) {
+module.exports = async function run( {
+	container,
+	command,
+	envCwd,
+	spinner,
+	debug,
+} ) {
 	const config = await initConfig( { spinner, debug } );
 
 	command = command.join( ' ' );
@@ -29,12 +37,7 @@ module.exports = async function run( { container, command, spinner, debug } ) {
 	// Shows a contextual tip for the given command.
 	showCommandTips( command, container, spinner );
 
-	await spawnCommandDirectly( {
-		container,
-		command,
-		spinner,
-		config,
-	} );
+	await spawnCommandDirectly( config, container, command, envCwd, spinner );
 
 	spinner.text = `Ran \`${ command }\` in '${ container }'.`;
 };
@@ -42,17 +45,22 @@ module.exports = async function run( { container, command, spinner, debug } ) {
 /**
  * Runs an arbitrary command on the given Docker container.
  *
- * @param {Object}   options
- * @param {string}   options.container The Docker container to run the command on.
- * @param {string}   options.command   The command to run.
- * @param {WPConfig} options.config    The wp-env configuration.
- * @param {Object}   options.spinner   A CLI spinner which indicates progress.
+ * @param {WPConfig} config    The wp-env configuration.
+ * @param {string}   container The Docker container to run the command on.
+ * @param {string}   command   The command to run.
+ * @param {string}   envCwd    The working directory for the command to be executed from.
+ * @param {Object}   spinner   A CLI spinner which indicates progress.
  */
-function spawnCommandDirectly( { container, command, config, spinner } ) {
+function spawnCommandDirectly( config, container, command, envCwd, spinner ) {
+	// We need to pass absolute paths to the container.
+	envCwd = path.resolve( '/var/www/html', envCwd );
+
 	const composeCommand = [
 		'-f',
 		config.dockerComposeConfigPath,
 		'run',
+		'-w',
+		envCwd,
 		'--rm',
 		container,
 		...command.split( ' ' ), // The command will fail if passed as a complete string.

package/lib/commands/start.js

@@ -193,7 +193,7 @@ module.exports = async function start( { spinner, debug, update, xdebug } ) {
 	}
 
 	const siteUrl = config.env.development.config.WP_SITEURL;
-	const e2eSiteUrl = `http://${ config.env.tests.config.WP_TESTS_DOMAIN }:${ config.env.tests.port }/`;
+	const testsSiteUrl = config.env.tests.config.WP_SITEURL;
 
 	const { out: mySQLAddress } = await dockerCompose.port(
 		'mysql',
@@ -213,7 +213,7 @@ module.exports = async function start( { spinner, debug, update, xdebug } ) {
 		.concat( siteUrl ? ` at ${ siteUrl }` : '.' )
 		.concat( '\n' )
 		.concat( 'WordPress test site started' )
-		.concat( e2eSiteUrl ? ` at ${ e2eSiteUrl }` : '.' )
+		.concat( testsSiteUrl ? ` at ${ testsSiteUrl }` : '.' )
 		.concat( '\n' )
 		.concat( `MySQL is listening on port ${ mySQLPort }` )
 		.concat(

package/lib/config/add-or-replace-port.js

@@ -0,0 +1,32 @@
+/**
+ * Internal dependencies
+ */
+const { ValidationError } = require( './validate-config' );
+
+/**
+ * Adds or replaces the port to the given domain or URI.
+ *
+ * @param {string}  input     The domain or URI to operate on.
+ * @param {string}  port      The port to append.
+ * @param {boolean} [replace] Indicates whether or not the port should be replaced if one is already present. Defaults to true.
+ * @return {string} The string with the port added or replaced.
+ */
+module.exports = function addOrReplacePort( input, port, replace = true ) {
+	// This matches both domains and URIs with an optional port and anything
+	// that remains after. We can use this to build an output string that
+	// adds or replaces the port without making any other changes to the input.
+	const matches = input.match(
+		/^((?:.+:\/\/)?[a-z0-9.\-]+)(?::([0-9]+))?(.*)$/i
+	);
+	if ( ! matches ) {
+		throw new ValidationError( `Invalid domain or uri: ${ input }.` );
+	}
+
+	// When a port is already present we will do nothing if the caller doesn't want it to be replaced.
+	if ( matches[ 2 ] !== undefined && ! replace ) {
+		return input;
+	}
+
+	// Place the port in the correct location in the input.
+	return matches[ 1 ] + ':' + port + matches[ 3 ];
+};

package/lib/config/config.js

@@ -14,6 +14,7 @@ const { validateConfig, ValidationError } = require( './validate-config' );
 const readRawConfigFile = require( './read-raw-config-file' );
 const parseConfig = require( './parse-config' );
 const { includeTestsPath, parseSourceString } = parseConfig;
+const addOrReplacePort = require( './add-or-replace-port' );
 const md5 = require( '../md5' );
 
 /**
@@ -272,30 +273,25 @@ function withOverrides( config ) {
 	config.env.tests.phpVersion =
 		process.env.WP_ENV_PHP_VERSION || config.env.tests.phpVersion;
 
-	const updateEnvUrl = ( configKey ) => {
-		[ 'development', 'tests' ].forEach( ( envKey ) => {
-			try {
-				const baseUrl = new URL(
-					config.env[ envKey ].config[ configKey ]
-				);
-
-				// Don't overwrite the port of WP_HOME when set.
-				if ( ! ( configKey === 'WP_HOME' && !! baseUrl.port ) ) {
-					baseUrl.port = config.env[ envKey ].port;
-				}
+	// Some of our configuration options need to have the port added to them.
+	const addConfigPort = ( configKey ) => {
+		// Don't replace the port if one is set in WP_HOME.
+		const replace = configKey !== 'WP_HOME';
 
-				config.env[ envKey ].config[ configKey ] = baseUrl.toString();
-			} catch ( error ) {
-				throw new ValidationError(
-					`Invalid .wp-env.json: config.${ configKey } must be a valid URL.`
-				);
-			}
-		} );
+		config.env.development.config[ configKey ] = addOrReplacePort(
+			config.env.development.config[ configKey ],
+			config.env.development.port,
+			replace
+		);
+		config.env.tests.config[ configKey ] = addOrReplacePort(
+			config.env.tests.config[ configKey ],
+			config.env.tests.port,
+			replace
+		);
 	};
-
-	// Update wp config options to include the correct port number in the URL.
-	updateEnvUrl( 'WP_SITEURL' );
-	updateEnvUrl( 'WP_HOME' );
+	addConfigPort( 'WP_TESTS_DOMAIN' );
+	addConfigPort( 'WP_SITEURL' );
+	addConfigPort( 'WP_HOME' );
 
 	return config;
 }

package/lib/config/test/__snapshots__/config.js.snap

@@ -14,10 +14,10 @@ exports[`readConfig config file should match snapshot 1`] = `
         "TEST_VAL3": false,
         "WP_DEBUG": true,
         "WP_ENVIRONMENT_TYPE": "local",
-        "WP_HOME": "http://localhost:2000/",
+        "WP_HOME": "http://localhost:2000",
         "WP_PHP_BINARY": "php",
-        "WP_SITEURL": "http://localhost:2000/",
-        "WP_TESTS_DOMAIN": "localhost",
+        "WP_SITEURL": "http://localhost:2000",
+        "WP_TESTS_DOMAIN": "localhost:2000",
         "WP_TESTS_EMAIL": "admin@example.org",
         "WP_TESTS_TITLE": "Test Blog",
       },
@@ -36,10 +36,10 @@ exports[`readConfig config file should match snapshot 1`] = `
         "TEST_VAL3": false,
         "WP_DEBUG": false,
         "WP_ENVIRONMENT_TYPE": "local",
-        "WP_HOME": "http://localhost:1000/",
+        "WP_HOME": "http://localhost:1000",
         "WP_PHP_BINARY": "php",
-        "WP_SITEURL": "http://localhost:1000/",
-        "WP_TESTS_DOMAIN": "localhost",
+        "WP_SITEURL": "http://localhost:1000",
+        "WP_TESTS_DOMAIN": "localhost:1000",
         "WP_TESTS_EMAIL": "admin@example.org",
         "WP_TESTS_TITLE": "Test Blog",
       },
@@ -59,10 +59,10 @@ exports[`readConfig wp config values should use default config values 1`] = `
   "SCRIPT_DEBUG": false,
   "WP_DEBUG": false,
   "WP_ENVIRONMENT_TYPE": "local",
-  "WP_HOME": "http://localhost:8889/",
+  "WP_HOME": "http://localhost:8889",
   "WP_PHP_BINARY": "php",
-  "WP_SITEURL": "http://localhost:8889/",
-  "WP_TESTS_DOMAIN": "localhost",
+  "WP_SITEURL": "http://localhost:8889",
+  "WP_TESTS_DOMAIN": "localhost:8889",
   "WP_TESTS_EMAIL": "admin@example.org",
   "WP_TESTS_TITLE": "Test Blog",
 }
@@ -73,10 +73,10 @@ exports[`readConfig wp config values should use default config values 2`] = `
   "SCRIPT_DEBUG": true,
   "WP_DEBUG": true,
   "WP_ENVIRONMENT_TYPE": "local",
-  "WP_HOME": "http://localhost:8888/",
+  "WP_HOME": "http://localhost:8888",
   "WP_PHP_BINARY": "php",
-  "WP_SITEURL": "http://localhost:8888/",
-  "WP_TESTS_DOMAIN": "localhost",
+  "WP_SITEURL": "http://localhost:8888",
+  "WP_TESTS_DOMAIN": "localhost:8888",
   "WP_TESTS_EMAIL": "admin@example.org",
   "WP_TESTS_TITLE": "Test Blog",
 }

package/lib/config/test/add-or-replace-port.js

@@ -0,0 +1,53 @@
+/**
+ * Internal dependencies
+ */
+const addOrReplacePort = require( '../add-or-replace-port.js' );
+
+describe( 'addOrReplacePort', () => {
+	beforeEach( () => {
+		jest.clearAllMocks();
+	} );
+
+	it( 'should add or replace port with various inputs', () => {
+		const testMap = [
+			// Addition
+			{ in: 'test', expect: 'test:101' },
+			{ in: 'test/test?test#test', expect: 'test:101/test?test#test' },
+			{ in: 'http://test.com', expect: 'http://test.com:101' },
+			{
+				in: 'http://test.com/test?test#test',
+				expect: 'http://test.com:101/test?test#test',
+			},
+			{ in: 'ssh://test.com', expect: 'ssh://test.com:101' },
+			{ in: 'test.com', expect: 'test.com:101' },
+
+			// Replacement
+			{ in: 'test:99', expect: 'test:101' },
+			{ in: 'test:99/test?test#test', expect: 'test:101/test?test#test' },
+			{ in: 'http://test.com:99', expect: 'http://test.com:101' },
+			{
+				in: 'http://test.com:99/test?test#test',
+				expect: 'http://test.com:101/test?test#test',
+			},
+			{ in: 'ssh://test.com:99', expect: 'ssh://test.com:101' },
+			{ in: 'test.com:99', expect: 'test.com:101' },
+		];
+
+		for ( const test of testMap ) {
+			const result = addOrReplacePort( test.in, '101' );
+			expect( result ).toEqual( test.expect );
+		}
+	} );
+
+	it( 'should do nothing if port is present but replacement is not requested', () => {
+		const testMap = [
+			{ in: 'test', expect: 'test:103' },
+			{ in: 'test:99', expect: 'test:99' },
+		];
+
+		for ( const test of testMap ) {
+			const result = addOrReplacePort( test.in, '103', false );
+			expect( result ).toEqual( test.expect );
+		}
+	} );
+} );

package/lib/config/test/config.js

@@ -70,6 +70,44 @@ describe( 'readConfig', () => {
 			}
 		} );
 
+		it( 'should throw a validation error if WP_SITEURL is not a valid URL', async () => {
+			readFile.mockImplementation( () =>
+				Promise.resolve(
+					JSON.stringify( {
+						config: {
+							WP_SITEURL: 'test',
+						},
+					} )
+				)
+			);
+			expect.assertions( 2 );
+			try {
+				await readConfig( '.wp-env.json' );
+			} catch ( error ) {
+				expect( error ).toBeInstanceOf( ValidationError );
+				expect( error.message ).toContain( 'must be a valid URL' );
+			}
+		} );
+
+		it( 'should throw a validation error if WP_HOME is not a valid URL', async () => {
+			readFile.mockImplementation( () =>
+				Promise.resolve(
+					JSON.stringify( {
+						config: {
+							WP_SITEURL: 'test',
+						},
+					} )
+				)
+			);
+			expect.assertions( 2 );
+			try {
+				await readConfig( '.wp-env.json' );
+			} catch ( error ) {
+				expect( error ).toBeInstanceOf( ValidationError );
+				expect( error.message ).toContain( 'must be a valid URL' );
+			}
+		} );
+
 		it( 'should infer a core config when ran from a core directory', async () => {
 			readFile.mockImplementation( () =>
 				Promise.reject( { code: 'ENOENT' } )
@@ -854,17 +892,17 @@ describe( 'readConfig', () => {
 					development: {
 						port: 1000,
 						config: {
-							WP_TESTS_DOMAIN: 'localhost',
-							WP_SITEURL: 'http://localhost:1000/',
-							WP_HOME: 'http://localhost:1000/',
+							WP_TESTS_DOMAIN: 'localhost:1000',
+							WP_SITEURL: 'http://localhost:1000',
+							WP_HOME: 'http://localhost:1000',
 						},
 					},
 					tests: {
 						port: 2000,
 						config: {
-							WP_TESTS_DOMAIN: 'localhost',
-							WP_SITEURL: 'http://localhost:2000/',
-							WP_HOME: 'http://localhost:2000/',
+							WP_TESTS_DOMAIN: 'localhost:2000',
+							WP_SITEURL: 'http://localhost:2000',
+							WP_HOME: 'http://localhost:2000',
 						},
 					},
 				},
@@ -878,7 +916,7 @@ describe( 'readConfig', () => {
 						port: 1000,
 						testsPort: 2000,
 						config: {
-							WP_HOME: 'http://localhost:3000/',
+							WP_HOME: 'http://localhost:3000',
 						},
 					} )
 				)
@@ -890,17 +928,17 @@ describe( 'readConfig', () => {
 					development: {
 						port: 1000,
 						config: {
-							WP_TESTS_DOMAIN: 'localhost',
-							WP_SITEURL: 'http://localhost:1000/',
-							WP_HOME: 'http://localhost:3000/',
+							WP_TESTS_DOMAIN: 'localhost:1000',
+							WP_SITEURL: 'http://localhost:1000',
+							WP_HOME: 'http://localhost:3000',
 						},
 					},
 					tests: {
 						port: 2000,
 						config: {
-							WP_TESTS_DOMAIN: 'localhost',
-							WP_SITEURL: 'http://localhost:2000/',
-							WP_HOME: 'http://localhost:3000/',
+							WP_TESTS_DOMAIN: 'localhost:2000',
+							WP_SITEURL: 'http://localhost:2000',
+							WP_HOME: 'http://localhost:3000',
 						},
 					},
 				},
@@ -1153,9 +1191,9 @@ describe( 'readConfig', () => {
 				WP_PHP_BINARY: 'php',
 				WP_TESTS_EMAIL: 'admin@example.org',
 				WP_TESTS_TITLE: 'Test Blog',
-				WP_TESTS_DOMAIN: 'localhost',
-				WP_SITEURL: 'http://localhost:8889/',
-				WP_HOME: 'http://localhost:8889/',
+				WP_TESTS_DOMAIN: 'localhost:8889',
+				WP_SITEURL: 'http://localhost:8889',
+				WP_HOME: 'http://localhost:8889',
 			} );
 
 			expect( config.env.development.config ).toEqual( {
@@ -1167,9 +1205,9 @@ describe( 'readConfig', () => {
 				WP_PHP_BINARY: 'php',
 				WP_TESTS_EMAIL: 'admin@example.org',
 				WP_TESTS_TITLE: 'Test Blog',
-				WP_TESTS_DOMAIN: 'localhost',
-				WP_SITEURL: 'http://localhost:8888/',
-				WP_HOME: 'http://localhost:8888/',
+				WP_TESTS_DOMAIN: 'localhost:8888',
+				WP_SITEURL: 'http://localhost:8888',
+				WP_HOME: 'http://localhost:8888',
 			} );
 		} );
 	} );

package/lib/config/validate-config.js

@@ -83,9 +83,33 @@ function validateConfig( config, envLocation ) {
 		);
 	}
 
+	checkValidURL( envPrefix, config.config, 'WP_SITEURL' );
+	checkValidURL( envPrefix, config.config, 'WP_HOME' );
+
 	return config;
 }
 
+/**
+ * Validates the input and throws if it isn't a valid URL.
+ *
+ * @param {string} envPrefix The environment we're validating.
+ * @param {Object} config    The configuration object we're looking at.
+ * @param {string} configKey The configuration key we're validating.
+ */
+function checkValidURL( envPrefix, config, configKey ) {
+	if ( config[ configKey ] === undefined ) {
+		return;
+	}
+
+	try {
+		new URL( config[ configKey ] );
+	} catch {
+		throw new ValidationError(
+			`Invalid .wp-env.json: "${ envPrefix }config.${ configKey }" must be a valid URL.`
+		);
+	}
+}
+
 module.exports = {
 	validateConfig,
 	ValidationError,

package/lib/wordpress.js

@@ -44,20 +44,7 @@ async function checkDatabaseConnection( { dockerComposeConfigPath, debug } ) {
  * @param {Object}        spinner     A CLI spinner which indicates progress.
  */
 async function configureWordPress( environment, config, spinner ) {
-	const url = ( () => {
-		const port = config.env[ environment ].port;
-		const domain =
-			environment === 'tests'
-				? config.env.tests.config.WP_TESTS_DOMAIN
-				: config.env.development.config.WP_SITEURL;
-		if ( port === 80 ) {
-			return domain;
-		}
-
-		return `${ domain }:${ port }`;
-	} )();
-
-	const installCommand = `wp core install --url="${ url }" --title="${ config.name }" --admin_user=admin --admin_password=password --admin_email=wordpress@example.com --skip-email`;
+	const installCommand = `wp core install --url="${ config.env[ environment ].config.WP_SITEURL }" --title="${ config.name }" --admin_user=admin --admin_password=password --admin_email=wordpress@example.com --skip-email`;
 
 	// -eo pipefail exits the command as soon as anything fails in bash.
 	const setupCommands = [ 'set -eo pipefail', installCommand ];

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/env",
-	"version": "5.16.0",
+	"version": "6.0.0",
 	"description": "A zero-config, self contained local WordPress environment for development and testing.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -51,5 +51,5 @@
 	"scripts": {
 		"test": "echo \"Error: run tests from root\" && exit 1"
 	},
-	"gitHead": "d61700b9f1c72ba0b030fc815ef1685b4f4031ec"
+	"gitHead": "6df0c62d43b8901414ccd22ffbe56eaa99d012a6"
 }