node package manager
Painless code sharing. npm Orgs help your team discover, share, and reuse code. Create a free org »

assemble-middleware-decompress

assemble-middleware-decompress NPM version

Assemble plugin for extracting zip, tar and tar.gz archives.

Upgrade notice! v0.2.0 or greater of this plugin depend on Assemble v0.5.0. This plugin will not work with Assemble v0.4.0!

Install

Install with npm:

npm i assemble-middleware-decompress --save

Next, add the plugin to the Assemble options:

options: {
  plugins: ['assemble-middleware-decompress', 'other/plugins/*.js']
}

Visit the plugins docs 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

assemble: {
  options: {
    plugins: ['assemble-contrib-download', 'assemble-middleware-decompress'],
    download: {
      repo: 'assemble/handlebars-helpers',
      files: ['docs/helpers.zip'],
      dest: 'tmp/'
    }
    decompress: {
      files: ['tmp/helpers.zip'],
      dest: 'docs/helpers/'
    }
  }
}

Other Assemble plugins

Here are some related projects you might be interested in from the Assemble core team.

Visit assemble.io/plugins for more information about Assemble plugins.

Contributing

Find a bug? Have a feature request? Please create an Issue.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality, and run docs in the command line to build the docs with Verb.

Pull requests are also encouraged, and if you find this project useful please consider "starring" it to show your support! Thanks!

Author

Jon Schlinkert

License

Copyright (c) 2014 Jon Schlinkert, contributors.
Released under the MIT license


This file was generated by grunt-verb on May 01, 2014.