/broccoli-svg-optimizer

Broccoli plugin for optimizing SVG files by SVGO with a persistent cache for fast restarts

Primary LanguageJavaScriptMIT LicenseMIT

broccoli-svg-optimizer

Build Status Build status Greenkeeper badge

Broccoli plugin for optimizing SVG files by SVGO with a persistent cache for fast restarts.

Installation

npm install --save-dev broccoli-svg-optimizer

Usage

var SVGOptimizer = require('broccoli-svg-optimizer');
var outputNode = new SVGOptimizer(inputNode, {
  persist: false,
  svgoConfig: {
    plugins: [
      { removeTitle: true }
    ]
  }
});

Options

svgoConfig

Type: Object
Default: null

Enable\disable\configure SVGO plugins to customize SVG optimization. Most of the plugins are enabled by default. Check out SVGO repository for available options.

Example:

svgoConfig: {
  plugins: [
    { removeUselessStrokeAndFill: false },
    { removeAttrs: { attrs: '(fill|fill-rule)' } },
    { removeTitle: true },
    { removeDesc: { removeAny: true } },
  ]
}

svgoModule

Type: reference to a custom svgo module
Default: svgo module defined in broccoli-svg-optimizer dependencies

Sets custom svgo module.

Example:

const SVGOptimizer = require('broccoli-svg-optimizer');

let outputNode = new SVGOptimizer(inputNode, {
  svgoModule: require('svgo')
});

persist

Type: Boolean
Default: true

Enable\disable a persistent cache to improve build performance across restarts. Check out broccoli-persistent-filter for more details.

Running Tests

npm install
npm test

License

This project is distributed under the MIT license.

GitHub @ivanvotti  ·  Twitter @ivanvotti