@wordpress/create-block 2.8.0 → 3.0.0

package/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 ## Unreleased
 
+## 3.0.0 (2022-03-03)
+
+### Breaking Changes
+
+-   It is no longer mandatory to provide the deprecated `templatesPath` option when configuring the custom project template ([#39049](https://github.com/WordPress/gutenberg/pull/39049)).
+-   Custom project templates will use default template files during scaffolding for the WordPress plugin shell and/or individual blocks. It is possible to replace them with a custom set of template files by using the `pluginTemplatesPath` and/or `blockTemplatesPath` options ([#39049](https://github.com/WordPress/gutenberg/pull/39049)).
+-   The default `esnext` project template got renamed to `static` ([#39049](https://github.com/WordPress/gutenberg/pull/39049)).
+
+### New Features
+
+-   Added CLI prompts for three additional plugin header fields: `Plugin URI`, `Domain Path`, and `Update URI` ([#39096](https://github.com/WordPress/gutenberg/pull/39096)).
+
+### Deprecations
+
+-   To remove confusion when configuring custom project templates, the `templatesPath` option got renamed to `pluginTemplatesPath`. The old name still works but is considered deprecated, and it might get removed in the future ([#39049](https://github.com/WordPress/gutenberg/pull/39049)).
+
+### Documentation
+
+-   Include a missing note on how to create a zip file for a WordPress plugin ([#39049](https://github.com/WordPress/gutenberg/pull/39049))
+
+## 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

@@ -1,18 +1,18 @@
 # Create Block
 
-Create Block is an officially supported way to create blocks for registering a block for a WordPress plugin. It offers a modern build setup with no configuration. It generates PHP, JS, CSS code, and everything else you need to start the project.
+Create Block is an officially supported tool for scaffolding WordPress plugins with blocks. It generates PHP, JS, CSS code, and everything you need to start the project. It integrates a modern build setup with no configuration.
 
 It is largely inspired by [create-react-app](https://create-react-app.dev/docs/getting-started). Major kudos to [@gaearon](https://github.com/gaearon), the whole Facebook team, and the React community.
 
 ## Description
 
-Blocks are the fundamental element of the WordPress block editor. They are the primary way in which plugins and themes can register their own functionality and extend the capabilities of the editor.
+Blocks are the fundamental element of the WordPress block editor. They are the primary way in which plugins can register their functionality and extend the editor's capabilities.
 
 Visit the [Gutenberg handbook](https://developer.wordpress.org/block-editor/developers/block-api/block-registration/) to learn more about Block API.
 
 ## Quick start
 
-You just need to provide the `slug` which is the target location for scaffolded plugin files and the internal block name.
+You only need to provide the `slug` – the target location for scaffolded plugin files and the internal block name.
 
 ```bash
 $ npx @wordpress/create-block todo-list
@@ -26,7 +26,7 @@ It creates a WordPress plugin that you need to [install manually](https://wordpr
 
 ## Usage
 
-The following command generates PHP, JS and CSS code for registering a block.
+The following command generates a project with PHP, JS, and CSS code for registering a block with a WordPress plugin.
 
 ```bash
 $ npx @wordpress/create-block [options] [slug]
@@ -34,16 +34,16 @@ $ npx @wordpress/create-block [options] [slug]
 
 ![Demo](https://user-images.githubusercontent.com/699132/103872910-4de15f00-50cf-11eb-8c74-67ca91a8c1a4.gif)
 
-`[slug]` is optional. When provided it triggers the quick mode where it is used as the block slug used for its identification, the output location for scaffolded files, and the name of the WordPress plugin. The rest of the configuration is set to all default values unless overridden with some of the options listed below.
+`[slug]` is optional. When provided, it triggers the quick mode where it is used as the block slug used for its identification, the output location for scaffolded files, and the name of the WordPress plugin. The rest of the configuration is set to all default values unless overridden with some options listed below.
 
 Options:
 
 ```bash
 -V, --version                output the version number
--t, --template <name>        plugin template type name, allowed values: "es5", "esnext", the name of an external npm package (default: "esnext"), or the path to a local directory.
+-t, --template <name>        project template type name; allowed values: "static" (default), "es5", the name of an external npm package, or the path to a local directory
 --namespace <value>          internal namespace for the block name
---title <value>              display title for the plugin/block
---short-description <value>  short description for the plugin/block
+--title <value>              display title for the block and the WordPress plugin
+--short-description <value>  short description for the block and the WordPress plugin
 --category <name>            category name for the block
 --wp-scripts                 enable integration with `@wordpress/scripts` package
 --no-wp-scripts              disable integration with `@wordpress/scripts` package
@@ -59,16 +59,16 @@ More examples:
 $ npx @wordpress/create-block
 ```
 
-2. ES5 template – it is also possible to pick ES5 template when you don't want to deal with a build step (`npm start`) which enables ESNext and JSX support.
+2. External npm package – it is also possible to select an external npm package as a template.
 
 ```bash
-$ npx @wordpress/create-block --template es5
+$ npx @wordpress/create-block --template my-template-package
 ```
 
 3. Local template directory – it is also possible to pick a local directory as a template.
 
 ```bash
-$ npx @wordpress/create-block --template ./path/to/template
+$ npx @wordpress/create-block --template ./path/to/template-directory
 ```
 
 4. Help – you need to use `npx` to output usage information.
@@ -77,61 +77,67 @@ $ npx @wordpress/create-block --template ./path/to/template
 $ npx @wordpress/create-block --help
 ```
 
-When you scaffold a block, you must provide at least a `slug` name, the `namespace` which usually corresponds to either the `theme` or `plugin` name, and the `category`. In most cases, we recommended pairing blocks with plugins rather than themes, because only using plugin ensures that all blocks still work when your theme changes.
+When you scaffold a block, you must provide at least a `slug` name, the `namespace` which usually corresponds to either the `theme` or `plugin` name. In most cases, we recommended pairing blocks with WordPress plugins rather than themes, because only using plugin ensures that all blocks still work when your theme changes.
 
 ## Available Commands
 
-When bootstrapped with the `esnext` template (or any external template with `wpScripts` flag enabled), you can run several commands inside the directory:
+When bootstrapped with the `static` template (or any other project template with `wpScripts` flag enabled), you can run several commands inside the directory:
 
 ```bash
 $ 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 plugin-zip
+```
+
+Creates a zip file for a WordPress plugin. [Learn more](https://github.com/WordPress/gutenberg/tree/HEAD/packages/scripts#plugin-zip).
 
 ```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._
 
-## External Templates
+## External Project Templates
 
-Since version `0.19.0` it is possible to use external templates hosted on npm. These packages need to contain `.mustache` files that will be used during the block scaffolding process.
+Are you looking for a way to share your project configuration? Creating an external project template hosted on npm or located in a local directory is possible. These npm packages can provide custom `.mustache` files that replace default files included in the tool for the WordPress plugin or/and the block. It's also possible to override default configuration values used during the scaffolding process.
 
-### Template Configuration
+### Project Template Configuration
 
-It is mandatory to provide the main file (`index.js` by default) for the package that returns a configuration object. It must contain at least the `templatesPath` field.
+Providing the main file (`index.js` by default) for the package that returns a configuration object is mandatory. Several options allow customizing the scaffolding process.
 
-#### `templatesPath`
+#### `pluginTemplatesPath`
 
-A mandatory field with the path pointing to the location where plugin template files live (nested folders are also supported). All files without the `.mustache` extension will be ignored.
+This optional field allows overriding file templates related to **the WordPress plugin shell**. The path points to a location with template files ending with the `.mustache` extension (nested folders are also supported). When not set, the tool uses its own set of templates.
 
 _Example:_
 
@@ -139,13 +145,13 @@ _Example:_
 const { join } = require( 'path' );
 
 module.exports = {
-	templatesPath: join( __dirname, 'plugin-templates' ),
+	pluginTemplatesPath: join( __dirname, 'plugin-templates' ),
 };
 ```
 
 #### `blockTemplatesPath`
 
-An optional field with the path pointing to the location where template files for the individual block live (nested folders are also supported). All files without the `.mustache` extension will be ignored.
+This optional field allows overriding file templates related to **the individual block**. The path points to a location with template files ending with the `.mustache` extension (nested folders are also supported). When not set, the tool uses its own set of templates.
 
 _Example:_
 
@@ -159,7 +165,7 @@ module.exports = {
 
 #### `assetsPath`
 
-This setting is useful when your template scaffolds a plugin that uses static assets like images or fonts, which should not be processed. It provides the path pointing to the location where assets are located. They will be copied to the `assets` subfolder in the generated plugin.
+This setting is useful when your template scaffolds a WordPress plugin that uses static assets like images or fonts, which should not be processed. It provides the path pointing to the location where assets are located. They will be copied to the `assets` subfolder in the generated plugin.
 
 _Example:_
 
@@ -185,32 +191,49 @@ module.exports = {
 		dashicon: 'palmtree',
 		version: '1.2.3',
 	},
-	templatesPath: __dirname,
 };
 ```
 
-The following configurable variables are used with the template files. Template authors can change default values to use when users don't provide their data:
-
--   `$schema` (default: `https://schemas.wp.org/trunk/block.json`)
--   `apiVersion` (default: `2`) - see https://make.wordpress.org/core/2020/11/18/block-api-version-2/.
--   `slug` (no default)
--   `namespace` (default: `'create-block'`)
--   `title` (no default) - a display title for your block.
--   `description` (no default) - a short description for your block.
--   `dashicon` (no default) - an icon property thats makes it easier to identify a block, see https://developer.wordpress.org/resource/dashicons/.
--   `category` (default: `'widgets'`) - blocks are grouped into categories to help users browse and discover them. The categories provided by core are `text`, `media`, `design`, `widgets`, `theme`, and `embed`.
--   `attributes` (no default) - see https://developer.wordpress.org/block-editor/developers/block-api/block-attributes/.
--   `supports` (no default) - optional block extended support features, see https://developer.wordpress.org/block-editor/developers/block-api/block-supports/.
--   `author` (default: `'The WordPress Contributors'`)
--   `license` (default: `'GPL-2.0-or-later'`)
--   `licenseURI` (default: `'https://www.gnu.org/licenses/gpl-2.0.html'`)
--   `version` (default: `'0.1.0'`)
--   `wpScripts` (default: `true`)
--   `wpEnv` (default: `false`)
+The following configurable variables are used with the template files. Template authors can change default values to use when users don't provide their data.
+
+**Project**:
+
+-   `wpScripts` (default: `true`) – enables integration with the `@wordpress/scripts` package and adds common scripts to the `package.json`.
+-   `wpEnv` (default: `false`) – enables integration with the `@wordpress/env` package and adds the `env` script to the `package.json`.
+-   `customScripts` (default: {}) – the list of custom scripts to add to `package.json` . It also allows overriding default scripts.
 -   `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'`)
--   `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>
+**Plugin header fields** ([learn more](https://developer.wordpress.org/plugins/plugin-basics/header-requirements/)):
+
+-   `pluginURI` (no default) – the home page of the plugin.
+-   `version` (default: `'0.1.0'`) – the current version number of the plugin.
+-   `author` (default: `'The WordPress Contributors'`) – the name of the plugin author(s).
+-   `license` (default: `'GPL-2.0-or-later'`) – the short name of the plugin’s license.
+-   `licenseURI` (default: `'https://www.gnu.org/licenses/gpl-2.0.html'`) – a link to the full text of the license.
+-   `domainPath` (no default) – a custom domain path for the translations ([more info](https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/#domain-path)).
+-   `updateURI:` (no default) – a custom update URI for the plugin ([related dev note](https://make.wordpress.org/core/2021/06/29/introducing-update-uri-plugin-header-in-wordpress-5-8/)).
+
+**Block metadata** ([learn more](https://developer.wordpress.org/block-editor/reference-guides/block-api/block-metadata/)):
+
+-   `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.
+-   `$schema` (default: `https://schemas.wp.org/trunk/block.json`) – the schema URL used for block validation.
+-   `apiVersion` (default: `2`) – the block API version ([related dev note](https://make.wordpress.org/core/2020/11/18/block-api-version-2/)).
+-   `slug` (no default) – the block slug used for identification in the block name.
+-   `namespace` (default: `'create-block'`) – the internal namespace for the block name.
+-   `title` (no default) – a display title for your block.
+-   `description` (no default) – a short description for your block.
+-   `dashicon` (no default) – an icon property thats makes it easier to identify a block ([available values](https://developer.wordpress.org/resource/dashicons/)).
+-   `category` (default: `'widgets'`) – blocks are grouped into categories to help users browse and discover them. The categories provided by core are `text`, `media`, `design`, `widgets`, `theme`, and `embed`.
+-   `attributes` (no default) – block attributes ([more details](https://developer.wordpress.org/block-editor/developers/block-api/block-attributes/)).
+-   `supports` (no default) – optional block extended support features ([more details](https://developer.wordpress.org/block-editor/developers/block-api/block-supports/).
+-   `editorScript` (default: `'file:./index.js'`) – an editor script definition.
+-   `editorStyle` (default: `'file:./index.css'`) – an editor style definition.
+-   `style` (default: `'file:./style-index.css'`) – a frontend and editor style definition.
+
+## 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/index.js

@@ -23,26 +23,29 @@ const commandName = `wp-create-block`;
 program
 	.name( commandName )
 	.description(
-		'Generates PHP, JS and CSS code for registering a block for a WordPress plugin.\n\n' +
-			'[slug] is optional. When provided it triggers the quick mode where ' +
+		'Generates PHP, JS and CSS code for registering a WordPress plugin with blocks.\n\n' +
+			'[slug] is optional. When provided, it triggers the quick mode where ' +
 			'it is used as the block slug used for its identification, the output ' +
 			'location for scaffolded files, and the name of the WordPress plugin.' +
 			'The rest of the configuration is set to all default values unless ' +
-			'overridden with some of the options listed below.'
+			'overridden with some options listed below.'
 	)
 	.version( version )
 	.arguments( '[slug]' )
 	.option(
 		'-t, --template <name>',
-		'plugin template type name, allowed values: "es5", "esnext", or the name of an external npm package',
-		'esnext'
+		'project template type name; allowed values: "static", "es5", the name of an external npm package, or the path to a local directory',
+		'static'
 	)
 	.option( '--namespace <value>', 'internal namespace for the block name' )
-	.option( '--title <value>', 'display title for the plugin/block' )
+	.option(
+		'--title <value>',
+		'display title for the block and the WordPress plugin'
+	)
 	// The name "description" is used internally so it couldn't be used.
 	.option(
 		'--short-description <value>',
-		'short description for the plugin/block'
+		'short description for the block and the WordPress plugin'
 	)
 	.option( '--category <name>', 'category name for the block' )
 	.option(
@@ -93,17 +96,55 @@ program
 					};
 					await scaffold( pluginTemplate, answers );
 				} else {
-					const prompts = getPrompts( pluginTemplate ).filter(
-						( { name } ) =>
-							! Object.keys( optionsValues ).includes( name )
-					);
 					log.info( '' );
-					log.info( "Let's customize your WordPress plugin:" );
-					const answers = await inquirer.prompt( prompts );
+					log.info(
+						"Let's customize your WordPress plugin with blocks:"
+					);
+
+					const filterOptionsProvided = ( { name } ) =>
+						! Object.keys( optionsValues ).includes( name );
+					const blockPrompts = getPrompts( pluginTemplate, [
+						'slug',
+						'namespace',
+						'title',
+						'description',
+						'dashicon',
+						'category',
+					] ).filter( filterOptionsProvided );
+					const blockAnswers = await inquirer.prompt( blockPrompts );
+
+					const pluginAnswers = await inquirer
+						.prompt( {
+							type: 'confirm',
+							name: 'configurePlugin',
+							message:
+								'Do you want to customize the WordPress plugin?',
+							default: false,
+						} )
+						.then( async ( { configurePlugin } ) => {
+							if ( ! configurePlugin ) {
+								return {};
+							}
+
+							const pluginPrompts = getPrompts( pluginTemplate, [
+								'pluginURI',
+								'version',
+								'author',
+								'license',
+								'licenseURI',
+								'domainPath',
+								'updateURI',
+							] ).filter( filterOptionsProvided );
+							const result = await inquirer.prompt(
+								pluginPrompts
+							);
+							return result;
+						} );
 					await scaffold( pluginTemplate, {
 						...defaultValues,
 						...optionsValues,
-						...answers,
+						...blockAnswers,
+						...pluginAnswers,
 					} );
 				}
 			} catch ( error ) {

package/lib/init-package-json.js

@@ -16,15 +16,19 @@ module.exports = async ( {
 	author,
 	description,
 	license,
+	pluginURI,
 	slug,
 	version,
+	wpEnv,
 	wpScripts,
 	npmDependencies,
+	customScripts,
 } ) => {
 	const cwd = join( process.cwd(), slug );
 
 	info( '' );
 	info( 'Creating a "package.json" file.' );
+
 	await writePkg(
 		cwd,
 		omitBy(
@@ -34,15 +38,20 @@ module.exports = async ( {
 				description,
 				author,
 				license,
+				homepage: pluginURI,
 				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/prompts.js

@@ -3,6 +3,7 @@
  */
 const { isEmpty, upperFirst } = require( 'lodash' );
 
+// Block metadata.
 const slug = {
 	type: 'input',
 	name: 'slug',
@@ -73,6 +74,29 @@ const category = {
 	choices: [ 'text', 'media', 'design', 'widgets', 'theme', 'embed' ],
 };
 
+// Plugin header fields.
+const pluginURI = {
+	type: 'input',
+	name: 'pluginURI',
+	message:
+		'The home page of the plugin (optional). Unique URL outside of WordPress.org:',
+};
+
+const version = {
+	type: 'input',
+	name: 'version',
+	message: 'The current version number of the plugin:',
+	validate( input ) {
+		// Regular expression was copied from https://semver.org.
+		const validSemVerPattern = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
+		if ( ! validSemVerPattern.test( input ) ) {
+			return 'Invalid Semantic Version provided. Visit https://regex101.com/r/vkijKf/1/ to discover all valid patterns.';
+		}
+
+		return true;
+	},
+};
+
 const author = {
 	type: 'input',
 	name: 'author',
@@ -92,19 +116,16 @@ const licenseURI = {
 	message: 'A link to the full text of the license (optional):',
 };
 
-const version = {
+const domainPath = {
 	type: 'input',
-	name: 'version',
-	message: 'The current version number of the plugin:',
-	validate( input ) {
-		// Regular expression was copied from https://semver.org.
-		const validSemVerPattern = /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/;
-		if ( ! validSemVerPattern.test( input ) ) {
-			return 'Invalid Semantic Version provided. Visit https://regex101.com/r/vkijKf/1/ to discover all valid patterns.';
-		}
+	name: 'domainPath',
+	message: 'A custom domain path for the translations (optional):',
+};
 
-		return true;
-	},
+const updateURI = {
+	type: 'input',
+	name: 'updateURI',
+	message: 'A custom update URI for the plugin (optional):',
 };
 
 module.exports = {
@@ -114,8 +135,11 @@ module.exports = {
 	description,
 	dashicon,
 	category,
+	pluginURI,
+	version,
 	author,
 	license,
 	licenseURI,
-	version,
+	domainPath,
+	updateURI,
 };

package/lib/scaffold.js

@@ -14,7 +14,7 @@ const { code, info, success } = require( './log' );
 const { writeOutputAsset, writeOutputTemplate } = require( './output' );
 
 module.exports = async (
-	{ blockOutputTemplates, outputTemplates, outputAssets },
+	{ blockOutputTemplates, pluginOutputTemplates, outputAssets },
 	{
 		$schema,
 		apiVersion,
@@ -27,12 +27,16 @@ module.exports = async (
 		attributes,
 		supports,
 		author,
+		pluginURI,
 		license,
 		licenseURI,
+		domainPath,
+		updateURI,
 		version,
 		wpScripts,
 		wpEnv,
 		npmDependencies,
+		customScripts,
 		folderName,
 		editorScript,
 		editorStyle,
@@ -43,7 +47,7 @@ module.exports = async (
 	namespace = namespace.toLowerCase();
 
 	info( '' );
-	info( `Creating a new WordPress plugin in "${ slug }" folder.` );
+	info( `Creating a new WordPress plugin in the "${ slug }" directory.` );
 
 	const view = {
 		$schema,
@@ -61,11 +65,16 @@ module.exports = async (
 		supports,
 		version,
 		author,
+		pluginURI,
 		license,
 		licenseURI,
 		textdomain: slug,
+		domainPath,
+		updateURI,
 		wpScripts,
+		wpEnv,
 		npmDependencies,
+		customScripts,
 		folderName,
 		editorScript,
 		editorStyle,
@@ -73,10 +82,10 @@ module.exports = async (
 	};
 
 	await Promise.all(
-		Object.keys( outputTemplates ).map(
+		Object.keys( pluginOutputTemplates ).map(
 			async ( outputFile ) =>
 				await writeOutputTemplate(
-					outputTemplates[ outputFile ],
+					pluginOutputTemplates[ outputFile ],
 					outputFile,
 					view
 				)
@@ -108,11 +117,11 @@ module.exports = async (
 
 	info( '' );
 	success(
-		`Done: block "${ title }" bootstrapped in the "${ slug }" folder.`
+		`Done: WordPress plugin "${ title }" bootstrapped in the "${ slug }" directory.`
 	);
 	if ( wpScripts ) {
 		info( '' );
-		info( 'Inside that directory, you can run several commands:' );
+		info( 'You can run several commands inside:' );
 		info( '' );
 		code( '  $ npm start' );
 		info( '    Starts the build for development.' );
@@ -129,11 +138,14 @@ module.exports = async (
 		code( '  $ npm run lint:js' );
 		info( '    Lints JavaScript files.' );
 		info( '' );
+		code( '  $ npm run plugin-zip' );
+		info( '    Creates a zip file for a WordPress plugin.' );
+		info( '' );
 		code( '  $ npm run packages-update' );
 		info( '    Updates WordPress packages to the latest version.' );
 	}
 	info( '' );
-	info( 'To enter the folder type:' );
+	info( 'To enter the directory type:' );
 	info( '' );
 	code( `  $ cd ${ slug }` );
 	if ( wpScripts ) {

package/lib/templates/{esnext/block → block}/index.js.mustache

@@ -30,7 +30,6 @@ registerBlockType( '{{namespace}}/{{slug}}', {
 	 * @see ./edit.js
 	 */
 	edit: Edit,
-
 	/**
 	 * @see ./save.js
 	 */

package/lib/templates/es5/$slug.php.mustache

@@ -1,6 +1,9 @@
 <?php
 /**
  * Plugin Name:       {{title}}
+{{#pluginURI}}
+ * Plugin URI:        {{{pluginURI}}}
+{{/pluginURI}}
 {{#description}}
  * Description:       {{description}}
 {{/description}}
@@ -17,6 +20,12 @@
  * License URI:       {{{licenseURI}}}
 {{/licenseURI}}
  * Text Domain:       {{textdomain}}
+{{#domainPath}}
+ * Domain Path:       {{{domainPath}}}
+{{/domainPath}}
+{{#updateURI}}
+ * Update URI:        {{{updateURI}}}
+{{/updateURI}}
  *
  * @package           {{namespace}}
  */

package/lib/templates/{esnext/plugin → plugin}/$slug.php.mustache

@@ -1,6 +1,9 @@
 <?php
 /**
  * Plugin Name:       {{title}}
+{{#pluginURI}}
+ * Plugin URI:        {{{pluginURI}}}
+{{/pluginURI}}
 {{#description}}
  * Description:       {{description}}
 {{/description}}
@@ -17,6 +20,12 @@
  * License URI:       {{{licenseURI}}}
 {{/licenseURI}}
  * Text Domain:       {{textdomain}}
+{{#domainPath}}
+ * Domain Path:       {{{domainPath}}}
+{{/domainPath}}
+{{#updateURI}}
+ * Update URI:        {{{updateURI}}}
+{{/updateURI}}
  *
  * @package           {{namespace}}
  */

package/lib/templates.js

@@ -22,10 +22,10 @@ const prompts = require( './prompts' );
 const predefinedPluginTemplates = {
 	es5: {
 		defaultValues: {
-			slug: 'es5-example',
-			title: 'ES5 Example',
+			slug: 'example-static-es5',
+			title: 'Example Static (ES5)',
 			description:
-				'Example block written with ES5 standard and no JSX – no build step required.',
+				'Example static block scaffolded with Create Block tool – no build step required.',
 			dashicon: 'smiley',
 			wpScripts: false,
 			editorScript: 'file:./index.js',
@@ -34,23 +34,17 @@ const predefinedPluginTemplates = {
 		},
 		templatesPath: join( __dirname, 'templates', 'es5' ),
 	},
-	esnext: {
+	static: {
 		defaultValues: {
-			slug: 'esnext-example',
-			title: 'ESNext Example',
+			slug: 'example-static',
+			title: 'Example Static',
 			description:
-				'Example block written with ESNext standard and JSX support – build step required.',
+				'Example static block scaffolded with Create Block tool.',
 			dashicon: 'smiley',
 			supports: {
 				html: false,
 			},
-			folderName: 'src',
-			editorScript: 'file:./index.js',
-			editorStyle: 'file:./index.css',
-			style: 'file:./style-index.css',
 		},
-		templatesPath: join( __dirname, 'templates', 'esnext', 'plugin' ),
-		blockTemplatesPath: join( __dirname, 'templates', 'esnext', 'block' ),
 	},
 };
 
@@ -103,22 +97,39 @@ const externalTemplateExists = async ( templateName ) => {
 };
 
 const configToTemplate = async ( {
-	assetsPath,
+	pluginTemplatesPath,
 	blockTemplatesPath,
 	defaultValues = {},
-	templatesPath,
+	assetsPath,
+	...deprecated
 } ) => {
-	if ( ! isObject( defaultValues ) || ! templatesPath ) {
+	if ( ! isObject( defaultValues ) ) {
 		throw new CLIError( 'Template found but invalid definition provided.' );
 	}
 
+	if ( deprecated.templatesPath ) {
+		pluginTemplatesPath = deprecated.templatesPath;
+		defaultValues = {
+			folderName: '.',
+			editorScript: 'file:./build/index.js',
+			editorStyle: 'file:./build/index.css',
+			style: 'file:./build/style-index.css',
+			...defaultValues,
+		};
+	} else {
+		pluginTemplatesPath =
+			pluginTemplatesPath || join( __dirname, 'templates', 'plugin' );
+		blockTemplatesPath =
+			blockTemplatesPath || join( __dirname, 'templates', 'block' );
+	}
+
 	return {
 		blockOutputTemplates: blockTemplatesPath
 			? await getOutputTemplates( blockTemplatesPath )
 			: {},
 		defaultValues,
 		outputAssets: assetsPath ? await getOutputAssets( assetsPath ) : {},
-		outputTemplates: await getOutputTemplates( templatesPath ),
+		pluginOutputTemplates: await getOutputTemplates( pluginTemplatesPath ),
 	};
 };
 
@@ -198,19 +209,20 @@ const getDefaultValues = ( pluginTemplate ) => {
 		licenseURI: 'https://www.gnu.org/licenses/gpl-2.0.html',
 		version: '0.1.0',
 		wpScripts: true,
+		customScripts: {},
 		wpEnv: false,
 		npmDependencies: [],
-		folderName: '.',
-		editorScript: 'file:./build/index.js',
-		editorStyle: 'file:./build/index.css',
-		style: 'file:./build/style-index.css',
+		folderName: './src',
+		editorScript: 'file:./index.js',
+		editorStyle: 'file:./index.css',
+		style: 'file:./style-index.css',
 		...pluginTemplate.defaultValues,
 	};
 };
 
-const getPrompts = ( pluginTemplate ) => {
+const getPrompts = ( pluginTemplate, keys ) => {
 	const defaultValues = getDefaultValues( pluginTemplate );
-	return Object.keys( prompts ).map( ( promptName ) => {
+	return keys.map( ( promptName ) => {
 		return {
 			...prompts[ promptName ],
 			default: defaultValues[ promptName ],

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/create-block",
-	"version": "2.8.0",
+	"version": "3.0.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": "bc1ccad6698ada7ea0096df8e55a188fcd3a1a26"
 }