@wordpress/env 4.5.1 → 4.8.0

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 ## Unreleased
 
+## 4.8.0 (2022-06-01)
+### Enhancement
+-   Removed the need for quotation marks when passing options to `wp-env run`.
+-   Setting a `config` key to `null` will prevent adding the constant to `wp-config.php` even if a default value is defined by `wp-env`.
+
+## 4.7.0 (2022-05-18)
+
+### Enhancement
+-   Added SSH protocol support for git sources
+
 ## 4.2.0 (2022-01-27)
 
 ### Enhancement

package/README.md

@@ -300,21 +300,23 @@ Positionals:
 The run command can be used to open shell sessions or invoke WP-CLI commands.
 
 <div class="callout callout-alert">
-To run a WP-CLI command that includes optional arguments, enclose the WP-CLI command in quotation marks; otherwise, the optional arguments are ignored. This is because flags are normally passed to `wp-env` itself, meaning that the flags are not considered part of the argument that specifies the WP-CLI command. With quotation marks, `wp-env` considers everything inside quotation marks the WP-CLI command argument.
+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
+quotation marks to be command argument.
 
-For example, to list cron schedules with optional arguments that specify the fields returned and the format of the output:
+For example, to ask `WP-CLI` for its help text:
 
 ```sh
-wp-env run cli "wp cron schedule list --fields=name --format=csv"
+wp-env run cli "wp --help"
 ```
 
-Without the quotation marks, WP-CLI lists the schedule in its default format, ignoring the `fields` and `format` arguments.
+Without the quotation marks, `wp-env` 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>
 
