# gulp-replace-path

> A string replace plugin for gulp

Latest version **0.4.0** (published 2014-11-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-replace-path
pnpm add gulp-replace-path
yarn add gulp-replace-path
bun add gulp-replace-path
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2014-11-03 |
| First published | 2014-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Maintainers | kennethlynne |
| Keywords | gulpplugin, replace |

## Links

- npm: https://www.npmjs.com/package/gulp-replace-path
- Repository: https://github.com/kennethlynne/gulp-replace-path
- Issues: https://github.com/kennethlynne/gulp-replace-path/issues
- npm.io page: https://npm.io/package/gulp-replace-path

## Dependencies (3)

- [event-stream](https://npm.io/package/event-stream.md) ~3.0.18
- [replacestream](https://npm.io/package/replacestream.md) 0.1.3
- [istextorbinary](https://npm.io/package/istextorbinary.md) ~1.0.0

## Recent versions

- 0.4.0 (latest) — 2014-11-03

## README

# gulp-replace-path [![NPM version][npm-image]][npm-url] [![Build status][travis-image]][travis-url]
> A string replace plugin for gulp 3 that supports injecting file path.

## Usage

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

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

Then, add it to your `gulpfile.js`:

```javascript
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


[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/kennethlynne/gulp-replace-path
[travis-image]: https://secure.travis-ci.org/kennethlynne/gulp-replace-path.svg?branch=master
[npm-url]: https://npmjs.org/package/gulp-replace-path
[npm-image]: https://badge.fury.io/js/gulp-replace-path.svg

---
_Source: https://npm.io/package/gulp-replace-path · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._