Skip to content

Latest commit

 

History

History
77 lines (60 loc) · 1.81 KB

README.md

File metadata and controls

77 lines (60 loc) · 1.81 KB
Raw

grunt-untar

A grunt task to decompress/extract tar files, implemented with streams.

The "untar" task

Overview

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

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

Options

options.mode

Type: String Default value: ''

The decompression mode. Currently supports tar and tgz. Automatically detected per dest:src pair, but can be overridden per target if desired.

Usage Examples

Default Options

In this example, the default options are used to decompress the passed tgz archive.

grunt.initConfig({
  untar: {
    files: {
      'dest/default_options': 'src/testing.tgz',
    },
  },
});

Custom Options

In this example, the mode option is used to inform the task that the tar must be unzipped before the extraction, as this cannot be deduced from the extension.

grunt.initConfig({
  untar: {
    options: {
      mode: 'tgz'
    },
    files: {
      'dest/with_mode': 'test/fixtures/fixtures.tgz.dummyext'
    }
  },
});

Getting Started

This plugin requires Grunt ~0.4.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-untar --save-dev

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

grunt.loadNpmTasks('grunt-untar');