Skip to content
New issue

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

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

Already on GitHub? # to your account

fix(removeComments): make preserving comments a param #1812

Merged
merged 1 commit into from
Oct 27, 2023

Conversation

SethFalco
Copy link
Member

@SethFalco SethFalco commented Oct 22, 2023

Converts the hard-coded exception to a param so users can override this behavior to preserve custom patterns or drop the logic altogether.

We retain the existing exception as the default value, as this convention is interpreted across minifiers as important. For example, Font Awesome prefixes their comment with a !.

<!--! Font Awesome Free 6.4.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license (Commercial License) Copyright 2023 Fonticons, Inc. -->

However, we also allow users to pass custom patterns, or either preservePatterns: [] or preservePatterns: false to indiscriminately remove comments.

This is completely backward compatible.

I also replaced the ignored comment in the tests with something that matches the kind of comment we're expecting to encounter with this prefix.

Related

@SethFalco SethFalco force-pushed the fix/remove-comments branch 4 times, most recently from c0064d4 to d09612d Compare October 22, 2023 09:52
plugins/removeComments.js Outdated Show resolved Hide resolved
@SethFalco SethFalco changed the title fix(removeComments): preserve copyright and licensing and add param fix(removeComments): make preserving comments a param Oct 26, 2023
@SethFalco SethFalco merged commit 7de793c into svg:main Oct 27, 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://github.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://github.com/svg/svgo/releases/tag/v3.0.3)

