tsync
v1.2.0
Published
Sync a glob of files through a unix pipeline to a destination directory.
Downloads
6
Maintainers
Readme
tsync
Sync a glob of files through a unix pipeline to a destination directory.
Why
So you can transform and sync files gulp-style, but at the process level via the universal interface.
How
Consider the following directory tree:
$ tree
.
└── src
└── a.txt "a"
1 directory, 1 file
Using tsync
we can sync the files in the src
directory into a new directory dest
that doesn't yet exist, transforming them along the way with sed:
$ tsync 'src/*' 'sed s/a/b/' dest
Gives:
$ tree
.
├── src
│ └── a.txt "a"
└── dest
└── a.txt "b"
2 directories, 2 files
Note
In the example above only one pipeline gets created as there is only one file to sync - a unique pipeline is required for each file being synced however, and all pipelines execute concurrently. You can use the
-c
flag if you need to limit the number of concurrent pipelines.
Install
$ npm install tsync [-g]
Test
$ npm test
Note: Currently the tests will probably only run in unix-like environments since they require the external dependencies bash
and diff
.
Use
$ tsync [OPTION] 'src-glob' transform [..] ['otherTransform --option'] dest
[OPTION]
-x --extension extension
Change file extensions to extension before writing todest
.-c --concurrency concurrency
The maximum number of concurrent pipelines. Defaults toInfinity
.
'src-glob'
The pattern to use when globbing files. Be careful to quote your pattern as your shell may perform expansion before tsync
gets invoked!
transform
A transform program. The transform should be a stream-friendly program that reads from stdin, and writes to stdout. You must specify at least one transform. If you don't need to transform anything, use cp -R
or rsync -au
to sync files.
[..] ['otherTransform --option']
You can pass as many transforms as you like, tsync
will pipe them together for you. If you need to pass options to a transform make sure to quote the full command string.
dest
The destination directory transformed files will be synced to.
Releases
The latest stable release is published to npm. Tarballs for each release can be found here.
License
Copyright © 2014 Jesse Tane [email protected]
This work is free. You can redistribute it and/or modify it under the terms of the WTFPL.
No Warranty. The Software is provided "as is" without warranty of any kind, either express or implied, including without limitation any implied warranties of condition, uninterrupted use, merchantability, fitness for a particular purpose, or non-infringement.