npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

imagemin-avif-webpack-plugin

v0.0.4

Published

Webpack plugin which converts images to the avif format while also keeping the original files.

Downloads

320

Readme

imagemin-avif-webpack-plugin

Webpack plugin which converts images to the Avif format while also keeping the original files. Compatible with webpack 5, webpack 4 and previous versions as well.

It uses imagemin, imagemin-avif under the hood.

Shoutout to @iampava and its imagemin-webp-webpack-plugin, which this repo is based on.

Motivation

A modern image format based on the AV1 video format. AVIF generally has better compression than WebP, JPEG, PNG and GIF and is designed to supersede them. AVIF competes with JPEG XL which has similar compression quality and is generally seen as more feature-rich than AVIF.

Check the support tables on Can I use

Installation

$ npm install imagemin-avif-webpack-plugin --save-dev

Usage

In order to use this plugin, add it to your webpack config.

const ImageminAvifWebpackPlugin= require("imagemin-avif-webpack-plugin");

module.exports = {
    plugins: [new ImageminAvifWebpackPlugin()]
};

⚠ Keep in mind that plugin order matters, so usually you'd want to put it last.

API

new ImageminAvifWebpackPlugin( [settings] );

settings

Type: Object

Default:

{
  config: [{
    test: /\.(jpe?g|png)/,
    options: {
      quality:  75
    }
  }],
  overrideExtension: true,
  detailedLogs: false,
  silent: false,
  strict: true
}

config

Type Array<Object: {test, options} >

The main config of the plugin which controls how different file types are converted. Each item in the array is an object with 2 properties:

  • test - a RegExp selecting just certain images. Supported image formats are JPG, PNG and GIF.
  • options -the converting options for the images that pass the above RegExp

⚠ The options object is actually the same one from the imagemin-avif plugin so check their documentation for the available settings.

overrideExtension

Type: boolean Default: true

By default the plugin will override the original file extension, so you will get: image.png -> image.avif

In case you want to concat '.avif' at the end of the file name, set the config value to false. Ex: image.png -> image.png.avif. It may be useful when using nginx or similar to serve .avif files, if http-accept header contains avif just add a suffix to the requested image.

detailedLogs

Type: boolean Default: false

By default the plugin will print to the console

  1. the total number of megabytes saved by the avif images compared to the original ones
  2. the number of images that failed being converted

This options tells the plugin to also log the size difference per converted image and the names of the images that failed conversion.

silent

Type: boolean Default: false

In case you don't want anything printed to the console set this option to false. This will override the detailedLogs option.

strict

Type: boolean Default: true

By default the webpack build will fail if any of the images that match your RegExps fail the conversion.

This option tells the plugin to not crash the build and keep going :)