# gulp-unzip

> gulp plugin for unzip

Latest version **1.1.0** (published 2019-06-01) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install gulp-unzip
pnpm add gulp-unzip
yarn add gulp-unzip
bun add gulp-unzip
```

## 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.1.0 |
| Published | 2019-06-01 |
| First published | 2014-03-18 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 588.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | terrierscript |
| Maintainers | inuscript, suisho, terrierscript |
| Keywords | gulpplugin, unzip, zip, package |

## Links

- npm: https://www.npmjs.com/package/gulp-unzip
- Repository: https://github.com/terrierscript/gulp-unzip
- Homepage: https://github.com/terrierscript/gulp-unzip#readme
- Issues: https://github.com/terrierscript/gulp-unzip/issues
- npm.io page: https://npm.io/package/gulp-unzip

## Dependencies (3)

- [vinyl](https://npm.io/package/vinyl.md) 2.2.0
- [unzipper](https://npm.io/package/unzipper.md) 0.9.15
- [vinyl-buffer](https://npm.io/package/vinyl-buffer.md) 1.0.1

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 1.1.0 (latest) — 2019-06-01
- 1.0.1 — 2019-01-28
- 1.0.0 — 2018-01-13
- 0.2.0 — 2016-11-24
- 0.1.4 — 2016-04-11
- 0.1.3 — 2015-02-10
- 0.1.2 — 2014-09-09
- 0.1.1 — 2014-03-20
- 0.1.0 — 2014-03-18
- 0.0.0 — 2014-03-18

## README

[![travis](https://travis-ci.org/terrierscript/gulp-unzip.svg)](https://travis-ci.org/terrierscript/gulp-unzip)
![dependencies](https://img.shields.io/david/terrierscript/gulp-unzip.svg)
![devDependencies](https://img.shields.io/david/dev/terrierscript/gulp-unzip.svg)
![Downloads per Week NPM](https://img.shields.io/npm/dw/gulp-unzip.svg)
![Open PRs](https://img.shields.io/github/issues-pr/terrierscript/gulp-unzip.svg)
![Open Issues](https://img.shields.io/github/issues-raw/terrierscript/gulp-unzip.svg)


# gulp-unzip
> gulp plugin for unzip file.

### Usage

```bash
npm install gulp-unzip --save
```

```js
var unzip = require('gulp-unzip')
gulp.task('filter_sample', function(){
  gulp.src("./download/bootstrap-3.1.1-dist.zip")
    .pipe(unzip())
    .pipe(gulp.dest('./tmp'))
})
```

### Options

#### filter

You can provide a `filter` option. It should be a function that gets an `entry` as an argument and returns `true` or `false`.

```js
var concat = require('gulp-concat')
var unzip = require('gulp-unzip')
var minimatch = require('minimatch')
gulp.task('filter_sample', function(){
  gulp.src("./download/bootstrap-3.1.1-dist.zip")
    .pipe(unzip({
      filter : function(entry){
        return minimatch(entry.path, "**/*.min.css")
      }
    }))
    .pipe(concat("bootstrap.css"))
    .pipe(gulp.dest('./tmp'))
})
```

#### keepEmpty

You can provide `true` or `false` in `keepEmpty` for whether you want to extract empty files from the archive or not. Defaults to `false`.

```js
gulp.task('filter_sample', function(){
  gulp.src("./download/bootstrap-3.1.1-dist.zip")
    .pipe(unzip({ keepEmpty : true }))
    //...
})
```

### Contributors

If you want to contribute to the project, please check de [Contribution Guidelines](CONTRIBUTING.md)

**Author**
- [terrierscript (@terrierscript)](https://github.com/terrierscript)

**Maintainers**
- [Ulises Gascón (@ulisesGascon)](https://github.com/ulisesGascon)

**Contributors**
- [Joey Cozza (@joeycozza)](https://github.com/joeycozza)
- [Joe Pettersson (@Joe8Bit)](https://github.com/Joe8Bit)
- [Erik Vold (@erikvold)](https://github.com/erikvold)
- [hami (@hami-jp)](https://github.com/hami-jp)
- [Selwyn (@Selwyn)](https://github.com/Siilwyn)
- [João Moreno (@joaomoreno)](https://github.com/joaomoreno)
- [Evan Oxfeld (@EvanOxfeld)](https://github.com/EvanOxfeld)

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