rsyncjs

Description

rsyncjs provides a similar API to rsync, but in pure js.

With some additional features, such as splitting large files and quota throttling support.

Todo: Convert to TS 4.5 and export ESM

Based on sync-directory by @gh:hoperyy

Releases

• (CodeSandbox official sandbox)[https://codesandbox.io/s/rsyncjs-rwr9t]
• (Git repo, issues and PR's)[https://gitlab.com/vblip/rsyncjs]
• (NPM rsyncjs)[https://www.npmjs.com/package/rsyncjs]
• (UnPKG)[https://unpkg.com/rsyncjs@latest/]

Examples

Node

import { async as rsync } from 'rsyncjs'

const sleep = (s) => new Promise((p) => setTimeout(p, s * 1000))

console.time('rsync')

const main = async () => {
  await rsync(srcDir, targetDir, {
    async afterEachSync({ type, relativePath }) {
      console.log(type, relativePath)
      await sleep(1.5) // delay 1.5s after one file was synced
    }
  })
  console.timeEnd('rsync')
}
main()

Shell

# yarn add global rsyncjs
# npx -y rsyncjs <from> <to> [options]
npm install -g rsyncjs
rsyncjs <from> <to> [options]

Synchronous use via deasync

var rsyncjsCJS = require('rsyncjs')
var deasync = require('deasync')
var rsync = deasync(rsyncjsCJS.async)

Browser use with FileSystem API

Not tested... but willing to support it.

API

import	Returns	Syntax	Blocks thread?
async	Promise	async / await, promises	No

Params

name	description	type	values	default
srcDir	src directory	String	absolute path	-
targetDir	target directory	String	absolute path	-
config.deleteOrphaned	Delete other files in targetDir	Boolean	-	true
config.afterEachSync	callback function when every file synced	Function	-	blank function
config.exclude	files that should not sync to target directory.	RegExp / String / Array (item is RegExp / String)	-	null
config.forceSync	some files must be synced even though 'excluded'	Function	-	(file) => { return false }
config.filter	function to filter. Syncs file when true	Function	-	filepath => true
config.onError	callback function when something wrong	Function	-	(err) => { throw new Error(err) }

• afterEachSync

  await rsync(srcDir, targetDir, {
    async afterEachSync({ type, relativePath }) {
      // type: init:hardlink / init:copy / add / change / unlink / unlinkDir
      // - init type: "init:copy"
      // - watch type: "add" / "change" / "unlink" / "unlinkDir"
      // relativePath: relative file path
    }
  })

• type

  • copy

    rsync(srcDir, targetDir, {
      type: 'copy'
    })

• exclude

  exclude node_modules

  • String

    rsync(srcDir, targetDir, {
      exclude: 'node_modules'
    })

  • RegExp

    rsync(srcDir, targetDir, {
      exclude: /node\_modules/
    })

  • Array

    rsync(srcDir, targetDir, {
      exclude: [/node\_modules/]
    })

    rsync(srcDir, targetDir, {
      exclude: ['node_modules']
    })

• forceSync

  rsync(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)
    }
  })

Cli

options:

• --quiet

  Disable unnecessary logs.

• -do, --deleteOrphaned

  Delete orphaned files/folders in target folder. false as default.

  Same as api deleteOrphaned.

Contributing

• Keep dependencies to a minimum, devDependencies are less of an issue.
• Make sure your tests pass on the latest official Node LTS image
  • This is what CodeSandbox runs