Registry / devops / vite-plugin-image-optimizer

vite-plugin-image-optimizer

library2.0.3jsnpmunverified

A Vite plugin for optimizing image assets (PNG, JPEG, GIF, TIFF, WebP, AVIF, SVG) at build time using Sharp.js and SVGO. Version 2.0.3 requires Node >=18.17.0, Vite >=5, SVGO >=4, and Sharp >=0.34.0. Provides lossless compression by default, with caching, filtering by test/include/exclude, public directory support, and detailed optimization stats logging. Differentiates from alternatives by combining Sharp and SVGO in one plugin without requiring imagemin or squoosh (which are unmaintained).

devops

npm install vite-plugin-image-optimizer

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · VITE-PLUGIN-IMAGE-

vite-plugin-image-optimizer

devopsjavascriptv2.0.3

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.

ViteImageOptimizer

✓ import { ViteImageOptimizer } from 'vite-plugin-image-optimizer'

✗ import ViteImageOptimizer from 'vite-plugin-image-optimizer'

Named import; default import is incorrect.

ViteImageOptimizer

✓ const { ViteImageOptimizer } = require('vite-plugin-image-optimizer')

✗ const ViteImageOptimizer = require('vite-plugin-image-optimizer')

CommonJS destructure; direct require returns module object.

ViteImageOptimizer

✓ import type { ViteImageOptimizer } from 'vite-plugin-image-optimizer'

Type import for TypeScript (only type, no runtime effect).

Configures ViteImageOptimizer with custom quality settings for raster formats and SVGO plugins for SVG optimization.

// vite.config.ts import { ViteImageOptimizer } from 'vite-plugin-image-optimizer'; import { defineConfig } from 'vite'; export default defineConfig({ plugins: [ ViteImageOptimizer({ logStats: true, ansiColors: true, test: /\.(jpe?g|png|gif|tiff|webp|svg|avif)$/i, includePublic: true, png: { quality: 80, }, jpeg: { quality: 80, }, webp: { quality: 75, }, avif: { quality: 60, }, svg: { multipass: true, plugins: ['preset-default', 'sortAttrs'], }, }), ], });

Debug

Known issues

breakingSharp and SVGO are not bundled; you must install them separately as dev dependencies.

fix

Run 'npm install --save-dev sharp svgo' before using the plugin.

affects: >=2.0.0

breakingNode >=18.17.0 required as of v2.0.0.

fix

Update Node.js to >=18.17.0 or use an older version of the plugin (v1.x).

affects: >=2.0.0

breakingVite >=5 required as of v2.0.0.

fix

Update Vite to >=5 or use plugin v1.x (which supports Vite >=3).

affects: >=2.0.0

deprecatedThe 'squoosh' option was considered but dropped; future versions may remove any leftover references.

fix

Use Sharp for raster optimization instead.

affects: >=2.0.0

gotchaPlugin skips optimization if output size is larger than input size; no warning or override.

fix

If you need force compression, set 'cache: false' and ensure Sharp quality settings are lossy.

affects: >=1.0.0

gotchaCaching is optional; default is no cache. Re-running build without clearing cache may use stale results.

fix

Enable caching by setting 'cache: true' in options, or delete cache directory manually.

affects: >=1.0.0

Errors

Common errors & fixes

Error: Cannot find module 'sharp'

Sharp is not installed as a dev dependency.

fix

Run 'npm install sharp --save-dev' or 'yarn add sharp --dev'

Error: Cannot find module 'svgo'

SVGO is not installed as a dev dependency.

fix

Run 'npm install svgo --save-dev' or 'yarn add svgo --dev'

TypeError: ViteImageOptimizer is not a function

Imported as default instead of named import.

fix

Use 'import { ViteImageOptimizer } from 'vite-plugin-image-optimizer'' instead of default import.

The plugin does not work with Vite 4.x

v2.0.0 requires Vite >=5.

fix

Upgrade Vite to ^5.0.0 or install plugin version 1.x ('npm install vite-plugin-image-optimizer@^1.0.0').

Upgrade

Version history

2.0.3latest on npm

Audit

Dependencies

viterequiredPeer dependency: Vite is the build tool this plugin extends.

svgorequiredPeer dependency: required for SVG optimization.

sharprequiredPeer dependency: required for raster image optimization.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/FatehAK/vite-plugin-image-optimizer ↗

packagevite-plugin-image-optimizer ↗

homepagehttps://github.com/FatehAK/vite-plugin-image-optimizer#readme ↗