@wordpress/create-block 2.8.0 → 2.9.0

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 ## Unreleased
 
+## 2.9.0 (2022-02-10)
+
+### 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` ([#38530](https://github.com/WordPress/gutenberg/pull/38530)).
+-    Introduce the `customScripts` property to allow templates to define additional scripts ([#38535](https://github.com/WordPress/gutenberg/pull/38535)).
+
 ## 2.8.0 (2022-01-27)
 
 ### New Features

package/README.md

@@ -87,37 +87,37 @@ When bootstrapped with the `esnext` template (or any external template with `wpS
 $ npm start
 ```
 
-Starts the build for development. [Learn more](/packages/scripts#start).
+Starts the build for development. [Learn more](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#start).
 
 ```bash
 $ npm run build
 ```
 
-Builds the code for production. [Learn more](/packages/scripts#build).
+Builds the code for production. [Learn more](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#build).
 
 ```bash
 $ npm run format
 ```
 
-Formats files. [Learn more](/packages/scripts#format).
+Formats files. [Learn more](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#format).
 
 ```bash
 $ npm run lint:css
 ```
 
-Lints CSS files. [Learn more](/packages/scripts#lint-style).
+Lints CSS files. [Learn more](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#lint-style).
 
 ```bash
 $ npm run lint:js
 ```
 
-Lints JavaScript files. [Learn more](/packages/scripts#lint-js).
+Lints JavaScript files. [Learn more](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#lint-js).
 
 ```bash
 $ npm run packages-update
 ```
 
-Updates WordPress packages to the latest version. [Learn more](/packages/scripts#packages-update).
+Updates WordPress packages to the latest version. [Learn more](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#packages-update).
 
 _Note: You don’t need to install or configure tools like [webpack](https://webpack.js.org), [Babel](https://babeljs.io) or [ESLint](https://eslint.org) yourself. They are preconfigured and hidden so that you can focus on coding._
 
@@ -206,11 +206,18 @@ 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.
+    `customScripts` (default: {}) - the list of custom scripts to add to `package.json`. It also allows overriding default scripts.
 -   `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'`)
 -   `editorStyle` (default: `'file:./build/index.css'`)
 -   `style` (default: `'file:./build/style-index.css'`)
 
-<br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>
+## Contributing to this package
+
+This is an individual package that's part of the Gutenberg project. The project is organized as a monorepo. It's made up of multiple self-contained software packages, each with a specific purpose. The packages in this monorepo are published to [npm](https://www.npmjs.com/) and used by [WordPress](https://make.wordpress.org/core/) as well as other software projects.
+
+To find out more about contributing to this package or Gutenberg as a whole, please read the project's main [contributor guide](https://github.com/WordPress/gutenberg/tree/HEAD/CONTRIBUTING.md).
+
+<br /><br /><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>

package/lib/init-package-json.js

@@ -18,13 +18,16 @@ module.exports = async ( {
 	license,
 	slug,
 	version,
+	wpEnv,
 	wpScripts,
 	npmDependencies,
+	customScripts,
 } ) => {
 	const cwd = join( process.cwd(), slug );
 
 	info( '' );
 	info( 'Creating a "package.json" file.' );
+
 	await writePkg(
 		cwd,
 		omitBy(
@@ -35,14 +38,18 @@ 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' } ),
+					...customScripts,
 				},
 			},
 			isEmpty

package/lib/scaffold.js

@@ -33,6 +33,7 @@ module.exports = async (
 		wpScripts,
 		wpEnv,
 		npmDependencies,
+		customScripts,
 		folderName,
 		editorScript,
 		editorStyle,
@@ -65,7 +66,9 @@ module.exports = async (
 		licenseURI,
 		textdomain: slug,
 		wpScripts,
+		wpEnv,
 		npmDependencies,
+		customScripts,
 		folderName,
 		editorScript,
 		editorStyle,

package/lib/templates.js

@@ -198,6 +198,7 @@ const getDefaultValues = ( pluginTemplate ) => {
 		licenseURI: 'https://www.gnu.org/licenses/gpl-2.0.html',
 		version: '0.1.0',
 		wpScripts: true,
+		customScripts: {},
 		wpEnv: false,
 		npmDependencies: [],
 		folderName: '.',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/create-block",
-	"version": "2.8.0",
+	"version": "2.9.0",
 	"description": "Generates PHP, JS and CSS code for registering a block for a WordPress plugin.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -31,7 +31,7 @@
 		"wp-create-block": "./index.js"
 	},
 	"dependencies": {
-		"@wordpress/lazy-import": "^1.4.0",
+		"@wordpress/lazy-import": "^1.4.1",
 		"chalk": "^4.0.0",
 		"check-node-version": "^4.1.0",
 		"commander": "^4.1.0",
@@ -48,5 +48,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "d95ccb9366e249133cdb1d7b25c382446b9ee502"
+	"gitHead": "2e4922861e49f5a090f9dc52056165092cfba163"
 }