Breaking: Rename relative option to relativeSymlinks (closes #251)

Author: phated

lib/dest/options.js

@@ -38,7 +38,7 @@ var config = {
     type: 'boolean',
     default: isWindows,
   },
-  relative: {
+  relativeSymlinks: {
     type: 'boolean',
     default: false,
   },

lib/dest/write-contents/write-symbolic-link.js

@@ -22,7 +22,7 @@ function writeSymbolicLink(file, optResolver, onWritten) {
 
   var symDirType =  useJunctions ? 'junction' : 'dir';
   var symType = isDirectory ? symDirType : 'file';
-  var isRelative = optResolver.resolve('relative', file);
+  var isRelative = optResolver.resolve('relativeSymlinks', file);
 
   // This is done after prepare() to use the adjusted file.base property
   if (isRelative && symType !== 'junction') {

lib/symlink/link-file.js

@@ -26,7 +26,7 @@ function linkStream(optResolver) {
 
     var symDirType =  useJunctions ? 'junction' : 'dir';
     var symType = isDirectory ? symDirType : 'file';
-    var isRelative = optResolver.resolve('relative', file);
+    var isRelative = optResolver.resolve('relativeSymlinks', file);
 
     // This is done after prepare() to use the adjusted file.base property
     if (isRelative && symType !== 'junction') {

lib/symlink/options.js

@@ -9,7 +9,7 @@ var config = {
     type: 'boolean',
     default: isWindows,
   },
-  relative: {
+  relativeSymlinks: {
     type: 'boolean',
     default: false,
   },

test/dest-symlinks.js

@@ -78,7 +78,7 @@ describe('.dest() with symlinks', function() {
 
     pipe([
       from.obj([file]),
-      vfs.dest(outputBase, { relative: true }),
+      vfs.dest(outputBase, { relativeSymlinks: true }),
       concat(assert),
     ], done);
   });
@@ -265,12 +265,12 @@ describe('.dest() with symlinks', function() {
 
     pipe([
       from.obj([file]),
-      vfs.dest(outputBase, { relative: true }),
+      vfs.dest(outputBase, { relativeSymlinks: true }),
       concat(assert),
     ], done);
   });
 
-  it('(windows) relative option is ignored when junctions are used', function(done) {
+  it('(windows) relativeSymlinks option is ignored when junctions are used', function(done) {
     if (!isWindows) {
       this.skip();
       return;
@@ -302,12 +302,12 @@ describe('.dest() with symlinks', function() {
 
     pipe([
       from.obj([file]),
-      vfs.dest(outputBase, { useJunctions: true, relative: true }),
+      vfs.dest(outputBase, { useJunctions: true, relativeSymlinks: true }),
       concat(assert),
     ], done);
   });
 
-  it('(windows) supports relative option when link is not for a directory', function(done) {
+  it('(windows) supports relativeSymlinks option when link is not for a directory', function(done) {
     if (!isWindows) {
       this.skip();
       return;
@@ -332,7 +332,7 @@ describe('.dest() with symlinks', function() {
     pipe([
       from.obj([file]),
       // The useJunctions option is ignored when file is not a directory
-      vfs.dest(outputBase, { useJunctions: true, relative: true }),
+      vfs.dest(outputBase, { useJunctions: true, relativeSymlinks: true }),
       concat(assert),
     ], done);
   });
@@ -371,7 +371,7 @@ describe('.dest() with symlinks', function() {
 
     pipe([
       from.obj([file]),
-      vfs.dest(outputBase, { useJunctions: false, relative: true }),
+      vfs.dest(outputBase, { useJunctions: false, relativeSymlinks: true }),
       concat(assert),
     ], done);
   });

test/symlink.js

@@ -200,7 +200,7 @@ describe('symlink stream', function() {
 
     pipe([
       from.obj([file]),
-      vfs.symlink(outputBase, { relative: true }),
+      vfs.symlink(outputBase, { relativeSymlinks: true }),
       concat(assert),
     ], done);
   });
@@ -417,12 +417,12 @@ describe('symlink stream', function() {
 
     pipe([
       from.obj([file]),
-      vfs.symlink(outputBase, { relative: true }),
+      vfs.symlink(outputBase, { relativeSymlinks: true }),
       concat(assert),
     ], done);
   });
 
-  it('(windows) relative option is ignored when junctions are used', function(done) {
+  it('(windows) relativeSymlinks option is ignored when junctions are used', function(done) {
     if (!isWindows) {
       this.skip();
       return;
@@ -455,12 +455,12 @@ describe('symlink stream', function() {
 
     pipe([
       from.obj([file]),
-      vfs.symlink(outputBase, { useJunctions: true, relative: true }),
+      vfs.symlink(outputBase, { useJunctions: true, relativeSymlinks: true }),
       concat(assert),
     ], done);
   });
 
-  it('(windows) supports relative option when link is not for a directory', function(done) {
+  it('(windows) supports relativeSymlinks option when link is not for a directory', function(done) {
     if (!isWindows) {
       this.skip();
       return;
@@ -485,7 +485,7 @@ describe('symlink stream', function() {
     pipe([
       from.obj([file]),
       // The useJunctions option is ignored when file is not a directory
-      vfs.symlink(outputBase, { useJunctions: true, relative: true }),
+      vfs.symlink(outputBase, { useJunctions: true, relativeSymlinks: true }),
       concat(assert),
     ], done);
   });
@@ -522,7 +522,7 @@ describe('symlink stream', function() {
 
     pipe([
       from.obj([file]),
-      vfs.symlink(outputBase, { useJunctions: false, relative: true }),
+      vfs.symlink(outputBase, { useJunctions: false, relativeSymlinks: true }),
       concat(assert),
     ], done);
   });