Code Monkey home page Code Monkey logo

gulp-findreplace's Introduction

gulp-findreplace NPM version download-image Build status

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

Usage

First, install gulp-findreplace as a development dependency:

npm install --save-dev gulp-findreplace

Then, add it to your gulpfile.js:

Regex Replace

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

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.