gulp-findreplace

Gulp plugin to find and replace stuff.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
gulp-findreplace
301.5.06 years ago6 years agoMinified + gzip package size for gulp-findreplace in KB

Readme

A gulp plugin that streamingly replaces matching strings with provided replacement string ⚡️

Usage

First, install gulp-findreplace as a development dependency:
npm install --save-dev gulp-findreplace

Then, add it to your gulpfile.js:

Regex Replace

var freplace = require('gulp-findreplace');

gulp.task('replaceIt', function(){
  gulp.src(['example.txt'])
    .pipe(freplace(/foo(.{3})/g, 'foo'))
    .pipe(gulp.dest('build/example.txt'));
});

String Replace

var freplace = require('gulp-findreplace');

gulp.task('replaceIt', function(){
  gulp.src(['example.txt'])
    .pipe(freplace('love', 'code'))
    .pipe(gulp.dest('build/example.txt'));
});
You can also refer to an example provided in ./examples directory.

API

gulp-findreplace works with streams and even if it encounter a file as a buffer it converts it to a stream then operates with provided string or regex.

freplace(stringQuery, replacement)

stringQuery

Type: String
The string to search for.

replacement

Type: String
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.

freplace(regex, replacement)

regex

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

replacement

Type: String