Skip to content

Latest commit

 

History

History
165 lines (113 loc) · 6.64 KB

README.md

File metadata and controls

165 lines (113 loc) · 6.64 KB
Raw

grunt-contrib-imagemin v1.1.0 Build Status: Linux Build Status: Windows

Minify images

Getting Started

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-contrib-imagemin --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-contrib-imagemin');

Imagemin task

Run this task with the grunt imagemin command.

Minify images using imagemin.

Comes bundled with the following optimizers:

We recommend using grunt-newer to only process changed files as minifying images can be quite slow.

Options

Options will only apply to the relevant files, so you don't need separate targets for png/jpg.

optimizationLevel (png)

Type: Number
Default: 3

Select optimization level between 0 and 7.

The optimization level 0 enables a set of optimization operations that require minimal effort. There will be no changes to image attributes like bit depth or color type, and no recompression of existing IDAT datastreams. The optimization level 1 enables a single IDAT compression trial. The trial chosen is what OptiPNG thinks it’s probably the most effective. The optimization levels 2 and higher enable multiple IDAT compression trials; the higher the level, the more trials.

Level and trials:

  1. 1 trial
  2. 8 trials
  3. 16 trials
  4. 24 trials
  5. 48 trials
  6. 120 trials
  7. 240 trials

progressive (jpg)

Type: Boolean
Default: true

Lossless conversion to progressive.

interlaced (gif)

Type: Boolean
Default: true

Interlace gif for progressive rendering.

svgoPlugins (svg)

Type: array
Default: []

Customize which SVGO plugins to use. More here.

use

Type: Array
Default: null

Additional plugins to use with imagemin.

Example config

You can either map your files statically or dynamically.

var mozjpeg = require('imagemin-mozjpeg');

grunt.initConfig({
  imagemin: {                          // Task
    static: {                          // Target
      options: {                       // Target options
        optimizationLevel: 3,
        svgoPlugins: [{ removeViewBox: false }],
        use: [mozjpeg()]
      },
      files: {                         // Dictionary of files
        'dist/img.png': 'src/img.png', // 'destination': 'source'
        'dist/img.jpg': 'src/img.jpg',
        'dist/img.gif': 'src/img.gif'
      }
    },
    dynamic: {                         // Another target
      files: [{
        expand: true,                  // Enable dynamic expansion
        cwd: 'src/',                   // Src matches are relative to this path
        src: ['**/*.{png,jpg,gif}'],   // Actual patterns to match
        dest: 'dist/'                  // Destination path prefix
      }]
    }
  }
});

grunt.loadNpmTasks('grunt-contrib-imagemin');
grunt.registerTask('default', ['imagemin']);

Release History

  • 2016-12-20   v1.5.0   Upgrade to imagemin ^5.2, rewrite to promises
  • 2016-05-23   v1.0.1   Check for data.contents existence.
  • 2015-11-09   v1.0.0   Update to imagemin ^4.0.
  • 2015-03-22   v0.9.4   Add support for renaming files.
  • 2015-02-11   v0.9.3   Remove pngquant.
  • 2014-11-11   v0.9.2   Bump imagemin dependency.
  • 2014-10-25   v0.9.1   Update plugin API.
  • 2014-10-22   v0.9.0   Update to imagemin 2.0.
  • 2014-08-27   v0.8.1   Bump dependencies.
  • 2014-08-11   v0.8.0   Better output. Update to chalk 0.5.0. Fixes imagemin options.
  • 2014-08-11   v0.7.2   Fix npm EPEERINVALID.
  • 2014-05-31   v0.7.1   Caching original image size before optimization. Remove unused dependencies.
  • 2014-04-29   v0.7.0   Update "imagemin" to 0.4
  • 2014-04-01   v0.6.1   Fix problem with corrupt images being created
  • 2014-03-28   v0.6.0   Updated "imagemin" to 0.2. Added percentage to size saved view - fixes #167. cache option removed. Adds "pretty-bytes".
  • 2014-01-13   v0.5.0   Extract the logic into an external lib imagemin.
  • 2014-01-08   v0.4.1   Prevent "Maximum call stack size exceeded". Speed up loading this task by lazy requiring bin deps.
  • 2013-11-22   v0.4.0   The pngquant option is now false by default instead of true.
  • 2013-09-09   v0.3.0   Add interlace option for GIF files.
  • 2013-08-16   v0.2.0   Add gifsicle and pngquant. Cache images so only changed images are optimized. Default optimizationLevel to 7 and progressive to true.
  • 2013-04-10   v0.1.4   Fix exception when running in verbose mode.
  • 2013-04-05   v0.1.3   Fix OptiPNG not being able to overwrite file. Allow overwriting src when dest/src is the same. Limit to 10 concurrent optimizations.
  • 2013-02-22   v0.1.2   Fix OptiPNG not working on some systems. Prevent OptiPNG from producing .bak files.
  • 2013-02-15   v0.1.1   First official release for Grunt 0.4.0.
  • 2013-01-30   v0.1.1rc8   Fix task not creating destination folders.
  • 2013-01-30   v0.1.1rc7   Updating to work with grunt v0.4.0rc7. Switching to this.files API.
  • 2012-11-01   v0.1.0   Initial release.

Task submitted by Sindre Sorhus

This file was generated on Mon Dec 19 2016 20:52:31.