{"id":42229,"library":"vite-plugin-image-optimizer","title":"Vite Image Optimizer","description":"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).","status":"active","version":"2.0.3","language":"javascript","source_language":"en","source_url":"https://github.com/FatehAK/vite-plugin-image-optimizer","tags":["javascript","vite","vite-plugin","image compression","image optimization","svgo","sharp.js","typescript"],"install":[{"cmd":"npm install vite-plugin-image-optimizer","lang":"bash","label":"npm"},{"cmd":"yarn add vite-plugin-image-optimizer","lang":"bash","label":"yarn"},{"cmd":"pnpm add vite-plugin-image-optimizer","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Peer dependency: Vite is the build tool this plugin extends.","package":"vite","optional":false},{"reason":"Peer dependency: required for SVG optimization.","package":"svgo","optional":false},{"reason":"Peer dependency: required for raster image optimization.","package":"sharp","optional":false}],"imports":[{"note":"Named import; default import is incorrect.","wrong":"import ViteImageOptimizer from 'vite-plugin-image-optimizer'","symbol":"ViteImageOptimizer","correct":"import { ViteImageOptimizer } from 'vite-plugin-image-optimizer'"},{"note":"CommonJS destructure; direct require returns module object.","wrong":"const ViteImageOptimizer = require('vite-plugin-image-optimizer')","symbol":"ViteImageOptimizer","correct":"const { ViteImageOptimizer } = require('vite-plugin-image-optimizer')"},{"note":"Type import for TypeScript (only type, no runtime effect).","symbol":"ViteImageOptimizer","correct":"import type { ViteImageOptimizer } from 'vite-plugin-image-optimizer'"}],"quickstart":{"code":"// vite.config.ts\nimport { ViteImageOptimizer } from 'vite-plugin-image-optimizer';\nimport { defineConfig } from 'vite';\n\nexport default defineConfig({\n  plugins: [\n    ViteImageOptimizer({\n      logStats: true,\n      ansiColors: true,\n      test: /\\.(jpe?g|png|gif|tiff|webp|svg|avif)$/i,\n      includePublic: true,\n      png: {\n        quality: 80,\n      },\n      jpeg: {\n        quality: 80,\n      },\n      webp: {\n        quality: 75,\n      },\n      avif: {\n        quality: 60,\n      },\n      svg: {\n        multipass: true,\n        plugins: ['preset-default', 'sortAttrs'],\n      },\n    }),\n  ],\n});","lang":"typescript","description":"Configures ViteImageOptimizer with custom quality settings for raster formats and SVGO plugins for SVG optimization."},"warnings":[{"fix":"Run 'npm install --save-dev sharp svgo' before using the plugin.","message":"Sharp and SVGO are not bundled; you must install them separately as dev dependencies.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Update Node.js to >=18.17.0 or use an older version of the plugin (v1.x).","message":"Node >=18.17.0 required as of v2.0.0.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Update Vite to >=5 or use plugin v1.x (which supports Vite >=3).","message":"Vite >=5 required as of v2.0.0.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Use Sharp for raster optimization instead.","message":"The 'squoosh' option was considered but dropped; future versions may remove any leftover references.","severity":"deprecated","affected_versions":">=2.0.0"},{"fix":"If you need force compression, set 'cache: false' and ensure Sharp quality settings are lossy.","message":"Plugin skips optimization if output size is larger than input size; no warning or override.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Enable caching by setting 'cache: true' in options, or delete cache directory manually.","message":"Caching is optional; default is no cache. Re-running build without clearing cache may use stale results.","severity":"gotcha","affected_versions":">=1.0.0"}],"env_vars":null,"search_vec":"'0.34.0':36 '18.17.0':29 '2.0.3':26 '4':33 '5':31 'altern':57 'asset':10 'avif':16 'build':19 'cach':43 'combin':59 'compress':39,80 'default':41 'detail':51 'differenti':55 'directori':48 'filter':44 'gif':13 'imag':2,9,79,81 'imagemin':68 'javascript':74 'jpeg':12 'log':54 'lossless':38 'node':28 'one':64 'optim':3,8,52,82 'plugin':6,65,78 'png':11 'provid':37 'public':47 'requir':27,67 'sharp':35,60 'sharp.js':22,84 'squoosh':70 'stat':53 'support':49 'svg':17 'svgo':24,32,62,83 'test/include/exclude':46 'tiff':14 'time':20 'typescript':85 'unmaintain':73 'use':21 'version':25 'vite':1,5,30,75,77 'vite-plugin':76 'webp':15 'without':66","created_at":"2026-06-04T18:56:15.067702+00:00","updated_at":"2026-06-04T18:56:15.067702+00:00","problems":[{"fix":"Run 'npm install sharp --save-dev' or 'yarn add sharp --dev'","cause":"Sharp is not installed as a dev dependency.","error":"Error: Cannot find module 'sharp'"},{"fix":"Run 'npm install svgo --save-dev' or 'yarn add svgo --dev'","cause":"SVGO is not installed as a dev dependency.","error":"Error: Cannot find module 'svgo'"},{"fix":"Use 'import { ViteImageOptimizer } from 'vite-plugin-image-optimizer'' instead of default import.","cause":"Imported as default instead of named import.","error":"TypeError: ViteImageOptimizer is not a function"},{"fix":"Upgrade Vite to ^5.0.0 or install plugin version 1.x ('npm install vite-plugin-image-optimizer@^1.0.0').","cause":"v2.0.0 requires Vite >=5.","error":"The plugin does not work with Vite 4.x"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/FatehAK/vite-plugin-image-optimizer#readme","github":"https://github.com/FatehAK/vite-plugin-image-optimizer","docs":null,"changelog":null,"pypi":null,"npm":"vite-plugin-image-optimizer","openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-04","next_check":"2026-09-02","install_tag":null}}