Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

gulp-imagemin

5.0.3 • Public • Published

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.


🦄 Support my open-source work by buying this awesome video course:
Learn to build apps and APIs with Node.js by Wes Bos
Try his free JavaScript 30 course for a taste of what to expect & check out his ES6, React, Sublime courses.


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%)

License

MIT © Sindre Sorhus

install

npm i gulp-imagemin

Downloadsweekly downloads

8,479

version

5.0.3

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability