@handy-common-utils/fs-utils

File system operations related utilities without any 3rd party dependency.

Features

• ⚡ Zero Production Dependencies: Lightweight, secure, and fast to install.
• 📦 Dual Module Support: Works seamlessly in both CommonJS (require) and ES Modules (import) environments.
• 🛠️ Fully Typed: Written in TypeScript with full type definitions out of the box.
• 💻 CLI Companions: Execute search-and-replace actions directly from your terminal or build scripts without writing JavaScript code.

How to use

First add it as a dependency:

npm install @handy-common-utils/fs-utils

Import in code

You can use either ES Modules (ESM) or CommonJS (CJS) syntax.

ES Modules (ESM):

import { FsUtils, addSurroundingInFile } from '@handy-common-utils/fs-utils';

// Using the FsUtils class:
const [,, filePath, matchPattern, beforeString, afterString] = process.argv;
await FsUtils.addSurroundingInFile(filePath, new RegExp(matchPattern), beforeString, afterString);

// Or importing individual functions directly:
await addSurroundingInFile(README_MD_FILE, /<example>(.*?)<\/example>/gms, '<example><b>', '</b></example>');

CommonJS (CJS):

const { FsUtils, addSurroundingInFile } = require('@handy-common-utils/fs-utils');

// Using the FsUtils class:
FsUtils.addSurroundingInFile(filePath, /pattern/, 'before', 'after');

// Or using individual functions directly:
addSurroundingInFile(filePath, /pattern/, 'before', 'after');

CLI Commands

There are also several commands you can use directly from your shell or build scripts:

• replace-in-file [--flags <regExpFlags>] filePath matchPattern replacement
• replace-in-files [--flags <regExpFlags>] matchPattern replacement file1 file2 file3 ...
• replace-in-file-with-file-content [--flags <regExpFlags>] filePath matchPattern contentFilePath
• add-surrounding-in-file [--flags <regExpFlags>] filePath matchPattern beforeString afterString

The optional --flags argument accepts any combination of RegExp flags (e.g. g, gi, gm). It can appear anywhere in the argument list. Without --flags, each command replaces only the first match (default String.replace behaviour).

How to run CLI commands

1. Via npx (No installation needed):

   # Replace all occurrences (g flag) using a capture group in the replacement ($1)
   npx @handy-common-utils/fs-utils replace-in-file --flags g index.html '<a href="([^"]*)">' '<a href="$1" target="_blank">'

2. Via Local Scripts (package.json): If installed as a project devDependency, you can use the commands directly in your package.json scripts:

   "scripts": {
     "patch-links": "replace-in-files --flags gi TODO DONE file1.txt file2.txt"
   }

3. Via Global Installation:

   npm install -g @handy-common-utils/fs-utils
   replace-in-files --flags gi TODO DONE file1.txt file2.txt

API

fs-utils

Classes

| Class | Description | | ------ | ------ | | FsUtils | - |

Type Aliases

| Type Alias | Description | | ------ | ------ | | FileEncoding | - | | ReplacementOrBuilder | - |

Classes

Abstract Class: FsUtils

Constructors

Constructor

new FsUtils(): FsUtils

Returns

FsUtils

Methods

addSurroundingInFile()

static addSurroundingInFile(filePath, matchPattern, addBefore, addAfter, fileEncoding?): Promise<void>

Add surrounding content to the matching sections in the text file.

Parameters

| Parameter | Type | Default value | Description | | ------ | ------ | ------ | ------ | | filePath | string | undefined | path to the file | | matchPattern | RegExp | undefined | RegExp for deciding which section of the file would be processed. You must have a capturing group in the pattern. You may want to use these tricks: m flag, g flag, s flag, [\s\S]*, .*? | | addBefore | string | undefined | the string to be added before the capturing group, no need to escape anything | | addAfter | string | undefined | the string to be added before the capturing group, no need to escape anything | | fileEncoding | BufferEncoding | undefined | 'utf-8' | encoding of the file |

Returns

Promise<void>

Promise of void

changeFileContent()

static changeFileContent(filePath, transformContent, fileEncoding?): Promise<void>

Change the text file content. This function loads the full content of the file into memory as string, so that it is not suitable for huge (for example, > 500MB) files. If the new content and original content are the same, the file won't be touched.

