@wordpress/env 10.14.0 → 10.16.0

package/LICENSE.md

@@ -1,6 +1,6 @@
 ## Gutenberg
 
-    Copyright 2016-2024 by the contributors
+    Copyright 2016-2025 by the contributors
 
 **License for Contributions (on and after April 15, 2021)**
 

package/lib/commands/destroy.js

@@ -5,7 +5,7 @@
 const { v2: dockerCompose } = require( 'docker-compose' );
 const fs = require( 'fs' ).promises;
 const path = require( 'path' );
-const inquirer = require( 'inquirer' );
+const { confirm } = require( '@inquirer/prompts' );
 
 /**
  * Promisified dependencies
@@ -40,14 +40,19 @@ module.exports = async function destroy( { spinner, scripts, debug } ) {
 		'WARNING! This will remove Docker containers, volumes, networks, and images associated with the WordPress instance.'
 	);
 
-	const { yesDelete } = await inquirer.prompt( [
-		{
-			type: 'confirm',
-			name: 'yesDelete',
+	let yesDelete = false;
+	try {
+		yesDelete = await confirm( {
 			message: 'Are you sure you want to continue?',
 			default: false,
-		},
-	] );
+		} );
+	} catch ( error ) {
+		if ( error.name === 'ExitPromptError' ) {
+			console.log( 'Cancelled.' );
+			process.exit( 1 );
+		}
+		throw error;
+	}
 
 	spinner.start();
 

package/lib/commands/start.js

@@ -6,7 +6,7 @@ const { v2: dockerCompose } = require( 'docker-compose' );
 const util = require( 'util' );
 const path = require( 'path' );
 const fs = require( 'fs' ).promises;
-const inquirer = require( 'inquirer' );
+const { confirm } = require( '@inquirer/prompts' );
 
 /**
  * Promisified dependencies
@@ -328,15 +328,21 @@ async function checkForLegacyInstall( spinner ) {
 			' and '
 		) }. Installs are now in your home folder.\n`
 	);
-	const { yesDelete } = await inquirer.prompt( [
-		{
-			type: 'confirm',
-			name: 'yesDelete',
+	let yesDelete = false;
+	try {
+		yesDelete = confirm( {
 			message:
 				'Do you wish to delete these old installs to reclaim disk space?',
 			default: true,
-		},
-	] );
+		} );
+	} catch ( error ) {
+		if ( error.name === 'ExitPromptError' ) {
+			console.log( 'Cancelled.' );
+			process.exit( 1 );
+		}
+		throw error;
+	}
+
 	if ( yesDelete ) {
 		await Promise.all( installs.map( ( install ) => rimraf( install ) ) );
 		spinner.info( 'Old installs deleted successfully.' );

package/lib/config/parse-config.js

@@ -52,6 +52,7 @@ const mergeConfigs = require( './merge-configs' );
  * @property {number}                    port           The port to use.
  * @property {number}                    mysqlPort      The port to use for MySQL. Random if empty.
  * @property {number}                    phpmyadminPort The port to use for phpMyAdmin. If empty, disabled phpMyAdmin.
+ * @property {boolean}                   multisite      Whether to set up a multisite installation.
  * @property {Object}                    config         Mapping of wp-config.php constants to their desired values.
  * @property {Object.<string, WPSource>} mappings       Mapping of WordPress directories to local directories which should be mounted.
  * @property {string|null}               phpVersion     Version of PHP to use in the environments, of the format 0.0.
@@ -89,6 +90,7 @@ const DEFAULT_ENVIRONMENT_CONFIG = {
 	testsPort: 8889,
 	mysqlPort: null,
 	phpmyadminPort: null,
+	multisite: false,
 	mappings: {},
 	config: {
 		FS_METHOD: 'direct',
@@ -142,7 +144,7 @@ async function parseConfig( configDirectoryPath, cacheDirectoryPath ) {
 	} );
 
 	// Users can provide overrides in environment
-	// variables that supercede all other options.
+	// variables that supersede all other options.
 	const environmentVarOverrides =
 		getEnvironmentVarOverrides( cacheDirectoryPath );
 
@@ -466,6 +468,10 @@ async function parseEnvironmentConfig(
 		parsedConfig.phpmyadminPort = config.phpmyadminPort;
 	}
 
+	if ( config.multisite !== undefined ) {
+		parsedConfig.multisite = config.multisite;
+	}
+
 	if ( config.phpVersion !== undefined ) {
 		// Support null as a valid input.
 		if ( config.phpVersion !== null ) {

package/lib/config/post-process-config.js

@@ -129,7 +129,7 @@ function appendPortToWPConfigs( config ) {
  */
 function validatePortUniqueness( config ) {
 	// We're going to build a map of the environments and their port
-	// so we can accomodate root-level config options more easily.
+	// so we can accommodate root-level config options more easily.
 	const environmentPorts = {};
 
 	// Add all of the environments to the map. This will
@@ -179,7 +179,7 @@ function validate( config ) {
  * @return {WPRootConfig} A deep copy of the root config object.
  */
 function deepCopyRootOptions( config ) {
-	// Create a shallow clone of the object first so we can operate on it safetly.
+	// Create a shallow clone of the object first so we can operate on it safely.
 	const rootConfig = Object.assign( {}, config );
 
 	// Since we're only dealing with the root options we don't want the environments.

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

@@ -29,6 +29,7 @@ exports[`Config Integration should load local and override configuration files 1
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "multisite": false,
       "mysqlPort": 23306,
       "phpVersion": null,
       "phpmyadminPort": null,
@@ -59,6 +60,7 @@ exports[`Config Integration should load local and override configuration files 1
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "multisite": false,
       "mysqlPort": 23307,
       "phpVersion": null,
       "phpmyadminPort": null,
@@ -106,6 +108,7 @@ exports[`Config Integration should load local configuration file 1`] = `
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "multisite": false,
       "mysqlPort": 13306,
       "phpVersion": null,
       "phpmyadminPort": null,
@@ -136,6 +139,7 @@ exports[`Config Integration should load local configuration file 1`] = `
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "multisite": false,
       "mysqlPort": 23307,
       "phpVersion": null,
       "phpmyadminPort": null,
@@ -183,6 +187,7 @@ exports[`Config Integration should use default configuration 1`] = `
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "multisite": false,
       "mysqlPort": null,
       "phpVersion": null,
       "phpmyadminPort": null,
@@ -213,6 +218,7 @@ exports[`Config Integration should use default configuration 1`] = `
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "multisite": false,
       "mysqlPort": null,
       "phpVersion": null,
       "phpmyadminPort": null,
@@ -260,6 +266,7 @@ exports[`Config Integration should use environment variables over local and over
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "multisite": false,
       "mysqlPort": 23306,
       "phpVersion": null,
       "phpmyadminPort": null,
@@ -291,6 +298,7 @@ exports[`Config Integration should use environment variables over local and over
         "url": "https://github.com/WordPress/WordPress.git",
       },
       "mappings": {},
+      "multisite": false,
       "mysqlPort": 23307,
       "phpVersion": null,
       "phpmyadminPort": null,

package/lib/config/test/parse-config.js

@@ -23,6 +23,7 @@ const DEFAULT_CONFIG = {
 	testsPort: 8889,
 	mysqlPort: null,
 	phpmyadminPort: null,
+	multisite: false,
 	phpVersion: null,
 	coreSource: {
 		type: 'git',

package/lib/config/test/validate-config.js

@@ -306,7 +306,7 @@ describe( 'validate-config', () => {
 	} );
 
 	describe( 'checkValidURL', () => {
-		it( 'throws for invaid URLs', () => {
+		it( 'throws for invalid URLs', () => {
 			expect( () =>
 				checkValidURL( 'test.json', 'test', 'localhost' )
 			).toThrow(

package/lib/config/validate-config.js

@@ -5,7 +5,7 @@
  */
 
 /**
- * Error subtype which indicates that an expected validation erorr occurred
+ * Error subtype which indicates that an expected validation error occurred
  * while reading wp-env configuration.
  */
 class ValidationError extends Error {}

package/lib/wordpress.js

@@ -86,11 +86,40 @@ async function configureWordPress( environment, config, spinner ) {
 		// Ignore error.
 	}
 
-	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`;
+	const isMultisite = config.env[ environment ].multisite;
+
+	const installMethod = isMultisite ? 'multisite-install' : 'install';
+	const installCommand = `wp core ${ installMethod } --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 ];
 
+	// Bootstrap .htaccess for multisite
+	if ( isMultisite ) {
+		// Using a subshell with `exec` was the best tradeoff I could come up
+		// with between readability of this source and compatibility with the
+		// way that all strings in `setupCommands` are later joined with '&&'.
+		setupCommands.push(
+			`(
+exec > /var/www/html/.htaccess
+echo 'RewriteEngine On'
+echo 'RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]'
+echo 'RewriteBase /'
+echo 'RewriteRule ^index\.php$ - [L]'
+echo ''
+echo '# add a trailing slash to /wp-admin'
+echo 'RewriteRule ^([_0-9a-zA-Z-]+/)?wp-admin$ $1wp-admin/ [R=301,L]'
+echo ''
+echo 'RewriteCond %{REQUEST_FILENAME} -f [OR]'
+echo 'RewriteCond %{REQUEST_FILENAME} -d'
+echo 'RewriteRule ^ - [L]'
+echo 'RewriteRule ^([_0-9a-zA-Z-]+/)?(wp-(content|admin|includes).*) $2 [L]'
+echo 'RewriteRule ^([_0-9a-zA-Z-]+/)?(.*\.php)$ $2 [L]'
+echo 'RewriteRule . index.php [L]'
+)`
+		);
+	}
+
 	// WordPress versions below 5.1 didn't use proper spacing in wp-config.
 	const configAnchor =
 		wpVersion && isWPMajorMinorVersionLower( wpVersion, '5.1' )

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/env",
-	"version": "10.14.0",
+	"version": "10.16.0",
 	"description": "A zero-config, self contained local WordPress environment for development and testing.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -36,12 +36,12 @@
 		"wp-env": "bin/wp-env"
 	},
 	"dependencies": {
+		"@inquirer/prompts": "^7.2.0",
 		"chalk": "^4.0.0",
 		"copy-dir": "^1.3.0",
 		"docker-compose": "^0.24.3",
 		"extract-zip": "^1.6.7",
 		"got": "^11.8.5",
-		"inquirer": "^7.1.0",
 		"js-yaml": "^3.13.1",
 		"ora": "^4.0.2",
 		"rimraf": "^5.0.10",
@@ -55,5 +55,5 @@
 	"scripts": {
 		"test": "echo \"Error: run tests from root\" && exit 1"
 	},
-	"gitHead": "b432c18934c9db866b6dba7d37517a4e97d642e3"
+	"gitHead": "f48b9f56629e400891abb5ae491504de475237ff"
 }