SVGO logo
## SVGO [![npm version](https://img.shields.io/npm/v/svgo)](https://npmjs.org/package/svgo) [![Discord](https://img.shields.io/discord/815166721315831868)](https://discord.gg/z8jX8NYxrE) **SVG O**ptimizer 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 ```sh # Via npm npm -g install svgo # Via yarn yarn global add svgo ``` ## CLI usage ```sh # Processing single files: svgo one.svg two.svg -o one.min.svg two.min.svg # Processing directory of svg files, recursively using `-f`, `--folder` : svgo -f ./path/to/folder/with/svg/files -o ./path/to/folder/with/svg/output # Help for advanced usage svgo --help ``` ## Configuration SVGO has a plugin-based architecture, separate plugins allows various xml svg optimizations. See [built-in plugins](#built-in-plugins). SVGO automatically loads configuration from `svgo.config.js` or from `--config ./path/myconfig.js`. Some general options can be configured via CLI. ```js // svgo.config.js module.exports = { multipass: true, // boolean. false by default datauri: 'enc', // 'base64' (default), 'enc' or 'unenc'. js2svg: { indent: 2, // string with spaces or number of spaces. 4 by default pretty: true, // boolean, false by default }, plugins: [ // set of built-in plugins enabled by default 'preset-default', // enable built-in plugins by name 'prefixIds', // or by expanded notation which allows to configure plugin { name: 'sortAttrs', params: { xmlnsOrder: 'alphabetical', }, }, ], }; ``` ### Default preset When extending default configuration specify `preset-default` plugin to enable optimisations. Each plugin of default preset can be disabled or configured with "overrides" param. ```js module.exports = { plugins: [ { name: 'preset-default', params: { overrides: { // customize default plugin options inlineStyles: { onlyMatchedOnce: false, }, // or disable plugins removeDoctype: false, }, }, }, ], }; ``` 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 ### Custom plugin It's also possible to specify a custom plugin: ```js const anotherCustomPlugin = require('./another-custom-plugin.js'); module.exports = { plugins: [ { name: 'customPluginName', 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. ```js 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. ```js 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 | Plugin | Description | Default | | ------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | | [cleanupAttrs](https://github.com/svg/svgo/blob/main/plugins/cleanupAttrs.js) | cleanup attributes from newlines, trailing, and repeating spaces | `enabled` | | [mergeStyles](https://github.com/svg/svgo/blob/main/plugins/mergeStyles.js) | merge multiple style elements into one | `enabled` | | [inlineStyles](https://github.com/svg/svgo/blob/main/plugins/inlineStyles.js) | move and merge styles from `