Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

svgo

Package Overview
Dependencies
7
Maintainers
3
Versions
91
Issues
File Explorer

Advanced tools

svgo

Nodejs-based tool for optimizing SVG vector graphics files

    2.8.0latest

Version published
Maintainers
3
Weekly downloads
14,102,691
decreased by-3.72%

Weekly downloads

Changelog

Source

If you enjoy SVGO and would like to support our work, consider sponsoring us directly via our OpenCollective.

Join us in our discord

Features and bug fixes

  • added --no-color flag for testing purposes but you may find it useful (https://github.com/svg/svgo/pull/1588)
  • handle url() in style attributes properly (https://github.com/svg/svgo/pull/1592)
  • removeXMLNS plugin now removes xmlns:xlink attribute (https://github.com/svg/svgo/pull/1508)
  • load .cjs configuration only with require to fix segfaults in linux (https://github.com/svg/svgo/pull/1605)

Refactorings

  • simplified and covered with types svg stringifier (https://github.com/svg/svgo/pull/1593)
  • migrated to visitor api and covered with types removeEmptyAttrs plugin (https://github.com/svg/svgo/pull/1594)
  • migrated to visitor api and covered with types inlineStyles plugin (https://github.com/svg/svgo/pull/1601)
  • migrated to picocolors (https://github.com/svg/svgo/pull/1606)

DX

I found some users are trying to enable plugins which are not part of default preset, for example

{ name: 'preset-default', params: { overrides: { cleanupListOfValues: true } } }

To fix this I made docs more concrete about plugin (https://github.com/svg/svgo/commit/5165ccb9d1f116b26a30a020e65aadd666012cb1) and introduced a warning when true is specified in overrides (https://github.com/svg/svgo/commit/cb7e9be623b6e2fbbfcb9b67c4c85131e1477925). Please give us feedback if you still have issues.

Thanks to @IlyaSkriblovsky, @devongovett, @matheus1lva, @omgovich, @renatorib and @TrySound

Readme

Source
SVGO logo

SVGO npm version Discord

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

Why?

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

Installation

npm -g install svgo

or

yarn global add svgo

CLI usage

svgo one.svg two.svg -o one.min.svg two.min.svg

Or use the --folder/-f flag to optimize a whole folder of SVG icons

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

See help for advanced usage

svgo --help

Configuration

Some options can be configured with CLI though it may be easier to have the configuration in a separate file. SVGO automatically loads configuration from svgo.config.js or module specified with --config flag.

module.exports = { multipass: true, // boolean. false by default datauri: 'enc', // 'base64', 'enc' or 'unenc'. 'base64' by default js2svg: { indent: 2, // string with spaces or number of spaces. 4 by default pretty: true, // boolean, false by default }, };

SVGO has a plugin-based architecture, so almost every optimization is a separate plugin. There is a set of built-in plugins. See how to configure them:

module.exports = { plugins: [ // enable a built-in plugin by name 'prefixIds', // or by expanded version { name: 'prefixIds', }, // some plugins allow/require to pass options { name: 'prefixIds', params: { prefix: 'my-prefix', }, }, ], };

The default preset of plugins is fully overridden if the plugins field is specified. Use preset-default plugin to customize plugins options.

module.exports = { plugins: [ { name: 'preset-default', params: { overrides: { // customize options for plugins included in preset inlineStyles: { onlyMatchedOnce: false, }, // or disable plugins removeDoctype: false, }, }, }, // enable builtin plugin not included in default preset 'prefixIds', // enable and configure builtin plugin not included in preset { name: 'sortAttrs', params: { xmlnsOrder: 'alphabetical', }, }, ], };

Default preset includes the following list of plugins:

  • removeDoctype
  • removeXMLProcInst
  • removeComments
  • removeMetadata
  • removeEditorsNSData
  • cleanupAttrs
  • mergeStyles
  • inlineStyles
  • minifyStyles
  • cleanupIDs
  • removeUselessDefs
  • cleanupNumericValues
  • convertColors
  • removeUnknownsAndDefaults
  • removeNonInheritableGroupAttrs
  • removeUselessStrokeAndFill
  • removeViewBox
  • cleanupEnableBackground
  • removeHiddenElems
  • removeEmptyText
  • convertShapeToPath
  • convertEllipseToCircle
  • moveElemsAttrsToGroup
  • moveGroupAttrsToElems
  • collapseGroups
  • convertPathData
  • convertTransform
  • removeEmptyAttrs
  • removeEmptyContainers
  • mergePaths
  • removeUnusedNS
  • sortDefsChildren
  • removeTitle
  • removeDesc

It's also possible to specify a custom plugin:

const anotherCustomPlugin = require('./another-custom-plugin.js'); module.exports = { plugins: [ { name: 'customPluginName', type: 'perItem', // 'perItem', 'perItemReverse' or 'full' params: { optionName: 'optionValue', }, fn: (ast, params, info) => {}, }, anotherCustomPlugin, ], };

API usage

SVGO provides a few low level utilities.

optimize

The core of SVGO is optimize function.

const { optimize } = require('svgo'); const result = optimize(svgString, { // optional but recommended field path: 'path-to.svg', // all config fields are also available here multipass: true, }); const optimizedSvgString = result.data;

loadConfig

If you write a tool on top of SVGO you might need a way to load SVGO config.

const { loadConfig } = require('svgo'); const config = await loadConfig(); // you can also specify a relative or absolute path and customize the current working directory const config = await loadConfig(configFile, cwd);

Built-in plugins

PluginDescriptionDefault
cleanupAttrscleanup attributes from newlines, trailing, and repeating spacesenabled
mergeStylesmerge multiple style elements into oneenabled
inlineStylesmove and merge styles from <style> elements to element style attributesenabled
removeDoctyperemove doctype declarationenabled
removeXMLProcInstremove XML processing instructionsenabled
removeCommentsremove commentsenabled
removeMetadataremove <metadata>enabled
removeTitleremove <title>enabled
removeDescremove <desc>enabled
removeUselessDefsremove elements of <defs> without idenabled
removeXMLNSremoves the xmlns attribute (for inline SVG)disabled
removeEditorsNSDataremove editors namespaces, elements, and attributesenabled
removeEmptyAttrsremove empty attributesenabled
removeHiddenElemsremove hidden elementsenabled
removeEmptyTextremove empty Text elementsenabled
removeEmptyContainersremove empty Container elementsenabled
removeViewBoxremove viewBox attribute when possibleenabled
cleanupEnableBackgroundremove or cleanup enable-background attribute when possibleenabled
minifyStylesminify <style> elements content with CSSOenabled
convertStyleToAttrsconvert styles into attributesdisabled
convertColorsconvert colors (from rgb() to #rrggbb, from #rrggbb to #rgb)enabled
convertPathDataconvert Path data to relative or absolute (whichever is shorter), convert one segment to another, trim useless delimiters, smart rounding, and much moreenabled
convertTransformcollapse multiple transforms into one, convert matrices to the short aliases, and much moreenabled
removeUnknownsAndDefaultsremove unknown elements content and attributes, remove attributes with default valuesenabled
removeNonInheritableGroupAttrsremove non-inheritable group's "presentation" attributesenabled
removeUselessStrokeAndFillremove useless stroke and fill attributesenabled
removeUnusedNSremove unused namespaces declarationenabled
prefixIdsprefix IDs and classes with the SVG filename or an arbitrary stringdisabled
cleanupIDsremove unused and minify used IDsenabled
cleanupNumericValuesround numeric values to the fixed precision, remove default px unitsenabled
cleanupListOfValuesround numeric values in attributes that take a list of numbers (like viewBox or enable-background)disabled
moveElemsAttrsToGroupmove elements' attributes to their enclosing groupenabled
moveGroupAttrsToElemsmove some group attributes to the contained elementsenabled
collapseGroupscollapse useless groupsenabled
removeRasterImagesremove raster imagesdisabled
mergePathsmerge multiple Paths into oneenabled
convertShapeToPathconvert some basic shapes to <path>enabled
convertEllipseToCircleconvert non-eccentric <ellipse> to <circle>enabled
sortAttrssort element attributes for epic readabilitydisabled
sortDefsChildrensort children of <defs> in order to improve compressionenabled
removeDimensionsremove width/height and add viewBox if it's missing (opposite to removeViewBox, disable it first)disabled
removeAttrsremove attributes by patterndisabled
removeAttributesBySelectorremoves attributes of elements that match a CSS selectordisabled
removeElementsByAttrremove arbitrary elements by ID or classNamedisabled
addClassesToSVGElementadd classnames to an outer <svg> elementdisabled
addAttributesToSVGElementadds attributes to an outer <svg> elementdisabled
removeOffCanvasPathsremoves elements that are drawn outside of the viewboxdisabled
removeStyleElementremove <style> elementsdisabled
removeScriptElementremove <script> elementsdisabled
reusePathsFind duplicated elements and replace them with linksdisabled

Other Ways to Use SVGO

Donators

SheetJS LLCFontello

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

Logo by André Castillo.

Keywords

FAQs

What is svgo?

Nodejs-based tool for optimizing SVG vector graphics files

Is svgo popular?

The npm package svgo receives a total of 13,444,971 weekly downloads. As such, svgo popularity was classified as popular.

Is svgo well maintained?

We found that svgo demonstrated a healthy version release cadence and project activity. It has 3 open source maintainers collaborating on the project.

Last updated on 02 Nov 2021
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc