svgo README

The project's README from github.com/svg/svgo. As one markdown file: README.md.

SVGO npm chat docs

SVGO, short for SVG Optimizer, is a Node.js library and command-line application for optimizing SVG files.

💖 Sponsor SVGO on Open Collective to support continued improvements in stability and performance.

Why?

SVG files, especially those exported from vector editors, usually contain a lot of redundant information. This includes editor metadata, comments, hidden elements, default or suboptimal values, and other stuff that can be safely removed or converted without impacting rendering.

Installation

You can install SVGO globally through npm, yarn, or pnpm. Alternatively, drop the global flag (global/-g) to use it in your Node.js project.

# npm
npm install -g svgo

# yarn
yarn global add svgo

# pnpm
pnpm add -g svgo

Command-line usage

Process single files:

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

Process a directory of files recursively with -r/--recursive and -f/--folder:

svgo -rf path/to/directory_with_svgs -o path/to/output_directory

Help for advanced usage:

svgo --help

Configuration

SVGO has a plugin architecture. You can read more about all plugins in Plugins | SVGO Documentation, and the default plugins in Preset Default | SVGO Documentation.

SVGO reads the configuration from svgo.config.mjs or the --config path/to/config.mjs command-line option. Some other parameters can be configured though command-line options too.

svgo.config.mjs

export default {
  multipass: false, // boolean
  datauri: 'base64', // 'base64'|'enc'|'unenc'
  js2svg: {
    indent: 4, // number
    pretty: false, // boolean
  },
  plugins: [
    'preset-default', // built-in plugins enabled by default
    'prefixIds', // enable built-in plugins by name

    // enable built-in plugins with an object to configure plugins
    {
      name: 'prefixIds',
      params: {
        prefix: 'uwu',
      },
    },
  ],
};

Default preset

Instead of configuring SVGO from scratch, you can tweak the default preset to suit your needs by configuring or disabling the respective plugin.

svgo.config.mjs

export default {
  plugins: [
    {
      name: 'preset-default',
      params: {
        overrides: {
          // disable a default plugin
          cleanupIds: false,

          // customize the params of a default plugin
          inlineStyles: {
            onlyMatchedOnce: false,
          },
        },
      },
    },
  ],
};

You can find a list of the default plugins in the order they run in Preset Default | SVGO Documentation.

Custom plugins

You can also specify custom plugins:

svgo.config.mjs

import importedPlugin from './imported-plugin';

export default {
  plugins: [
    // plugin imported from another JavaScript file
    importedPlugin,

    // plugin defined inline
    {
      name: 'customPlugin',
      params: {
        paramName: 'paramValue',
      },
      fn: (ast, params, info) => {},
    },
  ],
};

API usage

SVGO provides a few low level utilities.

optimize

The core of SVGO is optimize function.

import { optimize } from 'svgo';

const result = optimize(svgString, {
  path: 'path-to.svg', // recommended
  multipass: true, // all other config fields are available here
});

const optimizedSvgString = result.data;

loadConfig

If you write a tool on top of SVGO you may want to resolve the svgo.config.mjs file.

import { loadConfig } from 'svgo';

const config = await loadConfig();

You can also specify a path and customize the current working directory.

const config = await loadConfig(configFile, cwd);

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

Logo by André Castillo.

svgo (svg/svgo)

Searching Database…

22.8K ·GitHub
Svgo
Что это такое?SVGO (SVG Optimizer) — это библиотека для Node.js и консольная утилита, которые оптимизируют SVG-файлы: убирают лишнюю информацию, чтобы файлы весили меньше, но отображались так же.
Это консольная утилита или библиотека, которую я использую в коде?И то и другое: есть CLI для оптимизации файлов из терминала и библиотека для Node.js, которую можно вызывать из своего кода.
Чтобы это работало, нужно устанавливать Node.js?Да — Node.js версии 16 или новее. Это обычный JavaScript, поэтому работает везде, где работает Node: на Windows, macOS и Linux.
После оптимизации SVG будет выглядеть так же?Так и задумано: SVGO удаляет или преобразует только то, что можно убрать без влияния на отображение. Если какая-то оптимизация портит конкретный файл, этот плагин можно отключить в конфиге.
Какой мусор он вычищает из моих файлов?В основном то, что оставляют после себя векторные редакторы: метаданные, комментарии, скрытые элементы, а также значения по умолчанию или неоптимальные значения — всё это можно убрать, не меняя вид картинки.
Могу ли я написать свой плагин оптимизации?Да — помимо набора плагинов по умолчанию, в svgo.config.mjs можно указать собственные плагины и добавить свои преобразования в тот же конвейер.
Могу ли я построить на базе SVGO свой инструмент?Да — ядро библиотеки — это функция optimize(), а loadConfig() сама подхватит файл svgo.config.mjs, если ваш инструмент оборачивает SVGO.
What are similar projects?svgr, UglifyJS, primitive, raphael, fabric.js, lottie-web, Inquirer.js, tsup
Which topics is it in?vector-graphics, optimization, svg, graphics, javascript-library, hacktoberfest, command-line-tool, npm, tool, nodejs, javascript, cli
Creator
svg
Size
7.4 MB
Stars
22.8K
Updated
CommitAug 27Releasev4.1.0Aug 24
Age
14y
Commits · 90 Days