grunt-zip

Zip and unzip files via a grunt plugin

Getting Started

Install this grunt plugin next to your project's grunt.js gruntfile with: npm install grunt-zip

Then add this line to your project's grunt.js gruntfile:

grunt.loadNpmTasks('grunt-zip');

Documentation

grunt-zip introduces two grunt tasks: zip and unzip.

zip

grunt.initConfig({
  zip: {
    // We accept short syntax
    // 'destinationZip': ['firstFileToZip', 'secondFileToZip', ...]
    'acme.zip': ['index.html', 'rocket.js'],

    // As well as standard grunt sytax
    widgets: {
      // Files to zip together
      src: ['corkscrew.js', 'sillyStraw.js'],

      // Destination of zip file
      dest: 'widgets.zip'
    },

    // Specify working directory to zip from via `cwd`
    'more-widgets': {
      cwd: 'nested/'
      // Files will zip to 'corkscrew.js' and 'sillyStraw.js'
      src: ['nested/corkscrew.js', 'nested/sillyStraw.js'],
      dest: 'moreWidgets.zip'
    },

    // Adjust file paths via `router` for complex cases
    site: {
      // `router` receives the path from grunt (e.g. js/main.js)
      // The path it returns is what the file contents are saved as (e.g. all/main.js)
      // This CANNOT be used with `cwd` since there are potential ordering issues.
      router: function (filepath) {
        // Route each file to all/{{filename}}
        var filename = path.basename(filepath);
        return 'all/' + filename;
      }

      // Files will zip to 'main.js' and 'main.css'
      src: ['js/main.js', 'css/main.css'],
      dest: 'site.zip'
    },

    // If you want to use the 'DEFLATE' compression algorithm, encode data in base64, or include dotfiles, you must opt-in to it
    'even-more-widgets': {
      src: ['corkscrew.js', 'sillyStraw.js'],
      dest: 'evenMoreWidgets.zip',

      // Setting for DEFLATE compression
      compression: 'DEFLATE',

      // Setting for base64 encoding
      base64: true,

      // Setting to include dotfiles (e.g. .travis.yml)
      dot: true
    },

    // Skip/exclude files via `router`
    zipJsOnly: {
      // If router returns a falsy varaible, the file will be skipped
      router: function (filepath) {
        // Grab the extension
        var extname = path.extname(filepath);

        // If the file is a .js, add it to the zip
        if (extname === '.js') {
          return filepath;
        } else {
        // Otherwise, skip it
          return null;
        }
      }

      src: ['js/main.js', 'css/main.css'],
      dest: 'jsOnly.zip'
    }
  }
});

unzip

grunt.initConfig({
  'unzip': {
    // Short syntax
    // 'folderToExtractFilesTo': 'zipFileToExtract'
    gallery: 'photos.zip',

    // Long syntax
    catalog: {
      src: 'electronics.zip',
      dest: 'catalog'
    }

    // Note: If you provide multiple src files, they will all be extracted to the same folder.
    // This is not well-tested behavior so use at your own risk.

    // Adjust file paths of zipped files via `router`
    site: {
      // `router` receives the path that was used during zipping (e.g. css/bootstrap.css)
      // The path it returns is where the file contents will be written to (e.g. dist/bootstrap.css)
      router: function (filepath) {
        // Route each file to dist/{{filename}}
        var filename = path.basename(filepath);
        return 'dist/' + filename;
      }

      // Collects all nested files in same directory
      // css/bootstrap.css -> bootstrap.css, js/bootstrap.js -> bootstrap.js
      src: 'bootstrap.zip',
      dest: 'bootstrap/'
    },

    // If you want to disable the CRC32 check or decode data from base64, you must opt-in to it
    'unzip-more': {
      src: 'bootstrap.zip',
      dest: 'public',

      // Setting for disabling the CRC32 check
      checkCRC32: false,

      // Setting for decoding from base64
      base64: true
    },

    // Skip/exclude files via `router`
    unzipCssOnly: {
      // If router returns a falsy varaible, the file will be skipped
      router: function (filepath) {
        // Grab the extension
        var extname = path.extname(filepath);

        // If the file is a .css, extract it
        if (extname === '.css') {
          return filepath;
        } else {
        // Otherwise, skip it
          return null;
        }
      }

      src: ['bootstrap.css'],
      dest: 'bootstrap-css/'
    }


  }
});

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 your code using grunt and test via npm test.

Donating

Support this project and others by twolfson via gittip.

License

Copyright (c) 2013 Todd Wolfson Licensed under the MIT license.