/gulp-replace

A string replace plugin for gulp

Primary LanguageJavaScriptMIT LicenseMIT

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:

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

API

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

replace(string, replacement)

string

Type: String

The string to search for.

replacement

Type: String

The replacement string.

replace(regex, replace)

Note: gulp-replace cannot perform regex replacement on streams.

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.