{ "name": "grunt-zip-directories", "description": "Zip all top level directories in a folder.", "version": "1.0.1", "homepage": "https://github.com/RoyTinker/grunt-zip-directories", "author": { "name": "Roy Tinker", "email": "roytinker@gmail.com" }, "repository": { "type": "git", "url": "git://github.com/RoyTinker/grunt-zip-directories.git" }, "bugs": { "url": "https://github.com/RoyTinker/grunt-zip-directories/issues" }, "licenses": [ { "type": "MIT", "url": "https://github.com/RoyTinker/grunt-zip-directories/blob/master/LICENSE-MIT" } ], "engines": { "node": ">= 4.0.0" }, "scripts": { "test": "grunt test" }, "devDependencies": { "grunt-contrib-jshint": "^1.1.0", "grunt-contrib-clean": "^1.1.0", "grunt-contrib-nodeunit": "^1.0.0", "grunt": "^1.0.0" }, "peerDependencies": { "grunt": "^1.0.0" }, "keywords": [ "gruntplugin" ], "dependencies": { "archiver": "^2.0.3", "async": "^2.5.0" }, "main": "Gruntfile.js", "directories": { "test": "test" }, "license": "MIT", "readme": "# grunt-zip-directories\n\n> Zip all top level directories in a folder.\n\n## Getting Started\nThis plugin requires Grunt `^1.0.0`\n\nIf you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:\n\n```shell\nnpm install grunt-zip-directories --save-dev\n```\n\nOnce the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:\n\n```js\ngrunt.loadNpmTasks('grunt-zip-directories');\n```\n\n## The \"zip_directories\" task\n\n### Overview\nIn your project's Gruntfile, add a section named `zip_directories` to the data object passed into `grunt.initConfig()`.\n\n```js\ngrunt.initConfig({\n zip_directories: {\n your_target: {\n // Target-specific file lists and/or options go here.\n },\n },\n});\n```\n\n### Options\n\n*No Options*\n\n### Usage Examples\n\nIn 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.\n\n```js\ngrunt.initConfig({\n zip_directories: {\n\tirep: {\n files: [{\n filter: 'isDirectory',\n expand: true,\n cwd: './irep',\n src: ['*'],\n dest: './irep'\n }]\n }\n },\n});\n```\n\n## Contributing\nIn 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](http://gruntjs.com/).\n\n## Release History\n_(Nothing yet)_\n", "readmeFilename": "README.md" }