A Node package interface to a Go powered search and replace package

Usage no npm install needed!

<script type="module">
  import automatticVipSearchReplace from 'https://cdn.skypack.dev/@automattic/vip-search-replace';


nlm-github nlm-version

VIP Search & Replace

How to use this package?

const { replace } = require( '@automattic/vip-search-replace' );

// Create a readable and writeable stream. Can be any stream: File, std, etc...
const readableStream = fs.createReadStream( 'path_to_sql_file.sql' );
const writeableStream = fs.createWriteStream( 'path_to_sql_file_replaced.sql', { encoding: 'utf8' } );

const result = await replace( readableStream, [ 'thisdomain.com', 'thatdomain.com' ] );

result.pipe( writeableStream );


Commit Messages

This library uses nlm for package lifecycle management. As a result all commit messages must follow the Angular Commit message format: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#type


To execute tests before committing your changes, run:

npm t