Build Tooling: Correctly generate PHP files for server-side rendering of blocks on Windows OS #65248
Conversation
This file contains hidden or 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
… of blocks on Windows OS
t-hamano
added
[Type] Bug
t-hamano
commented
Sep 11, 2024
tools/webpack/blocks.js
Outdated
| from: `${ from }/**/*.php`, | ||
| to( { absoluteFilename } ) { | ||
| const [ , dirname, basename ] = | ||
| const [ , dirname, _basename ] = |
Contributor
Author
There was a problem hiding this comment.
This change was necessary to prevent an eslint error regarding the scope of the basename variable.
Member
There was a problem hiding this comment.
I'd prefer to completely rename one of these basenames, maybe this one should become fileBasename? The _ prefix often indicates unused or private variables and I think this can be more descriptive.
Contributor
Author
There was a problem hiding this comment.
Certainly. I updated it that way.
t-hamano
removed
the
[Type] Bug
|
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. |
|
Size Change: -211 B (-0.01%) Total Size: 1.77 MB
ℹ️ View Unchanged
|
sirreal
approved these changes
Sep 12, 2024
Member
sirreal
left a comment
sirreal
left a comment
There was a problem hiding this comment.
This looks correct. I've built zips before and after this change on my machine and they seem to include the exact same files. Thanks!
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.
Fixes #65244
What?
This PR correctly generates PHP files for server-side rendering of blocks when running
npm run {start|build}on a Windows host OS.Why?
This issue was caused by #63311.
After investigating the
tools\webpack\blocks.jsfile, which is a custom setting for the Gutenberg project, I found that thefilepathargument to thefilteroption of theCopyWebpackPluginplugin uses forward slashes instead of backslashes even on Windows OS.Example of
filepath:D:/Desktop/path/to/gutenberg/packages/block-library/src/archives/index.phpOn the other hand,
path.sepis a backslash on Windows OS, so it does not match the following conditional statement.How?
It is probably better to check the file name accurately with
path.basenamerather than checking the file name withendsWithmethod.Just to be sure, I ran
npm run buildon WSL2 (Ubuntu OS) and Windows host OS and got the diff of the entirebuild/directory, and the file configuration of each build directory is completely consistent in this PR.Testing Instructions
npm run {start|build}, make sure that the PHP file is generated inbuild/block-library/blocks/. as before.