Snapzip

snapzip is a fast and efficient image compression tool for JPEG and PNG files, written in Rust for optimal performance.

Features

• Optimized compression for JPEG and PNG images
• Simple command-line interface
• Reports compression statistics (before/after size, percentage saved, execution time)
• High performance thanks to Rust implementation

Installation

npm install -g snapzip

Usage

Compressing a JPEG image

snapzip image.jpg compressed.jpg

Compressing a PNG image

snapzip image.png compressed.png

Example output

🔧 Compressing image...
✅ Compression completed successfully!
📦 Size before: 1024 KB
📉 Size after:  512 KB
💾 Saved:       50.00%
⏱ Time:        0.25 seconds

How it works

snapzip uses:

• mozjpeg - An optimized JPEG implementation for JPEG image compression
• oxipng - A fast and efficient PNG optimizer for PNG image compression

System requirements

• Node.js: v12.0.0 or higher
• Supported operating systems:
  • Windows (x64)
  • macOS (Intel x64 and Apple Silicon arm64)
  • Linux (x64)

Development

Prerequisites

• Rust (2024 edition or newer)
• Cargo
• Node.js v12.0.0 or higher
• npm

Building from source

1. Clone the repository

   git clone https://github.com/alphajoop/snapzip.git
   cd snapzip

2. Build the Rust project

   cargo build --release

3. Install npm dependencies

   cd pkg
   npm install

4. Setup binaries for local testing

   # From the pkg directory
   mkdir -p bin
   # For Windows
   cp ../target/release/snapzip.exe bin/snapzip-win32-x64.exe
   # For macOS
   # cp ../target/release/snapzip bin/snapzip-darwin-x64
   # For Linux
   # cp ../target/release/snapzip bin/snapzip-linux-x64

Publishing

This package uses GitHub Actions to automatically build binaries for all supported platforms and publish to npm.

To publish a new version:

1. Make your changes
2. Create and push a new version tag:

   cd snapzip
   git tag v0.1.5  # Increment version number
   git push --tags

3. GitHub Actions will automatically build binaries for all platforms and publish to npm

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Alpha DIOP

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request.

1. Fork the project
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request