Create Block: Add lifecycle script execution support

[Adi-ty]

What?

Closes #71069

Currently, when using custom templates with @wordpress/create-block, postinstall script is being ignored during the scaffolding process. They get added to the generated package.json file but are never executed during the initial setup.

Why?

This is particularly problematic for external templates like WooCommerce's that rely on postinstall script for additional configuration and setup steps.

How?

Added lifecycle script execution support in the init-wp-scripts.js.

Testing Instructions

1. Create a test template with a postinstall script in package.json:

   {
     "scripts": {
       "postinstall": "echo 'Custom post-install setup complete'"
     }
   }

2. Run node packages/create-block/index.js test-block --template=./path/to/your/template with the template

3. Verify the lifecycle script executes and you see the logging output

4. Confirm the script runs successfully and the scaffolding process completes

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: Adi-ty <[email protected]>
Co-authored-by: gziolo <[email protected]>
Co-authored-by: ryanwelcher <[email protected]>
Co-authored-by: bacoords <[email protected]>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[gziolo]

It looks like npm install is never executed in a way that would automatically trigger preinstall and postinstall. Maybe more idiomatic way to go about it would be to refactor code to set dependencies and devDependencies in package.json and run npm install in one go instead of going one by one here.

[Adi-ty]

@gziolo Thanks for the feedback! I think the more idiomatic way would be to run a single npm install command that naturally triggers lifecycle scripts. I'll refactor the code to use this approach and push the updated implementation.

[Adi-ty]

@gziolo, should we use --legacy-peer-deps with npm install for peer dependency conflicts in templates to prioritize successful project creation over strict dependency resolution?

[ryanwelcher]

Maybe more idiomatic way to go about it would be to refactor code to set dependencies and devDependencies in package.json and run npm install in one go instead of going one by one here.

This is exactly what @bacoords and I were thinking as well. Doing that would also allow us to potentially include a package.json in the template files.

[gziolo]

I successfully tested it by adding the following entries in the template configuration:

{
	npmDependencies: [ '@wordpress/blocks' ],
	customScripts: {
		postinstall:
			"echo 'Custom post-install setup complete' > postinstall.txt",
		},
	},
}

This is how package.json looks like:

Previously, it would set the current latest version for @wordpress/blocks rather than the string latest.

A file was correctly created with postinstall:

I had to write to the file because npm install is noisy, so all messages are silenced during scaffolding.

---

Aside, in a follow-up PR, we could refactor further how @wordpress/scripts and @wordpress/env are installed as they could be added directly to devDependencies before running the unified npm install. Currently, they are still installed seperately.

[gziolo]

I updated the branch with the latest changes from trunk, added a changelog entry, and enabled auto-merge for this PR.

[Adi-ty]

Aside, in a follow-up PR, we could refactor further how @wordpress/scripts and @wordpress/env are installed as they could be added directly to devDependencies before running the unified npm install. Currently, they are still installed seperately.

@gziolo Thanks for the suggestion about unifying the @wordpress/scripts and @wordpress/env installation!

I'd be happy to work on a follow-up PR