# @neutrinojs/image-minify

> Neutrino middleware for optimizing images with imagemin

Latest version **8.3.0** (published 2018-06-27) · MPL-2.0 license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install @neutrinojs/image-minify
pnpm add @neutrinojs/image-minify
yarn add @neutrinojs/image-minify
bun add @neutrinojs/image-minify
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 8.3.0 |
| Published | 2018-06-27 |
| First published | 2017-12-07 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | ^6.9.0 \|\| ^8 \|\| >=9 |
| Dependencies | 8 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3903 |
| Author | Tim Kelty |
| Maintainers | edmorley, eliperelman, helfi92, timkelty |
| Keywords | neutrino, neutrino-middleware, image, imagemin |

## Links

- npm: https://www.npmjs.com/package/@neutrinojs/image-minify
- Repository: https://github.com/mozilla-neutrino/neutrino-dev/tree/master/packages/image-minify
- Homepage: https://neutrinojs.org/
- Issues: https://github.com/mozilla-neutrino/neutrino-dev/issues
- npm.io page: https://npm.io/package/@neutrinojs/image-minify

## Dependencies (8)

- [webpack](https://npm.io/package/webpack.md) ^3.12.0
- [deepmerge](https://npm.io/package/deepmerge.md) ^1.5.2
- [imagemin-svgo](https://npm.io/package/imagemin-svgo.md) ^6.0.0
- [imagemin-webp](https://npm.io/package/imagemin-webp.md) ^4.1.0
- [imagemin-mozjpeg](https://npm.io/package/imagemin-mozjpeg.md) ^6.0.0
- [imagemin-webpack](https://npm.io/package/imagemin-webpack.md) ^1.1.2
- [imagemin-gifsicle](https://npm.io/package/imagemin-gifsicle.md) 5.2.0
- [imagemin-pngquant](https://npm.io/package/imagemin-pngquant.md) ^5.1.0

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 8.3.0 (latest) — 2018-06-27
- 8.2.3 — 2018-04-26
- 8.2.2 — 2018-04-09
- 8.2.1 — 2018-03-26
- 8.2.0 — 2018-03-23
- 8.1.2 — 2018-02-26
- 8.1.1 — 2018-01-30
- 8.1.0 — 2018-01-29
- 8.0.18 — 2018-01-15
- 8.0.17 — 2018-01-14
- 8.0.16 — 2018-01-09
- 8.0.15 — 2018-01-08
- 8.0.14 — 2017-12-21
- 8.0.13 — 2017-12-14
- 8.0.12 — 2017-12-13
- … 23 more at https://npm.io/package/@neutrinojs/image-minify/versions

## README

# Neutrino Image Minify Middleware

`@neutrinojs/image-minify` is Neutrino middleware for optimizing images with imagemin.

[![NPM version][npm-image]][npm-url]
[![NPM downloads][npm-downloads]][npm-url]
[![Join the Neutrino community on Spectrum][spectrum-image]][spectrum-url]

## Requirements

- Node.js v6 LTS, v8, v9
- Yarn v1.2.1+, or npm v5.4+
- Neutrino v8

## Installation

`@neutrinojs/image-minify` can be installed via the Yarn or npm clients.

#### Yarn

```bash
❯ yarn add @neutrinojs/image-minify
```

#### npm

```bash
❯ npm install --save @neutrinojs/image-minify
```

## Usage

`@neutrinojs/image-minify` can be consumed from the Neutrino API, middleware, or presets. Require this package
and plug it into Neutrino:

```js
// Using function middleware format
const images = require('@neutrinojs/image-loader');
const imagemin = require('@neutrinojs/image-minify');

// Use with default options
neutrino.use(images);
neutrino.use(imagemin);

// Usage showing default options
neutrino.use(imagemin, {
  imagemin: {
    plugins: [
      gifsicle(),
      svgo(),
      pngquant(),
      mozjpeg(),
      webp()
    ]
  },
  plugin: {
    name: '[path][name].[ext]',
    test: /\.(png|jpg|jpeg|gif|webp)$/
  },
  useId: 'imagemin',
  rules: ['svg', 'img'],
  pluginId: 'imagemin',
});
```

```js
// Using object or array middleware format

// Use with default options
module.exports = {
  use: ['@neutrinojs/image-minify']
};

// Usage showing default options
module.exports = {
  use: [
    ['@neutrinojs/image-minify', {
      imagemin: {},
      plugin: {
        name: '[path][name].[ext]',
        test: /\.(png|jpg|jpeg|gif|webp)$/
      },
      rules: ['svg', 'img'],
      pluginId: 'imagemin'
    }]
  ]
};
```

- `imagemin`: Set options for [imagemin](https://github.com/imagemin/imagemin#options).
- `plugin`: Set options for [imagemin-webpack](https://github.com/itgalaxy/imagemin-webpack#standalone-plugin)'s ImageminWebpackPlugin.
- `rules`: Specify rules for the application of imagemin.
- `pluginId`: The imagemin plugin identifier. Override this to add an additional imagemin plugin instance.

## Customization

`@neutrinojs/image-minify` creates some conventions to make overriding the configuration easier once you are
ready to make changes.

### Rules

The following is a list of rules and their identifiers which can be overridden:

| Name | Description | Environments and Commands |
| --- | --- | --- |
| `img` | Optimize JPEG, PNG, GIF, and WEBP files imported from modules. Contains a single loader named `imagemin`. | all |
| `svg` | Optimize SVG files imported from modules. Contains a single loader named `imagemin`. | all |

### Plugins

The following is a list of plugins and their identifiers which can be overridden:

| Name | Description | Environments and Commands |
| --- | --- | --- |
| `imagemin` | Optimize any images added by other webpack plugins (e.g. `copy-webpack-plugin`). | all |

## Contributing

This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets and middleware. Follow the
[contributing guide](https://neutrinojs.org/contributing/) for details.

[npm-image]: https://img.shields.io/npm/v/@neutrinojs/image-minify.svg
[npm-downloads]: https://img.shields.io/npm/dt/@neutrinojs/image-minify.svg
[npm-url]: https://npmjs.org/package/@neutrinojs/image-minify
[spectrum-image]: https://withspectrum.github.io/badge/badge.svg
[spectrum-url]: https://spectrum.chat/neutrino

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