https://github.com/solodynamo/gulp-findreplace

A gulp plugin that finds ಠ_ಠ and replaces strings.
https://github.com/solodynamo/gulp-findreplace

find-and-replace gulp gulp-plugins gulp-stream regex

Last synced: 3 months ago
JSON representation

A gulp plugin that finds ಠ_ಠ and replaces strings.

• Host: GitHub
• URL: https://github.com/solodynamo/gulp-findreplace
• Owner: solodynamo
• License: mit
• Created: 2017-02-05T12:31:12.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-01T14:48:55.000Z (almost 8 years ago)
• Last Synced: 2024-11-14T11:33:43.963Z (3 months ago)
• Topics: find-and-replace, gulp, gulp-plugins, gulp-stream, regex
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/gulp-findreplace
• Size: 7.81 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gulp-findreplace [![NPM version][npm-image]][npm-url] [![download-image]][npm-url] [![Build status][travis-image]][travis-url]

> A gulp plugin that streamingly replaces matching strings with provided replacement string ⚡️

## Usage

First, install `gulp-findreplace` as a development dependency:

```shell

npm install --save-dev gulp-findreplace

```

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

### Regex Replace

```javascript

var freplace = require('gulp-findreplace');

gulp.task('replaceIt', function(){

  gulp.src(['example.txt'])

    .pipe(freplace(/foo(.{3})/g, 'foo'))

    .pipe(gulp.dest('build/example.txt'));

});

```

### String Replace

```javascript

var freplace = require('gulp-findreplace');

gulp.task('replaceIt', function(){

  gulp.src(['example.txt'])

    .pipe(freplace('love', 'code'))

    .pipe(gulp.dest('build/example.txt'));

});

```

You can also refer to an example provided in ./examples directory.

## API

gulp-findreplace works with streams and even if it encounter a file as a buffer it converts it to a stream then operates with provided string or regex.

### freplace(stringQuery, replacement)

#### stringQuery

Type: `String`

The string to search for.

#### replacement

Type: `String`

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.

### freplace(regex, replacement)

#### regex

Type: `RegExp`

The regex pattern to search for. See the [MDN documentation for RegExp] for details.

#### replacement

Type: `String`

[travis-url]: http://travis-ci.org/solodynamo/gulp-findreplace

[travis-image]: https://travis-ci.org/solodynamo/gulp-findreplace.svg?branch=master

[npm-url]: https://www.npmjs.com/package/gulp-findreplace

[npm-image]: https://badge.fury.io/js/gulp-findreplace.svg

[download-image]: https://img.shields.io/badge/Downloads-200%2B-Pink.svg