Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(reusePaths): reuse defs tag if exists and remove redundant nodes #1785

Merged
merged 2 commits into from
Sep 23, 2023

Conversation

SethFalco
Copy link
Member

@SethFalco SethFalco commented Sep 19, 2023

If an SVG already had a defs tag, the reusePaths plugin would create a new one anyway. This changes it so if a defs tag is found to exist in the document already, reuse and append to it.

This avoids having 2 defs in the same document after optimizing, which is unexpected, and also reducing the SVG size further.

When reusing paths in an existing defs tag, it kept around useless nodes that sometimes even broke the SVG. This removes the node if it's an href only, and removes it if it's an id only pointing to another href, and points elements directly to that href instead.

Example

The plugin used to output this before, which includes some redundant nodes that broke SVGs:

<defs>
  <use xlink:href="#a"/>
  <use id="b" xlink:href="#a"/>
  <clipPath id="c">
    <use href="#b" width="100%" height="100%" overflow="visible"/>
  </clipPath>
</defs>
  • <use xlink:href="#a"/> is literally doing nothing.
  • <use id="b" xlink:href="#a"/> this can go, and replace references of #b with #a.

Metrics

Taking the SVG from the bug reports, this both fixes the problem while producing an even smaller final output. The test was performed with only reusePaths enabled.

SVG Time % reduced final KiB
v3.0.2 39 ms 8.1% 100.613
this branch 45 ms 8.7% 99.886

I've also tested this in combination #1784 which still works correctly.

Related

Notes

  • When set as a default plugin, test-regression had 3 mismatches before, still at 3.

