Socket
Socket
Sign inDemoInstall

svgo

Package Overview
Dependencies
104
Maintainers
3
Versions
102
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    svgo

Nodejs-based tool for optimizing SVG vector graphics files


Version published
Maintainers
3
Install size
5.16 MB
Created

Package description

What is svgo?

The svgo npm package is a Node.js-based tool for optimizing SVG vector graphics files. SVGO stands for Scalable Vector Graphics Optimizer. It works by applying a series of transformations and optimizations to SVG files to reduce their size without affecting their visual quality. This is particularly useful for web development, where smaller file sizes can lead to faster load times and better performance.

What are svgo's main functionalities?

Minify SVG files

This feature allows you to minify SVG files by removing unnecessary data without affecting the rendering of the SVG. The code sample demonstrates how to use the optimize function to minify an SVG string.

const { optimize } = require('svgo');
const svgString = '<svg ...> ... </svg>';
const result = optimize(svgString, { path: 'path/to/svg/file.svg' });
console.log(result.data);

Remove specified attributes

This feature allows you to remove specified attributes from SVG elements. The code sample shows how to use the removeAttributesBySelector plugin to remove the 'fill' attribute from all elements that have it.

const { optimize } = require('svgo');
const svgString = '<svg ...> ... </svg>';
const result = optimize(svgString, {
  plugins: [
    {
      name: 'removeAttributesBySelector',
      params: {
        selector: '[fill]',
        attributes: 'fill'
      }
    }
  ]
});
console.log(result.data);

Prettify SVG files

This feature allows you to prettify SVG files by reformatting them with consistent indentation and spacing. The code sample demonstrates how to use the js2svg option with the pretty parameter set to true.

const { optimize } = require('svgo');
const svgString = '<svg ...> ... </svg>';
const result = optimize(svgString, {
  plugins: [
    'preset-default',
    'sortAttrs',
    {
      name: 'removeAttrs',
      params: { attrs: '(stroke|fill)' }
    }
  ],
  js2svg: { pretty: true }
});
console.log(result.data);

Other packages similar to svgo

Readme

Source

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 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>
removeDescremove <desc>
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
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)
removeDimensionsremove width/height attributes if viewBox is present (opposite to removeViewBox, disable it first) (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)
removeScriptElementremove <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

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

Logo by Yegor Bolshakov.

Keywords

FAQs

Last updated on 08 Nov 2017

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc