Create Block: Optimize the default template for multiple blocks case #68175
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gziolo
added
[Type] Enhancement
gziolo
requested review from
ryanwelcher,
ntwb,
nerrad and
ajitbohra
as code owners
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
gziolo
commented
Dec 20, 2024
| @@ -59,6 +59,7 @@ const predefinedPluginTemplates = { | |||
| }, | |||
| viewScript: 'file:./view.js', | |||
| example: {}, | |||
| folderName: './src/$slug', | |||
There was a problem hiding this comment.
I modified that only for the default templates bundled with the package instead of for every project template, as I'm not entirely sure what implications it would have for developer docs. @ndiego, do you forsee any complications?
|
Size Change: 0 B Total Size: 1.84 MB ℹ️ View Unchanged
|
|
Flaky tests detected in a499ab2. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12429700727
|
7 tasks
gziolo
added
the
Good First Review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Related to #25188.
@ryanwelcher explores a variant of the template that automatically supports multiple blocks in the single plugin:
Here, I propose updating the default template to scaffold a block in its subfolder named after the block's slug to make it easier to update to multiple blocks in a single plugin.
Why?
When a developer needs to add more than one block in a WordPress plugin scaffolder by
npx @wordpress/create-blockthey often need to move the first block to a subfolder and update the path in PHP file accordingly.How?
The default path to the block can be extended to contain the block's slug as the folder name.
Testing Instructions
Testing Instructions for Keyboard
Run
npm run test:create-blockand make sure the tests pass.Scaffold a block and inspect the project:
Ensure that the block still works as before in the block editor.