Scripts: Correctly resolve entry points when the directory is symlinked #54212
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
t-hamano
added
[Type] Bug
|
Size Change: +8.4 kB (+1%) Total Size: 1.52 MB
ℹ️ View Unchanged
|
t-hamano
force-pushed
the
scripts/fix-symlink-build
branch
from
214b7b0
to
ef5acd0
Compare
|
Flaky tests detected in ef5acd0. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/6096482834
|
t-hamano
changed the title
src directory is simlinked
t-hamano
commented
Sep 6, 2023
t-hamano
requested review from
gziolo,
ntwb,
nerrad,
ajitbohra and
ryanwelcher
as code owners
gziolo
reviewed
Sep 7, 2023
gziolo
approved these changes
Sep 8, 2023
There was a problem hiding this comment.
The code changes look good. Ideally, I'd like to wait to hear from @pbiron or @mastermind-0xff before landing these changes, so we can confirm it resolves the issue for them as reported in #44937.
|
Fix confirmed with #44937 (comment). |
the latest version of the PR works great in Windows, whether I run the scripts from the symlink dir or the target dir! |
|
I believe that this is going to be published to npm around September 20th, because the upcoming Gutenberg plugin release is delayed by a week. They are tied to each other to ensure the stability for WordPress packages unrelated to tooling. |
mikachan
added
[Type] Build Tooling
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 #44937
What?
This PR fixes a problem where a file other than
block.jsonis not generated when building a block using wp-scripts with a symlinked path.Note: This PR probably fixes a Windows-specific problem; nothing should change on MacOS, but I would appreciate it if you could test it to see if it works correctly.
Why?
In scripts, the path of
block.jsonis first searched for byglob()function.However, since the argument of the
glob()function is not an absolute path, such assrc/**/block.json, I expected that the path would not be resolved correctly when theblock.jsonpath was symlinked.Also, as with #38781, it appears that when using regular expressions in the
glob()function, they need to be unified with forward slashes.How?
Explicitly use the full path when searching for the path of
block.jsonand replace backslashes with forward slashes at the same time. This seems to have resulted in block.json being detected correctly and returning the resolved path at the same time.Testing Instructions
Note: For Windows users, start the command prompt with the administrator role.
pluginsdirectory in the root of the Gutenberg repository. and move to thepluginsdirectory.npx @wordpress/create-block test-block --no-wp-scripts. In thepluginsdirectory,test-blockdirectory should be created.test-block/builddirectory.renderproperty to thetest-block/src/block-a/block.jsonfile:"render": "file:./render.php"render.phpfile to thetest-block/src/block-a/directory.test-block/srcdirectory to the subdirectory calledtest-block/src/block-a.pluginsdirectory in another location calledplugins-symlink.mklink /d "C:\path\to\gutenberg/\plugins-symlink" "C:\path\to\gutenberg\plugins"ln -s /path/to/gutenberg/plugins /path/to/gutenberg/plugins-symlinkcd C:\path\to\plugins-symlink\test-blockcd /path/to/gutenberg/plugins-symlink/test-blockC:\path\to\gutenberg\node_modules\.bin\wp-scripts build/path/to/node_modules/.bin/wp-scripts buildtest-block/build/block-adirectory.