README

grunt-zip-directories

Zip all top level directories in a folder.

Getting Started

This plugin requires Grunt ^1.0.0

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-zip-directories --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-zip-directories');

The "zip_directories" task

Overview

In your project's Gruntfile, add a section named zip_directories to the data object passed into grunt.initConfig().

grunt.initConfig({
  zip_directories: {
    your_target: {
      // Target-specific file lists and/or options go here.
    },
  },
});

Options

No Options

Usage Examples

In this example, we find all top level folders in the irep directory, they will then be zipped including all files inside to irep/zips, the name of the zip will be the name of the original folder.

grunt.initConfig({
  zip_directories: {
    irep: {
      files: [{
        filter: 'isDirectory',
        expand: true,
        cwd: './irep',
        src: ['*'],
        dest: './irep'
      }]
    }
  },
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

(Nothing yet)

Usage no npm install needed!