A string replace plugin for gulp
npm install gulp-replace-fixFirst, install gulp-replace as a development dependency:
``shell`
npm install --save-dev gulp-replace
Then, add it to your gulpfile.js:
javascript
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'));
});
`
$3
`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'));
});
`$3
`javascript
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.
$3
#### string
Type:
StringThe string to search for.
#### replacement
Type:
String or FunctionThe 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.$3
#### regex
Type:
RegExpThe regex pattern to search for. See the [MDN documentation for RegExp] for details.
#### replacement
Type:
String or FunctionThe 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.$3
An optional third argument,
options, can be passed.#### options
Type:
Object##### options.skipBinary
Type:
boolean
Default: falseSkip 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
[travis-url]: http://travis-ci.org/lazd/gulp-replace
[travis-image]: https://secure.travis-ci.org/lazd/gulp-replace.svg?branch=master
[npm-url]: https://npmjs.org/package/gulp-replace
[npm-image]: https://badge.fury.io/js/gulp-replace.svg