# @wandiparis/gulp-images

> Gulp task that optimize images weight

Latest version **1.0.2** (published 2019-01-22) · ISC license · 0 weekly downloads

## Install

```sh
npm install @wandiparis/gulp-images
pnpm add @wandiparis/gulp-images
yarn add @wandiparis/gulp-images
bun add @wandiparis/gulp-images
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-01-22 |
| First published | 2017-04-05 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | drazik, laurent-bientz |

## Links

- npm: https://www.npmjs.com/package/@wandiparis/gulp-images
- Repository: https://github.com/WandiParis/gulp-tasks/tree/master/packages/gulp-images
- Homepage: https://github.com/WandiParis/gulp-tasks/tree/master/packages/gulp-images#readme
- Issues: https://github.com/WandiParis/gulp-tasks/issues
- npm.io page: https://npm.io/package/@wandiparis/gulp-images

## Dependencies (5)

- [gulp](https://npm.io/package/gulp.md) 4.0
- [gulp-newer](https://npm.io/package/gulp-newer.md) ^1.2.0
- [gulp-imagemin](https://npm.io/package/gulp-imagemin.md) ^3.0.2
- [imagemin-mozjpeg](https://npm.io/package/imagemin-mozjpeg.md) ^6.0.0
- [imagemin-pngquant](https://npm.io/package/imagemin-pngquant.md) ^5.0.0

## Recent versions

- 1.0.2 (latest) — 2019-01-22
- 1.0.1 — 2017-07-05
- 1.0.0 — 2017-04-05

## README

# gulp-images

Gulp task that optimizes images

[![npm version](https://badge.fury.io/js/%40wandiparis%2Fgulp-images.svg)](https://badge.fury.io/js/%40wandiparis%2Fgulp-images)

## Installation

```
npm install --save-dev @wandiparis/gulp-images
```

## Usage

Use with default parameters :

```js
// gulpfile.js

const images = require("@wandiparis/gulp-images");

const compile = images();

module.exports = {
    compile
};
```

Use with custom parameters (see below for the full list) :

```js
// gulpfile.js

const images = require("@wandiparis/gulp-images");

const compile = images({
    src: "path/to/img/**/*.{jpg,png}",
    dest: "path/to/dest"
});

module.exports = {
    compile
};
```

## Parameters

### src

See [`gulp.src` `globs` parameter](https://github.com/gulpjs/gulp/blob/4.0/docs/API.md#globs).

Default value : `'assets/img/**/*.{jpg,png,gif,svg}'`

### dest

See [`gulp.dest` `path` parameter](https://github.com/gulpjs/gulp/blob/4.0/docs/API.md#path).

Default value : `'web/img'`

### jpg

See [imagemin-mozjpeg options](https://github.com/imagemin/imagemin-mozjpeg#options)

Default value :

```js
{
    quality: 95
}
```

### png

See [imagemin-pngquant options](https://github.com/imagemin/imagemin-mozjpeg#options)

Default value : `{}`

### gif

See [imagemin-gifsicle options](https://github.com/imagemin/imagemin-gifsicle#options)

Default value : `{}`

### svg

See [imagemin-svgo options](https://github.com/imagemin/imagemin-svgo#options)

Default value :

```js
{
    plugins: [
        { removeViewBox: true }
    ]
}
```

---
_Source: https://npm.io/package/@wandiparis/gulp-images · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._