@handy-common-utils/fs-utils

@handy-common-utils/fs-utils

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

How to use

First add it as a dependency:

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

Then you can use it in the code:

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

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

You can either import and use the class as shown above, or you can import individual functions directly like below:

import { addSurroundingInFile } from 'fs-utils';

await addSurroundingInFile(README_MD_FILE, /<example>(.*?)<\/example>/gms, '<example><b>', '</b></example>');

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

• replace-in-file filePath matchPattern replacement
• replace-in-files matchPattern replacement file1 file2 file3 ...
• replace-in-file-with-file-content filePath matchPattern contentFilePath
• add-surrounding-in-file filePath matchPattern beforeString afterString

API

fs-utils | @handy-common-utils/fs-utils

• Preparing search index...
• The search index is not available

@handy-common-utils/fs-utils

• @handy-common-utils/fs-utils
• fs-utils

Module fs-utils

Re-exports

Functions

• escapeRegExpReplacement = FsUtils.escapeRegExpReplacement
• changeFileContent = FsUtils.changeFileContent
• replaceInFile = FsUtils.replaceInFile
• replaceInFilesWithEncoding = FsUtils.replaceInFilesWithEncoding
• replaceInFiles = FsUtils.replaceInFiles
• addSurroundingInFile = FsUtils.addSurroundingInFile
• replaceInFileWithFileContent = FsUtils.replaceInFileWithFileContent

Exports

Index

Classes

FsUtils

Type Aliases

FileEncoding ReplacementOrBuilder

Settings

Member Visibility

• Protected
• Inherited

Theme

OSLightDark

Modules

• @handy-common-utils/fs-utils
  • fs-utils

• FsUtils
• FileEncoding
• ReplacementOrBuilder

Generated using TypeDoc