email-prompt
CLI email prompt featuring autocompletion and validation.
Powers vercel --login
.
Usage
import emailPrompt from 'email-prompt';
let email;
try {
email = await emailPrompt({
});
} catch (err) {
console.log('\n> Aborted!');
return;
}
console.log('\n> Hello ' + email);
To run the demo, clone the project and run:
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 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 ↵returnabortChars
(Set
): a set of chars that abort the process. Defaults to Ctrl+CallowInvalidChars
(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