0.7.5 • Published 4 years ago

@prantlf/svgo v0.7.5

Weekly downloads
10
License
MIT
Repository
github
Last release
4 years ago

english | русский


SVGO NPM version Dependency Status Build Status Coverage Status

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

This is a fork maintaining the synchronous interface of the version 0.x.

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:

PluginDescription
cleanupAttrscleanup attributes from newlines, trailing, and repeating spaces
removeDoctyperemove doctype declaration
removeXMLProcInstremove XML processing instructions
removeCommentsremove comments
removeMetadataremove <metadata>
removeTitleremove <title> (disabled by default)
removeDescremove <desc> (only non-meaningful by default)
removeUselessDefsremove elements of <defs> without id
removeXMLNSremoves xmlns attribute (for inline svg, disabled by default)
removeEditorsNSDataremove editors namespaces, elements, and attributes
removeEmptyAttrsremove empty attributes
removeHiddenElemsremove hidden elements
removeEmptyTextremove empty Text elements
removeEmptyContainersremove empty Container elements
removeViewBoxremove viewBox attribute when possible (disabled by default)
cleanupEnableBackgroundremove or cleanup enable-background attribute when possible
minifyStylesminify <style> elements content with CSSO
convertStyleToAttrsconvert styles into attributes
convertColorsconvert colors (from rgb() to #rrggbb, from #rrggbb to #rgb)
convertPathDataconvert Path data to relative or absolute (whichever is shorter), convert one segment to another, trim useless delimiters, smart rounding, and much more
convertTransformcollapse multiple transforms into one, convert matrices to the short aliases, and much more
removeUnknownsAndDefaultsremove unknown elements content and attributes, remove attrs with default values
removeNonInheritableGroupAttrsremove non-inheritable group's "presentation" attributes
removeUselessStrokeAndFillremove useless stroke and fill attrs
removeUnusedNSremove unused namespaces declaration
cleanupIDsremove unused and minify used IDs
cleanupNumericValuesround numeric values to the fixed precision, remove default px units
cleanupListOfValuesround numeric values in attributes that take a list of numbers (like viewBox or enableBackground)
moveElemsAttrsToGroupmove elements' attributes to their enclosing group
moveGroupAttrsToElemsmove some group attributes to the contained elements
collapseGroupscollapse useless groups
removeRasterImagesremove raster images (disabled by default)
mergePathsmerge multiple Paths into one
convertShapeToPathconvert some basic shapes to <path>
sortAttrssort element attributes for epic readability (disabled by default)
transformsWithOnePathapply transforms, crop by real width, center vertical alignment, and resize SVG with one Path inside (disabled by default)
removeDimensionsremove width/height attributes if viewBox is present (disabled by default)
removeAttrsremove attributes by pattern (disabled by default)
removeElementsByAttrremove arbitrary elements by ID or className (disabled by default)
addClassesToSVGElementadd classnames to an outer <svg> element (disabled by default)
addAttributesToSVGElementadds attributes to an outer <svg> element (disabled by default)
removeStyleElementremove <style> elements (disabled by default)

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 @prantlf/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 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
  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

    or:

      $ svgo -f ../path/to/folder/with/svg/files -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
  • with GUI – svgo-gui

  • 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 copyrights

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

Logo by Yegor Bolshakov.