https://github.com/assemble/grunt-assemble-decompress
Assemble plugin for extracting zip, tar and tar.gz archives.
https://github.com/assemble/grunt-assemble-decompress
Last synced: about 1 year ago
JSON representation
Assemble plugin for extracting zip, tar and tar.gz archives.
- Host: GitHub
- URL: https://github.com/assemble/grunt-assemble-decompress
- Owner: assemble
- License: mit
- Created: 2013-11-28T17:49:30.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2015-09-25T13:17:45.000Z (over 10 years ago)
- Last Synced: 2025-04-02T16:03:32.416Z (about 1 year ago)
- Language: JavaScript
- Size: 199 KB
- Stars: 3
- Watchers: 10
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grunt-assemble-decompress [](http://badge.fury.io/js/grunt-assemble-decompress)
> Assemble plugin for extracting zip, tar and tar.gz archives.
```sh
$ npm i grunt-assemble-decompress --save
```
Next, add the plugin to the Assemble options:
```js
assemble: {
options: {
plugins: ['grunt-assemble-decompress', 'other/plugins/*.js']
}
}
```
Visit the [plugins docs](http://assemble.io/plugins/) for more info about plugins or for help getting started.
## Options
## files
Type: `String`
Default: `undefined`
Path the file or files to decompress.
## dest
Type: `String`
Default: `undefined`
Destination for the decompressed files.
## Examples
```js
assemble: {
options: {
plugins: ['grunt-assemble-download', 'grunt-assemble-decompress'],
download: {
repo: 'assemble/handlebars-helpers',
files: ['docs/helpers.zip'],
dest: 'tmp/'
}
decompress: {
files: ['tmp/helpers.zip'],
dest: 'docs/helpers/'
}
}
}
```
## Other grunt-assemble plugins
* [grunt-assemble](https://www.npmjs.com/package/grunt-assemble): Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… [more](https://www.npmjs.com/package/grunt-assemble) | [homepage](http://assemble.io)
* [grunt-assemble-anchors](https://www.npmjs.com/package/grunt-assemble-anchors): Assemble plugin for creating anchor tags from headings in generated html using Cheerio.js. | [homepage](https://github.com/assemble/grunt-assemble-anchors)
* [grunt-assemble-contextual](https://www.npmjs.com/package/grunt-assemble-contextual): Generates a JSON file with the context of each page. Basic plugin to help see… [more](https://www.npmjs.com/package/grunt-assemble-contextual) | [homepage](https://github.com/assemble/grunt-assemble-contextual)
* [grunt-assemble-download](https://www.npmjs.com/package/grunt-assemble-download): Assemble plugin for downloading files from GitHub. | [homepage](https://github.com/assemble/grunt-assemble-download)
* [grunt-assemble-i18n](https://www.npmjs.com/package/grunt-assemble-i18n): Plugin for adding i18n support to Assemble projects. | [homepage](https://github.com/assemble/grunt-assemble-i18n)
* [grunt-assemble-lunr](https://www.npmjs.com/package/grunt-assemble-lunr): Assemble plugin for adding search capabilities to your static site, with lunr.js. | [homepage](http://assemble.io)
* [grunt-assemble-navigation](https://www.npmjs.com/package/grunt-assemble-navigation): Assemble navigation plugin. Automatically generate Bootstrap-style, multi-level side nav. See the sidenav on assemble.io for… [more](https://www.npmjs.com/package/grunt-assemble-navigation) | [homepage](https://github.com/assemble/grunt-assemble-navigation)
* [grunt-assemble-permalinks](https://www.npmjs.com/package/grunt-assemble-permalinks): Permalinks plugin for Assemble, the static site generator for Grunt.js, Yeoman and Node.js. This plugin… [more](https://www.npmjs.com/package/grunt-assemble-permalinks) | [homepage](https://github.com/assemble/grunt-assemble-permalinks)
* [grunt-assemble-sitemap](https://www.npmjs.com/package/grunt-assemble-sitemap): Sitemap plugin for Assemble | [homepage](http://assemble.io/plugins)
* [grunt-assemble-toc](https://www.npmjs.com/package/grunt-assemble-toc): Assemble middleware for adding a Table of Contents (TOC) to any HTML page. | [homepage](http://assemble.io)
* [grunt-assemble-wordcount](https://www.npmjs.com/package/grunt-assemble-wordcount): Assemble plugin for displaying wordcount and average reading time to blog posts or pages. | [homepage](https://github.com/assemble/grunt-assemble-wordcount)
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/assemble/grunt-assemble-decompress/issues/new).
## Author
**Jon Schlinkert**
+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
## License
Copyright © 2015 Jon Schlinkert
Released under the MIT license.
***
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on September 25, 2015._