read-file-input v1.1.6

Allows you to capture user input by opening a text editor instead of stdin. Manually passing large amounts of data through stdin is cumbersome and not widely supported as it depends on the terminal emulator.

This module creates a temporary file and opens it with the configured text editor. When the user saves the file and quits the editor, we read back the file while optionally deleting it.

Since most text editors support UTF-8, any emojis and special characters will be handled safely instead of replying on the terminal.

Tweet @, I would love to know your opinion & experience on this project 😍

✨ Features

1. Cross platform
2. Supports graphical & terminal editors
3. Prefills the file with content

💿 Installation

npm i <!-- name -->

🚀 Quick Start

After <!-- name --> as a dependency using the above command, you can use it in the following way:

<!-- example -->

🧪 Configuration

<!-- config -->

💻 Building & Dev Setup

You need to be at least on Node.js v or above and follow the below instructions to build the project 👇

• STEP 1️⃣ Clone this project
• STEP 2️⃣ Run npm install to get all dependencies
• STEP 3️⃣ To build the TypeScript project run npm run build

Now you should have a dist folder in the project directory.

⚡ Running Examples

Once you have successfully built the project, to run a basic example 👇

node examples/basic.js

Checkout other examples to know more on different use cases and configuration of options of read-file-input.

🛠️ Writing Code

This project follows Vasanth's Commit Style for commit messages.

📰 License

The project is released under the MIT license(https://github.com///blob/main/LICENSE.md). Developed & maintained By Vasanth Srivatsa. Copyright © Vasanth Developer.

vsnth.dev  ·  YouTube @vasanthdeveloper  ·  Twitter @  ·  Discord Vasanth Developer