A string replace plugin for gulp
JavaScript HTML
Latest commit 65b5deb Apr 4, 2016 @lazd Merge pull request #66 from oleggromov/tests-refactoring
Tests refactoring

README.md

gulp-replace NPM version Build status

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'));
});

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.

gulp-replace options

An optional third argument, options, can be passed.

options

Type: Object

options.skipBinary

Type: boolean
Default: false

Skip binary files