Skip to content
Minify PNG, JPEG, GIF and SVG images
Branch: master
Clone or download
Latest commit 97cd1c3 May 30, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create funding.yml May 28, 2019
.editorconfig Meta tweaks Sep 22, 2017
.gitattributes Meta tweaks Nov 6, 2018
.gitignore Meta tweaks Sep 22, 2017
.npmrc
.travis.yml Require Node.js 8 May 30, 2019
fixture-svg-logo.svg Fix another regression of b57f1d6 (#318) Nov 6, 2018
fixture.png init Dec 30, 2013
index.js Require Node.js 8 May 30, 2019
license Meta tweaks Sep 22, 2017
package.json 6.0.0 May 30, 2019
readme.md Require Node.js 8 May 30, 2019
test.js Require Node.js 8 May 30, 2019

readme.md

gulp-imagemin Build Status XO code style

Minify PNG, JPEG, GIF and SVG images with imagemin

Issues with the output should be reported on the imagemin issue tracker.

Install

$ npm install --save-dev gulp-imagemin

Usage

Basic

const gulp = require('gulp');
const imagemin = require('gulp-imagemin');

gulp.task('default', () =>
	gulp.src('src/images/*')
		.pipe(imagemin())
		.pipe(gulp.dest('dist/images'))
);

Custom plugin options

//
.pipe(imagemin([
	imagemin.gifsicle({interlaced: true}),
	imagemin.jpegtran({progressive: true}),
	imagemin.optipng({optimizationLevel: 5}),
	imagemin.svgo({
		plugins: [
			{removeViewBox: true},
			{cleanupIDs: false}
		]
	})
]))
//

Note that you may come across an older, implicit syntax. In versions < 3, the same was written like this:

//
.pipe(imagemin({
	interlaced: true,
	progressive: true,
	optimizationLevel: 5,
	svgoPlugins: [
		{
			removeViewBox: true
		}
	]
}))
//

Custom plugin options and custom gulp-imagemin options

//
.pipe(imagemin([
	imagemin.svgo({
		plugins: [
			{
				removeViewBox: true
			}
		]
	})
], {
	verbose: true
}))
//

API

Comes bundled with the following lossless optimizers:

These are bundled for convenience and most users will not need anything else.

imagemin(plugins?, options?)

Unsupported files are ignored.

plugins

Type: Array
Default: [imagemin.gifsicle(), imagemin.jpegtran(), imagemin.optipng(), imagemin.svgo()]

Plugins to use. This will overwrite the default plugins. Note that the default plugins comes with good defaults and should be sufficient in most cases. See the individual plugins for supported options.

options

Type: object

verbose

Type: boolean
Default: false

Enabling this will log info on every image passed to gulp-imagemin:

gulp-imagemin: ✔ image1.png (already optimized)
gulp-imagemin: ✔ image2.png (saved 91 B - 0.4%)
You can’t perform that action at this time.