@wordpress/create-block 4.57.0 → 4.58.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/check-system-requirements.js

@@ -1,7 +1,7 @@
 /**
  * External dependencies
  */
-const inquirer = require( 'inquirer' );
+const { confirm } = require( '@inquirer/prompts' );
 const checkSync = require( 'check-node-version' );
 const tools = require( 'check-node-version/tools' );
 const { promisify } = require( 'util' );
@@ -34,14 +34,10 @@ async function checkSystemRequirements( engines ) {
 		log.error( 'The program may not complete correctly if you continue.' );
 		log.info( '' );
 
-		const { yesContinue } = await inquirer.prompt( [
-			{
-				type: 'confirm',
-				name: 'yesContinue',
-				message: 'Are you sure you want to continue anyway?',
-				default: false,
-			},
-		] );
+		const yesContinue = await confirm( {
+			message: 'Are you sure you want to continue anyway?',
+			default: false,
+		} );
 
 		if ( ! yesContinue ) {
 			log.error( 'Cancelled.' );

package/lib/index.js

@@ -1,7 +1,7 @@
 /**
  * External dependencies
  */
-const inquirer = require( 'inquirer' );
+const { confirm, select } = require( '@inquirer/prompts' );
 const { capitalCase } = require( 'change-case' );
 const program = require( 'commander' );
 
@@ -14,9 +14,9 @@ const log = require( './log' );
 const { engines, version } = require( '../package.json' );
 const scaffold = require( './scaffold' );
 const {
-	getPluginTemplate,
 	getDefaultValues,
-	getPrompts,
+	getProjectTemplate,
+	runPrompts,
 } = require( './templates' );
 
 const commandName = `wp-create-block`;
@@ -79,11 +79,13 @@ program
 				targetDir,
 			}
 		) => {
-			await checkSystemRequirements( engines );
 			try {
-				const pluginTemplate = await getPluginTemplate( templateName );
+				await checkSystemRequirements( engines );
+
+				const projectTemplate =
+					await getProjectTemplate( templateName );
 				const availableVariants = Object.keys(
-					pluginTemplate.variants
+					projectTemplate.variants
 				);
 				if ( variant && ! availableVariants.includes( variant ) ) {
 					if ( ! availableVariants.length ) {
@@ -113,7 +115,7 @@ program
 
 				if ( slug ) {
 					const defaultValues = getDefaultValues(
-						pluginTemplate,
+						projectTemplate,
 						variant
 					);
 					const answers = {
@@ -123,7 +125,7 @@ program
 						title: capitalCase( slug ),
 						...optionsValues,
 					};
-					await scaffold( pluginTemplate, answers );
+					await scaffold( projectTemplate, answers );
 				} else {
 					log.info( '' );
 					log.info(
@@ -133,25 +135,22 @@ program
 					);
 
 					if ( ! variant && availableVariants.length > 1 ) {
-						const result = await inquirer.prompt( {
-							type: 'list',
-							name: 'variant',
+						variant = await select( {
 							message:
 								'The template variant to use for this block:',
-							choices: availableVariants,
+							choices: availableVariants.map( ( value ) => ( {
+								value,
+							} ) ),
 						} );
-						variant = result.variant;
 					}
 
 					const defaultValues = getDefaultValues(
-						pluginTemplate,
+						projectTemplate,
 						variant
 					);
 
-					const filterOptionsProvided = ( { name } ) =>
-						! Object.keys( optionsValues ).includes( name );
-					const blockPrompts = getPrompts(
-						pluginTemplate,
+					const blockAnswers = await runPrompts(
+						projectTemplate,
 						[
 							'slug',
 							'namespace',
@@ -159,45 +158,36 @@ program
 							'description',
 							'dashicon',
 							'category',
-						],
-						variant
-					).filter( filterOptionsProvided );
-					const blockAnswers = await inquirer.prompt( blockPrompts );
-
-					const pluginAnswers = plugin
-						? await inquirer
-								.prompt( {
-									type: 'confirm',
-									name: 'configurePlugin',
-									message:
-										'Do you want to customize the WordPress plugin?',
-									default: false,
-								} )
-								.then( async ( { configurePlugin } ) => {
-									if ( ! configurePlugin ) {
-										return {};
-									}
+							! plugin && 'textdomain',
+						].filter( Boolean ),
+						variant,
+						optionsValues
+					);
 
-									const pluginPrompts = getPrompts(
-										pluginTemplate,
-										[
-											'pluginURI',
-											'version',
-											'author',
-											'license',
-											'licenseURI',
-											'domainPath',
-											'updateURI',
-										],
-										variant
-									).filter( filterOptionsProvided );
-									const result =
-										await inquirer.prompt( pluginPrompts );
-									return result;
-								} )
-						: {};
+					const pluginAnswers =
+						plugin &&
+						( await confirm( {
+							message:
+								'Do you want to customize the WordPress plugin?',
+							default: false,
+						} ) )
+							? await runPrompts(
+									projectTemplate,
+									[
+										'pluginURI',
+										'version',
+										'author',
+										'license',
+										'licenseURI',
+										'domainPath',
+										'updateURI',
+									],
+									variant,
+									optionsValues
+							  )
+							: {};
 
-					await scaffold( pluginTemplate, {
+					await scaffold( projectTemplate, {
 						...defaultValues,
 						...optionsValues,
 						variant,
@@ -209,6 +199,9 @@ program
 				if ( error instanceof CLIError ) {
 					log.error( error.message );
 					process.exit( 1 );
+				} else if ( error.name === 'ExitPromptError' ) {
+					log.info( 'Cancelled.' );
+					process.exit( 1 );
 				} else {
 					throw error;
 				}

package/lib/prompts.js

@@ -11,7 +11,6 @@ const upperFirst = ( [ firstLetter, ...rest ] ) =>
 // Block metadata.
 const slug = {
 	type: 'input',
-	name: 'slug',
 	message:
 		'The block slug used for identification (also the output folder name):',
 	validate( input ) {
@@ -25,7 +24,6 @@ const slug = {
 
 const namespace = {
 	type: 'input',
-	name: 'namespace',
 	message:
 		'The internal namespace for the block name (something unique for your products):',
 	validate( input ) {
@@ -39,25 +37,22 @@ const namespace = {
 
 const title = {
 	type: 'input',
-	name: 'title',
 	message: 'The display title for your block:',
-	filter( input ) {
+	transformer( input ) {
 		return input && upperFirst( input );
 	},
 };
 
 const description = {
 	type: 'input',
-	name: 'description',
 	message: 'The short description for your block (optional):',
-	filter( input ) {
+	transformer( input ) {
 		return input && upperFirst( input );
 	},
 };
 
 const dashicon = {
 	type: 'input',
-	name: 'dashicon',
 	message:
 		'The dashicon to make it easier to identify your block (optional):',
 	validate( input ) {
@@ -67,29 +62,41 @@ const dashicon = {
 
 		return true;
 	},
-	filter( input ) {
+	transformer( input ) {
 		return input && input.replace( /dashicon(s)?-/, '' );
 	},
 };
 
 const category = {
-	type: 'list',
-	name: 'category',
+	type: 'select',
 	message: 'The category name to help users browse and discover your block:',
-	choices: [ 'text', 'media', 'design', 'widgets', 'theme', 'embed' ],
+	choices: [ 'text', 'media', 'design', 'widgets', 'theme', 'embed' ].map(
+		( value ) => ( { value } )
+	),
+};
+
+const textdomain = {
+	type: 'input',
+	message:
+		'The text domain used to make strings translatable in the block (optional):',
+	validate( input ) {
+		if ( input.length && ! /^[a-z][a-z0-9\-]*$/.test( input ) ) {
+			return 'Invalid text domain specified. Text domain can contain only lowercase alphanumeric characters or dashes, and start with a letter.';
+		}
+
+		return true;
+	},
 };
 
 // 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.
@@ -105,32 +112,27 @@ const version = {
 
 const author = {
 	type: 'input',
-	name: 'author',
 	message:
 		'The name of the plugin author (optional). Multiple authors may be listed using commas:',
 };
 
 const license = {
 	type: 'input',
-	name: 'license',
 	message: 'The short name of the plugin’s license (optional):',
 };
 
 const licenseURI = {
 	type: 'input',
-	name: 'licenseURI',
 	message: 'A link to the full text of the license (optional):',
 };
 
 const domainPath = {
 	type: 'input',
-	name: 'domainPath',
 	message: 'A custom domain path for the translations (optional):',
 };
 
 const updateURI = {
 	type: 'input',
-	name: 'updateURI',
 	message: 'A custom update URI for the plugin (optional):',
 };
 
@@ -141,6 +143,7 @@ module.exports = {
 	description,
 	dashicon,
 	category,
+	textdomain,
 	pluginURI,
 	version,
 	author,

package/lib/scaffold.js

@@ -26,6 +26,7 @@ module.exports = async (
 		description,
 		dashicon,
 		category,
+		textdomain,
 		attributes,
 		supports,
 		author,
@@ -35,6 +36,9 @@ module.exports = async (
 		domainPath,
 		updateURI,
 		version,
+		requiresAtLeast,
+		requiresPHP,
+		testedUpTo,
 		wpScripts,
 		wpEnv,
 		npmDependencies,
@@ -57,13 +61,12 @@ module.exports = async (
 	}
 ) => {
 	slug = slug.toLowerCase();
-	namespace = namespace.toLowerCase();
 	const rootDirectory = join( process.cwd(), targetDir || slug );
 	const transformedValues = transformer( {
 		$schema,
 		apiVersion,
 		plugin,
-		namespace,
+		namespace: namespace.toLowerCase(),
 		slug,
 		title,
 		description,
@@ -78,12 +81,15 @@ module.exports = async (
 		domainPath,
 		updateURI,
 		version,
+		requiresAtLeast,
+		requiresPHP,
+		testedUpTo,
 		wpScripts,
 		wpEnv,
 		npmDependencies,
 		npmDevDependencies,
 		customScripts,
-		folderName,
+		folderName: folderName.replace( /\$slug/g, slug ),
 		editorScript,
 		editorStyle,
 		style,
@@ -95,7 +101,7 @@ module.exports = async (
 		customPackageJSON,
 		customBlockJSON,
 		example,
-		textdomain: slug,
+		textdomain: textdomain || slug,
 		rootDirectory,
 	} );
 

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

@@ -7,9 +7,13 @@
 {{#description}}
  * Description:       {{description}}
 {{/description}}
- * Requires at least: 6.6
- * Requires PHP:      7.2
  * Version:           {{version}}
+{{#requiresAtLeast}}
+ * Requires at least: {{requiresAtLeast}}
+{{/requiresAtLeast}}
+{{#requiresPHP}}
+ * Requires PHP:      {{requiresPHP}}
+{{/requiresPHP}}
 {{#author}}
  * Author:            {{author}}
 {{/author}}

package/lib/templates/es5/readme.txt.mustache

@@ -3,7 +3,9 @@
 Contributors:      {{author}}
 {{/author}}
 Tags:              block
-Tested up to:      6.6
+{{#testedUpTo}}
+Tested up to:      {{testedUpTo}}
+{{/testedUpTo}}
 Stable tag:        {{version}}
 {{#license}}
 License:           {{license}}

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

@@ -7,9 +7,13 @@
 {{#description}}
  * Description:       {{description}}
 {{/description}}
- * Requires at least: 6.6
- * Requires PHP:      7.2
  * Version:           {{version}}
+{{#requiresAtLeast}}
+ * Requires at least: {{requiresAtLeast}}
+{{/requiresAtLeast}}
+{{#requiresPHP}}
+ * Requires PHP:      {{requiresPHP}}
+{{/requiresPHP}}
 {{#author}}
  * Author:            {{author}}
 {{/author}}
@@ -42,6 +46,6 @@ if ( ! defined( 'ABSPATH' ) ) {
  * @see https://developer.wordpress.org/reference/functions/register_block_type/
  */
 function {{namespaceSnakeCase}}_{{slugSnakeCase}}_block_init() {
-	register_block_type( __DIR__ . '/build' );
+	register_block_type( __DIR__ . '/build/{{slug}}' );
 }
 add_action( 'init', '{{namespaceSnakeCase}}_{{slugSnakeCase}}_block_init' );

package/lib/templates/plugin/readme.txt.mustache

@@ -3,7 +3,9 @@
 Contributors:      {{author}}
 {{/author}}
 Tags:              block
-Tested up to:      6.6
+{{#testedUpTo}}
+Tested up to:      {{testedUpTo}}
+{{/testedUpTo}}
 Stable tag:        {{version}}
 {{#license}}
 License:           {{license}}

package/lib/templates.js

@@ -1,6 +1,7 @@
 /**
  * External dependencies
  */
+const inquirer = require( '@inquirer/prompts' );
 const { command } = require( 'execa' );
 const glob = require( 'fast-glob' );
 const { resolve } = require( 'path' );
@@ -58,6 +59,7 @@ const predefinedPluginTemplates = {
 			},
 			viewScript: 'file:./view.js',
 			example: {},
+			folderName: './src/$slug',
 		},
 		variants: {
 			static: {},
@@ -157,7 +159,7 @@ const configToTemplate = async ( {
 	};
 };
 
-const getPluginTemplate = async ( templateName ) => {
+const getProjectTemplate = async ( templateName ) => {
 	if ( predefinedPluginTemplates[ templateName ] ) {
 		return await configToTemplate(
 			predefinedPluginTemplates[ templateName ]
@@ -224,16 +226,20 @@ const getPluginTemplate = async ( templateName ) => {
 	}
 };
 
-const getDefaultValues = ( pluginTemplate, variant ) => {
+const getDefaultValues = ( projectTemplate, variant ) => {
 	return {
 		$schema: 'https://schemas.wp.org/trunk/block.json',
 		apiVersion: 3,
 		namespace: 'create-block',
 		category: 'widgets',
+		textdomain: '',
 		author: 'The WordPress Contributors',
 		license: 'GPL-2.0-or-later',
 		licenseURI: 'https://www.gnu.org/licenses/gpl-2.0.html',
 		version: '0.1.0',
+		requiresAtLeast: '6.7',
+		requiresPHP: '7.4',
+		testedUpTo: '6.7',
 		wpScripts: true,
 		customScripts: {},
 		wpEnv: false,
@@ -243,20 +249,33 @@ const getDefaultValues = ( pluginTemplate, variant ) => {
 		editorStyle: 'file:./index.css',
 		style: 'file:./style-index.css',
 		transformer: ( view ) => view,
-		...pluginTemplate.defaultValues,
-		...pluginTemplate.variants?.[ variant ],
-		variantVars: getVariantVars( pluginTemplate.variants, variant ),
+		...projectTemplate.defaultValues,
+		...projectTemplate.variants?.[ variant ],
+		variantVars: getVariantVars( projectTemplate.variants, variant ),
 	};
 };
 
-const getPrompts = ( pluginTemplate, keys, variant ) => {
-	const defaultValues = getDefaultValues( pluginTemplate, variant );
-	return keys.map( ( promptName ) => {
-		return {
-			...prompts[ promptName ],
+const runPrompts = async (
+	projectTemplate,
+	promptNames,
+	variant,
+	optionsValues
+) => {
+	const defaultValues = getDefaultValues( projectTemplate, variant );
+	const result = {};
+	for ( const promptName of promptNames ) {
+		if ( Object.keys( optionsValues ).includes( promptName ) ) {
+			continue;
+		}
+
+		const { type, ...config } = prompts[ promptName ];
+		result[ promptName ] = await inquirer[ type ]( {
+			...config,
 			default: defaultValues[ promptName ],
-		};
-	} );
+		} );
+	}
+
+	return result;
 };
 
 const getVariantVars = ( variants, variant ) => {
@@ -277,7 +296,7 @@ const getVariantVars = ( variants, variant ) => {
 };
 
 module.exports = {
-	getPluginTemplate,
 	getDefaultValues,
-	getPrompts,
+	getProjectTemplate,
+	runPrompts,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/create-block",
-	"version": "4.57.0",
+	"version": "4.58.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,14 +31,14 @@
 		"wp-create-block": "./index.js"
 	},
 	"dependencies": {
-		"@wordpress/lazy-import": "*",
+		"@inquirer/prompts": "^7.2.0",
+		"@wordpress/lazy-import": "^2.15.0",
 		"chalk": "^4.0.0",
 		"change-case": "^4.1.2",
 		"check-node-version": "^4.1.0",
 		"commander": "^9.2.0",
 		"execa": "^4.0.2",
 		"fast-glob": "^3.2.7",
-		"inquirer": "^7.1.0",
 		"make-dir": "^3.0.0",
 		"mustache": "^4.0.0",
 		"npm-package-arg": "^8.1.5",
@@ -48,5 +48,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "b432c18934c9db866b6dba7d37517a4e97d642e3"
+	"gitHead": "75a65eb8ffc168a92042544052f46d080a71ea45"
 }