Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fnando/svg_optimizer
Some SVG optimization based on Node's SVGO
https://github.com/fnando/svg_optimizer
Last synced: 12 days ago
JSON representation
Some SVG optimization based on Node's SVGO
- Host: GitHub
- URL: https://github.com/fnando/svg_optimizer
- Owner: fnando
- License: mit
- Created: 2013-08-19T08:12:18.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2024-01-17T22:59:03.000Z (10 months ago)
- Last Synced: 2024-10-19T14:39:36.131Z (25 days ago)
- Language: Ruby
- Size: 139 KB
- Stars: 19
- Watchers: 4
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# SvgOptimizer
[](https://github.com/fnando/svg_optimizer)
[](https://rubygems.org/gems/svg_optimizer)
[](https://rubygems.org/gems/svg_optimizer)
Some small optimizations for SVG files.
## Installation
```bash
gem install svg_optimizer
```
Or add the following line to your project's Gemfile:
```ruby
gem "svg_optimizer"
```
## Usage
```ruby
# Optimize an existing String.
xml = File.read("file.svg")
optimized = SvgOptimizer.optimize(xml)
# Optimize a file - it will override the original file.
SvgOptimizer.optimize_file("file.svg")
# Optimize a file - it saves a copy to "optimized/file.svg".
SvgOptimizer.optimize_file("file.svg", "optimized/file.svg")
```
You may have a need to optimize a *trusted* SVG document with entities that need to be
expanded. **Only if you are sure the file is trusted**, you may enable this additional entity
processing by passing the `trusted:` keyword argument:
``` ruby
# Optimize an existing trusted String which requires entity expansion.
xml = File.read("file.svg")
optimized = SvgOptimizer.optimize(xml, trusted: true)
# Optimize a trusted file which requires entity expansion - it will override the original file.
SvgOptimizer.optimize_file("file.svg", trusted: true)
```
You can specify the plugins you want to enable. The method signature is:
```ruby
SvgOptimizer.optimize(xml, plugins)
SvgOptimizer.optimize_file(input, output, plugins)
```
where `plugins` is an array of classes that implement the following contract:
```ruby
class MyPlugin < SvgOptimizer::Plugins::Base
def process
xml.xpath("//comment()").remove
end
end
```
The default list of plugins is stored at `SvgOptimizer::DEFAULT_PLUGINS`. To use
your new plugin, just do something like this:
```ruby
SvgOptimizer.optimize(xml, SvgOptimizer::DEFAULT_PLUGINS + [MyPlugin])
```
## Maintainer
- [Nando Vieira](https://github.com/fnando)
## Contributors
- https://github.com/fnando/svg_optimizer/contributors
## Contributing
For more details about how to contribute, please read
https://github.com/fnando/svg_optimizer/blob/main/CONTRIBUTING.md.
## License
The gem is available as open source under the terms of the
[MIT License](https://opensource.org/licenses/MIT). A copy of the license can be
found at https://github.com/fnando/svg_optimizer/blob/main/LICENSE.md.
## Code of Conduct
Everyone interacting in the svg_optimizer project's codebases, issue trackers,
chat rooms and mailing lists is expected to follow the
[code of conduct](https://github.com/fnando/svg_optimizer/blob/main/CODE_OF_CONDUCT.md).