grunt-rsync

A Grunt multitask for accessing the file copying and syncing capabilities of the rsync command line utility. Uses the rsyncwrapper npm module for the core functionality.

Release notes

• >= 0.5.0 Updated to rsyncwrapper 0.3.0.
• >= 0.4.0 Updated to rsyncwrapper 0.2.0.
• >= 0.3.0 Updated to rsyncwrapper 0.1.0. Some changes under the hood there, so a minor version bump seems appropriate. src values that include wildcards should now be properly expanded by the shell.
• >= 0.2.0 Updated task to properly use the config options object
• >= 0.1.0 Grunt 0.4 compatibility
• <= 0.0.5 Initial releases, Grunt 0.3 compatible

If you're upgrading to Grunt v0.4 you shouldn't need to make any changes to your existing grunt-rsync task config, just be sure to npm install the latest version. But be sure to place an issue if you have any problems.

Prerequisites

A reasonably modern version of rsync (>=v2.6.9) in your PATH.

Installation

$ npm install grunt-rsync

Usage

Add a rsync object to your Grunt config and grunt.loadNpmTasks("grunt-rsync").

All options defined in the config are passed verbatim to rsyncwrapper, so check that project's readme for more details on the possible options.

For example, the following task config defines three targets. The dist target could be used to create a distribution of a website ready for deployment, excluding files related to Git and uncompiled SCSS. The stage and prod targets could be used to copy the distribution to the relevant remote hosts over ssh.

(Note: grunt-rsync now uses the normalised target/task-level options as described in here.)

rsync: {
    options: {
        args: ["--verbose"],
        exclude: [".git*","*.scss","node_modules"],
        recursive: true
    },
    dist: {
        options: {
            src: "./",
            dest: "../dist"
        }
    },
    stage: {
        options: {
            src: "../dist/",
            dest: "/var/www/site",
            host: "user@staging-host",
            syncDestIgnoreExcl: true
        }
    },
    prod: {
        options: {
            src: "../dist/",
            dest: "/var/www/site",
            host: "user@live-host",
            syncDestIgnoreExcl: true
        }
    }
}

Wildcards, exclude patterns, globbing etc.

Any wildcards expansions and/or exclude patterns and globbing of paths are handled either by the shell or rsync itself. So importantly this task does not use Grunt's in-built path expanding and globbing.

For more information on rsync's syntax check the rsync manpages.

For information about how this task's options relate to rsync's functionality check rsyncwrapper.

Testing

Basic tests are run on Vows Async BDD via this package's Gruntfile. To test grunt-rsync clone the repo and install the devDependancies:

$ npm install --dev
$ npm test