Registry / devops / esbuild-plugin-compress

esbuild-plugin-compress

library1.0.1jsnpmunverified

An ESBuild plugin for compressing output files using gzip and/or brotli compression. Version 1.0.1 is the current stable release, with no updates since initial publish. Key differentiators: simple setup, supports both gzip and brotli, allows excluding files via micromatch patterns, and options to emit original files. Requires esbuild >= 0.14.0 and setting `write: false` in ESBuild options to access output files. Ships TypeScript types.

devops

npm install esbuild-plugin-compress

github ↗package ↗

INSTALL

IMPORT

SIG · ESBUILD-PLUGIN-COM

esbuild-plugin-compress

devopsjavascriptv1.0.1

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–223 runs

build_error

glibc

node 18–223 runs

build_error

Code

Verified usage

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

compress

✓ import { compress } from 'esbuild-plugin-compress'

✗ import compress from 'esbuild-plugin-compress'

Named export, not default. This is the only export.

CompressOptions

✓ import type { CompressOptions } from 'esbuild-plugin-compress'

✗ import { CompressOptions } from 'esbuild-plugin-compress'

Use type import for TypeScript types to avoid runtime overhead.

require usage

✓ const { compress } = require('esbuild-plugin-compress')

✗ const compress = require('esbuild-plugin-compress')

CommonJS require destructure as it's a named export. Not recommended if using TypeScript.

Build script using ESBuild with compression plugin for gzip and brotli output, excluding source maps.

import { build } from 'esbuild'; import { compress } from 'esbuild-plugin-compress'; build({ entryPoints: ['./src/index.ts'], outfile: './build/index.js', write: false, plugins: [ compress({ gzip: true, brotli: true, outputDir: 'dist', exclude: ['**/*.map'], }), ], }).catch(() => process.exit(1));

Debug

Known issues

gotchawrite must be set to false for the plugin to work

fix

Set `write: false` in ESBuild options to enable output file access.

affects: >=1.0.0

deprecatedNo deprecated features documented; plugin is minimal.

fix

N/A

affects: >=1.0.0

Errors

Common errors & fixes

Error: Output file must be set to 'write: false' to use compress plugin

Missing `write: false` in ESBuild options

fix

Add `write: false` to the build options object.

TypeError: esbuild_plugin_compress_1.compress is not a function

Incorrect import (default instead of named) in CommonJS

fix

Use `const { compress } = require('esbuild-plugin-compress');`

Cannot find module 'esbuild-plugin-compress'

Package not installed

fix

Run `npm install esbuild-plugin-compress --save-dev`

Upgrade

Version history

1.0.1latest on npm

Audit

Dependencies

esbuildrequiredpeer dependency required as plugin runtime

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/LinbuduLab/esbuild-plugins ↗

packagehttps://www.npmjs.com/package/esbuild-plugin-compress ↗