Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vercel/email-prompt
CLI email prompt with autocompletion and built-in validation
https://github.com/vercel/email-prompt
Last synced: 6 days ago
JSON representation
CLI email prompt with autocompletion and built-in validation
- Host: GitHub
- URL: https://github.com/vercel/email-prompt
- Owner: vercel
- License: mit
- Created: 2016-05-22T20:32:20.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-03-04T03:26:57.000Z (almost 2 years ago)
- Last Synced: 2024-10-29T17:18:17.652Z (2 months ago)
- Language: JavaScript
- Homepage: https://npmjs.com/email-prompt
- Size: 64.5 KB
- Stars: 275
- Watchers: 8
- Forks: 29
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# email-prompt
CLI email prompt featuring autocompletion and validation.
Powers [vercel](https://vercel.com/) `--login`.
## Usage
```js
import emailPrompt from 'email-prompt';
let email;
try {
email = await emailPrompt({
/* options */
});
} catch (err) {
console.log('\n> Aborted!');
return;
}
console.log('\n> Hello ' + email);
```
To run the demo, [clone](https://help.github.com/articles/cloning-a-repository/) the project and run:
```bash
npm install
node demo
```
### Options
- `start` (`String`): the beginning of the prompt. Defaults to `> Enter your email: `
- `domains` (`Set`): domain names to autocomplete (as `String`). Defaults to:
- `aol.com`
- `gmail.com`
- `google.com`
- `yahoo.com`
- `ymail.com`
- `hotmail.com`
- `live.com`
- `outlook.com`
- `inbox.com`
- `mail.com`
- `gmx.com`
- `icloud.com`
- `hey.com`
- `zeit.co`
- `vercel.com`
- `forceLowerCase` (`Boolean`): converts all input to lowercase. Defaults to `true`.
- `suggestionColor` (`String`): a [chalk](https://github.com/chalk/chalk) color. Defaults to `gray`
- `autocompleteChars` (`Set`): a set of chars that trigger autocompletion. Defaults to:
- ↹ Tab
- ↵ Return (enter)
- → Right arrow
- `resolveChars` (`Set`): a set of chars that resolve the promise. Defaults to ↵return
- `abortChars` (`Set`): a set of chars that abort the process. Defaults to Ctrl+C
- `allowInvalidChars` (`Boolean`): controls whether non-email chars are accepted. Defaults to `false`
### Notes
Some important implementation details:
- `email-prompt` automatically adapts the mode of `process.stdin` for you.
- The `stdin` stream is `resume`d and `pause`d upon the promise being
settled.
- When the promise resolves or rejects, the previous stdin mode is restored.
- The `tty` mode is set to `raw`, which means all the caret interactions
that you come to expect in a regular `stdin` prompt are simulated.
This gives us fine-grained control over the output and powers the
validation.
## Authors
- Guillermo Rauch ([@rauchg](https://twitter.com/rauchg)) - [Vercel](https://vercel.com)
- Leo Lamprecht ([@notquiteleo](https://twitter.com/notquiteleo)) - [Vercel](https://vercel.com)