JSPM

gulp-replace-path

0.4.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 411
  • Score
    100M100P100Q100488F
  • License MIT

A string replace plugin for gulp

Package Exports

  • gulp-replace-path

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-replace-path) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gulp-replace-path NPM version Build status

A string replace plugin for gulp 3 that supports injecting file path.

Usage

First, install gulp-replace-path as a development dependency:

npm install --save-dev gulp-replace-path

Then, add it to your gulpfile.js:

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

gulp.task('templates', function(){
  gulp.src(['file.txt'])
    .pipe(replace(/foo(.{3})/g, '$1foo'))
    .pipe(replace('{./}', function (match, __absolutePath__) {
      return path.dirname(path.relative(paths.src, __absolutePath__));
    }))
    .pipe(gulp.dest('build/file.txt'));
});

API

gulp-replace-path 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.

replace(regex, replacement[, options])

Note: gulp-replace-path 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.

gulp-replace-path options

An optional third argument, options, can be passed.

options

Type: Object

options.skipBinary

Type: boolean
Default: false

Skip binary files