node package manager

grunt-hardlink

grunt-hardlink v0.2.0

Create hard links.

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-hardlink --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-hardlink');

Hardlink task

Run this task with the grunt hardlink command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide. Pay special attention to the Building the files object dynamically section, which explains how to create many src-dest file mappings all at once.

Usage Examples

hardlink: {
  // Enable overwrite to delete hardlinks before recreating them 
  options: {
    overwrite: false
  },
  // The "build/target.txt" hardlink will be created and linked to 
  // "source/target.txt". 
  explicit: {
    src: 'source/target.txt',
    dest: 'build/target.txt'
  },
  // These examples using "expand" to generate src-dest file mappings: 
  // http://gruntjs.com/configuring-tasks#building-the-files-object-dynamically 
  expanded: {
    files: [
      // All child files in "source", starting with "foo-" will be hardlinked 
      // into the "build" directory, with the leading "source" stripped off. 
      // Note that it is not generally possible to hardlink directories, so 
      // using "isFile" filter is often a necessary measure to avoid this kind 
      // of error. 
      {
        expand: true,
        overwrite: false,
        cwd: 'source',
        src: ['foo-*'],
        dest: 'build',
        filter: 'isFile',
      },
      // All files inside "bar" and its sub-directories, recursively, will be 
      // hardlinked into an identical hierarchy under the "tmp" directory. 
      {
        expand: true,
        src: 'bar/**',
        dest: 'tmp',
        filter: 'isFile',
      }
    ]
  },
}

CLI overwrite option

To override the overwrite option via the CLI pass it as an option

  grunt hardlink --overwrite

Usage tips on Microsoft Windows

Make sure your command prompt has administrative privileges, otherwise the task will not work.

Release History

  • 2015-03-01   v0.2.0   Change name from "grunt-contrib-hardlink" to "grunt-hardlink". Change author references from "Grunt Team" to "Bruno Félix Rezende Ribeiro". Add "Bruno Félix Rezende Ribeiro" as a copyright holder.
  • 2015-03-01   v0.1.0   Unofficial release.

Task submitted by Bruno Félix Rezende Ribeiro

This file was generated on Sun Mar 01 2015 17:28:04.