⚙️ Node.js tool for optimizing SVG files
An update on what happened with v3.3.0 and v3.3.1. While we have retained CJS support, the migration to EMS has changed the acceptable ways to import SVGO, in ways that users depended on before. This effectively made SVGO v3 a breaking change.
Rather than resolve or workaround these differences, we've opted to release SVGO v3.3.2, which is effectively a revert to v3.2.0, and deprecate versions v3.3.0 and v3.3.1. We'll then proceed to work on releasing v4 which will document the breaking changes, and feature further breaking changes that were slated for v4, like disabling removeViewBox
by default.
Before the v4.0.0 release, I'll put more focus on testing and use release candidates, just to help make the release go smoothly! 👍🏽
Sorry for the headache, and thanks for your patience.
SVGO v3.3.0, which was meant to migrate to ESM without breaking CJS support, unfortunately broke CJS projects. There was a mistake with exports, so the loadConfig
function wasn't available in the CJS bundle and lead to issues for many users.
Thanks to everyone who raised the issue, and to @nuintun who submitted a pull request to resolve it so quickly.
I apologize for letting that breaking change through, and will aim to do better. Namely, by adding more tests to cover our exports, and any other public interface in general for each distribution of SVGO, so this doesn't happen again.
SVGO v3.3.1 should resolve the issue for CJS projects, but if you encounter anything else, do let us know by opening an issue on GitHub.
This release introduced breaking changes, which have been reverted in v3.3.2. The bug fixes will be reintroduced in v4.0.0.
SVGO is now a dual package, serving for both Common JS and ESM usage. We believe there shouldn't be any problems, especially as SVGO as largely stateless, but feel free to open an issue if you encounter problems with this.
To be explicit, this is not a breaking change, and SVGO should continue to work in Common JS projects!
Thanks to @jdufresne for doing the bulk of the work.
convertColors
, now converts all references to colors excluding references to IDs to lowercase. This can be disabled by setting convertCase
to false
.cleanupIds
, treat both URI encoded and non-URI encoded IDs as the same. By @liuweifeng in #1982collapseGroups
, check styles as well as attributes. By @johnkenny54 in #1952collapseGroups
, move attributes atomically. By @johnkenny54 in https://github.com/svg/svgo/pull/1930
convertPathData
, fix q control point when item is removed. By @KTibow in https://github.com/svg/svgo/pull/1927
convertPathData
, preserve vertex for markers only paths. By @SethFalco in #1967mergePaths
, don't merge paths if attributes/styles depend depend on the nodes bounding box. By @johnkenny54 in #1964moveElemsAttrsToGroups
, no longer moves the transforms if group has the filter
attribute. By @johnkenny54 in #1933prefixIds
, fixed issue where some IDs were not prefixed when style tag contained XML comments. By @john-neptune in #1942removeHiddenElems
, don't remove node if child element has a referenced ID. By @johnkenny54 in https://github.com/svg/svgo/pull/1925
removeHiddenElems
, treat path[opacity=0]
as a non-rendering node. By @johnkenny54 in #1948removeUselessDefs
, don't remove node if child element has an ID. By @johnkenny54 in https://github.com/svg/svgo/pull/1923
-o
argument) ends with a trailing slash to a location that didn't exist. By @SethFalco in #1954convertColors
, introduce parameter to convert colors to common casing (lowercase/uppercase). By @JayLeininger in https://github.com/svg/svgo/pull/1692
removeDeprecatedAttrs
, new plugin that is disabled by default to remove SVG attributes that are deprecated. By @jdufresne in #1869Before and after using vectors from various sources, with the default preset of each respective version:
SVG | Original | v3.2.0 | v3.3.0 | Delta |
---|---|---|---|---|
Arch Linux Logo | 9.529 KiB | 4.115 KiB | 4.097 KiB | ⬇️ 0.018 KiB |
Blobs | 50.45 KiB | 42.623 KiB | 42.609 KiB | ⬇️ 0.014 KiB |
Isometric Madness | 869.034 KiB | 540.582 KiB | 540.073 KiB | ⬇️ 0.509 KiB |
tldr-pages Banner | 2.071 KiB | 1.07 KiB | 1.07 KiB | |
Wikipedia Logo | 161.551 KiB | 111.668 KiB | 111.668 KiB |
Before and after of the browser bundle of each respective version:
v3.2.0 | v3.3.0 | Delta | |
---|---|---|---|
svgo.browser.js | 910.9 kB | 753.0 kB | ⬇️ 157.9 kB |
q
was incorrectly converted to t
. By @KTibow in https://github.com/svg/svgo/pull/1889
smartArcRounding
to false
. By @KTibow in https://github.com/svg/svgo/pull/1873
convertToQ
to false
. By @KTibow in https://github.com/svg/svgo/pull/1889
#stringifyPathData
for performance. By @SethFalco in https://github.com/svg/svgo/pull/1900
Set
instead of Array
for faster lookups. By @SethFalco in https://github.com/svg/svgo/pull/1899
Before and after using vectors from various sources, with the default preset of each respective version:
SVG | Original | v3.1.0 | v3.2.0 | Delta |
---|---|---|---|---|
Arch Linux Logo | 9.529 KiB | 4.162 KiB | 4.115 KiB | ⬇️ 0.047 KiB |
Blobs | 50.45 KiB | 42.949 KiB | 42.623 KiB | ⬇️ 0.326 KiB |
Isometric Madness | 869.034 KiB | 550.153 KiB | 540.582 KiB | ⬇️ 9.571 KiB |
tldr-pages Banner | 2.071 KiB | 1.07 KiB | 1.07 KiB | |
Wikipedia Logo | 161.551 KiB | 116 KiB | 111.668 KiB | ⬇️ 4.332 KiB |
Before and after of the browser bundle of each respective version:
v3.1.0 | v3.2.0 | Delta | |
---|---|---|---|
svgo.browser.js | 660.9 kB | 910.9 kB | ⬆️ 250 kB |
<style>
tag contains XML comments. By @john-neptune in https://github.com/svg/svgo/pull/1736
<defs>
), namely when <defs>
are defined at the end of the document. By @KTibow in https://github.com/svg/svgo/pull/1879
url('#a')
) across various plugins. By @SethFalco in https://github.com/svg/svgo/pull/1881
defaultMarkupDeclarations
. By @SethFalco in https://github.com/svg/svgo/pull/1872
Before and after using vectors from various sources, with the default preset of each respective version:
SVG | Original | v3.0.5 | v3.1.0 | Delta |
---|---|---|---|---|
Arch Linux Logo | 9.529 KiB | 4.608 KiB | 4.162 KiB | ⬇️ 0.446 KiB |
Blobs | 50.45 KiB | 42.949 KiB | 42.949 KiB | |
Isometric Madness | 869.034 KiB | 550.153 KiB | 550.153 KiB | |
tldr-pages Banner | 2.071 KiB | 1.07 KiB | 1.07 KiB | |
Wikipedia Logo | 161.551 KiB | 117.146 KiB | 116 KiB | ⬇️ 1.146 KiB |
Before and after of the browser bundle of each respective version:
v3.0.5 | v3.1.0 | Delta | |
---|---|---|---|
svgo.browser.js | 657.5 kB | 660.9 kB | ⬆️ 3.4 kB |
Z
between mergable M
/m
commands. By @KTibow in https://github.com/svg/svgo/pull/1856
z
conversions. By @KTibow in https://github.com/svg/svgo/pull/1842
<switch>
, as empty containers can be used for attributes like requiredFeatures
. By @vincentbernat in https://github.com/svg/svgo/pull/1747
.d.ts
file extension instead of .ts
. By @Exotelis in https://github.com/svg/svgo/pull/1780
#loadConfig
method. By @nuintun in https://github.com/svg/svgo/pull/1844
Before and after using vectors from various sources, with the default preset of each respective version:
SVG | Original | v3.0.4 | v3.0.5 | Delta |
---|---|---|---|---|
Arch Linux Logo | 9.529 KiB | 4.735 KiB | 4.608 KiB | ⬇️ 0.127 KiB |
Blobs | 50.45 KiB | 42.949 KiB | 42.949 KiB | |
Isometric Madness | 869.034 KiB | 550.593 KiB | 550.153 KiB | ⬇️ 0.44 KiB |
tldr-pages Banner | 2.071 KiB | 1.07 KiB | 1.07 KiB | |
Wikipedia Logo | 161.551 KiB | 117.152 KiB | 117.146 KiB | ⬇️ 0.006 KiB |
Before and after of the browser bundle of each respective version:
v3.0.4 | v3.0.5 | Delta | |
---|---|---|---|
svgo.browser.js | 656.9 kB | 657.5 kB | ⬆️ 0.6 kB |
Includes various bug fixes for existing plugins and a new optimization. Also splits removeXMLNS
, which removed XLink, into two separate plugins, removeXMLNS
and removeXlink
.
xmlns:xlink
) namespace. If that is desirable, you should enable the new Remove XLink (removeXlink
) plugin, which does more while being safer. By @TrySound and @SethFalco in https://github.com/svg/svgo/pull/1535
pre
elements in foreignObject
. By @SethFalco in https://github.com/svg/svgo/pull/1796
@-webkit-keyframes
in <style>
node. By @SethFalco in https://github.com/svg/svgo/pull/1826
z
command if going back to initial position, or drop z
if redundant. By @KTibow in https://github.com/svg/svgo/pull/1822
xmlns:xlink
) namespace and migrates from XLink attributes to the SVG 2 equivalent. Disabled by default. By @TrySound and @SethFalco in https://github.com/svg/svgo/pull/1535
Before and after using vectors from various sources, with the default preset of each respective version:
SVG | Original | v3.0.3 | v3.0.4 | Delta |
---|---|---|---|---|
Arch Linux Logo | 9.529 KiB | 4.738 KiB | 4.735 KiB | ⬇️ 0.003 KiB |
Blobs | 50.45 KiB | 42.949 KiB | 42.949 KiB | |
Isometric Madness | 869.034 KiB | 550.699 KiB | 550.593 KiB | ⬇️ 0.106 KiB |
tldr-pages Banner | 2.071 KiB | 1.07 KiB | 1.07 KiB | |
Wikipedia Logo | 161.552 KiB | 118.441 KiB | 117.152 KiB | ⬇️ 1.289 KiB |
Before and after of the browser bundle of each respective version:
v3.0.3 | v3.0.4 | Delta | |
---|---|---|---|
svgo.browser.js | 651.7 kB | 656.9 kB | ⬆️ 5.2 kB |
Includes various bug fixes and optimizations for existing plugins.
We're also revamped the documentation for the project. You can find it on svgo.dev! The frontend for svgo.dev is maintained in svg/svgo.dev, contributions are welcome.
preservePatterns
parameter. Preserves legal comments by default, same as the previous behavior, but can now be overridden. By @SethFalco in https://github.com/svg/svgo/pull/1812
removeAny
parameter to false
by default for accessibility. By @SethFalco in https://github.com/svg/svgo/pull/1806
defs
children after optimization. By @SethFalco in https://github.com/svg/svgo/pull/1785
null
, undefined
, or empty plugin. Instead, log a warning and ignore it. By @SethFalco in https://github.com/svg/svgo/issues/1128
on*
) and href
attributes with javascript:
URIs. By @cakeinpanic and @SethFalco in https://github.com/svg/svgo/pull/1807, https://github.com/svg/svgo/pull/1818, https://github.com/svg/svgo/pull/1819, https://github.com/svg/svgo/pull/1820
Before and after using vectors from various sources, with the default preset of each respective version:
SVG | Original | v3.0.2 | v3.0.3 | Delta |
---|---|---|---|---|
Arch Linux Logo | 8.584 KiB | 4.748 KiB | 4.747 KiB | ⬇️ 0.001 KiB |
Blobs | 50.45 KiB | 42.949 KiB | 42.949 KiB | |
Isometric Madness | 869.034 KiB | 550.829 KiB | 550.699 KiB | ⬇️ 0.13 KiB |
tldr-pages Banner | 2.071 KiB | 1.07 KiB | 1.07 KiB | |
Wikipedia Logo | 161.552 KiB | 118.441 KiB | 118.441 KiB |
Before and after of the browser bundle of each respective version:
v3.0.2 | v3.0.3 | Delta | |
---|---|---|---|
svgo.browser.js | 643.5 kB | 651.7 kB | ⬆️ 8.2 kB |
Installing @types/csso
no longer required
Thanks to @Kreeg, @XhmikosR and @TrySound