npmpackage.info

svgo

⚙️ Node.js tool for optimizing SVG files

3.3.2

21,146

MIT

JavaScript

176.02 kB

3,862,890,860 6.1

Installations

npm install svgo

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>=14.0.0

Score

62.7

Supply Chain

99.6

Quality

84.7

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

48

Total

830

Closed

219

Merged

563

Issues

Open

194

Total

1,251

Closed

1,057

Releases

v4.0.0-rc.1

Published on 07 Sept 2024

v4.0.0-rc.0

Published on 09 Jun 2024

v3.3.2

Published on 09 May 2024

v3.3.1

Published on 08 May 2024

v3.3.0

Published on 08 May 2024

v3.2.0

Published on 02 Jan 2024

View all 63 releases

Contributors

203

View all 203 contributors

Languages

JavaScript

JavaScript (100%)

Developer

svg

Download Statistics

Total Downloads

3,862,890,860

Last Day

2,121,267

Last Week

15,886,997

Last Month

72,566,518

Last Year

877,229,785

GitHub Statistics

21,146 Stars

1,539 Commits

1,390 Forks

242 Watching

5 Branches

203 Contributors

Bundle Size

562.98 kB

Minified

176.02 kB

Minified + Gzipped

Bundlephobia

Sponsor this package

https://opencollective.com/svgo

Maintainers

Package Meta Information

Latest Version

3.3.2

Package Id

svgo@3.3.2

Unpacked Size

1.42 MB

Size

357.05 kB

File Count

Publised On

09 May 2024

Total Downloads

Cumulative downloads

Total Downloads

3,862,890,860

Last day

-33.3%

2,121,267

Compared to previous day

Last week

-10.3%

15,886,997

Compared to previous week

Last month

-4.2%

72,566,518

Compared to previous month

Last year

5.5%

877,229,785

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

SVGO

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

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.

1# npm
2npm install -g svgo
3
4# yarn
5yarn global add svgo
6
7# pnpm
8pnpm add -g svgo

Command-line usage

Process single files:

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

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

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

Help for advanced usage:

1svgo --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

1export default {
2  multipass: false, // boolean
3  datauri: 'base64', // 'base64'|'enc'|'unenc'
4  js2svg: {
5    indent: 4, // number
6    pretty: false, // boolean
7  },
8  plugins: [
9    'preset-default', // built-in plugins enabled by default
10    'prefixIds', // enable built-in plugins by name
11
12    // enable built-in plugins with an object to configure plugins
13    {
14      name: 'prefixIds',
15      params: {
16        prefix: 'uwu',
17      },
18    },
19  ],
20};

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

1export default {
2  plugins: [
3    {
4      name: 'preset-default',
5      params: {
6        overrides: {
7          // disable a default plugin
8          cleanupIds: false,
9
10          // customize the params of a default plugin
11          inlineStyles: {
12            onlyMatchedOnce: false,
13          },
14        },
15      },
16    },
17  ],
18};

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

1import importedPlugin from './imported-plugin';
2
3export default {
4  plugins: [
5    // plugin imported from another JavaScript file
6    importedPlugin,
7
8    // plugin defined inline
9    {
10      name: 'customPlugin',
11      params: {
12        paramName: 'paramValue',
13      },
14      fn: (ast, params, info) => {},
15    },
16  ],
17};

API usage

SVGO provides a few low level utilities.

optimize

The core of SVGO is optimize function.

1import { optimize } from 'svgo';
2
3const result = optimize(svgString, {
4  path: 'path-to.svg', // recommended
5  multipass: true, // all other config fields are available here
6});
7
8const optimizedSvgString = result.data;

loadConfig

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

1import { loadConfig } from 'svgo';
2
3const config = await loadConfig();

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

1const config = await loadConfig(configFile, cwd);

Donors


SheetJS LLC	Fontello

License and Copyright

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

Logo by André Castillo.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

10

SAST

Determines if the project uses static code analysis.

9

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

Maintained

Determines if the project is "actively maintained".

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/svg/svgo/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/svg/svgo/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/svg/svgo/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/svg/svgo/codeql.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/svg/svgo/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/svg/svgo/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/svg/svgo/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/svg/svgo/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:62: update your workflow using https://app.stepsecurity.io/secureworkflow/svg/svgo/main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:63: update your workflow using https://app.stepsecurity.io/secureworkflow/svg/svgo/main.yml/main?enable=pin
Info: 0 out of 10 GitHub-owned GitHubAction dependencies pinned

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

Score

6.1

/10

Last Scanned on 2024-12-16

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to svgo

postcss-svgo

7.0.1

Optimise inline SVG with PostCSS.

imagemin-svgo

11.0.1

SVGO imagemin plugin

@types/svgo

3.0.0

Stub TypeScript definitions entry for svgo, which provides its own types definitions

@svgr/plugin-svgo

8.1.0

Optimize SVG

svgo

Installations

Developer Guide

Yes

CommonJS

>=14.0.0

Score

Pull Requests

48

830

219

563

Issues

194

1,251

1,057

Releases

Contributors

Languages

Developer

Download Statistics

GitHub Statistics

Bundle Size

562.98 kB

176.02 kB

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

3,862,890,860

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

SVGO

Why?

Installation

Command-line usage

Configuration

Default preset

Custom plugins

API usage

optimize

loadConfig

Donors

License and Copyright

10

10

10

10

10

9

7

5

4

0

0

0

0

6.1

/10

Other packages similar to svgo