Yeoman generator mixin method for generating symbolic links.

README.md

Your generator could mixin the symLink() method like so:

'use strict';

var generators      = require( 'yeoman-generator' )
,   _               = require( 'lodash' )
;

var MyGenerator = generators.Base.extend(
    {
       ...
    }
;

_.extend(
    MyGenerator.prototype
,   require( './generator-symlink.js' )
);

module.exports = MyGenerator;

generator-symlink.js

'use strict';

var fsCore  = require( 'fs' )
,   path    = require( 'path' )
;

module.exports =
    {
        /**
         *  Make a symbolic link within `#destinationRoot()`.
         *
         *  @method     _symLink
         *
         *  @param      {String}        src         The path relative to `#destinationRoot()` that should become the target of the symbolic link.
         *  @param      {String}        dst         The path relative to `#destinationRoot()` that should become the symbolic link.
         *
         */

        _symLink: function ( src, dst )
        {
            src = this.destinationPath( src );
            dst = this.destinationPath( dst );

            this.conflicter.checkForCollision(

                dst
            ,   this.fs.read( src )
            ,   function ( err, status ) {

                    if ( 'identical' === status ) return;

                    //  The symlink may exist, but may link to a nonexistent file in which case `status` will be `'create'`, so try unlinking it anyway.
                    //
                    try
                    {
                        fsCore.unlinkSync( dst );
                    }
                    catch ( error )
                    {
                        if ( 'ENOENT' !== error.code  ) throw error;
                    }

                    fsCore.symlinkSync( path.relative( path.dirname( dst ), src ), dst );
                }
            );
        }
    }
;

Created for yeoman/generator#547