Registry / devops / esbuild-plugin-imagemin

esbuild-plugin-imagemin

library1.0.1jsnpmunverified

An esbuild plugin that automatically minifies images (PNG, JPG, GIF, SVG) during the build process using imagemin. Version 1.0.1 is the latest stable release, supports both CJS and ESM imports, and provides TypeScript type definitions. It bundles several popular imagemin plugins (mozjpeg, gifsicle, pngquant, svgo) by default, with options to disable individual ones, configure their options, or add custom imagemin plugins. This plugin differentiates itself by integrating seamlessly with esbuild's build pipeline, requiring no additional loaders or configuration beyond adding the plugin.

devops

npm install esbuild-plugin-imagemin

github ↗package ↗

INSTALL

IMPORT

SIG · ESBUILD-PLUGIN-IMA

esbuild-plugin-imagemin

devopsjavascriptv1.0.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

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

default

✓ import imageminPlugin from 'esbuild-plugin-imagemin'

✗ const imageminPlugin = require('esbuild-plugin-imagemin')

ESM default import is preferred; CJS require also works.

ImageminPluginOptions

✓ import type { ImageminPluginOptions } from 'esbuild-plugin-imagemin'

TypeScript type import, available when using TS.

esbuild plugin array entry

✓ plugins: [imageminPlugin()]

✗ plugins: [imageminPlugin]

The plugin is a function that returns a plugin object; call it before passing to plugins array.

Shows basic setup of esbuild with the imagemin plugin enabled, using ESM imports and async build.

import esbuild from 'esbuild'; import imageminPlugin from 'esbuild-plugin-imagemin'; await esbuild.build({ entryPoints: ['src/index.js'], bundle: true, outfile: 'dist/bundle.js', plugins: [imageminPlugin()], });

Debug

Known issues

gotchaThe plugin is a function that must be called — passing the function reference directly will not work.

fix

Use imageminPlugin() instead of imageminPlugin in the plugins array.

affects: >=1.0.0

breakingVersion 1.0.0 changed the default plugins list; previous versions may have used different defaults.

fix

Review default plugins and use disableDefaultPlugins if needed.

affects: >=1.0.0

gotchaThe plugin only minifies images referenced via import/require in the bundle — it does not handle all image files automatically unless they are part of the build graph.

fix

Ensure images are imported in your source files.

affects: >0

deprecatedThe package previously did not ship TypeScript types; type definitions were added in v1.0.1.

fix

Upgrade to v1.0.1 to get built-in TypeScript support.

affects: <1.0.1

Errors

Common errors & fixes

Error: Cannot find module 'imagemin'

Missing imagemin dependency (peer dependency not auto-installed in some npm versions).

fix

npm install imagemin

TypeError: imageminPlugin is not a function

Calling the plugin without parentheses: plugins: [imageminPlugin] instead of plugins: [imageminPlugin()].

fix

Change to imageminPlugin()

Error: Is a directory

The plugin may attempt to process a directory path incorrectly if glob patterns are used.

fix

Ensure entry points are files, not directories.

Upgrade

Version history

1.0.1latest on npm

Audit

Dependencies

imageminrequiredCore image minimization library

imagemin-mozjpegoptionalDefault JPEG optimizer

imagemin-gifsicleoptionalDefault GIF optimizer

imagemin-pngquantoptionalDefault PNG optimizer

imagemin-svgooptionalDefault SVG optimizer

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/omyasn/esbuild-plugin-imagemin ↗

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