Scripts: Replace url-loader for SVGs with asset modules #39407
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
ocean90
added
[Type] Build Tooling
|
Size Change: 0 B Total Size: 1.16 MB ℹ️ View Unchanged
|
Yes, it's not easy to decide. I would say, it's fine to include in Thank you for working on the PR. It nicely aligns with other changes related to how webpack 5 handles assets. It's another breaking change, so I hope it won't cause too much distraction. I wish we would add it earlier with all other webpack 5 changes. |
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.
What?
This PRs tries to replace
url-loaderfor SVGs with Asset Modules which were introduced in webpack 5.Why?
The current solution is deprecated and it's recommend in the documentation of
@svgr/webpackto use the asset modules. Also, If you want to use a SVG as a React component you currently have to explicitly import aReactComponentlike so:How?
I'm removing
url-loaderas a dependency and updated the implementation based on https://react-svgr.com/docs/webpack/#use-svgr-and-asset-svg-in-the-same-project. Now you can do:Unfortunately,
'./star.svg?url'is currently causing an ESLint error:That's why I added the webpack resolver. But I'm currently not sure if that's a good idea and/or whether this can be part of the eslint-plugin instead and maybe a simple custom resolver which only handles this part should be created.
Testing Instructions
npx wp-create-block example-static --no-wp-scriptsexample-staticedit.jsEdit()by adding the following into the existing paragraph element:../node_modules/.bin/wp-scripts buildThe build folder should now have an
imagesdirectory with the SVG andindex.jshas also the SVG element.Visual output:
