https://github.com/tecfu/grunt-tar-passthru
Pass-through interface for linux tar commands in Grunt.
https://github.com/tecfu/grunt-tar-passthru
Last synced: 11 months ago
JSON representation
Pass-through interface for linux tar commands in Grunt.
- Host: GitHub
- URL: https://github.com/tecfu/grunt-tar-passthru
- Owner: tecfu
- License: mit
- Created: 2014-08-27T07:00:25.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2016-03-07T15:41:20.000Z (over 10 years ago)
- Last Synced: 2025-03-31T09:47:17.369Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://www.npmjs.org/package/grunt-tar-passthru
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-tar-passthru
- Pass-through interface for tar commands in Grunt.
- Requires tar already installed and accessible from terminal.
- Syntactically similar to entering a tar command in the terminal. Each
array value in a job essentially represents a single command line parameter.
- You can do anything with this that you can do with tar.
## Getting Started
This plugin requires Grunt `~0.4.5`
If 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:
```shell
npm install grunt-tar-passthru --save-dev
```
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
```js
grunt.loadNpmTasks('grunt-tar-passthru');
```
## The "tar_passthru" task
### Overview
In your project's Gruntfile, add a section named `tar_passthru` to the data object passed into `grunt.initConfig()`.
```js
grunt.initConfig({
tar_passthru: {
}
});
```
### Options
Here you can add string properties that you can reference using: <%= tar_passthru.options.xxxxxx %>.
### Jobs
An array of jobs you wish to tar.
### Usage Example
```js
grunt.initConfig({
tar_passthru: {
options : {
cwd : (function(){
return process.cwd()
}())
,timestamp : (function(){
//A FORMATTED TIMESTAMP STRING FOR BACKUP NAMING
var d = new Date(),dstr = '';
return ('0' + (d.getMonth()+1)).slice(-2)
+ '.' + ('0' + d.getDate()).slice(-2)
+ '.' + d.getFullYear()
+ '.' + ('0' + d.getHours()).slice(-2)
+ '' + ('0' + d.getMinutes()).slice(-2);
}())
}
,jobs : [
//this example translates to:
//tar -zcvf /path/to/archive.01.01.2001.1234.tar.gz -P /path/to/somedir --directory=/path/to/somedir --exclude=someotherdirname
[
//z:gzip, c:create archive, v:verbose,
//f:next argument is name of archive file
"-zcvf"
//archive path
,"/path/to/archive.<%= tar_passthru.options.timestamp %>.tar.gz"
//allow absolute path
,"-P"
//Files or Directories to tar
,[
'/path/to/somedir'
]
//Sets present working directory, makes sure archive
//top level is same as target[s]
,"--directory=/path/to/somedir"
//Excludes directory from archive
,"--exclude=someotherdirname"
]
]
}
});
```