1.0.0 • Published 2 years ago
@developertheexplorer/editor v1.0.0
@inquirer/editor
Prompt that'll open the user preferred editor with default content and allow for a convenient multi-line input controlled through the command line.
Installation
npm install @inquirer/editor
yarn add @inquirer/editorUsage
import editor from '@inquirer/editor';
const answer = await editor({
message: 'Enter a description'
});Options
| Property | Type | Required | Description |
|---|---|---|---|
| message | string | yes | The question to ask |
| validate | string => boolean \| string \| Promise<string \| boolean> | no | On submit, validate the content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash. |
| postfix | string | no (default to .txt) | The postfix of the file being edited. Adding this will add color highlighting to the file content in most editors. |
License
Copyright (c) 2022 Simon Boudrias (twitter: @vaxilart) Licensed under the MIT license.
1.0.0
2 years ago