Create Block: Improve custom project template configuration #39049
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] Breaking Change
|
Size Change: 0 B Total Size: 1.15 MB ℹ️ View Unchanged
|
gziolo
force-pushed
the
update/create-block-better-template-configuration
branch
from
1bfc038 to
4a2aed3
Compare
gziolo
requested review from
mkaz,
ryanwelcher,
ntwb,
nerrad and
ajitbohra
as code owners
ryanwelcher
requested changes
Feb 24, 2022
gziolo
changed the title
gziolo
force-pushed
the
update/create-block-better-template-configuration
branch
from
57eb4fe to
1cebad1
Compare
@ryanwelcher, can you check again? |
gziolo
added a commit
that referenced
this pull request
Mar 3, 2022
* Create Block: Improve project template configuration * Update the tutorial for block creation * Create Block: Improve documentation
mcsf
reviewed
Mar 31, 2022
| expected=6 | ||
| actual=$( find src -maxdepth 1 -type f | wc -l ) | ||
| if [ "$expected" -ne "$actual" ]; then | ||
| error "Expected $expected files in the `src` directory, but found $actual." |
There was a problem hiding this comment.
@gziolo: In sh and bash, backticks are the old way to represent command substitution. Which means that the line above actually evals as:
error "Expected $expected files in the $(src) directory ..."which will invoke src as a command that it will try to find in $PATH, which will either fail or do something that we don't want.
The fix should be to escape:
error "Expected $expected files in the \`src\` directory, but found $actual."The same applies for this other occurrence in the file:
error "Expected $expected files in the `build` directory, but found $actual."There was a problem hiding this comment.
Great to know. I'll update all that tomorrow. Thank you for the comment.
There was a problem hiding this comment.
It took me 20 days, but PR is ready: #40473 😅
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.
Description
Part of #25188. It addresses the action items listed by @ryanwelcher in #25188 (comment):
Changes applied
Breaking Changes
templatesPathoption when configuring the custom project template for@wordpress/create-block.@wordpress/create-blockwill 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 thepluginTemplatesPathand/orblockTemplatesPathoptions.esnextproject template got renamed tostaticin@wordpress/create-block.Deprecations
@wordpress/create-block, thetemplatesPathoption got renamed topluginTemplatesPath. The old name still works but is considered deprecated, and it might get removed in the futureDocumentation
@wordpress/create-blockpackage.Create a Block Tutorial
Fixes #27565. As part of the efforts, I updated
@wordpress/create-block-tutorial-templatepackage to become compatible with the new project template configuration. I also updated all pages inCreate a Block Tutorialto align closely with the scaffolder project.Automated Testing
Finally, I extended
./bin/test-create-block.shscript that runs verification on Continues Integration to cover two basic templates:statices5Testing Instructions
I scaffolded three test blocks using templates included in Gutenberg for the
@wordpress/create-blockpackage.npx wp-create-block example-static --no-wp-scripts cd example-static ../node_modules/.bin/wp-scripts buildnpx wp-create-block gutenpride --template @wordpress/create-block-tutorial-template --no-wp-scripts cd gutenpride ../node_modules/.bin/wp-scripts buildI tested all 3 blocks and they still work as intended when inserted into the post or theme template.
I also ensured that all verification pass on CI and locally for the integration tests that can be executed with:
Types of changes
Breaking change (fix or feature that would cause existing functionality to not work as expected).
Checklist:
*.native.jsfiles for terms that need renaming or removal).