gulp-replace-string

Replaces strings in files by using string or regex patterns.

You'll actually want to instead use @yodasws/gulp-pattern-replace (npm). It provides extra flexability and smaller dependency tree.

Forked this off gulp-string-replace because I wanted to be able to pass all the arguments/options in a single options object argument.

Installation

yarn

1yarn add --dev gulp-replace-string

npm

1npm install --save-dev gulp-replace-string

Usage

Regex Replace

1var replace = require('gulp-replace-string');
2
3gulp.task('replace_1', () => {
4  gulp.src(["./config.js"])
5    .pipe(replace(new RegExp('@env@', 'g'), 'production'))
6    .pipe(gulp.dest('./build/config.js'))
7});
8
9gulp.task('replace_2', () => {
10  gulp.src(["./index.html"])
11    .pipe(replace(/version(={1})/g, '$1v0.2.2'))
12    .pipe(gulp.dest('./build/index.html'))
13});
14
15gulp.task('replace_3', () => {
16  gulp.src(["./config.js"])
17    .pipe(replace(/foo/g, () => 'bar'))
18    .pipe(gulp.dest('./build/config.js'))
19});

String Replace

1gulp.task('replace_1', () => {
2  gulp.src(["./config.js"])
3    .pipe(replace('@env@', 'production'))
4    .pipe(gulp.dest('./build/config.js'))
5});

Function Replace

1gulp.task('replace_1', () => {
2  gulp.src(["./config.js"])
3    .pipe(replace('@env@', () => {
4        return argv.env === 'dev' ? 'dev' : 'production';
5    }))
6    .pipe(gulp.dest('./build/config.js'))
7});
8
9gulp.task('replace_2', () => {
10  gulp.src(["./config.js"])
11    .pipe(replace('environment', (pattern) => {
12        return pattern + '_mocked';
13    }))
14    .pipe(gulp.dest('./build/config.js'))
15});

Example with options object

1var options = {
2  pattern: /@env@/g
3  replacement: 'dev',
4  logs: {
5    enabled: false
6  }
7};
8
9gulp.task('replace_1', () => {
10  gulp.src(["./config.js"])
11    .pipe(replace(options)
12    .pipe(gulp.dest('./build/config.js'))
13});

An Array

1gulp.task('lint-js', () => {
2  gulp.src(["./config.js"])
3    .pipe(replace([/(if|for|switch|while)\(/g, '$1 (')
4    .pipe(gulp.dest('./build/config.js'));
5});

API

replace(options)

options

Type: Object

options.pattern

Type: String or RegExp

The string to search for.

options.replacement

Type: String or Function

The replacement string or function. Called once for each match. Function has access to regex outcome (all arguments are passed).

More details here: [MDN documentation for RegExp] and [MDN documentation for String.replace].

options.logs

Type: Boolean or Object

Output logs.

true is the same as:

1logs: {
2  enabled: true,
3  notReplaced: false,
4}

options.logs.enabled

Type: Boolean, Default: true

Output logs.

options.logs.notReplaced

Type: Boolean, Default: false

Output "not replaced" logs.

replace(pattern, replacement, options)

pattern

Type: String or RegExp

The string to search for.

replacement

Type: String or Function

The replacement string or function. Called once for each match. Function has access to regex outcome (all arguments are passed).

options

Type: Object

Same as above, but without properties pattern or replacement