# vite-plugin-compression2 > a fast vite compression plugin Latest version **2.5.3** (published 2026-03-21) · MIT license · 0 weekly downloads ## Install ```sh npm install vite-plugin-compression2 pnpm add vite-plugin-compression2 yarn add vite-plugin-compression2 bun add vite-plugin-compression2 ``` ## Health **Score 60/100 (C)** — status: stable. Positive: has types; esm support; no vulnerabilities; has provenance. Warnings: low downloads. ## Facts | | | |---|---| | Version | 2.5.3 | | Published | 2026-03-21 | | First published | 2022-10-24 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 2 | | Unpacked size | 49.9 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Provenance | attested (GitHub Actions) | | GitHub stars | 327 | | Author | Kanno | | Maintainers | nonzzz | | Keywords | vite, vite-plugin, compress | ## Links - npm: https://www.npmjs.com/package/vite-plugin-compression2 - Repository: https://github.com/nonzzz/vite-plugin-compression - Homepage: https://github.com/nonzzz/vite-plugin-compression#readme - Issues: https://github.com/nonzzz/vite-plugin-compression/issues - npm.io page: https://npm.io/package/vite-plugin-compression2 ## Dependencies (2) - [tar-mini](https://npm.io/package/tar-mini.md) ^0.2.0 - [@rollup/pluginutils](https://npm.io/package/@rollup/pluginutils.md) ^5.1.0 ## Alternatives - [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads - [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads - [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads - [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads - [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads ## Recent versions - 2.5.3 (latest) — 2026-03-21 - 2.5.2 — 2026-03-15 - 2.5.1 — 2026-03-11 - 2.5.0 — 2026-03-01 - 2.4.0 — 2025-12-03 - 2.3.1 — 2025-10-26 - 2.3.0 — 2025-10-13 - 2.2.1 — 2025-08-29 - 2.2.0 — 2025-06-18 - 2.1.0 — 2025-06-17 - 2.0.1 — 2025-06-05 - 2.0.0 — 2025-06-05 - 1.4.0 — 2025-05-23 - 1.3.3 — 2024-11-26 - 1.3.2 — 2024-11-26 - … 40 more at https://npm.io/package/vite-plugin-compression2/versions ## README

