Registry / devops / vite-plugin-compression2

vite-plugin-compression2

library2.5.3jsnpmunverified

A Vite plugin for compressing build assets using Node.js built-in compression algorithms (gzip, brotliCompress, deflate) and custom algorithms like zstd. Supports multiple algorithms, custom filenames, tarball creation, and artifact hooks. Current stable version is 2.5.3, released under MIT license. Differentiates from vite-plugin-compression by supporting multiple algorithms in one plugin, zstd via Node.js built-in, and better TypeScript typing.

devops

npm install vite-plugin-compression2

github ↗package ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-COMPRE

vite-plugin-compression2

devopsjavascriptv2.5.3

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

compression

✓ import { compression } from 'vite-plugin-compression2'

✗ import compression from 'vite-plugin-compression2'

Named export, not default export.

defineAlgorithm

✓ import { defineAlgorithm } from 'vite-plugin-compression2'

✗ import { defineAlgorithm } from 'vite-plugin-compression'

The package name is 'vite-plugin-compression2', not 'vite-plugin-compression'.

tarball

✓ import { tarball } from 'vite-plugin-compression2'

✗ const { tarball } = require('vite-plugin-compression2')

The plugin is ESM-only; require is not supported.

Basic Vite configuration enabling gzip and brotli compression for build assets, with minimum size threshold.

import { defineConfig } from 'vite' import { compression } from 'vite-plugin-compression2' export default defineConfig({ plugins: [ compression({ include: /\\.(html|xml|css|json|js|mjs|svg|yaml|yml|toml)$/, threshold: 1024, algorithms: ['gzip', 'brotliCompress'], deleteOriginalAssets: false }) ] })

Debug

Known issues

deprecatedOption `filter` is deprecated in favor of `include` and `exclude`.

fix

Use `include` and `exclude` options instead of `filter`.

affects: >=2.0.0

gotchaThe `filename` option must include placeholders like `[path]`, `[base]`, etc. or it will produce unexpected names.

fix

Use default filename pattern or provide a string with placeholders (e.g., `[path][base].gz`).

affects: >=2.0.0

breakingv2.x changed from a single algorithm option to an `algorithms` array. Old `algorithm` option no longer works.

fix

Use `algorithms: ['gzip']` instead of `algorithm: 'gzip'`.

affects: >=2.0.0

deprecatedNode.js versions below 14 may not support built-in zstd if using Node 19+.

fix

Ensure Node.js version >= 19 for zstd support, or use a custom algorithm.

affects: >=2.1.0

gotchaWhen using `deleteOriginalAssets: true`, the original uncompressed files are removed; ensure you have a backup or use tarball.

fix

Set `deleteOriginalAssets: false` or use the tarball plugin to archive.

affects: >=2.0.0

Errors

Common errors & fixes

Cannot find module 'vite-plugin-compression2'

Missing package installation or wrong package name (confusing with 'vite-plugin-compression').

fix

Install the correct package: `npm install vite-plugin-compression2 -D`

Error: Option 'algorithms' is not an array

Passing a single string instead of an array for the algorithms option.

fix

Use `algorithms: ['gzip']` (array) instead of `algorithms: 'gzip'`.

TypeError: compression is not a function

Importing default export instead of named export.

fix

Use `import { compression } from 'vite-plugin-compression2'`

Upgrade

Version history

2.5.3latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

11 hits · last 30 days

node

Resources

githubhttps://github.com/nonzzz/vite-plugin-compression ↗

packagehttps://www.npmjs.com/package/vite-plugin-compression2 ↗