webcomp

webcomp (WEB COMPressor) is a command-line tool that compresses files into multiple formats, including Brotli, Compress (LZW), Deflate, Gzip, and Zstandard. It generates pre-compressed files for hosting on web servers, reducing bandwidth usage and improving performance.

Features

• Multi-Format Compression: Supports Brotli, Compress (LZW), Deflate, Gzip, and Zstandard.

• Efficiency-Oriented: Automatically skips files if compression results in larger sizes.

• Dry Run Mode: Preview compression or cleaning operations without making changes.

• Detailed Reports: Provides a summary of compressed, errored, and skipped files.

• Multi-Threaded: Parallel processing for faster compression.

• Broad File Support: Handles a wide range of file types including CSS, HTML, JSON, and more.

• Cross-Platform Builds: Binaries for Windows, macOS, and Linux.

Supported File Types

webcomp processes files based on their extensions only. Supported extensions include:

• Text files: CSS, CSV, HTML, JS, JSON, MAP, MD, SGML, SVG, TSV, TXT, WASM, XHTML, XML, XSLT, YAML, MATHML.

Usage

• webcomp will not generate a compressed file if the compressed file's size is larger than the original file. This behavior ensures that unnecessary larger files are not created.
• webcomp also supports a "Dry Run Mode," allowing users to preview which files will be compressed or deleted without performing the actual operation. To enable this mode, pass --dry-run as a command-line option.
• In addition, webcomp generates a detailed report after compression or cleaning operations. The report includes:
  • Compressed files: Files successfully compressed.
  • Errored files: Files that encountered errors during compression or file I/O.
  • Skipped files: Files skipped because their compressed size exceeded the original size.

Compressing dummy-static-website

Command Line Options

webcomp [options]

Examples

• Display version information:

webcomp --version

• Compress files in specific directories using Brotli and Deflate:

webcomp -p ./public -p ./dist --brotli --deflate

• Perform a dry run to preview compression:

webcomp -p ./public -p ./dist --brotli --dry-run

• Compress files with multiple algorithms and custom Zstandard level:

webcomp -p ./assets --brotli --gzip --zstd --zstd-level 15

• Clean existing compressed files:

webcomp --clean -p ./public -p ./dist

• Perform a dry run to preview file cleaning:

webcomp --clean --dry-run -p ./public -p ./dist

Build Instructions

Prerequisite

• Install the Rust programming language. See Rust installation guide.

Build for Different Platforms

Windows (MSVC)

1. Setup a build environment. See Microsoft guide.
2. Install the Rust toolchain stable-x86_64-pc-windows-msvc
3. Run the build script

build-win.cmd

4. The executable will be located in target-win/release

MacOS (Universal Binary)

1. Install Xcode command line tools:

xcode-select --install

2. Install Rust targets:

rustup target add x86_64-apple-darwin aarch64-apple-darwin

3. Run the build script

./build-mac.sh

4. The executable will be located in dist-mac

Linux (musl libc)

1. Install Docker. See Docker installation guide.
2. Run the build script

./build-linux.sh

3. Executable will be located in target-docker/release

Acknowledgments

webcomp relies on the following open-source projects:

• anyhow: Error handling.
• brotli: Brotli compression.
• clap: Command-line argument parsing.
• clap-help: Extended help formatting.
• flate2: Gzip and Deflate compression.
• indicatif: Progress indicators.
• lazy-regex: Regex compilation.
• lzw: LZW compression.
• rust_search: File searching.
• threadpool: Multi-threading.
• zstd: Zstandard compression.

License

webcomp is licensed under the MIT license.