sync two directories by copying or creating hardlink
npm install sync-directory2sync-directory can sync files from src directory to target directory.
We have two ways to sync files: hardlink and copy.
If type is copy, sync-directory will copy files from src directory to target directory.
If type is hardlink, sync-directory can create hardlink files in target directory from src directory.
Apparently, the type hardlink is quicker than type copy, and sync-directory uses hardlink by default.
``bash`
npm i sync-directory -g
`bash`
syncdir
Example: syncdir aaa bbb -w
options:
+ -w, --watch
Watch changes. false as default.watch
Same as api .
+ --quiet
Disable unnecessary logs.
+ -do, --deleteOrphaned
Delete orphaned files/folders in target folder. false as default.
Same as api deleteOrphaned.
+ -c, --copy
Sync with type copy, hardlink as default.
Same as api type: 'copy'.
+ -symlink, --symlink
support symlink while sync running. false as default.
Same as api supportSymlink.
`js`
require('sync-directory')(srcDir, targetDir[, config]);
+ parames
name | description | type | values | default
---- | ---- | ---- | ---- | ----
srcDir | src directory | String | absolute path | -targetDir
| target directory | String | absolute path | -config.watch
| watch files change | Boolean | - | falseconfig.type
| way to sync files | String | 'copy' / 'hardlink' | 'hardlink'
| Decide if you want to delete other files in targetDir when srcDir files are removed | Boolean | - | trueconfig.afterSync
| callback function when files synced | Function | - | blank functionconfig.supportSymlink
| ensure symlink in target if src has symlinks | Boolean | - | falseconfig.exclude
| files that should not sync to target directory. | RegExp / String / Array (item is RegExp / String) | - | nullconfig.forceSync
| some files must be synced even though 'excluded' | Function | - | (file) => { return false }
| callback function to filter synced files. Sync file when returning true | Function | - | filepath => true
| callback function when something wrong | Function | - | (err) => { throw new Error(err) }
+ return
`js`
const watcher = require('sync-directory')(A, B);
watcher is undefined.
`js`
const watcher = require('sync-directory')(A, B, {
watch: true
});
watcher is a chokidar watcher.
+ watch
`js`
require('sync-directory')(srcDir, targetDir, {
watch: true
});
+ afterSync
`js`
require('sync-directory')(srcDir, targetDir, {
afterSync({ type, relativePath }) {
// type: add / change / unlink / unlinkDir
// relativePath: relative file path
}
});
+ type
copy
`js`
require('sync-directory')(srcDir, targetDir, {
type: 'copy'
});
hardlink (default)
`js`
require('sync-directory')(srcDir, targetDir);
+ exclude
exclude node_modules
+ String
`js`
require('sync-directory')(srcDir, targetDir, {
exclude: 'node_modules'
});
+ RegExp
`js`
require('sync-directory')(srcDir, targetDir, {
exclude: /node\_modules/
});
+ Array
`js`
require('sync-directory')(srcDir, targetDir, {
exclude: [/node\_modules/]
});
`js`
require('sync-directory')(srcDir, targetDir, {
exclude: ['node_modules']
});
+ forceSync
`js`
require('sync-directory')(srcDir, targetDir, {
exclude: 'node_modules',
forceSync(file) {
// all files in "node_modules" will be synced event though "exclude" is configed
return /node_modules/.test(file);
}
});
+ supportSymlink
`js
// srcFolder:
// a/ a is symlink
// 1.js
// targetFolder:
// a/ a is not symlink
// 1.js
require('sync-directory')(srcDir, targetDir, {
supportSymlink: false,
});
`
`js
// srcFolder:
// a/ a is symlink
// 1.js
// targetFolder:
// a/ a is the same symlink
// 1.js
require('sync-directory')(srcDir, targetDir, {
supportSymlink: true,
});
``