svgo

Nodejs-based tool for optimizing SVG vector graphics files

npm install svgo
2 780 downloads in the last day
15 522 downloads in the last week
59 045 downloads in the last month

english | русский


logo

SVGO NPM version Dependency Status Build Status Coverage Status

SVG Optimizer is a Nodejs-based tool for optimizing SVG vector graphics files.

Why?

SVG files, especially exported from various editors, usually contains a lot of redundant and useless information such as editor metadata, comments, hidden elements, default or non-optimal values and other stuff that can be safely removed or converted without affecting SVG rendering result.

What it can do

SVGO has a plugin-based architecture, so almost every optimization is a separate plugin.

Today we have:

  • [ > ] cleanup attributes from newlines, trailing and repeating spaces
  • [ > ] remove doctype declaration
  • [ > ] remove XML processing instructions
  • [ > ] remove comments
  • [ > ] remove <metadata>
  • [ > ] remove <title>
  • [ > ] remove editors namespaces, elements and attributes
  • [ > ] remove empty attributes
  • [ > ] remove hidden elements
  • [ > ] remove empty Text elements
  • [ > ] remove empty Container elements
  • [ > ] remove viewBox attribute when possible
  • [ > ] remove or cleanup enable-background attribute when possible
  • [ > ] convert styles into attributes
  • [ > ] convert colors (from rgb() to #rrggbb, from #rrggbb to #rgb)
  • [ > ] convert Path data to relative, convert one segment to another, trim useless delimiters and much more
  • [ > ] collapse multiple transforms into one, convert matrices to the short aliases and much more
  • [ > ] remove unknown elements content and attributes, remove attrs with default values
  • [ > ] remove non-inheritable group's "presentation" attributes
  • [ > ] remove unused namespaces declaration
  • [ > ] remove unused and minify used IDs
  • [ > ] round numeric values to the fixed precision, remove default 'px' units
  • [ > ] move elements attributes to the existing group wrapper
  • [ > ] move some group attributes to the content elements
  • [ > ] collapse useless groups
  • [ > ] remove raster images (disabled by default)
  • [ > ] merge multiple Paths into one
  • [ > ] convert some basic shapes to path
  • [ > ] apply transforms, crop by real width, center vertical alignment and resize SVG with one Path inside

Want to know how it works and how to write your own plugin? Of course you want to.

How to use

$ [sudo] npm install -g svgo
Usage:
  svgo [OPTIONS] [ARGS]

Options:
  -h, --help : Help
  -v, --version : Version
  -i INPUT, --input=INPUT : Input file, "-" for STDIN
  -s STRING, --string=STRING : Input SVG data string
  -f FOLDER, --folder=FOLDER : Input folder, optimize and rewrite all *.svg files
  -o OUTPUT, --output=OUTPUT : Output file (by default the same as the input), "-" for STDOUT
  --config=CONFIG : Config file to extend or replace default
  --disable=DISABLE : Disable plugin by name
  --enable=ENABLE : Enable plugin by name
  --datauri=DATAURI : Output as Data URI string (base64, URI encoded or unencoded)
  --pretty : Make SVG pretty printed

Arguments:
  INPUT : Alias to --input
  OUTPUT : Alias to --output
  • with files:

      $ svgo test.svg
    

    or:

      $ svgo test.svg test.min.svg
    
  • with STDIN / STDOUT:

      $ cat test.svg | svgo -i - -o - > test.min.svg
    
  • with folder

      $ svgo -f ../path/to/folder/with/svg/files
    
  • with strings:

      $ svgo -s '<svg version="1.1">test</svg>' -o test.min.svg
    

    or even with Data URI base64:

      $ svgo -s 'data:image/svg+xml;base64,…' -o test.min.svg
    
  • with SVGZ:

    from .svgz to .svg:

      $ gunzip -c test.svgz | svgo -i - -o test.min.svg
    

    from .svg to .svgz:

      $ svgo test.svg -o - | gzip -cfq9 > test.svgz
    
  • with GUI – svgo-gui

  • as a Nodejs module – examples
  • as a Grunt task – grunt-svgmin
  • as a Gulp task – gulp-svgmin
  • as an OSX Folder Action – svgo-osx-folder-action

License and copyrights

This software is released under the terms of the MIT license.

Logo by Yegor Bolshakov.

npm loves you