email-prompt
CLI email prompt featuring autocompletion and validation.
Powers vercel --login
.
Usage
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 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 (asString
). 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 totrue
. -
suggestionColor
(String
): a chalk color. Defaults togray
-
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 tofalse
Notes
Some important implementation details:
-
email-prompt
automatically adapts the mode ofprocess.stdin
for you. - The
stdin
stream isresume
d andpause
d upon the promise being settled. - When the promise resolves or rejects, the previous stdin mode is restored.
- The
tty
mode is set toraw
, which means all the caret interactions that you come to expect in a regularstdin
prompt are simulated. This gives us fine-grained control over the output and powers the validation.
Authors
- Guillermo Rauch (@rauchg) - Vercel
- Leo Lamprecht (@notquiteleo) - Vercel