[![codecov](https://codecov.io/gh/nonzzz/vite-plugin-compression/branch/master/graph/badge.svg?token=NG4475OP6B)](https://codecov.io/gh/nonzzz/vite-compression-plugin) [![Download](https://img.shields.io/npm/dm/vite-plugin-compression2)](https://www.npmjs.com/package/vite-plugin-compression2) ## Install ```bash $ yarn add vite-plugin-compression2 -D # or $ npm install vite-plugin-compression2 -D # or $ pnpm add vite-plugin-compression2 -D ``` ## Usage ### Basic Usage ```js import { defineConfig } from 'vite' import { compression } from 'vite-plugin-compression2' export default defineConfig({ plugins: [ // ...your plugins compression() ] }) ``` ### Multiple Algorithms ```js import { compression, defineAlgorithm } from 'vite-plugin-compression2' export default defineConfig({ plugins: [ compression({ algorithms: [ 'gzip', 'brotliCompress', defineAlgorithm('deflate', { level: 9 }) ] }) ] }) ``` ### Custom Algorithm Function ```js import { compression, defineAlgorithm } from 'vite-plugin-compression2' export default defineConfig({ plugins: [ compression({ algorithms: [ defineAlgorithm( async (buffer, options) => { // Your custom compression logic return compressedBuffer }, { customOption: true } ) ] }) ] }) ``` ### With Tarball ```js import { compression, tarball } from 'vite-plugin-compression2' export default defineConfig({ plugins: [ compression(), // If you want to create a tarball archive, use tarball plugin after compression tarball({ dest: './dist/archive' }) ] }) ``` ## Options ### Compression Plugin Options | params | type | default | description | | ---------------------- | --------------------------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `include` | `string \| RegExp \| Array` | `/\.(html\|xml\|css\|json\|js\|mjs\|svg\|yaml\|yml\|toml)$/` | Include all assets matching any of these conditions. | | `exclude` | `string \| RegExp \| Array` | `-` | Exclude all assets matching any of these conditions. | | `threshold` | `number` | `0` | Only assets bigger than this size are processed (in bytes) | | `algorithms` | `Algorithms` | `['gzip', 'brotliCompress']` | Array of compression algorithms or defineAlgorithm results | | `filename` | `string \| function` | `[path][base].gz` or `[path][base]. br` If algorithm is `zstandard` be `[path][base].zst` | The target asset filename pattern | | `deleteOriginalAssets` | `boolean` | `false` | Whether to delete the original assets or not | | `skipIfLargerOrEqual` | `boolean` | `true` | Whether to skip the compression if the result is larger than or equal to the original file | | `logLevel` | `string` | `info` | Control sdout info | | `artifacts` | `function` | `undefined` | Sometimes you need to copy something to the final output. This option may help you. | | `scheduler` | `SchedulerOptions` | `undefined` | Limit concurrency | ### Tarball Plugin Options | params | type | default | description | | ------ | -------- | ------- | --------------------------------- | | `dest` | `string` | `-` | Destination directory for tarball | ## API ### `defineAlgorithm(algorithm, options?)` Define a compression algorithm with options. **Parameters:** - `algorithm`: Algorithm name (`'gzip' | 'brotliCompress' | 'deflate' | 'deflateRaw' | 'zstandard' | 'gz' | 'br' | 'brotli' | 'zstd'`) or custom function - `options`: Compression options for the algorithm **Returns:** `[algorithm, options]` tuple **Examples:** ```js // Built-in algorithm with default options defineAlgorithm('gzip') // Built-in algorithm with custom options defineAlgorithm('gzip', { level: 9 }) // Brotli with custom quality defineAlgorithm('brotliCompress', { params: { [require('zlib').constants.BROTLI_PARAM_QUALITY]: 11 } }) // Custom algorithm function defineAlgorithm( async (buffer, options) => { // Your compression implementation return compressedBuffer }, { customOption: 'value' } ) ``` ### Supported Algorithms | Algorithm | Aliases | Extension | Node.js Support | Description | | ---------------- | -------------- | --------- | ----------------------- | -------------------------------------------------------------- | | `gzip` | `gz` | `.gz` | All versions | Standard gzip compression with good balance of speed and ratio | | `brotliCompress` | `brotli`, `br` | `.br` | All versions | Brotli compression with better compression ratio than gzip | | `deflate` | - | `.gz` | All versions | Deflate compression algorithm | | `deflateRaw` | - | `.gz` | All versions | Raw deflate compression without headers | | `zstandard` | `zstd` | `.zst` | >= 22.15.0 or >= 23.8.0 | Zstandard compression with excellent speed/ratio balance | | Custom Function | - | Custom | All versions | Your own compression algorithm implementation | ### Algorithm Types The `algorithms` option accepts: ```typescript type Algorithms = | Algorithm[] // ['gzip', 'brotliCompress'] | DefineAlgorithmResult[] // [defineAlgorithm('gzip'), ...] | (Algorithm | DefineAlgorithmResult)[] // Mixed array ``` ## Migration If you're upgrading from v1.x, please check the [Migration Guide](./MIGRATION-GUIDE.md). ## Q & A [FAQ](./Q&A.md) ### Examples #### Basic Gzip Only ```js compression({ algorithms: ['gzip'] }) ``` #### Multiple Algorithms with Custom Options ```js compression({ algorithms: [ defineAlgorithm('gzip', { level: 9 }), defineAlgorithm('brotliCompress', { params: { [require('zlib').constants.BROTLI_PARAM_QUALITY]: 11 } }) ] }) ``` #### Custom Filename Pattern ```js compression({ algorithms: ['gzip'], filename: '[path][base].[hash].gz' }) ``` #### Delete Original Files ```js compression({ algorithms: ['gzip'], deleteOriginalAssets: true }) ``` #### Size Threshold ```js compression({ algorithms: ['gzip'], threshold: 1000 // Only compress files larger than 1KB }) ``` ## Production Deployment After building your project with compressed assets, you need to configure your web server to serve these pre-compressed files. ### Nginx Configuration ```nginx http { # Enable gzip_static module to serve pre-compressed .gz files gzip_static on; # Enable brotli_static to serve pre-compressed .br files # Requires ngx_brotli module: https://github.com/google/ngx_brotli brotli_static on; # Fallback to dynamic compression if static file not found gzip on; gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; server { listen 80; server_name example.com; root /var/www/html; location / { try_files $uri $uri/ /index.html; } } } ``` ### Apache Configuration ```apache # Enable mod_deflate for fallback dynamic compression AddOutputFilterByType DEFLATE text/html text/plain text/xml text/css text/javascript application/javascript application/json # Serve pre-compressed files RewriteEngine On # Serve .br file if it exists and client supports brotli RewriteCond %{HTTP:Accept-Encoding} br RewriteCond %{REQUEST_FILENAME}.br -f RewriteRule ^(.*)$ $1.br [L] # Serve .gz file if it exists and client supports gzip RewriteCond %{HTTP:Accept-Encoding} gzip RewriteCond %{REQUEST_FILENAME}.gz -f RewriteRule ^(.*)$ $1.gz [L] # Set correct content-type and encoding headers Header set Content-Type "application/javascript" Header set Content-Encoding "gzip" Header set Content-Type "text/css" Header set Content-Encoding "gzip" Header set Content-Type "application/javascript" Header set Content-Encoding "br" Header set Content-Type "text/css" Header set Content-Encoding "br" ``` ## Performance Tips ### Compression Level Selection Choose compression levels based on your deployment strategy: ```js compression({ algorithms: [ // Development: faster builds, lower compression defineAlgorithm('gzip', { level: 6 }), // Default level // Production: slower builds, better compression defineAlgorithm('gzip', { level: 9 }), // Maximum compression // Brotli: quality 10-11 recommended for static assets defineAlgorithm('brotliCompress', { params: { [require('zlib').constants.BROTLI_PARAM_QUALITY]: 11 } }) ] }) ``` **Recommendations:** - **Development/CI**: Level 6 (gzip) or Quality 4-6 (brotli) - faster builds - **Production**: Level 9 (gzip) or Quality 10-11 (brotli) - best compression - **Balance**: Level 7-8 (gzip) or Quality 8-9 (brotli) - good compromise ### File Size Threshold Only compress files that benefit from compression: ```js compression({ threshold: 1024, // 1KB minimum - recommended algorithms: ['gzip', 'brotliCompress'] }) ``` **Why use a threshold?** - Files smaller than 1KB may not benefit from compression - HTTP overhead can make tiny compressed files slower - Saves build time and disk space ### Multi-Algorithm Strategy Use both gzip and brotli for maximum compatibility and performance: ```js compression({ algorithms: [ defineAlgorithm('gzip', { level: 9 }), // Wide browser support (all browsers) defineAlgorithm('brotliCompress', { // Better compression (modern browsers) params: { [require('zlib').constants.BROTLI_PARAM_QUALITY]: 11 } }) ] }) ``` **Benefits:** - Brotli: 15-20% better compression than gzip - Gzip: Fallback for older browsers - Server automatically serves the best format based on `Accept-Encoding` header ### Selective Compression Compress only specific file types for optimal results: ```js compression({ include: [/\.(js|mjs|json|css|html|svg)$/], // Text-based files exclude: [/\.(png|jpg|jpeg|gif|webp|woff|woff2)$/], // Already compressed formats threshold: 1024 }) ``` **File types that compress well:** - JavaScript/TypeScript (`.js`, `.mjs`, `.ts`) - CSS (`.css`) - HTML (`.html`) - JSON (`.json`) - SVG (`.svg`) - XML (`.xml`) **File types to skip:** - Images (`.png`, `.jpg`, `.webp`) - already compressed - Fonts (`.woff`, `.woff2`) - already compressed - Videos (`.mp4`, `.webm`) - already compressed ### Others - If you want to analyze your bundle assets, try [vite-bundle-analyzer](https://github.com/nonzzz/vite-bundle-analyzer) - `tarball` option `dest` means to generate a tarball somewhere - `tarball` is based on the `ustar` format. It should be compatible with all popular tar distributions (gnutar, bsdtar etc) ### Node.js Version Requirements - **gzip, brotliCompress, deflate, deflateRaw**: All Node.js versions supported - **zstd**: Requires Node.js >= 22.15.0 or >= 23.8.0 > **Note**: If you try to use zstd compression on an unsupported Node.js version, the plugin will throw a helpful error message indicating the required version. ### Sponsors

### LICENSE [MIT](./LICENSE) ## Acknowledgements [NWYLZW](https://github.com/NWYLZW) ### Author [Kanno](https://github.com/nonzzz) --- _Source: https://npm.io/package/vite-plugin-compression2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._