gulp-replace

A string replace plugin for gulp 3

Usage

First, install gulp-replace as a development dependency:

npm install --save-dev gulp-replace

Then, add it to your gulpfile.js:

Regex Replace

var replace = require('gulp-replace');

gulp.task('templates', function(){
  gulp.src(['file.txt'])
    .pipe(replace(/foo(.{3})/g, '$1foo'))
    .pipe(gulp.dest('build/file.txt'));
});

Use FilePath

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

var replace = require('gulp-replace');

gulp.task('templates', function(){
  gulp.src(['file.txt'])
    .pipe(replace('bar', 'foo'))
    .pipe(gulp.dest('build/file.txt'));
});

API

gulp-replace can be called with a string or regex.

replace(string, replacement[, options])

string

Type: String

The string to search for.

replacement

Type: String or Function

The replacement string or function. If replacement is a function, it will be called once for each match and will be passed the string that is to be replaced.

replace(regex, replacement[, options])

regex

Type: RegExp

The regex pattern to search for. See the MDN documentation for RegExp for details.

replacement

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.

options

Type: Object

options.skipBinary

Type: boolean Default: false

Skip binary files

options.passFileName

Type: boolean Default: false

Passes full file path to the replacement function