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.

Sign up for GitHub

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

Jump to bottom

Update dependency svgo to v3 #19

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update dependency svgo to v3 #19

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Oct 27, 2022 •
edited
Loading

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
svgo (source) ^1.1.1 -> ^3.0.0 age adoption passing confidence

Release Notes

svg/svgo (svgo)

v3.3.2

Compare Source

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

Compare Source

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 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

Compare Source

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 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
SVG Optimization

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 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

v3.2.0

Compare Source

What's Changed

Bug Fixes
SVG Optimization
Performance

Metrics

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

v3.1.0

Compare Source

What's Changed

Bug Fixes
SVG Optimization

Metrics

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

v3.0.5

Compare Source

What's Changed

Bug Fixes
Chores

Metrics

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

v3.0.4

Compare Source

Includes various bug fixes for existing plugins and a new optimization. Also splits removeXMLNS, which removed XLink, into two separate plugins, removeXMLNS and removeXlink.

What's Changed

Default Behavior
Bug Fixes
SVG Optimization

Metrics

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

v3.0.3

Compare Source

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.

What's Changed

Settings
Bug Fixes
SVG Optimization
Performance
Chores

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 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

v3.0.2

Compare Source

Installing @types/csso no longer required

v3.0.1

Compare Source

  • store exposed types only in .d.ts files, no longer need to enable js checking
  • update svgo.browser.js
  • fixed "begin" attribute cleanup

Thanks to @​Kreeg, @​XhmikosR and @​TrySound

v3.0.0

Compare Source

SVGO v3

Improvements and fixes

  • fixed datauri option when multipass is not enabled
  • improved default preset warnings

Breaking channges

  • Node.js 14+ is required for version
  • stable package is replaced with native stable sort (required node 12+)
Config

Typescript types are exposed out of the box. No longer need to install @types/svgo

// svgo.config.js
/**
 * @​type {import('svgo').Config}
 */
export default {
  // svgo configuration
}

Active flag is no longer supported

export default {
  plugins: [
    {
      name: 'removeDoctype',
      active: true
    },
    {
      name: 'removeComments',
      active: false
    }
  ]
}

extendDefaultPlugins is removed, preset-default plugin should be used instead
when need to customize plugins defaults

export default {
  plugins: [
    {
      name: 'preset-default',
      params: {
        overrides: {
          // plugins customization
        }
      }
    }
  ]
}

Enabled sortAttrs plugin by default to get better gzip compression.

<svg>
-  <rect fill-opacity="" stroke="" fill="" stroke-opacity="" />
+  <rect fill="" fill-opacity="" stroke="" stroke-opacity="" />
</svg>

Can be disabled if necessary

export default {
  plugins: [
    {
      name: 'preset-default',
      params: {
        overrides: {
          sortAttrs: false
        }
      }
    }
  ]
}

cleanupIDs plugin is renamed to cleanupIds

export default {
  plugins: [
    'cleanupIds'
  ]
}
// or
export default {
  plugins: [
    {
      name: 'preset-default',
      params: {
        overrides: {
          cleanupIds: {}
        }
      }
    }
  ]
}

Removed cleanupIds plugin "prefix" param, prefixIds should be used instead

export default {
  plugins: [
    'cleanupIds',
    {
      name: 'prefixIds',
      params: {
        prefix: 'my-prefix'
      }
    }
  ]
}
Public API

Removed width and height from optimization result.

const { width, height } = optimize(svg).info

Can be found with custom plugin

let width = null
let height = null
const plugin = {
  name: 'find-size',
  fn: () => {
    return {
      element: {
        enter: (node, parentNode) => {
          if (parentNode.type === 'root') {
            width = node.attributes.width
            height = node.attributes.height
          }
        }
      }
    }
  }
}
optimize(svg, {
  plugins: ['preset-default', plugin]
})

Removed error and modernError from optimization result

const {data, error, modernError } = optimize(svg)

Now all errors are thrown, parsing error can be checked by name

try {
  const { data } = optimize(svg)
} catch (error) {
  if (error.name === 'SvgoParserError') {
    // formatted error
    error.toString()
  } else {
    // runtime error
  }
}
Custom plugins

Removed full, perItem and perItemReverse plugin types.
visitor is the only supported plugin api so plugin.type
is no longer required.

Removed plugin.active flag.

Removed plugin.params used as default params, destructuring with defaults can be used instead

name and fn are only required now

const plugin = {
  name: 'my-custom-plugin',
  fn: (root, params) => {
    const { myParam = true } = params
    return {}
  }
}

Removed createContentItem and JSAPI class from nodes.
All nodes are now plain objects with one exception.
parentNode need to be defined to not break builtin plugins.

const plugin = {
  name: 'my-custom-plugin',
  fn: () => {
    return {
      element: {
        enter: (node) => {
          if (node === 'g') {
            const child = {
              type: 'element',
              name: 'g',
              attributes: {},
              children: []
            }
            Object.defineProperty(child, 'parentNode', {
              writable: true,
              value: node,
            })
            node.children.push(child)
          }
        }
      }
    }
  }
}

Thanks to @​istarkov, @​boidolr, @​deining, @​ranman, @​mondeja, @​liamcmitchell-sc, @​rogierslag, @​kriskowal, @​hugolpz and @​TrySound

v2.8.0

Compare Source

If you enjoy SVGO and would like to support our work, consider sponsoring us directly via our OpenCollective.

Join us in our discord

Features and bug fixes

Refactorings

DX

I found some users are trying to enable plugins which are not part of default preset, for example

{
  name: 'preset-default',
  params: {
    overrides: {
      cleanupListOfValues: true
    }
  }
}

To fix this I made docs more concrete about plugin (svg/svgo@5165ccb)
and introduced a warning when true is specified in overrides (svg/svgo@cb7e9be).
Please give us feedback if you still have issues.

Thanks to @​IlyaSkriblovsky, @​devongovett, @​matheus1lva, @​omgovich, @​renatorib and @​TrySound

v2.7.0

Compare Source

If you enjoy SVGO and would like to support our work, consider sponsoring us directly via our OpenCollective.

Join us in our discord

ES Modules support

This release adds support for es modules in svgo.config.js when package.json type field is "module".
For projects with mixed cjs and esm svgo.config.mjs and svgo.config.cjs are also supported as fallback.

See https://github.com/svg/svgo/pull/1583

export default {
  plugins: [
    'preset-default'
  ]
}

Fixes

Refactorings

Follwing plugins are migrated to the new visitor plugin api and covered with tsdoc

Other internal changes

Thanks to @​renatorib, @​matheus1lva, @​omgovich, @​deepsweet, @​ai, @​samouss and @​TrySound

v2.6.1

Compare Source

Thanks to @​XhmikosR, @​thewilkybarkid, @​renatorib, @​matheus1lva, @​omgovich and @​TrySound

v2.6.0

Compare Source

If you enjoy SVGO and would like to support our work, consider sponsoring us directly via our OpenCollective.

We have some good stuff in this release

Better syntax errors (https://github.com/svg/svgo/pull/1553)

Before people struggled to figure out what and why happens with such cryptic error

Error: Error in parsing SVG: Unquoted attribute value
Line: 1
Column: 29
Char: 6
File: input.svg

This gives too little information when a lot of svgs are transformed.

New errors look like this, include context and point to exact location with the issue.
We hope this will solve many issues when dealing with bundlers and other tools integrations.

Error: SvgoParserError: input.svg:2:29: Unquoted attribute value

  1 | <svg viewBox="0 0 120 120">
> 2 |   <circle fill="#ff0000" cx=60.444444" cy="60" r="50"/>
    |                             ^
  3 | </svg>
  4 |

pefixIds plugin is now idempotent (https://github.com/svg/svgo/pull/1561)

To get better compression results SVGO uses multipass option. This option is used
to run prefixIds plugin only once to prefix ids and classes properly.

Though sometimes users run svgo manually a few times which leads to duplicated
prefixes and make code much bigger. To solves this prefixIds was redesigned
to add prefix only when it does not exit in ids and classes.

Eventually all plugins are planned to be determenistic and idempotent
so multipass option would not be necessary and single pass compression
could be as effective as possible.

New js2svg options (https://github.com/svg/svgo/pull/1546)

js2svg.eol: 'lf' | 'crlf'

Allows to customize end of line characters which is usually resolved by os.EOL in node.

finalNewline: boolean

Ensures SVG output has a final newline which is required for some tools like git.

Fixes and refactorings

Follwing plugins are migrated to the new visitor plugin api and covered with tsdoc

Also fixed a few bugs

Thanks to @​XhmikosR, @​matheus1lva, @​deepsweet, @​omgovich, @​adalinesimonian and @​TrySound

v2.5.0

Compare Source

In this release we have a couple of fixes

Visitor api now get parentNode in enter and exit callback

return {
  element: {
    enter: (node, parentNode) => {
    },
    exit: (node, parentNode) => {
    }
  }
}

And a lot of plugins are migrated to visitor api and covered them with tsdoc

  • addAttributesToSVGElement
  • addClassesToSVGElement
  • cleanupAttrs
  • cleanupEnableBackground
  • cleanupListOfValues
  • cleanupNumericValues
  • convertColors
  • convertEllipseToCircle
  • convertShapeToPath
  • convertTransform
  • mergePaths
  • removeAttributesBySelector
  • removeAttrs
  • removeComments
  • removeDesc
  • removeDoctype
  • removeElementsByAttr
  • removeEmptyText
  • removeMetadata
  • removeRasterImages
  • removeScriptElement
  • removeStyleElement
  • removeTitle
  • removeXMLProcInst
  • removeHiddenElems
  • removeViewBox
  • removeUselessDefs
  • removeOffCanvasPaths
  • removeUnknownsAndDefaults
  • sortDefsChildren

Thanks to @​XhmikosR, @​morganney, @​oBusk, @​matheus1lva and @​TrySound

v2.4.0

Compare Source

Hey everybody!

In this release I happy to introduce the new plugin "preset-default" which allows to declaratively setup and customize default set of plugins. Previous solution extendDefaultPlugins utility prevented parcel users from using cachable json config, svgo-loader and svgo-jsx required svgo to be installed locally. "preset-default" plugin is just another builtin plugi.

module.exports = {
  plugins: [
    {
      name: 'preset-default',
      params: {
        overrides: {
          // customize options
          builtinPluginName: {
            optionName: 'optionValue',
          },
          // or disable plugins
          anotherBuiltinPlugin: false,
        },
      },
    },
  ],
};

We also fixed a few bugs

Thanks to @​TrySound, @​ydaniv, @​ludofischer, @​XhmikosR and @​joseprio

v2.3.1

Compare Source

Fixed vulnerability in css-select dependency (https://github.com/svg/svgo/pull/1485)

Thanks to @​ericcornelissen

v2.3.0

Compare Source

Hey, everybody! We have a big release here.

  • The new plugin is added for merging style elements into one. See #​1381

Before:

<svg>
  <style media="print">
    .st0{ fill:red; padding-top: 1em; padding-right: 1em; padding-bottom: 1em; padding-left: 1em; }
  </style>
  <style>
    .test { background: red; }
  </style>
</svg>

After:

<svg>
  <style>
    @&#8203;media print{
      .st0{ fill:red; padding-top: 1em; padding-right: 1em; padding-bottom: 1em; padding-left: 1em; }
    }
    .test { background: red; }
  </style>
</svg>
  • CLI got new --exclude flag which uses regexps to exclude some files from --folder. See #​1409
svgo --folder=svgs --exclude "invalid-icon" "bad-.+"

  • Internal AST is migrated to XAST. This spec makes maintaining plugins easier and may be used as interop with other tools like SVGR.

  • The new visitor plugin type combines features of "full", "perItem" and "perItemReverse" plugins without loosing simplicity. Eventually only visitor api will be supported. See #​1454

Also small fixes

Thanks to @​chambo-e, @​strarsis, @​XhmikosR, @​omgovich and @​TrySound

v2.2.2

Compare Source

v2.2.1

Compare Source

This is a big patch with new style computing (https://github.com/svg/svgo/pull/1399) and landed to master regression tests

A lot of bugs are fixed

435 of 526 regression tests are passing

Thanks to @​XhmikosR @​sk- and @​TrySound

v2.2.0

Compare Source

Wow, two minor releases in a row. There is a big reason for that. We got a new logo! See it in readme. Big thanks to @​DerianAndre.

There were also implemented brand new path data parser and stringifier (https://github.com/svg/svgo/pull/1378 and https://github.com/svg/svgo/pull/1387) to do more reliable transformations and produce smaller svg.

A cup of small fixes

Thanks to @​sk- @​XhmikosR @​deepsweet and @​TrySound

v2.1.0

Compare Source

This release introduced two big changes

See fixed bugs

Thanks to @​XhmikosR @​sk- @​chromakode @​devongovett and @​TrySound

v2.0.3

Compare Source

Thanks to @​ChrisRu @​XhmikosR @​yisibl @​TrySound

v2.0.2

Compare Source

Thanks to @​XhmikosR and @​TrySound

v2.0.1

Compare Source

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), 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.

  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
0 participants