npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gulp-replace

v1.1.4

Published

A string replace plugin for gulp

Downloads

1,053,629

Readme

gulp-replace NPM version Build status

A string replace plugin for gulp

Read me for gulp 3

Usage

First, install gulp-replace as a development dependency:

npm install --save-dev gulp-replace
# or
yarn add --dev gulp-replace

Then, add it to your gulpfile.js:

Simple string replace

const replace = require('gulp-replace');
const { src, dest } = require('gulp');

function replaceTemplate() {
  return src(['file.txt'])
    .pipe(replace('bar', 'foo'))
    .pipe(dest('build/'));
};

// or replace multiple strings
function replaceTemplate() {
  return src(['file.txt'])
    .pipe(replace('bar', 'foo'))
    .pipe(replace('baz', 'fuz'))
    .pipe(dest('build/'));
};

exports.replaceTemplate = replaceTemplate;

Simple regex replace

const replace = require('gulp-replace');
const { src, dest } = require('gulp');

function replaceTemplate() {
  return src(['file.txt'])
      // See https://mdn.io/string.replace#Specifying_a_string_as_a_parameter
      .pipe(replace(/foo(.{3})/g, '$1foo'))
      .pipe(dest('build/'));
};

exports.replaceTemplate = replaceTemplate;

String replace with function callback

const replace = require('gulp-replace');
const { src, dest } = require('gulp');

function replaceTemplate() {
  return src(['file.txt'])
    .pipe(replace('foo', function handleReplace(match){ return match.reverse(); })
    .pipe(dest('build/'))
};

exports.replaceTemplate = replaceTemplate;

Regex replace with function callback

const replace = require('gulp-replace');
const { src, dest } = require('gulp');

function replaceTemplate() {
  return src(['file.txt'])
    .pipe(replace(/foo(.{3})/g, function handleReplace(match, p1, offset, string) {
      // Replace foobaz with barbaz and log a ton of information
      // See https://mdn.io/string.replace#Specifying_a_function_as_a_parameter
      console.log('Found ' + match + ' with param ' + p1 + ' at ' + offset + ' inside of ' + string);
      return 'bar' + p1;
    }))
    .pipe(dest('build/'));
};

exports.replaceTemplate = replaceTemplate;

Function callback with file object

const replace = require('gulp-replace');
const { src, dest } = require('gulp');

function replaceTemplate() {
  return src(['file.txt'])
    .pipe(replace('filename', function handleReplace() {
         // Replaces instances of "filename" with "file.txt"
         // this.file is also available for regex replace
         // See https://github.com/gulpjs/vinyl#instance-properties for details on available properties
         return this.file.relative;
       }))
    .pipe(dest('build/'));
};

exports.replaceTemplate = replaceTemplate;

API

gulp-replace can be called with a string or regex.

replace(string, replacement[, options])

CAUTION: replacement could NOT be arrow function, because arrow function could not bind this

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.

The value of this.file will be equal to the vinyl instance for the file being processed.

replace(regex, replacement[, options])

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 on special replacement string patterns and arguments to the replacement function.

The value of this.file will be equal to the vinyl instance for the file being processed.

gulp-replace options

An optional third argument, options, can be passed.

options

Type: Object

options.skipBinary

Type: boolean
Default: true

Skip binary files. This option is true by default. If you want to replace content in binary files, you must explicitly set it to false.