-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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(convertPathData): fix q control point behavior when item is removed #1927
Conversation
ac56ec3
to
efb2fe7
Compare
efb2fe7
to
d719446
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for taking a look at this. The fix makes sense to me.
I'd appreciate it if you'd include a test case in future PRs. I've added one for you here, though. 👍🏽
Is there a release being planned soon? Thanks to the both of you for fixing it. |
Hey! I was planning to make a release by the end of the month. Maintenance was stalled last month as I got ill, then had some client work that took priority. I expect to be back on SVGO next week, though. 👍🏽 |
[![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.2.0` -> `3.3.2`](https://renovatebot.com/diffs/npm/svgo/3.2.0/3.3.2) | [![age](https://developer.mend.io/api/mc/badges/age/npm/svgo/3.3.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/svgo/3.3.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/svgo/3.2.0/3.3.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/svgo/3.2.0/3.3.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>svg/svgo (svgo)</summary> ### [`v3.3.2`](https://togithub.com/svg/svgo/releases/tag/v3.3.2) [Compare Source](https://togithub.com/svg/svgo/compare/v3.3.1...v3.3.2) ##### Notice 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. ### [`v3.3.1`](https://togithub.com/svg/svgo/releases/tag/v3.3.1) [Compare Source](https://togithub.com/svg/svgo/compare/v3.3.0...v3.3.1) ##### Notice 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](https://togithub.com/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. ### [`v3.3.0`](https://togithub.com/svg/svgo/releases/tag/v3.3.0) [Compare Source](https://togithub.com/svg/svgo/compare/v3.2.0...v3.3.0) ##### Deprecated This release introduced breaking changes, which have been reverted in v3.3.2. The bug fixes will be reintroduced in v4.0.0. ##### What's Changed ##### ESM 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](https://togithub.com/jdufresne) for doing the bulk of the work. ##### Default Behavior - [`convertColors`](), now converts all references to colors excluding references to IDs to lowercase. This can be disabled by setting `convertCase` to `false`. ##### Bug Fixes - [`cleanupIds`](), treat both URI encoded and non-URI encoded IDs as the same. By [@​liuweifeng](https://togithub.com/liuweifeng) in [#​1982](https://togithub.com/svg/svgo/issues/1982) - [`collapseGroups`](), check styles as well as attributes. By [@​johnkenny54](https://togithub.com/johnkenny54) in [#​1952](https://togithub.com/svg/svgo/issues/1952) - [`collapseGroups`](), move attributes atomically. By [@​johnkenny54](https://togithub.com/johnkenny54) in [https://github.com/svg/svgo/pull/1930](https://togithub.com/svg/svgo/pull/1930) - [`convertPathData`](), fix q control point when item is removed. By [@​KTibow](https://togithub.com/KTibow) in [https://github.com/svg/svgo/pull/1927](https://togithub.com/svg/svgo/pull/1927) - [`convertPathData`](), preserve vertex for markers only paths. By [@​SethFalco](https://togithub.com/SethFalco) in [#​1967](https://togithub.com/svg/svgo/issues/1967) - [`mergePaths`](), don't merge paths if attributes/styles depend depend on the nodes bounding box. By [@​johnkenny54](https://togithub.com/johnkenny54) in [#​1964](https://togithub.com/svg/svgo/issues/1964) - [`moveElemsAttrsToGroups`](), no longer moves the transforms if group has the `filter` attribute. By [@​johnkenny54](https://togithub.com/johnkenny54) in [#​1933](https://togithub.com/svg/svgo/issues/1933) - [`prefixIds`](), fixed issue where some IDs were not prefixed when style tag contained XML comments. By [@​john-neptune](https://togithub.com/john-neptune) in [#​1942](https://togithub.com/svg/svgo/issues/1942) - [`removeHiddenElems`](), don't remove node if child element has a referenced ID. By [@​johnkenny54](https://togithub.com/johnkenny54) in [https://github.com/svg/svgo/pull/1925](https://togithub.com/svg/svgo/pull/1925) - [`removeHiddenElems`](), treat `path[opacity=0]` as a non-rendering node. By [@​johnkenny54](https://togithub.com/johnkenny54) in [#​1948](https://togithub.com/svg/svgo/issues/1948) - [`removeUselessDefs`](https://svgo.dev/docs/plugins/remove-useless-defs/), don't remove node if child element has an ID. By [@​johnkenny54](https://togithub.com/johnkenny54) in [https://github.com/svg/svgo/pull/1923](https://togithub.com/svg/svgo/pull/1923) - When stringifying path data, include a space before numbers represented in scientific notation. By [@​johnkenny54](https://togithub.com/johnkenny54) in [#​1961](https://togithub.com/svg/svgo/issues/1961) - No longer crashes when the output (`-o` argument) ends with a trailing slash to a location that didn't exist. By [@​SethFalco](https://togithub.com/SethFalco) in [#​1954](https://togithub.com/svg/svgo/issues/1954) ##### SVG Optimization - [`convertColors`](), introduce parameter to convert colors to common casing (lowercase/uppercase). By [@​JayLeininger](https://togithub.com/JayLeininger) in [https://github.com/svg/svgo/pull/1692](https://togithub.com/svg/svgo/pull/1692) - [`removeDeprecatedAttrs`](), new plugin that is disabled by default to remove SVG attributes that are deprecated. By [@​jdufresne](https://togithub.com/jdufresne) in [#​1869](https://togithub.com/svg/svgo/issues/1869) ##### Metrics Before 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](https://archlinux.org/art/) | 9.529 KiB | 4.115 KiB | 4.097 KiB | ⬇️ 0.018 KiB | | [Blobs](https://gitlab.gnome.org/GNOME/gnome-backgrounds/-/blob/main/backgrounds/blobs-d.svg) | 50.45 KiB | 42.623 KiB | 42.609 KiB | ⬇️ 0.014 KiB | | [Isometric Madness](https://inkscape.org/~Denis_Kuznetsky/%E2%98%85isometric-madness) | 869.034 KiB | 540.582 KiB | 540.073 KiB | ⬇️ 0.509 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.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 | </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:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNTEuMiIsInVwZGF0ZWRJblZlciI6IjM3LjM1MS4yIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIiwibGFiZWxzIjpbXX0=-->
Looks like this commit reverted in |
Yeah, if you read the release notes, due to accidental breaking changes we deprecated and reverted the last release. If you aren't impacted by the breaking changes in v3.3.1, you're welcome to continue using that until v4 comes out. Meanwhile, I'd recommend waiting for v4 (or at least the v4 release candidates) which will include these bug fixes. |
That's unfortunate, as latest stable will bring back old bugs, would it perhaps be a good idea to keep the bug fixes and reverting just the module changes? |
If you were using v3.3.0 or v3.3.1 without issue, you're welcome to continue using it!
I would've done that, but the switch to ESM was done before any of the bug fixes, so I couldn't just cherry-pick that change away. With v4 being planned anyway, it seemed more worthwhile to focus on that rather than backport. I was hoping to have a v4 release candidate out this week, but I was held up. I'd expect SVGO v4.0.0-rc.0 to be out next week, though. That will include the bug fixes, though you'll also need to peek at the release notes to see breaking changes. (Mostly impacting imports, and a few changes to default plugins like Meanwhile, if it's urgent, I'd recommend either disabling the optimization, or using the patch feature of Yarn/pnpm (or |
Just a heads-up, the release candidate for SVGO v4 is now available. Feel free to use/try it, and if you encounter any other problems, report an issue! https://github.com/svg/svgo/releases/tag/v4.0.0-rc.0 |
[![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.2.0` -> `3.3.2`](https://renovatebot.com/diffs/npm/svgo/3.2.0/3.3.2) | [![age](https://developer.mend.io/api/mc/badges/age/npm/svgo/3.3.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/svgo/3.3.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/svgo/3.2.0/3.3.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/svgo/3.2.0/3.3.2?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>svg/svgo (svgo)</summary> ### [`v3.3.2`](https://togithub.com/svg/svgo/releases/tag/v3.3.2) [Compare Source](https://togithub.com/svg/svgo/compare/v3.3.1...v3.3.2) #### Notice 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. ### [`v3.3.1`](https://togithub.com/svg/svgo/releases/tag/v3.3.1) [Compare Source](https://togithub.com/svg/svgo/compare/v3.3.0...v3.3.1) #### Notice 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](https://togithub.com/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. ### [`v3.3.0`](https://togithub.com/svg/svgo/releases/tag/v3.3.0) [Compare Source](https://togithub.com/svg/svgo/compare/v3.2.0...v3.3.0) #### Deprecated This release introduced breaking changes, which have been reverted in v3.3.2. The bug fixes will be reintroduced in v4.0.0. #### What's Changed ##### ESM 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](https://togithub.com/jdufresne) for doing the bulk of the work. ##### Default Behavior - [`convertColors`](), now converts all references to colors excluding references to IDs to lowercase. This can be disabled by setting `convertCase` to `false`. ##### Bug Fixes - [`cleanupIds`](), treat both URI encoded and non-URI encoded IDs as the same. By [@​liuweifeng](https://togithub.com/liuweifeng) in [#​1982](https://togithub.com/svg/svgo/issues/1982) - [`collapseGroups`](), check styles as well as attributes. By [@​johnkenny54](https://togithub.com/johnkenny54) in [#​1952](https://togithub.com/svg/svgo/issues/1952) - [`collapseGroups`](), move attributes atomically. By [@​johnkenny54](https://togithub.com/johnkenny54) in [https://github.com/svg/svgo/pull/1930](https://togithub.com/svg/svgo/pull/1930) - [`convertPathData`](), fix q control point when item is removed. By [@​KTibow](https://togithub.com/KTibow) in [https://github.com/svg/svgo/pull/1927](https://togithub.com/svg/svgo/pull/1927) - [`convertPathData`](), preserve vertex for markers only paths. By [@​SethFalco](https://togithub.com/SethFalco) in [#​1967](https://togithub.com/svg/svgo/issues/1967) - [`mergePaths`](), don't merge paths if attributes/styles depend depend on the nodes bounding box. By [@​johnkenny54](https://togithub.com/johnkenny54) in [#​1964](https://togithub.com/svg/svgo/issues/1964) - [`moveElemsAttrsToGroups`](), no longer moves the transforms if group has the `filter` attribute. By [@​johnkenny54](https://togithub.com/johnkenny54) in [#​1933](https://togithub.com/svg/svgo/issues/1933) - [`prefixIds`](), fixed issue where some IDs were not prefixed when style tag contained XML comments. By [@​john-neptune](https://togithub.com/john-neptune) in [#​1942](https://togithub.com/svg/svgo/issues/1942) - [`removeHiddenElems`](), don't remove node if child element has a referenced ID. By [@​johnkenny54](https://togithub.com/johnkenny54) in [https://github.com/svg/svgo/pull/1925](https://togithub.com/svg/svgo/pull/1925) - [`removeHiddenElems`](), treat `path[opacity=0]` as a non-rendering node. By [@​johnkenny54](https://togithub.com/johnkenny54) in [#​1948](https://togithub.com/svg/svgo/issues/1948) - [`removeUselessDefs`](https://svgo.dev/docs/plugins/remove-useless-defs/), don't remove node if child element has an ID. By [@​johnkenny54](https://togithub.com/johnkenny54) in [https://github.com/svg/svgo/pull/1923](https://togithub.com/svg/svgo/pull/1923) - When stringifying path data, include a space before numbers represented in scientific notation. By [@​johnkenny54](https://togithub.com/johnkenny54) in [#​1961](https://togithub.com/svg/svgo/issues/1961) - No longer crashes when the output (`-o` argument) ends with a trailing slash to a location that didn't exist. By [@​SethFalco](https://togithub.com/SethFalco) in [#​1954](https://togithub.com/svg/svgo/issues/1954) ##### SVG Optimization - [`convertColors`](), introduce parameter to convert colors to common casing (lowercase/uppercase). By [@​JayLeininger](https://togithub.com/JayLeininger) in [https://github.com/svg/svgo/pull/1692](https://togithub.com/svg/svgo/pull/1692) - [`removeDeprecatedAttrs`](), new plugin that is disabled by default to remove SVG attributes that are deprecated. By [@​jdufresne](https://togithub.com/jdufresne) in [#​1869](https://togithub.com/svg/svgo/issues/1869) #### Metrics Before 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](https://archlinux.org/art/) | 9.529 KiB | 4.115 KiB | 4.097 KiB | ⬇️ 0.018 KiB | | [Blobs](https://gitlab.gnome.org/GNOME/gnome-backgrounds/-/blob/main/backgrounds/blobs-d.svg) | 50.45 KiB | 42.623 KiB | 42.609 KiB | ⬇️ 0.014 KiB | | [Isometric Madness](https://inkscape.org/~Denis_Kuznetsky/%E2%98%85isometric-madness) | 869.034 KiB | 540.582 KiB | 540.073 KiB | ⬇️ 0.509 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.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 | </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:eyJjcmVhdGVkSW5WZXIiOiIzNy4zOTMuMCIsInVwZGF0ZWRJblZlciI6IjM3LjM5My4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJjaG9yZTpkZXBzIl19--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
fix #1926 by only resetting the control point if an item is included
realistically this should be fine as it'll still get reset on move commands, and likely if a command is dropped the control point stayed the same
there's another issue with how in the case
M0 0Q10 0 10 10Q10 10 10 10T20 20
, convertPathData should convertT
to longhand and update the control point before dropping the useless command (changing the control point), but that's out of scope for this PR. (if my thinking is correct, i can't think of any cases where converting from q to t is affected by this behavior)