@frsource/frs-replace - replace content directly in your files/streams with ease (CLI included)! 📝

File an Issue · Question or an idea? · Benchmarks

The fastest (see benchmarks) CLI & Node wrapper around javascript replace which allows in-file replacing (with possibility to save changed file as a copy), globbing, piping and many more!

Getting Started (CLI) · Examples and recipes (CLI)
Getting Started (Node) · Examples and recipes (Node)

:scroll: Installation

npm install @frsource/frs-replace

or execute it right away:

npx @frsource/frs-replace

:keyboard: CLI

frs-replace <regex> <replacement> [flags]

Basic usage:

frs-replace something anything -i foo.js -o foo_replaced.js

# all of the occurences of "something" in `foo.js` will be replaced with "anything" and saved to `foo_replaced.js`

More examples below.

Arguments

Flags

Note: Every boolean option can be negated with use of --no- prefix, e.g. --stdout or --no-stdout turn stdout output on or off, respectively.

Note: Object types can be set using dot notation. So, e.g. if you want to pass utf8 value under i-read-opts encoding field you should write --i-read-opts.encoding utf8.

:mag_right: Examples and recipes - CLI

1. Replace all a occurrences with b from the foo.js file and return the result (using CLI)

frs-replace a b -i foo.js --stdout

2. Replace all a occurrences with b from foo.js and save the result to the foo_replaced.js (using CLI)

frs-replace a b -i foo.js -o foo_replaced.js

3. Replace all a occurrences with b from an array of files and save the result to the foo_replaced.js using default \n as a result-joining string (using CLI)

frs-replace a b -i foo.js -i foo2.js -o foo_replaced.js

4. Replace all a occurrences with b from all .js files in the foo directory and save the result to the foo_replaced.js using \n/////\n as a result-joining string (using CLI)

frs-replace a b -i foo/*.js -o foo_replaced.js --o-join-str "\n/////\n"

5. Replace all a occurrences with b in a content string abcd and save the result to the foo_replaced.js (using CLI)

frs-replace a b --content abcd -o foo_replaced.js

6. Replace all a occurrences with b from a piped stream and save it to the output file (using CLI)

<read-file> | frs-replace a b > <output-file-path>

7. Replace all a occurrences with b from a piped stream and pass it through the stdout stream to the <next-command> (using CLI)

<read-file> | frs-replace a b | <next-command>

:books: Node API

@frsource/frs-replace package is shipped in 2 flavors: synchronous and asynchronous:

import { sync, async } from '@frsource/frs-replace';

sync({/* options */});
await async({/* options */});

Where /* options */ is an object containing:

Note: one of parameters: input or content is required

:mag_right: Examples and recipes - Node

Note: While all of examples are using synchronous API method in all cases your can use async as well.

1. Replace all a occurrences with b from the foo.js file and return the result

import { sync } from '@frsource/frs-replace';

const result = sync({
  input: 'foo.js',
  regex: new RegExp('a', 'g'),
  replacement: 'b',
  output: 'foo_replaced.js',
});

2. Replace all a occurrences with b from foo.js and save the result to the foo_replaced.js

import { sync } from '@frsource/frs-replace';
const result = sync({
  input: 'foo.js',
  regex: new RegExp('a', 'g'),
  replacement: 'b',
  output: 'foo_replaced.js',
});

3. Replace all a occurrences with b from an array of files and save the result to the foo_replaced.js using default \n as a result-joining string

import { sync } from '@frsource/frs-replace';
const result = sync({
  input: ['foo.js', 'foo2.js'],
  regex: new RegExp('a', 'g'),
  replacement: 'b',
  output: 'foo_replaced.js',
});

4. Replace all a occurrences with b from all .js files in the foo directory and save the result to the foo_replaced.js using \n/////\n as a result-joining string

import { sync } from '@frsource/frs-replace';
const result = sync({
  input: 'foo/*.js',
  regex: new RegExp('a', 'g'),
  replacement: 'b',
  outputJoinString: '\n/////\n',
  output: 'foo_replaced.js',
});

5. Replace all a occurrences with b in a content string abcd and save the result to the foo_replaced.js

import { sync } from '@frsource/frs-replace';
const result = sync({
  content: 'abcd',
  regex: new RegExp('a', 'g'),
  replacement: 'b',
  output: 'foo_replaced.js',
});

:chart_with_upwards_trend: Benchmarks

Tested on Node v24.22.2.

input as glob pattern [40 files]

input & replacement as strings