gulp-replace
    Overview
    Documentation
    Insights
    Code
    Contributors
    Dependencies
    Alternatives

gulp-replace

A string replace plugin for gulp

1.0.0  •  Published 1 years ago  •  by Larry Davis  •  MIT License

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:

Simple string replace

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

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

Simple regex replace

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

gulp.task('templates', function(){
  gulp.src(['file.txt'])
    // See http://mdn.io/string.replace#Specifying_a_string_as_a_parameter
    .pipe(replace(/foo(.{3})/g, '$1foo'))
    .pipe(gulp.dest('build/'));
});

String replace with function callback

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

gulp.task('templates', function(){
  gulp.src(['file.txt'])
    .pipe(replace('foo', function(match) {
      // Replaces instances of "foo" with "oof"
      return match.reverse();
    }))
    .pipe(gulp.dest('build/'));
});

Regex replace with function callback

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

gulp.task('templates', function(){
  gulp.src(['file.txt'])
    .pipe(replace(/foo(.{3})/g, function(match, p1, offset, string) {
      // Replace foobaz with barbaz and log a ton of information
      // See http://mdn.io/string.replace#Specifying_a_function_as_a_parameter
      console.log('Found ' + match + ' with param ' + p1 + ' at ' + offset + ' inside of ' + string);
      return 'bar' + p1;
    }))
    .pipe(gulp.dest('build/'));
});

Function callback with file object

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

gulp.task('templates', function(){
  gulp.src(['file.txt'])
    .pipe(replace('filename', function() {
      // Replaces instances of "filename" with "file.txt"
      // this.file is also available for regex replace
      // See https://github.com/gulpjs/vinyl#instance-properties for details on available properties
      return this.file.relative;
    }))
    .pipe(gulp.dest('build/'));
});

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.

The value of this.file will be equal to the vinyl instance for the file being processed.

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 on special replacement string patterns and arguments to the replacement function.

The value of this.file will be equal to the vinyl instance for the file being processed.

gulp-replace options

An optional third argument, options, can be passed.

options

Type: Object

options.skipBinary

Type: boolean
Default: true

Skip binary files. This option is true by default. If you want to replace content in binary files, you must explicitly set it to false

We are hiring frontend and backend developers!
Come and help us build the ultimate open source directory 🔥

Popularity

Weekly Downloads
186.9K
Stars
444

Maintenance

Development

Last ver 1 year ago
Created 6 years ago
Last commit 10 months ago
23 days between commits

Technology

Node version: 9.6.1
8.3K unpacked

Legal and Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

16 contributors
Larry Davis
Maintainer, 48 commits, 17 merges
Works at Adobe Systems, Inc
Gromych
11 commits, 2 PRs
Works at toptal
Shinnosuke Watanabe
5 commits, 3 PRs
Jeroen Wellner
3 commits, 1 PRs
Works at Wellner Consultancy
jolyonruss
2 commits, 1 PRs
hemanth.hm
1 commits, 1 PRs
Works at paypal

Tags

gulpplugin
replace
© 2019 Devstore, Inc.
Devstore helps developers find and use open-source packages, so they can focus on building amazing things