Oxidised Vector Graphics

OXVG is an effort to create high-performance SVG tooling.

It's planned to include transforming, optimising, and linting, all written in Rust.

🎯 Tools

The following tools will be available in a CLI binary.

🪶 Optimiser (In Progress)

[!info]- Please check out our plan for a v0.0.1 release

For now, expect bugs!

An SVG optimiser similar to SVGO is in the works and is showing to be multiple times faster on some tasks.

Please be aware that this isn't an exact clone of SVGO and certain differences may be found. If you rely on stability, for the time being we recommend sticking to SVGO.

You can read more about these differences and why in this wiki page.

🤖 Transformer (Planned)

An SVG transformer similar to Inkscape's actions is planned.

🧹 Linter (Planned)

A basic linter similar to svglint is planned to make catching issues in SVG documents much easier.

📖 Libraries

If you're a Rust developer wanting to work with SVGs in your project, we have a set of crates at your disposal. As of now though, we're quite unstable and certain crates may be updated, merged, or moved as we see fit.

Actions (pre-alpha)

These are where the commands for our transformer will live and will contain a set of actions to manipulate SVGs.

AST (alpha)

This crate provides a set of traits that can be used to implement a DOM similar to that of the browser web standards. Though it's not a 1-to-1 match; it's designed for easily traversing and manipulating the DOM.

There's currently an implementation with markup5ever's rcdom which can do the following

• Parse and serialize XML, SVG, and HTML documents
• Commonly used browser API implementations for DOM nodes, elements, attributes, etc.
• An implementation of selectors for using DOM CSS queries

Style (alpha)

This crate uses lightningcss to provide some shortcuts for using CSS with our AST.

• Parsing presentation attributes as CSS (hopefully this can be ported to lightningcss)
• Collecting the computed styles of a HTML element

Optimiser (alpha)

This is where the jobs (i.e. SVGO plugins) for our optimiser live and can also be used as a library for use in your applications.

Path (beta)

This is a library for parsing, optimising, and serialising path definitions (e.g. <path d="..." />).

It's mostly complete and good to use in your application, though expect some changes as we may include feature to enable simple manipulations for paths in the future.

💭 Other future ideas

The future potential of this project is still undecided. The following may be available some point in the future.

• NPX & NPM bindings
• A web frontend comparable to InkScape
• A TUI frontend

Building

This project is currently in very early development and doesn't have any distributions yet. You can run the project for yourself by doing the following

git clone [email protected]:noahbald/oxvg.git
cargo build --package oxvg
./target/debug/oxvg.exe --help

Or you can try running it through cargo instead

cargo run -- --help

Contributing

You're welcome to help out and pick up a good first issue or email me to help.

---

Inspiration and Thanks

Thank you to the following projects for providing me inspiration to break into the tooling space.

• oxc

Thank you to these high quality, open source projects on SVG tooling

• SVGO
• InkScape

Licensing

OXVG is open-source and licensed under the MIT License

This project ports or copies code from other open-source projects, listed below

• SVGO
• oxc