Adding the "env" script when --wp-env or wpEnv is present. (#38530)

* Adding the env script when --wp-env wpEnv is used. * Update docs to reference adding the `env` command. * Fixes issues where not having flag will add "env" : false. * Build out the scripts so that wpEnv and wpScripts are independently added. * Update changelog. * Fix grammar. * Update packages/create-block/CHANGELOG.md Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl> Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>
WordPress · Feb 4, 2022 · e9f8e41 · e9f8e41
1 parent ea79ef6
commit e9f8e41
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 9 deletions.
diff --git a/packages/create-block/CHANGELOG.md b/packages/create-block/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### New Features
+
+-    Automatically add a `"env": "wp-env"` entry to scripts when the `--wp-env` is passed or when a template sets `wpEnv` to `true`.
+
 ## 2.8.0 (2022-01-27)
 
 ### New Features

diff --git a/packages/create-block/README.md b/packages/create-block/README.md
@@ -206,7 +206,7 @@ The following configurable variables are used with the template files. Template
 -   `licenseURI` (default: `'https://www.gnu.org/licenses/gpl-2.0.html'`)
 -   `version` (default: `'0.1.0'`)
 -   `wpScripts` (default: `true`)
--   `wpEnv` (default: `false`)
+-   `wpEnv` (default: `false`) - enables integration with the `@wordpress/env` package and adds the `env` command to the package.json.
 -   `npmDependencies` (default: `[]`) – the list of remote npm packages to be installed in the project with [`npm install`](https://docs.npmjs.com/cli/v8/commands/npm-install) when `wpScripts` is enabled.
 -   `folderName` (default: `.`) – the location for the `block.json` file and other optional block files generated from block templates included in the folder set with the `blockTemplatesPath` setting.
 -   `editorScript` (default: `'file:./build/index.js'`)

diff --git a/packages/create-block/lib/init-package-json.js b/packages/create-block/lib/init-package-json.js
@@ -18,13 +18,15 @@ module.exports = async ( {
 	license,
 	slug,
 	version,
+	wpEnv,
 	wpScripts,
 	npmDependencies,
 } ) => {
 	const cwd = join( process.cwd(), slug );
 
 	info( '' );
 	info( 'Creating a "package.json" file.' );
+
 	await writePkg(
 		cwd,
 		omitBy(
@@ -35,14 +37,17 @@ module.exports = async ( {
 				author,
 				license,
 				main: wpScripts && 'build/index.js',
-				scripts: wpScripts && {
-					build: 'wp-scripts build',
-					format: 'wp-scripts format',
-					'lint:css': 'wp-scripts lint-style',
-					'lint:js': 'wp-scripts lint-js',
-					'packages-update': 'wp-scripts packages-update',
-					'plugin-zip': 'wp-scripts plugin-zip',
-					start: 'wp-scripts start',
+				scripts: {
+					...( wpScripts && {
+						build: 'wp-scripts build',
+						format: 'wp-scripts format',
+						'lint:css': 'wp-scripts lint-style',
+						'lint:js': 'wp-scripts lint-js',
+						'packages-update': 'wp-scripts packages-update',
+						'plugin-zip': 'wp-scripts plugin-zip',
+						start: 'wp-scripts start',
+					} ),
+					...( wpEnv && { env: 'wp-env' } ),
 				},
 			},
 			isEmpty

diff --git a/packages/create-block/lib/scaffold.js b/packages/create-block/lib/scaffold.js
@@ -65,6 +65,7 @@ module.exports = async (
 		licenseURI,
 		textdomain: slug,
 		wpScripts,
+		wpEnv,
 		npmDependencies,
 		folderName,
 		editorScript,