webcomp
| Crates.io | webcomp |
| lib.rs | webcomp |
| version | 1.0.0 |
| created_at | 2025-01-13 07:55:27.315718+00 |
| updated_at | 2025-01-13 07:55:27.315718+00 |
| description | webcomp (WEB COMPressor) is a command-line tool that compresses files into multiple formats, including Brotli, Compress (LZW), Deflate, Gzip, and Zstandard. It helps generate pre-compressed files for hosting on web servers to reduce data traffic. |
| homepage | https://github.com/koma-private/webcomp |
| repository | https://github.com/koma-private/webcomp |
| max_upload_size | |
| id | 1514355 |
| size | 327,769 |
Masanori KOMAGAMINE (koma-private)
documentation
README
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
webcompwill 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.webcompalso 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-runas a command-line option.- In addition,
webcompgenerates 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]
| Short Option | Long Option | Value | description |
|---|---|---|---|
| -p | --path | <PATH> |
Specify one or more paths to compress. |
| -b | --brotli | Enable Brotli compression. | |
| --clean | Remove existing compressed files. | ||
| -c | --compress | Enable Compress (LZW) compression. | |
| --compress-min-code-size | <COMPRESS_MIN_CODE_SIZE> |
Minimum code size for LZW compression. Must be 8 or greater. Default: 8 |
|
| -d | --deflate | Enable Deflate compression. | |
| --dry_run | Enable dry run mode. Show what would be compressed and its estimated size reduction without actually compressing. | ||
| -g | --gzip | Enable Gzip compression. | |
| --max-threads | <MAX_THREADS> |
Maximum threads for parallel processing. Default: 10 |
|
| -V | --version | Display version information and exit. | |
| -z | --zstd | Enable Zstandard compression. | |
| --zstd-level | <ZSTD_LEVEL> |
Set Zstandard compression level (range: 1-22). Default: 10 |
|
| -h | --help | Display help information. | |
| -h | --dry-run | Perform a dry run without making changes (for compression or cleaning). |
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)
- Setup a build environment. See Microsoft guide.
- Install the Rust toolchain
stable-x86_64-pc-windows-msvc - Run the build script
build-win.cmd
- The executable will be located in
target-win/release
MacOS (Universal Binary)
- Install Xcode command line tools:
xcode-select --install
- Install Rust targets:
rustup target add x86_64-apple-darwin aarch64-apple-darwin
- Run the build script
./build-mac.sh
- The executable will be located in
dist-mac
Linux (musl libc)
- Install Docker. See Docker installation guide.
- Run the build script
./build-linux.sh
- 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.