[Compare Source](https://github.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://github.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://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1812](https://github.com/svg/svgo/pull/1812)
- **Remove Description**, set the `removeAny` parameter to `false` by
default for accessibility. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1806](https://github.com/svg/svgo/pull/1806)

##### Bug Fixes

- **Remove Raster Images**, removes inlined JPEG images. By
[@&#8203;abejfehr](https://github.com/abejfehr) in
[https://github.com/svg/svgo/pull/1742](https://github.com/svg/svgo/pull/1742)
- **Cleanup IDs**, correctly handle when 2 IDs have been referenced in a
single attribute. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1795](https://github.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://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1817](https://github.com/svg/svgo/pull/1817)
- **Inline Styles**, treat style prop keys as case-insensitive. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1797](https://github.com/svg/svgo/pull/1797)
- **Inline Styles**, remove all classes in multiclass selector. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1801](https://github.com/svg/svgo/pull/1801)
- **Inline Styles**, ignore empty CSS blocks instead of adding empty
style attribute. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1823](https://github.com/svg/svgo/pull/1823)
- **Minify Styles**, removes unused class selectors when the document
has no classes. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1800](https://github.com/svg/svgo/pull/1800)
- **Prefix IDs**, reuse the same prefix when encountering an ID multiple
times. By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1814](https://github.com/svg/svgo/pull/1814)
- **Remove Hidden Elements**, stops removing non-rendering elements like
masks. By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1793](https://github.com/svg/svgo/pull/1793)
- **Reuse Paths**, creates a new ID if the current one is referenced by
another element. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1784](https://github.com/svg/svgo/pull/1784)
- **Reuse Paths**, removes redundant `defs` children after optimization.
By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1785](https://github.com/svg/svgo/pull/1785)
- **Reuse Paths**, stops duplicating attributes into the shared
definition. By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1791](https://github.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://github.com/SethFalco) in
[https://github.com/svg/svgo/issues/1128](https://github.com/svg/svgo/issues/1128)

##### SVG Optimization

- **Convert Transform**, omit spaces between functions. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1802](https://github.com/svg/svgo/pull/1802)
- **Remove Scripts**, removes callbacks (`on*`) and `href` attributes
with `javascript:` URIs. By
[@&#8203;cakeinpanic](https://github.com/cakeinpanic) and
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1807](https://github.com/svg/svgo/pull/1807),
[https://github.com/svg/svgo/pull/1818](https://github.com/svg/svgo/pull/1818),
[https://github.com/svg/svgo/pull/1819](https://github.com/svg/svgo/pull/1819),
[https://github.com/svg/svgo/pull/1820](https://github.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://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1790](https://github.com/svg/svgo/pull/1790)

##### Performance

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

##### Chores

- Revise the README. By [@&#8203;ADTC](https://github.com/ADTC) in
[https://github.com/svg/svgo/pull/1731](https://github.com/svg/svgo/pull/1731)
- Fix dead link to postcss-svgo in README. By
[@&#8203;Lehoczky](https://github.com/Lehoczky) in
[https://github.com/svg/svgo/pull/1770](https://github.com/svg/svgo/pull/1770)
- Replace webpack loader library in README as previous was deprecated.
By [@&#8203;tanyabouman](https://github.com/tanyabouman) in
[https://github.com/svg/svgo/pull/1771](https://github.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://github.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://github.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://github.com/svg/svgo/releases/tag/v3.0.3)

[Compare Source](https://github.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://github.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://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1812](https://github.com/svg/svgo/pull/1812)
- **Remove Description**, set the `removeAny` parameter to `false` by
default for accessibility. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1806](https://github.com/svg/svgo/pull/1806)

##### Bug Fixes

- **Remove Raster Images**, removes inlined JPEG images. By
[@&#8203;abejfehr](https://github.com/abejfehr) in
[https://github.com/svg/svgo/pull/1742](https://github.com/svg/svgo/pull/1742)
- **Cleanup IDs**, correctly handle when 2 IDs have been referenced in a
single attribute. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1795](https://github.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://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1817](https://github.com/svg/svgo/pull/1817)
- **Inline Styles**, treat style prop keys as case-insensitive. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1797](https://github.com/svg/svgo/pull/1797)
- **Inline Styles**, remove all classes in multiclass selector. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1801](https://github.com/svg/svgo/pull/1801)
- **Inline Styles**, ignore empty CSS blocks instead of adding empty
style attribute. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1823](https://github.com/svg/svgo/pull/1823)
- **Minify Styles**, removes unused class selectors when the document
has no classes. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1800](https://github.com/svg/svgo/pull/1800)
- **Prefix IDs**, reuse the same prefix when encountering an ID multiple
times. By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1814](https://github.com/svg/svgo/pull/1814)
- **Remove Hidden Elements**, stops removing non-rendering elements like
masks. By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1793](https://github.com/svg/svgo/pull/1793)
- **Reuse Paths**, creates a new ID if the current one is referenced by
another element. By [@&#8203;SethFalco](https://github.com/SethFalco)
in
[https://github.com/svg/svgo/pull/1784](https://github.com/svg/svgo/pull/1784)
- **Reuse Paths**, removes redundant `defs` children after optimization.
By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1785](https://github.com/svg/svgo/pull/1785)
- **Reuse Paths**, stops duplicating attributes into the shared
definition. By [@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1791](https://github.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://github.com/SethFalco) in
[https://github.com/svg/svgo/issues/1128](https://github.com/svg/svgo/issues/1128)

##### SVG Optimization

- **Convert Transform**, omit spaces between functions. By
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1802](https://github.com/svg/svgo/pull/1802)
- **Remove Scripts**, removes callbacks (`on*`) and `href` attributes
with `javascript:` URIs. By
[@&#8203;cakeinpanic](https://github.com/cakeinpanic) and
[@&#8203;SethFalco](https://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1807](https://github.com/svg/svgo/pull/1807),
[https://github.com/svg/svgo/pull/1818](https://github.com/svg/svgo/pull/1818),
[https://github.com/svg/svgo/pull/1819](https://github.com/svg/svgo/pull/1819),
[https://github.com/svg/svgo/pull/1820](https://github.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://github.com/SethFalco) in
[https://github.com/svg/svgo/pull/1790](https://github.com/svg/svgo/pull/1790)

##### Performance

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

##### Chores

- Revise the README. By [@&#8203;ADTC](https://github.com/ADTC) in
[https://github.com/svg/svgo/pull/1731](https://github.com/svg/svgo/pull/1731)
- Fix dead link to postcss-svgo in README. By
[@&#8203;Lehoczky](https://github.com/Lehoczky) in
[https://github.com/svg/svgo/pull/1770](https://github.com/svg/svgo/pull/1770)
- Replace webpack loader library in README as previous was deprecated.
By [@&#8203;tanyabouman](https://github.com/tanyabouman) in
[https://github.com/svg/svgo/pull/1771](https://github.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://github.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 <sungik.dev@gmail.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

removeComments Plugin not working as expected.
2 participants