Passes full file path to the replacement function

README.md

@@ -21,6 +21,19 @@ gulp.task('templates', function(){
     .pipe(gulp.dest('build/file.txt'));
 });
 ```
+### Use FilePath
+```javascript
+var replace = require('gulp-replace');
+
+gulp.task('templates', function(){
+  gulp.src(['file.txt'])
+    .pipe(replace(/foo(.{3})/g, function($0, str){
+		return str + 'foo' + this.filePath;
+	}, {passFileName: true}))
+    .pipe(gulp.dest('build/file.txt'));
+});
+```
+
 ### String Replace
 ```javascript
 var replace = require('gulp-replace');
@@ -61,6 +74,8 @@ Type: `String` or `Function`
 
 The replacement string or function. See the [MDN documentation for String.replace] for details.
 
+if `Function` and `options.passFileName` is true, then Function within the filePath is equal to the current file `file.path`.
+
 ### gulp-replace options
 
 An optional third argument, `options`, can be passed.
@@ -69,11 +84,17 @@ An optional third argument, `options`, can be passed.
 Type: `Object`
 
 ##### options.skipBinary
-Type: `boolean`  
+Type: `boolean`
 Default: `false`
 
 Skip binary files
 
+##### options.passFileName
+Type: `boolean`
+Default: `false`
+
+Passes full file path to the replacement function
+
 
 [MDN documentation for RegExp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp
 [MDN documentation for String.replace]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace#Specifying_a_string_as_a_parameter

index.js

@@ -5,73 +5,86 @@ var rs = require('replacestream');
 var istextorbinary = require('istextorbinary');
 
 module.exports = function(search, replacement, options) {
-  return new Transform({
-    objectMode: true,
-    transform: function(file, enc, callback) {
-      if (file.isNull()) {
-        return callback(null, file);
-      }
-
-      function doReplace() {
-        if (file.isStream()) {
-          file.contents = file.contents.pipe(rs(search, replacement));
-          return callback(null, file);
-        }
-
-        if (file.isBuffer()) {
-          if (search instanceof RegExp) {
-            file.contents = new Buffer(String(file.contents).replace(search, replacement));
-          }
-          else {
-            var chunks = String(file.contents).split(search);
-
-            var result;
-            if (typeof replacement === 'function') {
-              // Start with the first chunk already in the result
-              // Replacements will be added thereafter
-              // This is done to avoid checking the value of i in the loop
-              result = [ chunks[0] ];
-
-              // The replacement function should be called once for each match
-              for (var i = 1; i < chunks.length; i++) {
-                // Add the replacement value
-                result.push(replacement(search));
-
-                // Add the next chunk
-                result.push(chunks[i]);
-              }
-
-              result = result.join('');
-            }
-            else {
-              result = chunks.join(replacement);
-            }
-
-            file.contents = new Buffer(result);
-          }
-          return callback(null, file);
-        }
-
-        callback(null, file);
-      }
-
-      if (options && options.skipBinary) {
-        istextorbinary.isText(file.path, file.contents, function(err, result) {
-          if (err) {
-            return callback(err, file);
-          }
-
-          if (!result) {
-            callback(null, file);
-          } else {
-            doReplace();
-          }
-        });
-
-        return;
-      }
-
-      doReplace();
-    }
-  });
+	return new Transform({
+		objectMode: true,
+		transform: function(file, enc, callback) {
+			if (file.isNull()) {
+				return callback(null, file);
+			}
+
+			function doReplace() {
+				if (file.isStream()) {
+					file.contents = file.contents.pipe(rs(search, replacement));
+					return callback(null, file);
+				}
+
+				if (file.isBuffer()) {
+					if (search instanceof RegExp) {
+						file.contents = new Buffer(String(file.contents).replace(search, replacement));
+					}
+					else {
+						var chunks = String(file.contents).split(search);
+
+						var result;
+						if (typeof replacement === 'function') {
+							// Start with the first chunk already in the result
+							// Replacements will be added thereafter
+							// This is done to avoid checking the value of i in the loop
+							result = [ chunks[0] ];
+
+							// The replacement function should be called once for each match
+							for (var i = 1; i < chunks.length; i++) {
+								// Add the replacement value
+								result.push(replacement(search));
+
+								// Add the next chunk
+								result.push(chunks[i]);
+							}
+
+							result = result.join('');
+						}
+						else {
+							result = chunks.join(replacement);
+						}
+
+						file.contents = new Buffer(result);
+					}
+					return callback(null, file);
+				}
+
+				callback(null, file);
+			}
+
+			if (options) {
+				if (options.passFileName && typeof replacement === 'function') {
+					var userReplacement = replacement;
+					replacement = function () {
+						var context = {
+							filePath: file.path
+						};
+						userReplacement.apply(context, arguments);
+					};
+				}
+
+				if(options.skipBinary) {
+					istextorbinary.isText(file.path, file.contents, function(err, result) {
+						if (err) {
+							return callback(err, file);
+						}
+
+						if (!result) {
+							callback(null, file);
+						} else {
+							doReplace();
+						}
+					});
+
+					return;
+				}
+
+			}
+
+			doReplace();
+		}
+	});
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "gulp-replace",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "description": "A string replace plugin for gulp",
   "dependencies": {
     "istextorbinary": "1.0.2",