-Note that quotation marks are not required for a WP-CLI command that excludes optional arguments, although it does not hurt to include them. For example, the following command syntaxes return identical results: `wp-env run cli "wp cron schedule list"` or `wp-env run cli wp cron schedule list`.
-
-For more information about all the available commands, see [WP-CLI Commands](https://developer.wordpress.org/cli/commands/).
-
 ```sh
 wp-env run <container> [command..]
 
@@ -323,11 +325,7 @@ Runs an arbitrary command in one of the underlying Docker containers. The
 "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.
+cli bash` will open bash in the development WordPress instance.
 
 Positionals:
   container  The container to run the command on.            [string] [required]
@@ -460,12 +458,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"`                   |
-| GitHub repository | `<owner>/<repo>[#<ref>]`      | `"WordPress/WordPress"`, `"WordPress/gutenberg#trunk"`   |
-| ZIP File          | `http[s]://<host>/<path>.zip` | `"https://wordpress.org/wordpress-5.4-beta2.zip"`        |
+| 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"`        |
 
 Remote sources will be downloaded into a temporary directory located in `~/.wp-env`.
 
@@ -519,6 +518,8 @@ WP_HOME: 'http://localhost',
 
 On the test instance, all of the above are still defined, but `WP_DEBUG` and `SCRIPT_DEBUG` are set to false.
 
+These can be overridden by setting a value within the `config` configuration. Setting it to `null` will prevent the constant being defined entirely.
+
 Additionally, the values referencing a URL include the specified port for the given environment. So if you set `testsPort: 3000, port: 2000`, `WP_HOME` (for example) will be `http://localhost:3000` on the tests instance and `http://localhost:2000` on the development instance.
 
 ### Examples
@@ -534,9 +535,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
 {

package/lib/cli.js

@@ -92,6 +92,10 @@ module.exports = function cli() {
 		default: false,
 	} );
 
+	// Make sure any unknown arguments are passed to the command as arguments.
+	// This allows options to be passed to "run" without being quoted.
+	yargs.parserConfiguration( { 'unknown-options-as-args': true } );
+
 	yargs.command(
 		'start',
 		wpGreen(
@@ -171,7 +175,7 @@ module.exports = function cli() {
 				describe: 'The container to run the command on.',
 			} );
 			args.positional( 'command', {
-				type: 'string',
+				type: 'array',
 				describe: 'The command to run.',
 			} );
 		},
@@ -189,6 +193,7 @@ module.exports = function cli() {
 		'$0 run tests-cli bash',
 		'Open a bash session in the WordPress tests instance.'
 	);
+
 	yargs.command(
 		'destroy',
 		wpRed(

package/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;

package/lib/config/parse-config.js

@@ -114,14 +114,42 @@ function parseSourceString( sourceString, { workDirectoryPath } ) {
 		};
 	}
 
+	// SSH URLs (git)
+	const supportedProtocols = [ 'ssh:', 'git+ssh:' ];
+	try {
+		const sshUrl = new URL( sourceString );
+		if ( supportedProtocols.includes( sshUrl.protocol ) ) {
+			const pathElements = sshUrl.pathname
+				.split( '/' )
+				.filter( ( e ) => !! e );
+			const basename = pathElements
+				.slice( -1 )[ 0 ]
+				.replace( /\.git/, '' );
+			const workingPath = path.resolve(
+				workDirectoryPath,
+				...pathElements.slice( 0, -1 ),
+				basename
+			);
+			return {
+				type: 'git',
+				url: sshUrl.href.split( '#' )[ 0 ],
+				ref: sshUrl.hash.slice( 1 ) || undefined,
+				path: workingPath,
+				clonePath: workingPath,
+				basename,
+			};
+		}
+	} catch ( err ) {}
+
 	const gitHubFields = sourceString.match(
 		/^([^\/]+)\/([^#\/]+)(\/([^#]+))?(?:#(.+))?$/
 	);
+
 	if ( gitHubFields ) {
 		return {
 			type: 'git',
 			url: `https://github.com/${ gitHubFields[ 1 ] }/${ gitHubFields[ 2 ] }.git`,
-			ref: gitHubFields[ 5 ] || 'master',
+			ref: gitHubFields[ 5 ],
 			path: path.resolve(
 				workDirectoryPath,
 				gitHubFields[ 2 ],
@@ -136,6 +164,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 +189,4 @@ function includeTestsPath( source, { workDirectoryPath } ) {
 		),
 	};
 }
+module.exports.includeTestsPath = includeTestsPath;

package/lib/config/test/config.js

@@ -4,6 +4,7 @@
  */
 const { readFile, stat } = require( 'fs' ).promises;
 const os = require( 'os' );
+const { join, resolve } = require( 'path' );
 
 /**
  * Internal dependencies
@@ -101,13 +102,17 @@ describe( 'readConfig', () => {
 			process.env.WP_ENV_HOME = 'here/is/a/path';
 			const configWith = await readConfig( '.wp-env.json' );
 			expect(
-				configWith.workDirectoryPath.includes( 'here/is/a/path' )
+				configWith.workDirectoryPath.includes(
+					join( 'here', 'is', 'a', 'path' )
+				)
 			).toBe( true );
 
 			process.env.WP_ENV_HOME = undefined;
 			const configWithout = await readConfig( '.wp-env.json' );
 			expect(
-				configWithout.workDirectoryPath.includes( 'here/is/a/path' )
+				configWithout.workDirectoryPath.includes(
+					join( 'here', 'is', 'a', 'path' )
+				)
 			).toBe( false );
 
 			process.env.WP_ENV_HOME = oldEnvHome;
@@ -126,13 +131,17 @@ describe( 'readConfig', () => {
 			process.env.WP_ENV_HOME = 'here/is/a/path';
 			const configWith = await readConfig( '.wp-env.json' );
 			expect(
-				configWith.workDirectoryPath.includes( 'here/is/a/path' )
+				configWith.workDirectoryPath.includes(
+					join( 'here', 'is', 'a', 'path' )
+				)
 			).toBe( true );
 
 			process.env.WP_ENV_HOME = undefined;
 			const configWithout = await readConfig( '.wp-env.json' );
 			expect(
-				configWithout.workDirectoryPath.includes( 'here/is/a/path' )
+				configWithout.workDirectoryPath.includes(
+					join( 'here', 'is', 'a', 'path' )
+				)
 			).toBe( false );
 
 			process.env.WP_ENV_HOME = oldEnvHome;
@@ -242,26 +251,31 @@ describe( 'readConfig', () => {
 			readFile.mockImplementation( () =>
 				Promise.resolve(
 					JSON.stringify( {
-						plugins: [ './relative', '../parent', '~/home' ],
+						plugins: [
+							'./relative',
+							'../parent',
+							`${ os.homedir() }/home`,
+						],
 					} )
 				)
 			);
 			const config = await readConfig( '.wp-env.json' );
+
 			expect( config.env.development ).toMatchObject( {
 				pluginSources: [
 					{
 						type: 'local',
-						path: expect.stringMatching( /^\/.*relative$/ ),
+						path: expect.stringMatching( /^(\/||\\).*relative$/ ),
 						basename: 'relative',
 					},
 					{
 						type: 'local',
-						path: expect.stringMatching( /^\/.*parent$/ ),
+						path: expect.stringMatching( /^(\/||\\).*parent$/ ),
 						basename: 'parent',
 					},
 					{
 						type: 'local',
-						path: expect.stringMatching( /^\/.*home$/ ),
+						path: expect.stringMatching( /^(\/||\\).*home$/ ),
 						basename: 'home',
 					},
 				],
@@ -270,17 +284,17 @@ describe( 'readConfig', () => {
 				pluginSources: [
 					{
 						type: 'local',
-						path: expect.stringMatching( /^\/.*relative$/ ),
+						path: expect.stringMatching( /^(\/||\\).*relative$/ ),
 						basename: 'relative',
 					},
 					{
 						type: 'local',
-						path: expect.stringMatching( /^\/.*parent$/ ),
+						path: expect.stringMatching( /^(\/||\\).*parent$/ ),
 						basename: 'parent',
 					},
 					{
 						type: 'local',
-						path: expect.stringMatching( /^\/.*home$/ ),
+						path: expect.stringMatching( /^(\/||\\).*home$/ ),
 						basename: 'home',
 					},
 				],
@@ -310,28 +324,28 @@ describe( 'readConfig', () => {
 			expect( config.env.development.pluginSources ).toEqual( [
 				{
 					type: 'local',
-					path: expect.stringMatching( /^\/.*test1a$/ ),
+					path: expect.stringMatching( /^(\/||\\).*test1a$/ ),
 					basename: 'test1a',
 				},
 			] );
 			expect( config.env.development.themeSources ).toEqual( [
 				{
 					type: 'local',
-					path: expect.stringMatching( /^\/.*test2a$/ ),
+					path: expect.stringMatching( /^(\/||\\).*test2a$/ ),
 					basename: 'test2a',
 				},
 			] );
 			expect( config.env.tests.pluginSources ).toEqual( [
 				{
 					type: 'local',
-					path: expect.stringMatching( /^\/.*test1b$/ ),
+					path: expect.stringMatching( /^(\/||\\).*test1b$/ ),
 					basename: 'test1b',
 				},
 			] );
 			expect( config.env.tests.themeSources ).toEqual( [
 				{
 					type: 'local',
-					path: expect.stringMatching( /^\/.*test2b$/ ),
+					path: expect.stringMatching( /^(\/||\\).*test2b$/ ),
 					basename: 'test2b',
 				},
 			] );
@@ -345,15 +359,19 @@ describe( 'readConfig', () => {
 			expect( config.env.development ).toMatchObject( {
 				coreSource: {
 					type: 'local',
-					path: expect.stringMatching( /^\/.*relative$/ ),
-					testsPath: expect.stringMatching( /^\/.*tests-relative$/ ),
+					path: expect.stringMatching( /^(\/||\\).*relative$/ ),
+					testsPath: expect.stringMatching(
+						/^(\/||\\).*tests-relative$/
+					),
 				},
 			} );
 			expect( config.env.tests ).toMatchObject( {
 				coreSource: {
 					type: 'local',
-					path: expect.stringMatching( /^\/.*relative$/ ),
-					testsPath: expect.stringMatching( /^\/.*tests-relative$/ ),
+					path: expect.stringMatching( /^(\/||\\).*relative$/ ),
+					testsPath: expect.stringMatching(
+						/^(\/||\\).*tests-relative$/
+					),
 				},
 			} );
 		} );
@@ -377,22 +395,22 @@ describe( 'readConfig', () => {
 					{
 						type: 'git',
 						url: 'https://github.com/WordPress/gutenberg.git',
-						ref: 'master',
-						path: expect.stringMatching( /^\/.*gutenberg$/ ),
+						ref: undefined,
+						path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
 						basename: 'gutenberg',
 					},
 					{
 						type: 'git',
 						url: 'https://github.com/WordPress/gutenberg.git',
 						ref: 'trunk',
-						path: expect.stringMatching( /^\/.*gutenberg$/ ),
+						path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
 						basename: 'gutenberg',
 					},
 					{
 						type: 'git',
 						url: 'https://github.com/WordPress/gutenberg.git',
 						ref: '5.0',
-						path: expect.stringMatching( /^\/.*gutenberg$/ ),
+						path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
 						basename: 'gutenberg',
 					},
 					{
@@ -401,7 +419,7 @@ describe( 'readConfig', () => {
 							'https://github.com/WordPress/theme-experiments.git',
 						ref: 'tt1-blocks@0.4.3',
 						path: expect.stringMatching(
-							/^\/.*theme-experiments\/tt1-blocks$/
+							/^(\/||\\).*theme-experiments(\/||\\)tt1-blocks$/
 						),
 						basename: 'tt1-blocks',
 					},
@@ -431,28 +449,32 @@ describe( 'readConfig', () => {
 						type: 'zip',
 						url:
 							'https://downloads.wordpress.org/plugin/gutenberg.zip',
-						path: expect.stringMatching( /^\/.*gutenberg$/ ),
+						path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
 						basename: 'gutenberg',
 					},
 					{
 						type: 'zip',
 						url:
 							'https://downloads.wordpress.org/plugin/gutenberg.8.1.0.zip',
-						path: expect.stringMatching( /^\/.*gutenberg$/ ),
+						path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
 						basename: 'gutenberg',
 					},
 					{
 						type: 'zip',
 						url:
 							'https://downloads.wordpress.org/theme/twentytwenty.zip',
-						path: expect.stringMatching( /^\/.*twentytwenty$/ ),
+						path: expect.stringMatching(
+							/^(\/||\\).*twentytwenty$/
+						),
 						basename: 'twentytwenty',
 					},
 					{
 						type: 'zip',
 						url:
 							'https://downloads.wordpress.org/theme/twentytwenty.1.3.zip',
-						path: expect.stringMatching( /^\/.*twentytwenty$/ ),
+						path: expect.stringMatching(
+							/^(\/||\\).*twentytwenty$/
+						),
 						basename: 'twentytwenty',
 					},
 				],
@@ -482,34 +504,42 @@ describe( 'readConfig', () => {
 						type: 'zip',
 						url:
 							'https://www.example.com/test/path/to/gutenberg.zip',
-						path: expect.stringMatching( /^\/.*gutenberg$/ ),
+						path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
 						basename: 'gutenberg',
 					},
 					{
 						type: 'zip',
 						url:
 							'https://www.example.com/test/path/to/gutenberg.8.1.0.zip',
-						path: expect.stringMatching( /^\/.*gutenberg.8.1.0$/ ),
+						path: expect.stringMatching(
+							/^(\/||\\).*gutenberg.8.1.0$/
+						),
 						basename: 'gutenberg.8.1.0',
 					},
 					{
 						type: 'zip',
 						url:
 							'https://www.example.com/test/path/to/twentytwenty.zip',
-						path: expect.stringMatching( /^\/.*twentytwenty$/ ),
+						path: expect.stringMatching(
+							/^(\/||\\).*twentytwenty$/
+						),
 						basename: 'twentytwenty',
 					},
 					{
 						type: 'zip',
 						url:
 							'https://www.example.com/test/path/to/twentytwenty.1.3.zip',
-						path: expect.stringMatching( /^\/.*twentytwenty.1.3$/ ),
+						path: expect.stringMatching(
+							/^(\/||\\).*twentytwenty.1.3$/
+						),
 						basename: 'twentytwenty.1.3',
 					},
 					{
 						type: 'zip',
 						url: 'https://example.com/twentytwenty.1.3.zip',
-						path: expect.stringMatching( /^\/.*twentytwenty.1.3$/ ),
+						path: expect.stringMatching(
+							/^(\/||\\).*twentytwenty.1.3$/
+						),
 						basename: 'twentytwenty.1.3',
 					},
 				],
@@ -550,12 +580,12 @@ describe( 'readConfig', () => {
 			const matchObj = {
 				test: {
 					type: 'local',
-					path: expect.stringMatching( /^\/.*relative$/ ),
+					path: expect.stringMatching( /^(\/||\\).*relative$/ ),
 					basename: 'relative',
 				},
 				test2: {
 					type: 'git',
-					path: expect.stringMatching( /^\/.*gutenberg$/ ),
+					path: expect.stringMatching( /^(\/||\\).*gutenberg$/ ),
 					basename: 'gutenberg',
 				},
 			};
@@ -653,24 +683,25 @@ describe( 'readConfig', () => {
 			expect( config.env.development.mappings ).toEqual( {
 				test1: {
 					basename: 'test1',
-					path: '/test1',
+					// resolve is required to remove drive letters on Windows.
+					path: resolve( '/test1' ),
 					type: 'local',
 				},
 				test3: {
 					basename: 'test3',
-					path: '/test3',
+					path: resolve( '/test3' ),
 					type: 'local',
 				},
 			} );
 			expect( config.env.tests.mappings ).toEqual( {
 				test1: {
 					basename: 'test1',
-					path: '/test1',
+					path: resolve( '/test1' ),
 					type: 'local',
 				},
 				test2: {
 					basename: 'test2',
-					path: '/test2',
+					path: resolve( '/test2' ),
 					type: 'local',
 				},
 			} );
@@ -702,14 +733,14 @@ describe( 'readConfig', () => {
 			expect( config.env.development.mappings ).toEqual( {
 				test: {
 					basename: 'test3',
-					path: '/test3',
+					path: resolve( '/test3' ),
 					type: 'local',
 				},
 			} );
 			expect( config.env.tests.mappings ).toEqual( {
 				test: {
 					basename: 'test2',
-					path: '/test2',
+					path: resolve( '/test2' ),
 					type: 'local',
 				},
 			} );

package/lib/wordpress.js

@@ -64,6 +64,11 @@ async function configureWordPress( environment, config, spinner ) {
 	for ( let [ key, value ] of Object.entries(
 		config.env[ environment ].config
 	) ) {
+		// Allow the configuration to skip a default constant by specifying it as null.
+		if ( null === value ) {
+			continue;
+		}
+
 		// Add quotes around string values to work with multi-word strings better.
 		value = typeof value === 'string' ? `"${ value }"` : value;
 		setupCommands.push(

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/env",
-	"version": "4.5.1",
+	"version": "4.8.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": "446565ecaa40370173c18926535e975ec5652b71"
+	"gitHead": "a3e0b62091e8a8bdf5e2518e42d60d7098af48cc"
 }