@SethFalco SethFalco changed the title fix: reuse defs tag in reusePaths fix(reusePaths): reuse defs tag if exists Sep 20, 2023
@SethFalco SethFalco force-pushed the fix/reuse-paths branch 3 times, most recently from 5f01e36 to 86880fb Compare September 20, 2023 15:00
@SethFalco SethFalco changed the title fix(reusePaths): reuse defs tag if exists fix(reusePaths): reuse defs tag if exists and remove redundant nodes Sep 20, 2023
@SethFalco SethFalco force-pushed the fix/reuse-paths branch 2 times, most recently from 75cabf7 to 16f566b Compare September 20, 2023 17:15
@SethFalco SethFalco merged commit 5f40d8b into svg:main Sep 23, 2023
5 checks passed
nono referenced this pull request in cozy/cozy-stack Nov 13, 2023
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [svgo](https://svgo.dev) ([source](https://togithub.com/svg/svgo)) |
[`3.0.2` -> `3.0.3`](https://renovatebot.com/diffs/npm/svgo/3.0.2/3.0.3)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/svgo/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/svgo/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/svgo/3.0.2/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/svgo/3.0.2/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>svg/svgo (svgo)</summary>

### [`v3.0.3`](https://togithub.com/svg/svgo/releases/tag/v3.0.3)

[Compare Source](https://togithub.com/svg/svgo/compare/v3.0.2...v3.0.3)

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](https://svgo.dev/)!
The frontend for svgo.dev is maintained in
[svg/svgo.dev](https://togithub.com/svg/svgo.dev), contributions are
welcome.

#### What's Changed

##### Settings

- **Remove Comments**, introduces `preservePatterns` parameter.
Preserves legal comments by default, same as the previous behavior, but
can now be overridden. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1812](https://togithub.com/svg/svgo/pull/1812)
- **Remove Description**, set the `removeAny` parameter to `false` by
default for accessibility. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1806](https://togithub.com/svg/svgo/pull/1806)

##### Bug Fixes

- **Remove Raster Images**, removes inlined JPEG images. By
[@&#8203;abejfehr](https://togithub.com/abejfehr) in
[https://github.com/svg/svgo/pull/1742](https://togithub.com/svg/svgo/pull/1742)
- **Cleanup IDs**, correctly handle when 2 IDs have been referenced in a
single attribute. By [@&#8203;SethFalco](https://togithub.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1795](https://togithub.com/svg/svgo/pull/1795)
- **Cleanup IDS**, correctly handle when we've encountered a reference
to a node that doesn't exist. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1817](https://togithub.com/svg/svgo/pull/1817)
- **Inline Styles**, treat style prop keys as case-insensitive. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1797](https://togithub.com/svg/svgo/pull/1797)
- **Inline Styles**, remove all classes in multiclass selector. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1801](https://togithub.com/svg/svgo/pull/1801)
- **Inline Styles**, ignore empty CSS blocks instead of adding empty
style attribute. By [@&#8203;SethFalco](https://togithub.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1823](https://togithub.com/svg/svgo/pull/1823)
- **Minify Styles**, removes unused class selectors when the document
has no classes. By [@&#8203;SethFalco](https://togithub.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1800](https://togithub.com/svg/svgo/pull/1800)
- **Prefix IDs**, reuse the same prefix when encountering an ID multiple
times. By [@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1814](https://togithub.com/svg/svgo/pull/1814)
- **Remove Hidden Elements**, stops removing non-rendering elements like
masks. By [@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1793](https://togithub.com/svg/svgo/pull/1793)
- **Reuse Paths**, creates a new ID if the current one is referenced by
another element. By [@&#8203;SethFalco](https://togithub.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1784](https://togithub.com/svg/svgo/pull/1784)
- **Reuse Paths**, removes redundant `defs` children after optimization.
By [@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1785](https://togithub.com/svg/svgo/pull/1785)
- **Reuse Paths**, stops duplicating attributes into the shared
definition. By [@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1791](https://togithub.com/svg/svgo/pull/1791)
- Don't crash on a `null`, `undefined`, or empty plugin. Instead, log a
warning and ignore it. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/issues/1128](https://togithub.com/svg/svgo/issues/1128)

##### SVG Optimization

- **Convert Transform**, omit spaces between functions. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1802](https://togithub.com/svg/svgo/pull/1802)
- **Remove Scripts**, removes callbacks (`on*`) and `href` attributes
with `javascript:` URIs. By
[@&#8203;cakeinpanic](https://togithub.com/cakeinpanic) and
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1807](https://togithub.com/svg/svgo/pull/1807),
[https://github.com/svg/svgo/pull/1818](https://togithub.com/svg/svgo/pull/1818),
[https://github.com/svg/svgo/pull/1819](https://togithub.com/svg/svgo/pull/1819),
[https://github.com/svg/svgo/pull/1820](https://togithub.com/svg/svgo/pull/1820)
- **Convert One-Stop Gradients**, new plugin to convert gradients with
one stop to a solid color, disabled by default. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1790](https://togithub.com/svg/svgo/pull/1790)

##### Performance

- Various optimizations for path handling. By
[@&#8203;marvinhagemeister](https://togithub.com/marvinhagemeister) in
[https://github.com/svg/svgo/pull/1716](https://togithub.com/svg/svgo/pull/1716)
and
[https://github.com/svg/svgo/pull/1717](https://togithub.com/svg/svgo/pull/1717)

##### Chores

- Revise the README. By [@&#8203;ADTC](https://togithub.com/ADTC) in
[https://github.com/svg/svgo/pull/1731](https://togithub.com/svg/svgo/pull/1731)
- Fix dead link to postcss-svgo in README. By
[@&#8203;Lehoczky](https://togithub.com/Lehoczky) in
[https://github.com/svg/svgo/pull/1770](https://togithub.com/svg/svgo/pull/1770)
- Replace webpack loader library in README as previous was deprecated.
By [@&#8203;tanyabouman](https://togithub.com/tanyabouman) in
[https://github.com/svg/svgo/pull/1771](https://togithub.com/svg/svgo/pull/1771)

#### Metrics

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](https://archlinux.org/art/) | 8.584 KiB | 4.748 KiB
| 4.747 KiB | ⬇️ 0.001 KiB |
|
[Blobs](https://gitlab.gnome.org/GNOME/gnome-backgrounds/-/blob/main/backgrounds/blobs-d.svg)
| 50.45 KiB | 42.949 KiB | 42.949 KiB | |
| [Isometric
Madness](https://inkscape.org/~Denis_Kuznetsky/%E2%98%85isometric-madness)
| 869.034 KiB | 550.829 KiB | 550.699 KiB | ⬇️ 0.13 KiB |
| [tldr-pages
Banner](https://togithub.com/tldr-pages/tldr/blob/main/images/banner.svg)
| 2.071 KiB | 1.07 KiB | 1.07 KiB | |
| [Wikipedia
Logo](https://en.wikipedia.org/wiki/File:Wikipedia-logo-v2.svg) |
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 |

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 6am on Monday" in timezone
Europe/Paris, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/cozy/cozy-stack).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40Ni4wIiwidXBkYXRlZEluVmVyIjoiMzcuNDYuMCIsInRhcmdldEJyYW5jaCI6Im1hc3RlciJ9-->
sungik-choi referenced this pull request in channel-io/bezier-react Nov 16, 2023
[![Mend Renovate logo
banner](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [svgo](https://svgo.dev) ([source](https://togithub.com/svg/svgo)) |
[`3.0.2` -> `3.0.3`](https://renovatebot.com/diffs/npm/svgo/3.0.2/3.0.3)
|
[![age](https://developer.mend.io/api/mc/badges/age/npm/svgo/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/svgo/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/svgo/3.0.2/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/svgo/3.0.2/3.0.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### Release Notes

<details>
<summary>svg/svgo (svgo)</summary>

### [`v3.0.3`](https://togithub.com/svg/svgo/releases/tag/v3.0.3)

[Compare Source](https://togithub.com/svg/svgo/compare/v3.0.2...v3.0.3)

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](https://svgo.dev/)!
The frontend for svgo.dev is maintained in
[svg/svgo.dev](https://togithub.com/svg/svgo.dev), contributions are
welcome.

#### What's Changed

##### Settings

- **Remove Comments**, introduces `preservePatterns` parameter.
Preserves legal comments by default, same as the previous behavior, but
can now be overridden. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1812](https://togithub.com/svg/svgo/pull/1812)
- **Remove Description**, set the `removeAny` parameter to `false` by
default for accessibility. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1806](https://togithub.com/svg/svgo/pull/1806)

##### Bug Fixes

- **Remove Raster Images**, removes inlined JPEG images. By
[@&#8203;abejfehr](https://togithub.com/abejfehr) in
[https://github.com/svg/svgo/pull/1742](https://togithub.com/svg/svgo/pull/1742)
- **Cleanup IDs**, correctly handle when 2 IDs have been referenced in a
single attribute. By [@&#8203;SethFalco](https://togithub.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1795](https://togithub.com/svg/svgo/pull/1795)
- **Cleanup IDS**, correctly handle when we've encountered a reference
to a node that doesn't exist. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1817](https://togithub.com/svg/svgo/pull/1817)
- **Inline Styles**, treat style prop keys as case-insensitive. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1797](https://togithub.com/svg/svgo/pull/1797)
- **Inline Styles**, remove all classes in multiclass selector. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1801](https://togithub.com/svg/svgo/pull/1801)
- **Inline Styles**, ignore empty CSS blocks instead of adding empty
style attribute. By [@&#8203;SethFalco](https://togithub.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1823](https://togithub.com/svg/svgo/pull/1823)
- **Minify Styles**, removes unused class selectors when the document
has no classes. By [@&#8203;SethFalco](https://togithub.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1800](https://togithub.com/svg/svgo/pull/1800)
- **Prefix IDs**, reuse the same prefix when encountering an ID multiple
times. By [@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1814](https://togithub.com/svg/svgo/pull/1814)
- **Remove Hidden Elements**, stops removing non-rendering elements like
masks. By [@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1793](https://togithub.com/svg/svgo/pull/1793)
- **Reuse Paths**, creates a new ID if the current one is referenced by
another element. By [@&#8203;SethFalco](https://togithub.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1784](https://togithub.com/svg/svgo/pull/1784)
- **Reuse Paths**, removes redundant `defs` children after optimization.
By [@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1785](https://togithub.com/svg/svgo/pull/1785)
- **Reuse Paths**, stops duplicating attributes into the shared
definition. By [@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1791](https://togithub.com/svg/svgo/pull/1791)
- Don't crash on a `null`, `undefined`, or empty plugin. Instead, log a
warning and ignore it. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/issues/1128](https://togithub.com/svg/svgo/issues/1128)

##### SVG Optimization

- **Convert Transform**, omit spaces between functions. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1802](https://togithub.com/svg/svgo/pull/1802)
- **Remove Scripts**, removes callbacks (`on*`) and `href` attributes
with `javascript:` URIs. By
[@&#8203;cakeinpanic](https://togithub.com/cakeinpanic) and
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1807](https://togithub.com/svg/svgo/pull/1807),
[https://github.com/svg/svgo/pull/1818](https://togithub.com/svg/svgo/pull/1818),
[https://github.com/svg/svgo/pull/1819](https://togithub.com/svg/svgo/pull/1819),
[https://github.com/svg/svgo/pull/1820](https://togithub.com/svg/svgo/pull/1820)
- **Convert One-Stop Gradients**, new plugin to convert gradients with
one stop to a solid color, disabled by default. By
[@&#8203;SethFalco](https://togithub.com/SethFalco) in
[https://github.com/svg/svgo/pull/1790](https://togithub.com/svg/svgo/pull/1790)

##### Performance

- Various optimizations for path handling. By
[@&#8203;marvinhagemeister](https://togithub.com/marvinhagemeister) in
[https://github.com/svg/svgo/pull/1716](https://togithub.com/svg/svgo/pull/1716)
and
[https://github.com/svg/svgo/pull/1717](https://togithub.com/svg/svgo/pull/1717)

##### Chores

- Revise the README. By [@&#8203;ADTC](https://togithub.com/ADTC) in
[https://github.com/svg/svgo/pull/1731](https://togithub.com/svg/svgo/pull/1731)
- Fix dead link to postcss-svgo in README. By
[@&#8203;Lehoczky](https://togithub.com/Lehoczky) in
[https://github.com/svg/svgo/pull/1770](https://togithub.com/svg/svgo/pull/1770)
- Replace webpack loader library in README as previous was deprecated.
By [@&#8203;tanyabouman](https://togithub.com/tanyabouman) in
[https://github.com/svg/svgo/pull/1771](https://togithub.com/svg/svgo/pull/1771)

#### Metrics

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](https://archlinux.org/art/) | 8.584 KiB | 4.748 KiB
| 4.747 KiB | ⬇️ 0.001 KiB |
|
[Blobs](https://gitlab.gnome.org/GNOME/gnome-backgrounds/-/blob/main/backgrounds/blobs-d.svg)
| 50.45 KiB | 42.949 KiB | 42.949 KiB | |
| [Isometric
Madness](https://inkscape.org/~Denis_Kuznetsky/%E2%98%85isometric-madness)
| 869.034 KiB | 550.829 KiB | 550.699 KiB | ⬇️ 0.13 KiB |
| [tldr-pages
Banner](https://togithub.com/tldr-pages/tldr/blob/main/images/banner.svg)
| 2.071 KiB | 1.07 KiB | 1.07 KiB | |
| [Wikipedia
Logo](https://en.wikipedia.org/wiki/File:Wikipedia-logo-v2.svg) |
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 |

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "on Monday after 10am before 7pm" in
timezone Asia/Seoul, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/channel-io/bezier-react).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy40Ni4wIiwidXBkYXRlZEluVmVyIjoiMzcuNDYuMCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Ed Sungik Choi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

reusePaths removes object
2 participants