feat(svgr): create new Docusaurus SVGR plugin #10677
Open
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
slorber
added
the
Argos
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Size Change: +52 kB (+0.46%) Total Size: 11.3 MB
ℹ️ View Unchanged
|
⚡️ Lighthouse report for the deploy preview of this PR
|
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
|
Size Change: +54.8 kB (+0.47%) Total Size: 11.7 MB
ℹ️ View Unchanged
|
2 tasks
|
I'm not going to merge it right now because I'd like to do another patch release for v3.6 |
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.
Motivation
We historically include SVGR in core by default
This works but it's a bit annoying since it doesn't make it easy for configuring it, including SVGO optimizations that cause troubles in some cases:
Since we don't really want core to expose configuration options, let's extract all this logic to a dedicated plugin instead, that allows passing plugin options to configure both SVGR and SVGO.
Breaking change?
For v3 retro compatibility, I'm adding the new SVGR plugin to the classic preset. Since everybody uses the preset (afaik),
I'm not going to consider it a breaking change unless someone complains in which case we'll look for a solution that we could implement in a patch release.
Note: better retro-compatibility is possible to achieve. But it's more complex and probably not worth it. If any user doesn't use the preset, that's super easy to install/use the plugin manually.
Note: we may change our current SVGR/SVGO defaults in another PR, but that will be a breaking change. Tracked in #10679.
Usage
Preset:
Plugin:
Note the API is using
svgr.svgrConfigon purpose, it's not a mistake. We might add plugin options that are not directly SVGR options in the future but are more related to the SVGR + Webpack (loader) integration. Or options that decide whether or not to merge the provided config into the default one.Customizing SVGO
Provide custom SVGO options this way:
If you want to use a custom
svgo.config.jsfile you can usesvgoConfig: undefined. When not passing any explicit SVGO config options (which we do by default), the SVGO config file will be used.Test Plan
CI + Argos
Test links
Pages with SVGs:
Docs:
.svgo.config.js.svgo.config.jsRelated issues/PRs
See: