grunt-contrib-compress v1.1.0
Compress files and folders
Getting Started
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-contrib-compress --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt.loadNpmTasks('grunt-contrib-compress');
This plugin was designed to work with Grunt >= 0.4.x. If you're still using grunt v0.3.x it's strongly recommended that you upgrade, but in case you can't please use v0.3.2.
Compress task
Run this task with the grunt compress
command.
Task targets, files and options may be specified according to the grunt Configuring tasks guide.
Node Libraries Used:
archiver (for zip/tar)
zlib (for gzip).
Options
archive
Type: String
or Function
Modes: zip
tar
This is used to define where to output the archive. Each target can only have one output file.
If the type is a Function it must return a String.
This option is only appropriate for many-files-to-one compression modes like zip and tar. For gzip for example, please use grunt's standard src/dest specifications.
mode
Type: String
This is used to define which mode to use, currently supports gzip
, deflate
, deflateRaw
, tar
, tgz
(tar gzip) and zip
.
Automatically detected per dest:src
pair, but can be overridden per target if desired.
level
Type: Integer
Modes: zip
gzip
Default: 1
Sets the level of archive compression.
pretty
Type: Boolean
Default: false
Pretty print file sizes when logging.
File Data
The following additional keys may be passed as part of a dest:src pair when using an Archiver-backed format.
All keys can be defined as a Function
that receives the file name and returns in the type specified below.
date
Type: Date
Modes: zip
tar
tgz
Sets the file date.
mode
Type: Integer
Modes: zip
tar
tgz
Sets the file permissions.
store
Type: Boolean
Default: false
If true, file contents will be archived without compression.
Type: String
Modes: zip
Sets the file comment.
gid
Type: Integer
Modes: tar
tgz
Sets the group of the file in the archive
uid
Type: Integer
Modes: tar
tgz
Sets the user of the file in the archive
Usage Examples
compress: {
main: {
options: {
archive: 'archive.zip'
},
files: [
{src: ['path/*'], dest: 'internal_folder/', filter: 'isFile'},
{src: ['path/**'], dest: 'internal_folder2/'},
{expand: true, cwd: 'path/', src: ['**'], dest: 'internal_folder3/'},
{flatten: true, src: ['path/**'], dest: 'internal_folder4/', filter: 'isFile'}
]
}
}
compress: {
main: {
options: {
mode: 'gzip'
},
expand: true,
cwd: 'assets/',
src: ['**/*'],
dest: 'public/'
}
}
compress: {
main: {
options: {
archive: 'archive.zip'
},
files: [
{expand: true, cwd: 'path/', src: ['the_file'], dest: '/'}
]
}
},
compress: {
main: {
options: {
mode: 'gzip'
},
files: [
{expand: true, src: ['src/*.js'], dest: 'dist/', ext: '.gz.js'}
]
}
}
compress: {
main: {
options: {
archive: function () {
return git.tag + '.zip'
}
},
files: [
{expand: true, src: ['src/*.js'], dest: 'dist/'}
]
}
}
Release History
- 2016-03-04 v1.1.0 Add ability to replace file in the same location.
- 2016-02-15 v1.0.0 Update archiver, chalk and pretty-bytes.
- 2015-10-23 v0.14.0 change to verbose output dependency updates Archiver 0.16
- 2014-12-25 v0.13.0 Update archiver to v0.13 small fixes
- 2014-09-23 v0.12.0 Output update. Prevent zipping dot files and allow for forcing through fail.warn within loop.
- 2014-08-26 v0.11.0 Update archiver to v0.11.0
- 2014-07-14 v0.10.0 Don't apply extensions automatically (use
ext
or rename
). - 2014-05-20 v0.9.1 allow directories to pass-through to archiver via filter
- 2014-05-20 v0.9.0 Update archiver to v0.9.0
- 2014-04-09 v0.8.0 Update archiver to v0.8.0
- 2014-02-17 v0.7.0 Update archiver to v0.6.0
- 2014-01-12 v0.6.0 Update archiver to v0.5.0
- 2013-11-27 v0.5.3 Allow archive option to be a function.
- 2013-06-03 v0.5.2 Allow custom extensions using the ext property.
- 2013-05-28 v0.5.1 Avoid gzip on folders.
- 2013-04-23 v0.5.0 Add support for deflate and deflateRaw.
- 2013-04-15 v0.4.10 Fix issue where task finished before all data was compressed.
- 2013-04-09 v0.4.9 Bump Archiver version.
- 2013-04-07 v0.4.8 Open streams lazily to avoid too many open files.
- 2013-04-01 v0.4.7 Pipe gzip to fix gzip issues. Add tests that undo compressed files to test.
- 2013-03-25 v0.4.6 Fix node v0.8 compatibility issue with gzip.
- 2013-03-20 v0.4.5 Update to archiver 0.4.1 Fix issue with gzip failing intermittently.
- 2013-03-19 v0.4.4 Fixes for Node.js v0.10. Explicitly call grunt.file methods with map and filter.
- 2013-03-14 v0.4.3 Fix for gzip; continue iteration on returning early.
- 2013-03-13 v0.4.2 Refactor task like other contrib tasks. Fix gzip of multiple files. Remove unused dependencies.
- 2013-02-22 v0.4.1 Pretty print compressed sizes. Logging each addition to a compressed file now only happens in verbose mode.
- 2013-02-15 v0.4.0 First official release for Grunt 0.4.0.
- 2013-01-23 v0.4.0rc7 Updating grunt/gruntplugin dependencies to rc7. Changing in-development grunt/gruntplugin dependency versions from tilde version ranges to specific versions.
- 2013-01-14 v0.4.0rc5 Updating to work with grunt v0.4.0rc5. Conversion to grunt v0.4 conventions. Replace basePath with cwd.
- 2012-10-12 v0.3.2 Rename grunt-contrib-lib dep to grunt-lib-contrib.
- 2012-10-09 v0.3.1 Replace zipstream package with archiver.
- 2012-09-24 v0.3.0 General cleanup. Options no longer accepted from global config key.
- 2012-09-18 v0.2.2 Test refactoring. No valid source check. Automatic mode detection.
- 2012-09-10 v0.2.0 Refactored from grunt-contrib into individual repo.
Task submitted by Chris Talkington
This file was generated on Fri Mar 04 2016 17:02:42.