svgo

• reduced browser build size 1450kB -> 820kB (https://github.com/svg/svgo/commit/82778c872d9fb990c22c431b63843a5bd50175f7)
• fixed adding empty <defs> by reusePaths plugin (https://github.com/svg/svgo/pull/1201)
• fixed reporting parsing errors (https://github.com/svg/svgo/commit/ea82cc28807a1d77220b9c8bb94ad657f9285e31)
• fixed convertEllipseToCircle plugin when rx or ry attributes are not specified (https://github.com/svg/svgo/commit/7f4e05297ade6747a2b6ca63109d75dc9c4ea3c0)
• fixed removing mask-type on <mask> (https://github.com/svg/svgo/commit/4490d62ee9f83febeb18f4a83a297c544459514a)
• fixed removing elements when class is empty in removeElementsByAttr plugin (https://github.com/svg/svgo/commit/d9f68d3be0958f5d0899ae0a361d5f3b1ce12b95)
• disable removing spaces in <path> by default to support many broken non-browser environments (https://github.com/svg/svgo/pull/1353)
• fixed error message in addAttributesToSVGElement plugin (https://github.com/svg/svgo/commit/c1edce4d2d9e64d026d9cb3de544181198cad5f3)

Thanks to @ChrisRu @XhmikosR @yisibl @TrySound

• added better docs (https://github.com/svg/svgo/pull/1337)
• removed unsafe usage of Buffer constructor (https://github.com/svg/svgo/pull/1341)
• fixed incorrect regexp in convertStyleToAttrs plugin (https://github.com/svg/svgo/pull/1338)
• fixed swallowing errors in config files (https://github.com/svg/svgo/pull/1342)

Thanks to @XhmikosR and @TrySound

• fixed path intersection in mergePaths plugin (https://github.com/svg/svgo/pull/1229)
• fixed --indent flag in CLI (https://github.com/svg/svgo/pull/1331)
• fixed multipass option (https://github.com/svg/svgo/pull/1332, https://github.com/svg/svgo/pull/1177)
• fixed plugins order (https://github.com/svg/svgo/pull/1334)
• detect .svg files in folder case-insensitively (https://github.com/svg/svgo/pull/1316)

Thanks to @sk- @Brooooooklyn @strarsis @AlpayY @TrySound

Happy to introduce SVGO 2.0. Package size was drastically reduced. Configuration
is heavily simplified. Node 10.13+ is required.

• smaller install size
• simplified config format
• added browser ready es module bundle
• API is synchronous
• support only svgo.config.js for external configuration

Config changes

Since early versions plugins configuration was affected by yaml syntax.
Though it was not practial in json or javascript for writing and for internal
work.

plugins:
    - removeViewBox: true
    - removeAttr:
        attrs: '(fill|stroke)'

{
  plugins: [
    {
      removeViewBox: true
    },
    {
      removeAttr: {
        attrs: '(fill|stroke)'
      }
    }
  ]
}

In the new version plugins configuration is closer to internal representation.

{
  plugins: [
    {
      name: 'removeViewBox'
    },
    {
      name: 'removeAttr',
      params: {
        attrs: '(fill|stroke)'
      }
    }
  ]
}

In v1 full flag allowed to disable all default plugins and run only specified
in plugins list. In v2 it's default behaviour. To extend default plugins list
you can use extendDefaultPlugins utility.

{
  plugins: extendDefaultPlugins([
    {
      name: 'removeViewBox',
      active: false,
    }
  ])
}

Loading custom plugin by path was removed in favour of manual import or require.

+const customPlugin = require('./custom-plugin.js')
 {
   plugins: [
     {
       name: 'customPlugin',
-      path: './custom-plugin.js'
+      ...customPlugin
     }
   ]
 }

CLI changes

Painful coa was replaced with well maintained commander.

--enable and --disable flags are removed. In later versions we will explore
plugins setup via CLI.

Inlined json config is no longer suppored. CLI flags should be used instead.

--config="{multipass:true}"

By default SVGO CLI will search for svgo.config.js. --config flag allows
to specify js config with any name.

YAML and JSON configuration is no longer supported for the sake of simplicity
and less dependencies.

Node API changes

Initially SVGO was implemented with callback style api to fit sax recommendation.
Though in practice api was synchronous and allowed to access the result assigned
in callback right after optimisation.

For v1 callback style was replaced with promise api which cannot longer be run
synchronously. This was a pain point for many tools and required hacking svgo.

In v2 this pain is considered and api is now synchronous. No hacks necessary.

SVGO class is replaced with optimize function.

-const { SVGO } = require('svgo')
-const svgo = new SVGO({
-  // config
-  multipass: true
-})
-svgo.optimize(svgstring, { path: './file.svg' }).then(result => {
-  ...
-})
+const { optimize, extendDefaultPlugins } = require('svgo')
+optimize(svgstring, {
+  path: './file.svg',
+  multipass: true,
+})

Some tools require the same logic for resolving svgo config as SVGO CLI.

const { loadConfig, optimize } = require('svgo')
...
const config = await loadConfig()
optimize(svgstring, { path: './file.svg', ...config })

Browser ready bundle

There were a lot of request for this feature in the past.
Now tools like svgomg may use official and tested es module for browsers with optimize, extendDefaultPlugins and createContentItem support.

import {
  optimize,
  extendDefaultPlugins,
  createContentItem
} from 'svgo/dist/svgo.browser.js'

• Fixed TypeError: Cannot set property 'multipassCount' of undefined

• Updated CSSO version to 4.0.2 fixing the issue with empty semicolons ";;" in styles (thanks to @strarsis and @lahmatiy).
• prefixIds plugin now runs only once with --multipass option (by @strarsis).
• cleanupIDs plugin is prevented from producing a preserved ID, including one which matches a preserved prefix, when minifying (by @thomsj).

• Custom plugins now can be loaded from external js through path plugin param.
• New plugin convertEllipseToCircle to convert ellipse with equal radius measures to circle (by @tigt).
• New plugin sortDefsChildren for improved compression (by @davidleston).
• SVGO now removes unnecessary spaces after arcto path command flags.
• removeDimensions plugin now adds viewBox if it's missing (by @adipascu).
• Fixed removeUnusedNS not counting attributes in <svg> tag itself.
• Fixed an issue with incorrect processing multiple images (by @cyberalien).
• Fixed an error with incorrect converting multiple segmented curve to an arc.
• Fixed an error with matrix decomposition in convertTransform due to rounding error leading to illegal value.
• Added force option for mergePaths plugin (by @goyney).
• Added options to prefixIds plugin for selectively prefixing IDs and/or classes (by @strarsis).
• Exported config function (by @1000ch).

• Update js-yaml for Code Injection warning (by @kaungst).

Some goodness from pull-requests.

• Bump up js-yaml version to fix DoS vulnerability (by @eugestarr).

Some goodness from pull-requests.

• Fixed extra blank lines when processing many files (by @panczarny).
• Added --recursive option to process folders recursevely with option -f (by @dartess).
• Added removeAttributesBySelector plugin to remove elements matching a css selector (by @bmease).
• Added removeOffCanvasPaths plugin to remove elements outside of the viewbox (by @JoshyPHP).
• removeAttrs plugin: added preserveCurrentColor color (by @roblevintennis) and 3rd optional filter for a value (by @Herman-Freund).
• Added reusePaths plugin to replace duplicated elements with link (by @jhowcrof).
• Added support of comma-separated plugins list in --disable and --enable options (by @jmwebservices).
• Added option to preserve IDs based on prefix in cleanupIDs plugin (by @bkotzz).
• Replaced colors dependency with chalk (by @xPaw).

• Fixed crash in SVGO.optimize() when ‘info’ is absent.
• Removed extra space after cleanupListOfValues plugin.

• Fixed collapseGroups plugin removing property with a child having inherit value.
• version attribute value is not more being rounded.
• Fixed jsAPI clone method with respect to the introduced CSS classes.
• Fixed scaling strokes with vector-effect="non-scaling-stroke" (by @alexjlockwood).
• Fixed passing properties from groups in collapseGroups plugin if child have a filter (by @stristr).
• Fixed arc path commands parsing without separators after flags, effectively producing a JS error.
• Fixed viewBox separators parsing.
• Fixed removeNonInheritableGroupAttrs plugin to work as intended.
• Fixed removing path segments without length in presence of stroke-linecap.
• Fixed removeUnknownsAndDefaults plugin removing attributes from elements with id.
• Fixed converting to large arcs from nearly straight lines curves.
• Fixed collapseGroups plugin affecting <switch> and its subgroups.
• Fixed convertTransform plugin converting to rotate() with wrong sign in some case.
• Fixed cleanupListOfValues plugin not preserving non-numeric values.
• Fixed !important being passed to attributes in convertStyleToAttrs plugin.
• Added option keepImportant to convertStyleToAttrs plugin to preserve styles with !important.
• removeHiddenElems plugin now also removes elements with visibility="hidden" attribute (by @mikolaj92).
• Added forceAbsolutePath option to convertPathData plugin to always use absolute coordinates (by @cool).
• Added keepRoleAttr for removeUnknownsAndDefaults plugin to preserve role- attributes (by @himedlooff).
• Added xmlns order option in sortAttrs plugin (by @hellatan).
• Added an option to prefixIds plugin to pass prefix as false or as a function that returns false (by @vzaidman).
• prefixIds plugin now adds prefix to every class (by @vzaidman).
• Updated and improved docs a bit (multiple authors).

Fixed issue with prefixIDs plugin not replacing url() values correctly (by @harrisjose).

• Fixed bug with removing groups that are direct child of <switch>.
• Fixed bug with shorthand path points counting (thanks @alexjlockwood for noticing).
• Fixed crash on parsing invalid transform, e.g. without close parenthesis.

• Fixed removeViewBox plugin to check for zero start coordinates.
• Removed extra info from STDOUT when it set to output.

• Fixed a couple of errors related to inlineStyles plugin.
• Updated some lost details in documentation to reflect v1.0 changes.

• Fixed error “Object.defineProperty called on non-object” in images with <foreignObject/>.

• SVGO now requires Node 4 or higher.
• Changed CLI syntax to treat filenames as input, thus allowing svgo *.svg syntax.
• SVGO.optimize() now returns Promise.
• Added datauri option to JS API.
• Added support for SVG 2 href attribute.
• cleanupIDs now don't removes IDs if an image consists only of defs.
• New plugin inlineStyles for converting styles from <style> element to attributes if possible (by @strarsis).
• cleanupNumericValues now rounds values in viewBox (by @caub).
• New plugin: removeScriptElement (disabled by default) to align with removeStyleElement (by @pklingem).
• minifyStyles now removes styles based on usage with controlling options (by @lahmatiy).
• New option except in cleanupIDs to keep IDs (by @Velenir).
• New option force in cleanupIDs to work even if SVG contains style or script elements (by @Velenir).
• Fixed arcs transforming with different signed scale parameters (by @JoshyPHP).
• Fixed removeUselessStrokeAndFill to check for style or script elements per file (by @caub).
• New option keepAriaAttrs in removeUnknownsAndDefaults (by @davidtheclark).
• Corrected parsing in cleanupIDs to account animation syntax (by @caub).
• #ff0000 now converts to red as well as #f00 (by @davidleston).
• Added “gray” variation to colors list per CSS Color Module Level 4 (by @ydaniv).
• Fixed error on empty files.
• A separator character in removeAttrs now can be changed per elemSeparator option (by @mikestreety).
• addAttributesToSVGElement now can add values to attributes.

• Extended currentColor match conditions (string, rx, bool) (by @AlimovSV)
• Fixed removing <animate> in <stop>.
• Fixed removing same transform in inner element in removeUnknownsAndDefaults.
• Fixed collapsing groups with same non-inheritable attribue.
• Corrected removing of leading zero in case of exponential notation.

• Reverted the requirement of Node.js to version 0.10.
• Added addAttributesToSVGElement to the default config to allow using it with --enable option.
• Added korean translation of “How it works” doc (by @primeiros).