svgc 0.1.0

`svgc` (previously SvgCompress) is a tool for compressing SVG files by removing unnecessary whitespace, comments, metadata and some other data. It also supports optimization with [SVGO](https://github.com/svg/svgo) and compression into [SVGZ](https://ru.wikipedia.org/wiki/SVG#SVGZ). The tool helps reduce the file size and clean up SVG files for better performance and preparing for release versions.
svgc-0.1.0 is not a library.

svgc

Rust version of the SvgCompress tool.

Description

svgc is a tool for compressing SVG files by removing unnecessary whitespace, comments, metadata and some other data. It also supports optimization with SVGO and compression into SVGZ. The tool helps reduce the file size and clean up SVG files for better performance and preparing for release versions.

Installation

  1. Clone the repository:

    git clone https://github.com/pasabanov/svgc
cd svgc

  2. Build:

    cargo build --profile release

    The built file will be located in the target/release directory.

  3. (Optional) If you want to use --svgo option, make sure SVGO is installed.

Note that the gzip utility is built into the executable and does not need to be installed on the system.

Usage

To compress SVG files, run the script with the following command:

svgc [options] paths

Options

-h, --help Show this help message and exit
-v, --version Show the version of the script
-r, --recursive Recursively process directories
-f, --remove-fill Remove fill="..." attributes
-o, --svgo Use SVGO if it exists in the system
-z, --svgz Compress to .svgz format with gzip utility after processing
-n, --no-default Do not perform default optimizations (in case you only want to use SVGO, gzip or both)

Examples

  1. Compress a single SVG file: 
    svgc my-icon.svg
  2. Compress all SVG files in some directories and files: 
    svgc my-icons-directory1 my-icon.svg directory2 icon2.svg
  3. Compress all SVG files in a directory and all subdirectories: 
    svgc -r my-icons-directory
  4. Compress an SVG file removing every fill=... attribute in it (making it monocolor): 
    svgc -f my-icon.svg
  5. Compress all SVG files in a directory and all subdirectories, removing fill attributes, then optimize with SVGO, then compress to .svgz with gzip: 
    svgc -rfoz my-icons-directory

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright

2024 Petr Alexandrovich Sabanov