behnam/js-svgo

:tiger: Nodejs-based tool for optimizing SVG vector graphics files

english | русский

---

SVGO

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

Why?

SVG files, especially exported from various editors, usually contain 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:

Plugin	Description
cleanupAttrs	cleanup attributes from newlines, trailing, and repeating spaces
removeDoctype	remove doctype declaration
removeXMLProcInst	remove XML processing instructions
removeComments	remove comments
removeMetadata	remove <metadata>
removeTitle	remove <title>
removeDesc	remove <desc>
removeUselessDefs	remove elements of <defs> without id
removeXMLNS	removes xmlns attribute (for inline svg, disabled by default)
removeEditorsNSData	remove editors namespaces, elements, and attributes
removeEmptyAttrs	remove empty attributes
removeHiddenElems	remove hidden elements
removeEmptyText	remove empty Text elements
removeEmptyContainers	remove empty Container elements
removeViewBox	remove viewBox attribute when possible
cleanupEnableBackground	remove or cleanup enable-background attribute when possible
minifyStyles	minify <style> elements content with CSSO
convertStyleToAttrs	convert styles into attributes
convertColors	convert colors (from rgb() to #rrggbb, from #rrggbb to #rgb)
convertPathData	convert Path data to relative or absolute (whichever is shorter), convert one segment to another, trim useless delimiters, smart rounding, and much more
convertTransform	collapse multiple transforms into one, convert matrices to the short aliases, and much more
removeUnknownsAndDefaults	remove unknown elements content and attributes, remove attrs with default values
removeNonInheritableGroupAttrs	remove non-inheritable group's "presentation" attributes
removeUselessStrokeAndFill	remove useless stroke and fill attrs
removeUnusedNS	remove unused namespaces declaration
cleanupIDs	remove unused and minify used IDs
cleanupNumericValues	round numeric values to the fixed precision, remove default px units
cleanupListOfValues	round numeric values in attributes that take a list of numbers (like viewBox or enableBackground)
moveElemsAttrsToGroup	move elements' attributes to their enclosing group
moveGroupAttrsToElems	move some group attributes to the contained elements
collapseGroups	collapse useless groups
removeRasterImages	remove raster images (disabled by default)
mergePaths	merge multiple Paths into one
convertShapeToPath	convert some basic shapes to <path>
sortAttrs	sort element attributes for epic readability (disabled by default)
removeDimensions	remove width/height attributes if viewBox is present (opposite to removeViewBox, disable it first) (disabled by default)
removeAttrs	remove attributes by pattern (disabled by default)
removeElementsByAttr	remove arbitrary elements by ID or className (disabled by default)
addClassesToSVGElement	add classnames to an outer <svg> element (disabled by default)
addAttributesToSVGElement	adds attributes to an outer <svg> element (disabled by default)
removeStyleElement	remove <style> elements (disabled by default)
removeScriptElement	remove <script> elements (disabled by default)

Want to know how it works and how to write your own plugin? Of course you want to. (동작방법)

Installation

$ [sudo] npm install -g svgo

Usage

CLI

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 or folder (by default the same as the input), "-" for STDOUT
  -p PRECISION, --precision=PRECISION : Set number of digits in the fractional part, overrides plugins params
  --config=CONFIG : Config file or JSON string 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)
  --multipass : Enable multipass
  --pretty : Make SVG pretty printed
  --indent=INDENT : Indent number when pretty printing SVGs
  -q, --quiet : Only output error messages, not regular status messages
  --show-plugins : Show available plugins and exit

Arguments:
  INPUT : Alias to --input

• with files:

  $ svgo test.svg

  or:

  $ svgo *.svg

  $ svgo test.svg -o test.min.svg

  $ svgo test.svg other.svg third.svg

  $ svgo test.svg other.svg third.svg -o test.min.svg -o other.min.svg -o third.min.svg

• with STDIN / STDOUT:

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

• with folder

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

  or:

  $ svgo -f ../path/to/folder/with/svg/files -o ../path/to/folder/with/svg/output

  $ svgo *.svg -o ../path/to/folder/with/svg/output

• 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

Other Ways to Use SVGO

• as a web app - SVGOMG
• as a Nodejs module – examples
• as a Grunt task – grunt-svgmin
• as a Gulp task – gulp-svgmin
• as a Mimosa module – mimosa-minify-svg
• as an OSX Folder Action – svgo-osx-folder-action
• as a webpack loader – image-webpack-loader
• as a Telegram Bot – svgo_bot
• as a PostCSS plugin - postcss-svgo

License and Copyright

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

Logo by Yegor Bolshakov.