https://github.com/mrmlnc/syncy
:file_folder: One-way synchronization of directories with glob
https://github.com/mrmlnc/syncy
glob rsync synchronization
Last synced: 7 months ago
JSON representation
:file_folder: One-way synchronization of directories with glob
- Host: GitHub
- URL: https://github.com/mrmlnc/syncy
- Owner: mrmlnc
- License: mit
- Created: 2016-02-29T19:00:12.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-12-01T20:14:34.000Z (almost 6 years ago)
- Last Synced: 2025-03-17T18:21:48.201Z (7 months ago)
- Topics: glob, rsync, synchronization
- Language: TypeScript
- Homepage:
- Size: 110 KB
- Stars: 18
- Watchers: 5
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SyncY
> One-way synchronization of directories with [glob](https://github.com/isaacs/node-glob).
[](https://travis-ci.org/mrmlnc/syncy)
[](https://ci.appveyor.com/project/mrmlnc/syncy)
## :bulb: Highlights
* :rocket: Fast by using streams and Promises. Used [cp-file](https://github.com/sindresorhus/cp-file) and [rimraf](https://github.com/isaacs/rimraf).
* :beginner: User-friendly by accepting globs.
## Donate
If you want to thank me, or promote your Issue.
[](https://paypal.me/mrmlnc)
> Sorry, but I have work and support for packages requires some time after work. I will be glad of your support and PR's.
## Install
```
$ npm install --save syncy
```
## Usage
```js
const syncy = require('syncy');
syncy(['src/**', '!src/folder/**'], 'dest')
.then(() => {
console.log('Done!');
})
.catch(console.error);
```
## API
```
syncy(patterns, dest, [options])
```
#### patterns
* Type: `string|string[]`
Glob patterns that represent files to copy
#### dest
* Type: `string|string[]`
Destination directory or directories.
#### options
* Type: `object`
```js
{
// Display log messages when copying and removing files
verbose: false,
// Or create your own function.
verbose: (stamp) {
// action - `copy` or `remove`
// to - only for `copy` action
console.log(stamp.action + ' | ' + stamp.from + ' | ' + stamp.to);
},
// The base path to be removed from the path. Default: none
base: 'base_path'
// Remove all files from dest that are not found in src. Default: true
updateAndDelete: true,
// Never remove js files from destination. Default: false
ignoreInDest: ['**/*.js']
}
```
## How to work with Gulp?
```js
const gulp = require('gulp');
const syncy = require('syncy');
gulp.task('sync', (done) => {
syncy(['node_modules/gulp/**'], 'dest')
.then(() => {
done();
})
.catch((err) => {
done(err);
});
});
```
## How to work with Grunt?
```js
const syncy = require('syncy');
module.exports = (grunt) => {
// Default task(s).
grunt.registerTask('default', function() {
const done = this.async();
syncy(['node_modules/grunt/**'], 'dest')
.then(() => {
done();
})
.catch((err) => {
done(err);
});
});
};
```
## Tests
**Tech specs**:
* Intel Core i7-3610QM
* RAM 8GB
* SSD (555MB/S, 530MB/S)
* Windows 10
* Node.js v6.4.0
**Files**: [AngularJS](https://github.com/angular/angular.js/releases/tag/v1.6.0-rc.1) from release v1.6.0-rc.1.
**Note**: `UpdateAndDelete` option is enabled in the grunt-sync, because other plugins have this option initially.
| Description of tests | syncy | gulp-directory-sync | grunt-sync |
|------------------------------------------------------|-------|---------------------|------------|
| First run | 3,7s | 9,1s | 10,1s |
| Re-run | 0,7s | 1,0s | 0,8s |
| Delete single file from dest directory | 0,7s | 0,9s | 0,8s |
## Changelog
See the [Releases section of our GitHub project](https://github.com/mrmlnc/syncy/releases) for changelogs for each release version.
## License
This software is released under the terms of the MIT license.