Parameters

| Parameter | Type | Default value | Description | | ------ | ------ | ------ | ------ | | filePath | string | undefined | path to the file | | transformContent | (originalContent, filePath) => string | PromiseLike<string> | undefined | function for getting the new file content | | fileEncoding | BufferEncoding | undefined | 'utf-8' | encoding of the file |

Returns

Promise<void>

Promise of void

escapeRegExpReplacement()

static escapeRegExpReplacement(input): string

Escape the ' sign in the string for using the string as the second argument to String.replace(...)

Parameters

| Parameter | Type | Description | | ------ | ------ | ------ | | input | string | the original string |

Returns

string

a new string with all ' in the original string being replaced by '$'

replaceInFile()

static replaceInFile(filePath, matchPattern, replacementOrBuilder, fileEncoding?): Promise<void>

Replace the matching sections in the text file.

Parameters

| Parameter | Type | Default value | Description | | ------ | ------ | ------ | ------ | | filePath | string | undefined | path to the file | | matchPattern | RegExp | undefined | RegExp for deciding which section of the file would be replaced. You may want to use these tricks: m flag, g flag, s flag, [\s\S]*, .*? | | replacementOrBuilder | ReplacementOrBuilder | undefined | The replacement string or a function for building the replacement string. Please note that you can use special replacement patterns but also you need to take care of the escaping. For details of special replacement patterns see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace | | fileEncoding | BufferEncoding | undefined | 'utf-8' | encoding of the file |

Returns

Promise<void>

Promise of void

replaceInFiles()

static replaceInFiles(matchPattern, replacementOrBuilder, ...filePaths): Promise<void>

Replace the matching sections in multiple utf-8 text files. The replacing opertions on those files happen in parallel.

Parameters

| Parameter | Type | Description | | ------ | ------ | ------ | | matchPattern | RegExp | RegExp for deciding which section of the file would be replaced. You may want to use these tricks: m flag, g flag, s flag, [\s\S]*, .*? | | replacementOrBuilder | ReplacementOrBuilder | The replacement string or a function for building the replacement string. Please note that you can use special replacement patterns but also you need to take care of the escaping. For details of special replacement patterns see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace | | ...filePaths | string[] | patsh to the files |

Returns

Promise<void>

Promise of void

replaceInFilesWithEncoding()

static replaceInFilesWithEncoding(matchPattern, replacementOrBuilder, fileEncoding, ...filePaths): Promise<void>

Replace the matching sections in multiple text files. The replacing opertions on those files happen in parallel.

Parameters

| Parameter | Type | Description | | ------ | ------ | ------ | | matchPattern | RegExp | RegExp for deciding which section of the file would be replaced. You may want to use these tricks: m flag, g flag, s flag, [\s\S]*, .*? | | replacementOrBuilder | ReplacementOrBuilder | The replacement string or a function for building the replacement string. Please note that you can use special replacement patterns but also you need to take care of the escaping. For details of special replacement patterns see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace | | fileEncoding | BufferEncoding | undefined | encoding of the file, in most of the cases 'utf-8' should be used | | ...filePaths | string[] | patsh to the files |

Returns

Promise<void>

Promise of void

replaceInFileWithFileContent()

static replaceInFileWithFileContent(filePath, matchPattern, contentFilePath, fileEncoding?): Promise<void>

Replace the matching sections in the text file with content from another file.

Parameters

| Parameter | Type | Default value | Description | | ------ | ------ | ------ | ------ | | filePath | string | undefined | path of the file | | matchPattern | RegExp | undefined | RegExp for deciding which section of the file would be replaced. You must have a capturing group in the pattern. You may want to use these tricks: m flag, g flag, s flag, [\s\S]*, .*? | | contentFilePath | string | undefined | path of the file for getting the replacement content | | fileEncoding | BufferEncoding | undefined | 'utf-8' | encoding of the files |

Returns

Promise<void>

Promise of void

Type Aliases

Type Alias: FileEncoding

FileEncoding = Parameters<Buffer["toString"]>["0"]

Type Alias: ReplacementOrBuilder

ReplacementOrBuilder = string | ((matchPattern, filePath) => string | PromiseLike<string>)