chore(deps): update dependency svgo to v4#5383
Conversation
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
Dependency Update Review: svgo v3.3.3 → v4.0.1
This is a Renovate-managed update pinning the svgo transitive dependency (via resolutions in docs/package.json) to the latest major version.
What's happening
svgo is not a direct dependency of the docs site — it's pulled in transitively (likely by Docusaurus or its SVG-handling plugins). The resolutions field forces all consumers to use the pinned version.
Noteworthy items
Security improvement: svgo v4.0.1 enforces sax >= 1.5.0, which improves protection against XML entity expansion attacks. This is a good reason to accept the major bump.
Resolution scope: The yarn.lock entry svgo@4.0.1, svgo@^3.0.2, svgo@^3.2.0 shows that all transitive consumers requesting ^3.x ranges are being overridden to v4. This is intentional behavior of the resolutions field, but worth being aware of — if any transitive dependency relied on svgo v3-specific APIs (e.g., removeScriptElement renamed to removeScripts, or the changed querySelectorAll signature), it could silently break SVG optimization in the docs build.
Breaking changes in v4: The major breaking changes (import restructuring, plugin renames, selector helper API changes) only matter if custom SVGO config or plugins are used. Since this repo doesn't appear to have a custom svgo.config.js in the docs directory, the default preset change (disabling removeViewBox and removeTitle) is the most likely behavioral difference — preserving SVG scalability and accessibility is arguably better behavior anyway.
Lock file: The cascading dependency updates (css-tree v2 → v3, mdn-data 2.0.30 → 2.27.1, commander v7 → v11, picocolors 1.0.0 → 1.1.1) all look consistent with the svgo v4 requirements.
Verdict
The change looks correct and safe for a docs site with no custom SVGO configuration. The security improvement in v4.0.1 (sax entity expansion guards) is a good justification for accepting this major version bump.
879e109 to
192e72f
Compare
There was a problem hiding this comment.
Review: svgo v3.3.3 → v4.0.1 (Renovate Bot Update)
This is a follow-up to the previous review. The PR updates the svgo resolution pin in docs/package.json from v3.3.3 to v4.0.1.
Summary of Changes
The diff is clean and straightforward:
docs/package.json: resolution pin updated from3.3.3to4.0.1docs/yarn.lock: cascading dependency updates (css-tree v2→v3, mdn-data 2.0.30→2.27.1, commander v7→v11, picocolors 1.0.0→1.1.1, sax ≥1.5.0 enforced)
Assessment
No concerns with this update. The previous review comments identified all relevant considerations, and nothing has changed since then that would affect the assessment:
-
CI is passing where it matters — The "Test Deploy to GitHub Pages" check passed successfully (1m44s), which is the most relevant validation that the docs build works correctly with svgo v4. This is the key signal that the major version bump did not break anything in practice.
-
Security — The sax ≥ 1.5.0 enforcement in v4.0.1 provides improved XML entity expansion guards. This is a concrete security improvement.
-
No custom SVGO config — Since the docs directory doesn't use a custom
svgo.config.js, the breaking API changes in v4 (renamed plugins, restructured imports, selector helper changes) are not applicable. -
Behavioral change is benign — The default-preset change (disabling
removeViewBoxandremoveTitle) means docs SVGs will preserve scalability and accessibility attributes, which is better behavior. -
Lock file consistency — All transitive dependency bumps are consistent and expected for svgo v4's stated requirements.
Verdict
Approve. The docs deploy check passed, Codacy and Snyk show no new issues, and the update brings a security improvement. Safe to merge.
192e72f to
e24cb07
Compare
There was a problem hiding this comment.
Follow-up Review: svgo v3.3.3 → v4.0.1
This is a Renovate-managed resolution pin update for svgo in docs/package.json, scoped entirely to the docs site. The diff is limited to docs/package.json and docs/yarn.lock — there are no changes to any C# source, source generators, test projects, or .csproj files.
Previous review points — all remain valid
Both prior claude reviews correctly identified the key considerations:
- No custom
svgo.config.jsin the docs directory, so v4 breaking API changes (plugin renames, import restructuring, selector helper signature changes) do not apply. - The default-preset behavioral change (disabling
removeViewBoxandremoveTitle) is a net improvement for SVG scalability and accessibility. - The
sax >= 1.5.0enforcement in v4.0.1 is a concrete security improvement (XML entity expansion guards). - All cascading lock file updates (css-tree v2→v3, mdn-data 2.0.30→2.27.1, commander v7→v11) are consistent with svgo v4's stated requirements.
Current CI state
Checks are currently pending on a new run (the "Test Deploy to GitHub Pages" check, which is the key validation for this change, previously passed in an earlier run per the prior reviews). Snyk security shows 9 tests passing with no new issues.
No new concerns
Nothing in the diff raises concerns beyond what was already analyzed. This is a straightforward docs-toolchain dependency bump with no impact on TUnit's .NET core, source generators, test engine, or AOT compatibility.
Safe to merge once CI completes successfully.
This PR contains the following updates:
3.3.3→4.0.1Release Notes
svg/svgo (svgo)
v4.0.1Compare Source
What's Changed
Dependencies
Bug Fixes
<use>elements referencing an empty container that were removed. By @johnkenny54 in #2051Performance
Other Changes
--show-pluginsargument appends the presets a plugin is in to the end of the line. By @viralcodex in #2174preset-if it is a preset (collection of plugins). By @SethFalco in #2178Metrics
Before and after of the browser bundle of each respective version:
v4.0.0Compare Source
Illustration by Vukory
It's been just over a year since our first release candidate, but I believe we can now release SVGO v4.0.0 with confidence! Thank you to all contributors who tested our RC builds and reported issues back up, this really smoothed out the process.
We actually wanted to do the release sooner, but it was a challenge to find the right time to publish a major release, since that means setting time aside to support users through migrations, helping downstream projects migrate, being available to fix or document things that users found to have an unexpected impact by this release, etc. I appreciate everyone's patience, and now that this is done, we can hopefully increase the pace of development again and tackle that backlog of old bugs. ^-^'
Breaking Changes
Please refer to the Migration Guide from v3 to v4 for a more concise version! This section is more verbose as it delves into the motivation of changes too.
Dropped Support for Node.js v14
Node.js v14 is no longer supported by the Node.js team, including security support, since 30 April 2023. Node.js v16 is no longer supported either, but as some are still using it, we'll save dropping support for Node.js v16 for the next major release.
This allows us to update our dependencies to more recent versions and to access more modern Node.js APIs.
Node.js v14 may still work at the time of this release, but we'll no longer be testing against v14 from now on.
Default Plugins
Both removeViewBox and removeTitle have been disabled by default. Both have been major pain points for users and don't make sense to enable in most cases. Other libraries wrapping SVGO have also been disabling these plugins by default, such as Docusaurus and SVGR.
If you would like either of these plugins enabled, you can do so by configuring it in the SVGO config, see the README for more context, however please read the warnings described in the documentation of the plugins first:
export default { plugins: [ 'preset-default', // built-in plugins enabled by default + 'removeViewBox', + 'removeTitle', ], };removeScriptElement → removeScripts
The removeScriptElement plugin has been renamed to removeScripts, to more accurately reflect what the plugin does. It does not only remove the
<script>tag, but also event handlers and script URIs from links.To migrate, amend your SVGO config to refer to
removeScriptsinstead if you use that plugin.export default { plugins: [ 'preset-default', // built-in plugins enabled by default - 'removeScriptElement', + 'removeScripts', ], };Imports/Exports
We now enforce boundaries between the intended public API and any internal structures/helpers. This is the biggest change in SVGO's JavaScript API and will enable maintainers and users to have a mutual understanding of what is public API and what isn't.
There are two ways to import SVGO:
svgo— for normal usage, such as scripts or server-side applications.svgo/browser— for browser usage.If you use the browser bundle, you must amend how you import SVGO:
For ESM/browser, you must use named imports:
We support 3 environments, ESM, Common JS, and browser. The only functional difference is that the
loadConfigfunction is not exported in the browser bundle.If you depended on a helper that we haven't declared as public, then you are encouraged to implement it yourself, or dig into our source and copy it over to your project.
Importing Plugins
If you import/require the array of built-in plugins, or a single plugin during runtime, this is now a top-level export instead:
Selector Helpers
The
XastNode#parentNodeproperty was declared legacy and pending removal for v4, but was still used internally. The remaining instances have now been removed, which required a refactor of the selector helpers.This effects custom plugins that use any of the following functions, where the
selector(2nd) argument could reference parent or sibling nodes (i.e.div > span):querySelectorAllquerySelectormatchesPreviously, these functions had the context of the whole node tree, even if a child node was passed to it. It no longer has that context by default. The new API for these functions is as follows:
A helper has been provided named
#mapNodesToParents, which does this for you. This can be used to easily migrate to the new API. If you're not sure if you need it, then it's safer to take this approach. The third argument won't be necessary ifselectordoes not traverse nodes, for example, querying using one or more attributes of a single node.What Else
ESM
SVGO is now a dual package, serving for both Common JS and ESM usage. To be more explicit, SVGO will continue to work on Common JS projects!
Thanks to @jdufresne for doing the bulk of the work.
Default Behavior
convertCasetofalse.Bug Fixes
filterattribute. By @johnkenny54 in #1933path[opacity=0]as a non-rendering node. By @johnkenny54 in #1948-oargument) ends with a trailing slash to a location that didn't exist. By @SethFalco in #1954Features
VERSIONexport so get the version of SVGO during runtime. By @SethFalco in #2016isPresetandpluginsproperty to plugins, which are only defined for presets. This will indicate if the plugin is a preset, and return the plugins that are in the preset in the order they are invoked.SVG Optimization
Performance
Developer Experience
Metrics
Before and after using vectors from various sources, with the default preset of each respective version:
Note: The increase in size from previous versions is from disabling
removeViewBoxandremoveTitle, with the benefit of preserving scalability and accessibility.Before and after of the browser bundle of each respective version:
Configuration
📅 Schedule: (UTC)
🚦 Automerge: Enabled.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by Renovate Bot.