Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/teplostanski/nreplacer
https://github.com/teplostanski/nreplacer
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/teplostanski/nreplacer
- Owner: teplostanski
- License: gpl-3.0
- Created: 2023-10-15T10:00:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-21T16:57:26.000Z (about 1 year ago)
- Last Synced: 2024-02-22T20:49:45.928Z (10 months ago)
- Language: TypeScript
- Size: 512 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# nreplacer
Effortlessly replace text in any text-based file or directory using the power and simplicity of Node.js.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
- [Contributing](#contributing)
- [License](#license)
## Installation
Install `nreplacer` globally for easy access from any directory:
```bash
npm install -g nreplacer
```
Or install it locally for your project:
```bash
npm install nreplacer --save-dev
```
## Usage
#### Replace text in a file or directory using the CLI. You can provide either plain text or regex patterns in the --search parameter:
Example with plain text:
```bash
nreplacer --file --search "old-text" --replace "new-text" [--global] [--noprint] [--nocolor]
```
Example with a regex pattern:
```bash
nreplacer --file --search "/\d{3}-\d{2}-\d{4}/g" --replace "XXX-XX-XXXX" [--global] [--noprint] [--nocolor]
```
| Option | Description |
| ------------- | -------------------------------------------------------------------------------------------------------------- |
| `--file` | The path to the file or directory where you want to perform the replacement. |
| `--search` | The text or pattern you wish to search for. |
| `--replace` | The text you wish to replace the searched text/pattern with. |
| `--global` | (Optional) If specified, will replace all occurrences. If omitted, only the first occurrence will be replaced. |
| `--noverbose` | (Optional) If specified, disables verbose output and only performs the replacement silently. |
| `--noprint` | (Optional) If specified, suppresses the output printing. |
| `--nocolor` | (Optional) If specified, disables color in the output. |
---
#### For programmatic usage in your JavaScript or TypeScript projects:
You can also utilize nreplacer in your JavaScript or TypeScript projects. Here's how you can use the replaceInFiles function:
Example with plain text:
```javascript
import { replaceInFiles } from "nreplacer";
const filePathOrDir = 'test.txt';
const searchValue = 'old-text';
const replaceValue = 'new-text';
const globalReplace = true;
replaceInFiles(filePathOrDir, searchValue, replaceValue, globalReplace);
```
Example with a regex pattern:
```javascript
import { replaceInFiles } from "nreplacer";
const filePathOrDir1 = 'test1.txt';
const filePathOrDir2 = 'test2.txt';
const searchValue = /\d{3}-\d{2}-\d{4}/g; // Searching for patterns like "123-45-6789"
const replaceValue = 'XXX-XX-XXXX';
const globalReplace = true;
const replaceFunc1 = replaceInFiles
const replaceFunc2 = replaceInFiles
await replaceFunc1(filePathOrDir1, searchValue, replaceValue, globalReplace)
await replaceFunc2(filePathOrDir2, searchValue)
```
By leveraging these examples, you can efficiently integrate nreplacer into your projects and automate text replacement tasks programmatically.
## Features
- **Fast & Efficient**: Uses streams for efficient memory usage even with large files.
- **Flexible**: Supports both global and single occurrence replacements.
- **Safe**: Checks file type and ensures it's a text-based format before processing.
- **Intuitive CLI**: Simple and straightforward command line interface.
- **Regex Support**: Utilize regular expressions for text searching.
- **Configurable Output**: Control the verbosity and color of the CLI output with flags.
## Recent Updates
- Enhanced output formatting with microsecond precision.
- Integrated boxen for improved CLI output framing.
- Added `noprint` option to suppress output.
- Enhanced CLI output with a bordered box.
- Regex support added for searching.
Check out our [Changelog](./CHANGELOG.md) for a detailed history of updates.
## Contributing
We welcome contributions! Please see our [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on how to contribute.
## License
This project is licensed under the GNU General Public License v3.0 (GPL-3.0). See [LICENSE.md](./LICENSE.md) for more details.