Scripts: Scan block.json files to detect entry points for the build process
#37661
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
|
Size Change: 0 B Total Size: 1.13 MB ℹ️ View Unchanged
|
gziolo
force-pushed
the
update/scan-block-json-entry-points
branch
from
0f751a3 to
87dcefd
Compare
gziolo
commented
Dec 30, 2021
| name( module, chunks, cacheGroupKey ) { | ||
| return `${ cacheGroupKey }-${ chunks[ 0 ].name }`; | ||
| name( _, chunks, cacheGroupKey ) { | ||
| const chunkName = chunks[ 0 ].name; |
There was a problem hiding this comment.
We have to account for subfolders now. We missed that before which forces developers to use a flat structure in the build folder.
gziolo
commented
Dec 30, 2021
| @@ -45,6 +45,6 @@ module.exports = { | |||
| ], | |||
| reporters: [ | |||
| 'default', | |||
| '<rootDir>packages/scripts/config/jest-github-actions-reporter.js', | |||
| '<rootDir>packages/scripts/config/jest-github-actions-reporter/index.js', | |||
There was a problem hiding this comment.
I moved this reporter to a subfolder to ensure we have configs only at the root level of the config directory.
gziolo
added
the
Developer Experience
gziolo
changed the title
block.json files to detect entry points in the build processblock.json files to detect entry points for the build process
gziolo
force-pushed
the
update/scan-block-json-entry-points
branch
from
87dcefd to
e533e67
Compare
|
I rebased this branch with the latest changes applied to |
7 tasks
Closed
1 task
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
Partially addresses #25188.
This PR enhances how entry points for the plugin are discovered. They now can be detected by scanning all script fields in
block.jsonfiles located in thesrcdirectory. The fallback entry point remains the samesrc/index.js(other supported extensions:.jsx,.ts, and.tsx) in case there is noblock.jsonfile found.This complements #37612 where the
@wordpress/create-blockscaffolding tool can now putblock.jsonfile in thesrcdirectory and copies those files to thebuildfolder when runningwp-scripts build. The same change can also work separately with extra effort on the plugin's author side.More details in the screencasts:
wp-scripts-build-block-json-1.mov
wp-scripts-build-2.mov
How has this been tested?
Scaffolding
I generated three blocks using templates included in Gutenberg
ES5
ESNext + JSX (the default)
Gutenpride (handbook tutorial)
WordPress environment
I used
wp-envcommand integrated with the Gutenberg project.I created an override to the existing config:
File:
.wp-env.override.json{ "plugins": [ ".", "./es5-example", "./esnext-example", "./gutenpride" ] }I executed:
Testing plugins
I opened the following URL to test all the installed plugins: http://localhost:8888/wp-admin.
I created a new post and inserter all 3 blocks:
I saved the post and confirmed it renders correctly on the frontend.
Screenshots
Editor:
Frontend:
Types of changes
New feature (non-breaking change which adds functionality).
Checklist:
*.native.jsfiles for terms that need renaming or removal).