Skip to content

Latest commit

 

History

History
123 lines (71 loc) · 2.98 KB

README.md

File metadata and controls

123 lines (71 loc) · 2.98 KB
Raw

About hook.io-tar

A hook to archive and unarchive with tar. Operates synchronously for now.

NOTE: Pull request making this asynchronous are very welcome as long as they work with huge (2+ gigabyte compressed) files.

Tar Icon

Build Status

Install

npm install -g hook.io-tar

Usage

./bin/hookio-tar

This starts a hook and reads the local config.json. The files listed there will be compressed or uncompressed. A sample is provided in examples/example-config.json. The config option is included for debugging and testing purposes, in general you will want to use messages and code.

Messages

tar::archive [in]

source: an array of source file names. Required. Those files will be archived.
target: the target file name. Required.

tar::unarchive [in]

source: the source file name. Required. This is the file that will be unarchived.
targetPath: The optional target path (-C tar option). Optional.

tar::error [out]

code: code
source:
target:

tar::archive-complete [out]

code: code
source:
target:

tar::unarchive-complete [out]

source : 
targetPath : The target file name.

Hook.io Schema support

The package config contains experimental hook.io schema definitions. The definition is also exported as hook. Signatures will be served from a signature server (more to come).

Coffeescript

Tar = require("hook.io-tar").Tar
hook = new Tar(name: 'tar')

Javascript

var Tar = require("hook.io-tar").Tar;
var hook = new Tar({ name: 'tar' });

Advertising :)

Check out

Follow us on Twitter at

  • @getscottyapp
  • @martin_sunset

and like us on Facebook please. Every mention is welcome and we follow back.

Trivia

Listened to lots of M.I.A. and Soundgarden while writing this.

Release Notes

0.0.3

  • Ah well. Nothing to report here

0.0.2

  • Minor cleanups, including coffee-script beautification

0.0.1

  • First version

Internal Stuff

  • npm run-script watch

Publish new version

  • Change version in package.json
  • git tag -a v0.0.3 -m 'version 0.0.3'
  • git push --tags
  • npm publish

Contributing to hook.io-tar

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
  • Fork the project
  • Start a feature/bugfix branch
  • Commit and push until you are happy with your contribution
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the package.json, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2011 Martin Wawrusch. See LICENSE for further details.