# broccoli-svg-optimizer

> Broccoli plugin for optimizing SVG files with SVGO

Latest version **2.1.0** (published 2022-10-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install broccoli-svg-optimizer
pnpm add broccoli-svg-optimizer
yarn add broccoli-svg-optimizer
bun add broccoli-svg-optimizer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2022-10-06 |
| First published | 2016-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 12.* \|\| 14.* \|\| >= 16 |
| Dependencies | 3 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 (+3 in 1 direct dependencies) |
| Install scripts | no |
| Author | Ivan Volti |
| Maintainers | ivanvotti, jfh |
| Keywords | broccoli, broccoli-plugin, svgo |

## Links

- npm: https://www.npmjs.com/package/broccoli-svg-optimizer
- Repository: https://github.com/voltidev/broccoli-svg-optimizer
- Issues: https://github.com/voltidev/broccoli-svg-optimizer/issues
- npm.io page: https://npm.io/package/broccoli-svg-optimizer

## Dependencies (3)

- [svgo](https://npm.io/package/svgo.md) 1.3.0
- [safe-stable-stringify](https://npm.io/package/safe-stable-stringify.md) ^2.2.0
- [broccoli-persistent-filter](https://npm.io/package/broccoli-persistent-filter.md) ^3.1.2

## Recent versions

- 2.1.0 (latest) — 2022-10-06
- 2.0.0 — 2019-07-26
- 1.2.0 — 2018-12-24
- 1.1.0 — 2018-05-23
- 1.0.2 — 2017-07-18
- 1.0.1 — 2016-09-06
- 1.0.0 — 2016-05-24

## README

# broccoli-svg-optimizer

[![Build Status](https://travis-ci.org/voltidev/broccoli-svg-optimizer.svg?branch=master)](https://travis-ci.org/voltidev/broccoli-svg-optimizer)
[![Build status](https://ci.appveyor.com/api/projects/status/26lyufkk6ueam952/branch/master?svg=true)](https://ci.appveyor.com/project/voltidev/broccoli-svg-optimizer)

Broccoli plugin for optimizing SVG files by [SVGO](https://github.com/svg/svgo) with a persistent cache for fast restarts.

## Installation

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

## Usage

```js
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](https://github.com/svg/svgo) plugins to customize SVG optimization. Most of the plugins are enabled by default. Check out [SVGO repository](https://github.com/svg/svgo/tree/master/plugins) for available options.

Example:

```js
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:

```js
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](https://github.com/stefanpenner/broccoli-persistent-filter) for more details.

## Running Tests

```
npm install
npm test
```

## License

This project is distributed under the MIT license.

---

GitHub [@voltidev](https://github.com/voltidev)  · 
Twitter [@voltidev](https://twitter.com/voltidev)

---
_Source: https://npm.io/package/broccoli-svg-optimizer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._