rollup-plugin-compression

1.0.3 verified Mon Apr 27 auth: no javascript

Rollup plugin to compress the dist directory into a ZIP file after build. Version 1.0.3, stable. Simplifies build packaging for Vite/Rollup projects. Key differentiator: focuses solely on ZIP compression with options for source name, target name, and ignoring base directory. Alternative to more complex bundling tools.

Common errors

error Cannot find module 'rollup-plugin-compression' ↓

cause Package not installed or import path error.

fix

Run 'npm install rollup-plugin-compression -D' and check import is from 'rollup-plugin-compression'.

Warnings

gotcha Exported function name is 'compresssionBuild' (note extra 's'). Typos may cause import errors. ↓

fix Use the exact name: import compresssionBuild from 'rollup-plugin-compression'.

gotcha Plugin only supports ZIP compression type. Other compression formats not available. ↓

fix If other formats needed, use alternative plugins like rollup-plugin-zip or vite-plugin-zip-pack.

gotcha Options 'sourceName' defaults to 'dist' and must match the output directory. Mismatch may cause empty zip. ↓

fix Verify the build output directory name matches sourceName.

Install

npm install rollup-plugin-compression

yarn add rollup-plugin-compression

pnpm add rollup-plugin-compression

Imports

compresssionBuild
```
import compresssionBuild from 'rollup-plugin-compression'
```
Default export, function name has typo 'compresssionBuild' (double s).

ICompressionOptions

import type { ICompressionOptions } from 'rollup-plugin-compression'

TypeScript type import for options.

Quickstart

Shows how to configure the plugin in a Vite config file with TypeScript types.

// vite.config.ts
import compresssionBuild from 'rollup-plugin-compression';
import type { ICompressionOptions } from 'rollup-plugin-compression';

const option: ICompressionOptions = {
  sourceName: 'dist',
  type: 'zip',
  targetName: 'my-app',
  ignoreBase: false
};

export default defineConfig({
  plugins: [compresssionBuild(option)]
});