grp

gulp-replace-path

A string replace plugin for gulp that supports injecting the files path

Showing:

Popularity

Downloads/wk

1.9K

GitHub Stars

3

Maintenance

Last Commit

7yrs ago

Contributors

6

Package

Dependencies

3

Size (min+gzip)

4.0KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

gulp-replace-path NPM version Build status

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

TODO:

  • Fix tests
  • Fix documentation
  • Implement dynamic injection

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('somePath/', __absolutePath__));
    }))
    .pipe(gulp.dest('build/file.txt'));
});

In some target file you may set some variable based on the files current location

function pathifyThis() {
  return {
    templateUrl: '{./}/template.html'
  }
}

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial