# gulp-imageisux

**Repository Path**: astros001/gulp-imageisux

## Basic Information

- **Project Name**: gulp-imageisux
- **Description**: 智图gulp插件
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2018-09-07
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

#gulp-imageisux

[![NPM](https://nodei.co/npm/gulp-imageisux.png)](https://nodei.co/npm/gulp-imageisux/)

[智图](http://zhitu.isux.us/)的gulp插件

##Introduce
这是智图的gulp插件，它能自动压缩图片，并生成对应的webp格式(可选)。
你只需要声明`src(path)`图片源地址，并执行方法`pipe(imageisux())`就好了。

##Install
当然，你需要先安装[gulp](http://gulpjs.com/)。

```js
$ npm install --global gulp
```

然后安装插件。

```js
//全局安装
$ npm install --global gulp-imageisux

//局部安装
$ npm install --save-dev gulp-imageisux
```

##Usage
1、声明图片地址，例如放在img目录下面`gulp.src(['img/*'])`。
2、指定参数，压缩图片导出目录`/dest/`和是否同时导出webp格式。

```js
var imageisux = require('gulp-imageisux');

gulp.task('imageisux', function() {
	return gulp.src(['img/*'])
			   .pipe(imageisux('/dirpath/',true));
});
```

##API
两个参数，`dirpath`目标目录以及`enableWebp`是否同时导出对应WEBP格式图片。

 - `dirpath`: 如果未定义，会自动生成两个目录：'/dest/'目录放压缩后图片，'/webp/'目录放对应的webp格式压缩图片。

 - `enableWebp`  : 若为`true`，则会同时输出webp图片；若为`false`，则只会有压缩后原格式图片。