JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 21919458
  • Score
    100M100P100Q248426F

Nodejs-based tool for optimizing SVG vector graphics files

Package Exports

  • svgo
  • svgo/bin/svgo
  • svgo/lib/svgo
  • svgo/lib/svgo/config
  • svgo/lib/svgo/js2svg
  • svgo/lib/svgo/js2svg.js
  • svgo/lib/svgo/jsAPI
  • svgo/lib/svgo/jsAPI.js
  • svgo/lib/svgo/plugins
  • svgo/lib/svgo/plugins.js
  • svgo/lib/svgo/svg2js
  • svgo/lib/svgo/svg2js.js
  • svgo/lib/svgo/tools
  • svgo/plugins/_collections.js
  • svgo/plugins/cleanupAttrs
  • svgo/plugins/cleanupEnableBackground
  • svgo/plugins/collapseGroups
  • svgo/plugins/convertColors
  • svgo/plugins/convertPathData
  • svgo/plugins/convertPathData.js
  • svgo/plugins/convertStyleToAttrs
  • svgo/plugins/convertStyleToAttrs.js
  • svgo/plugins/convertTransform
  • svgo/plugins/convertTransform.js
  • svgo/plugins/moveElemsAttrsToGroup
  • svgo/plugins/removeComments
  • svgo/plugins/removeComments.js
  • svgo/plugins/removeDoctype
  • svgo/plugins/removeEditorsNSData
  • svgo/plugins/removeEmptyAttrs
  • svgo/plugins/removeEmptyContainers
  • svgo/plugins/removeEmptyText
  • svgo/plugins/removeHiddenElems
  • svgo/plugins/removeMetadata
  • svgo/plugins/removeUnknownsAndDefaults
  • svgo/plugins/removeUnusedNS
  • svgo/plugins/removeViewBox
  • svgo/plugins/removeXMLProcInst

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (svgo) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

logo

SVGO v0.1.0 Build 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 editors namespaces, elements and attributes
  • [ > ] remove empty attributes
  • [ > ] remove default "px" unit
  • [ > ] remove a lot of hidden elements
  • [ > ] remove empty Text elements
  • [ > ] remove empty Container elements
  • [ > ] remove viewBox attribute
  • [ > ] remove or cleanup enable-background attribute
  • [ > ] 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 unused namespaces declaration
  • [ > ] move elements attributes to the existing group wrapper
  • [ > ] collapse groups

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
  -c CONFIG, --config=CONFIG : Local config file to extend default
  --disable=DISABLE : Disable plugin by name
  --enable=ENABLE : Enable plugin by name
  --datauri : Output as Data URI base64 string
  --pretty : Make SVG pretty printed

Arguments:
  INPUT : Alias to --input
  OUTPUT : Alias to --output
  • with files:
$ svgo test.svg
$ 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 (even with Data URI base64):
$ svgo -s '<svg version="1.1">test</svg>' -o test.min.svg
$ svgo -s 'data:image/svg+xml;base64,…' -o test.min.svg
  • with GUI (currently Mac OS X app only)
  • as a Nodejs module - examples

TODO

License and copyrights

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

Logo by Yegor Bolshakov.