Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindresorhus/gulp-imagemin
Minify PNG, JPEG, GIF and SVG images
https://github.com/sindresorhus/gulp-imagemin
compress-images gulp-plugin imagemin javascript minify-images nodejs
Last synced: 7 days ago
JSON representation
Minify PNG, JPEG, GIF and SVG images
- Host: GitHub
- URL: https://github.com/sindresorhus/gulp-imagemin
- Owner: sindresorhus
- License: mit
- Created: 2013-12-30T17:53:03.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2024-05-05T20:14:24.000Z (6 months ago)
- Last Synced: 2024-05-22T21:32:31.595Z (6 months ago)
- Topics: compress-images, gulp-plugin, imagemin, javascript, minify-images, nodejs
- Language: JavaScript
- Homepage:
- Size: 214 KB
- Stars: 1,896
- Watchers: 30
- Forks: 158
- Open Issues: 22
-
Metadata Files:
- Readme: readme.md
- License: license
- Security: .github/security.md
Awesome Lists containing this project
- awesome-github-star - gulp-imagemin
README
# gulp-imagemin
> Minify PNG, JPEG, GIF and SVG images with [`imagemin`](https://github.com/imagemin/imagemin)
*Issues with the output should be reported on the [`imagemin` issue tracker](https://github.com/imagemin/imagemin/issues).*
## Install
```sh
npm install --save-dev gulp-imagemin
```
## Usage
### Basic
```js
import gulp from 'gulp';
import imagemin from 'gulp-imagemin';
export default () => (
gulp.src('src/images/*')
.pipe(imagemin())
.pipe(gulp.dest('dist/images'))
);
```
### Custom plugin options
```js
import imagemin, {gifsicle, mozjpeg, optipng, svgo} from 'gulp-imagemin';
// …
.pipe(imagemin([
gifsicle({interlaced: true}),
mozjpeg({quality: 75, progressive: true}),
optipng({optimizationLevel: 5}),
svgo({
plugins: [
{
name: 'removeViewBox',
active: true
},
{
name: 'cleanupIDs',
active: false
}
]
})
]))
// …
```
### Custom plugin options and custom `gulp-imagemin` options
```js
import imagemin, {svgo} from 'gulp-imagemin';
// …
.pipe(imagemin([
svgo({
plugins: [
{
name: 'removeViewBox',
active: true
}
]
})
], {
verbose: true
}))
// …
```
## API
Comes bundled with the following optimizers:
- [gifsicle](https://github.com/imagemin/imagemin-gifsicle) — *Compress GIF images, lossless*
- [mozjpeg](https://github.com/imagemin/imagemin-mozjpeg) — *Compress JPEG images, lossy*
- [optipng](https://github.com/imagemin/imagemin-optipng) — *Compress PNG images, lossless*
- [svgo](https://github.com/imagemin/imagemin-svgo) — *Compress SVG images, lossless*
These are bundled for convenience and most users will not need anything else.
### imagemin(plugins?, options?)
Unsupported files are ignored.
#### plugins
Type: `Array`\
Default: `[gifsicle(), mozjpeg(), optipng(), svgo()]`
[Plugins](https://www.npmjs.com/browse/keyword/imageminplugin) to use. This will completely overwrite all the default plugins. So, if you want to use custom plugins and you need some of defaults too, then you should pass default plugins as well. Note that the default plugins come 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%)
```
##### silent
Type: `boolean`\
Default: `false`
Don't log the number of images that have been minified.
You can also enable this from the command-line with the `--silent` flag if the option is not already specified.