Scripts: Recommend passing JS entry points with paths#68251
Conversation
|
Size Change: 0 B Total Size: 1.84 MB ℹ️ View Unchanged
|
|
Flaky tests detected in c311cc9. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/12580277890
|
|
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. |
sirreal
left a comment
There was a problem hiding this comment.
I have not tested done manual testing.
The changes and documentation updates look correct.
I included testing instructions in the PR's description that I used to validate that the changes work as expected. |
* Scripts: Recommend passing JS entry points with paths * Add changelog entries * Improve the code documentation * Improve the code documentation * Improve documentation around the source path Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: sirreal <jonsurrell@git.wordpress.org>
* Scripts: Recommend passing JS entry points with paths * Add changelog entries * Improve the code documentation * Improve the code documentation * Improve documentation around the source path Co-authored-by: gziolo <gziolo@git.wordpress.org> Co-authored-by: sirreal <jonsurrell@git.wordpress.org>
What?
Improves listing entry points in the build commands:
buildandstartfrom the@wordpress/scriptspackage. Using explicit entry points in the command becomes the recommended way to build the project that contains JavaScript code for UI plugins extending the editor in WordPress core.Why?
Today,
@wordpress/create-blockis too optimized for the specific use case of developing a single block as a WordPress plugin. Things quickly get more complicated when a custom JavaScript is integrated to extend the block editor. In particular, extending the default webpack config included with@wordpress/scriptsis way too complex. This is an attempt to address it by promoting an improved strategy for handling multiple JacaScript files as entry points.How?
Testing Instructions
Create a new
my-pluginfolder:mkdir my-plugin cd my-pluginCreate a
package.jsonfile:Create two JavaScript files in the
my-pluginsubfolder:entry-one.js
entry-two.js
Run the build
Ensure that two files were bundled in the
buildfolder:Move two entry points to the
testfolder and run the command again with different params:Ensure that two files were bundled in the
distfolder: