Skip to content

Releases: svg/svgo

v3.2.0

02 Jan 00:06
252b28c
Compare
Choose a tag to compare

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

11 Dec 00:45
d17b001
Compare
Choose a tag to compare

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

30 Nov 16:18
5144936
Compare
Choose a tag to compare

What's Changed

Bug Fixes

Chores

  • Improved exported types for the #loadConfig method. By @nuintun in #1844

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

18 Nov 18:29
ee0a0f5
Compare
Choose a tag to compare

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

  • Remove XML Namespace, no longer removes the XLink (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 #1535

Bug Fixes

SVG Optimization

  • Convert Path Commands, convert to z command if going back to initial position, or drop z if redundant. By @KTibow in #1822
  • Inline Styles, when inlining a CSS property that's already declared in a presentation attribute of the node, drop the attribute. By @SethFalco in #1829
  • Remove XLink, new plugin that removes the XLink (xmlns:xlink) namespace and migrates from XLink attributes to the SVG 2 equivalent. Disabled by default. By @TrySound and @SethFalco in #1535

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

08 Nov 22:56
96fedb4
Compare
Choose a tag to compare

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

Default Behavior

  • Remove Comments, introduces preservePatterns parameter. Preserves legal comments by default, same as the previous behavior, but can now be overridden. By @SethFalco in #1812
  • Remove Description, set the removeAny parameter to false by default for accessibility. By @SethFalco in #1806

Bug Fixes

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

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

18 Nov 16:50
Compare
Choose a tag to compare

Installing @types/csso no longer required

v3.0.1

11 Nov 10:26
Compare
Choose a tag to compare
  • 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

23 Oct 14:08
Compare
Choose a tag to compare

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

02 Nov 07:56
Compare
Choose a tag to compare

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

  • added --no-color flag for testing purposes but you may find it useful (#1588)
  • handle url() in style attributes properly (#1592)
  • removeXMLNS plugin now removes xmlns:xlink attribute (#1508)
  • load .cjs configuration only with require to fix segfaults in linux (#1605)

Refactorings

  • simplified and covered with types svg stringifier (#1593)
  • migrated to visitor api and covered with types removeEmptyAttrs plugin (#1594)
  • migrated to visitor api and covered with types inlineStyles plugin (#1601)
  • migrated to picocolors (#1606)

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 (5165ccb)
and introduced a warning when true is specified in overrides (cb7e9be).
Please give us feedback if you still have issues.

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

v2.7.0

23 Sep 21:20
Compare
Choose a tag to compare

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

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

Fixes

  • added validation to removeAttrs plugin (#1582)

Refactorings

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

Other internal changes

  • covered svg parser with tsdoc (#1584)
  • avoided parentNode in style manager which makes us one step closer to releasing new plugin api publicly (#1576)
  • replaced colorette with nanocolors (#1586)

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