|
|
|
@ -1,102 +1,262 @@ |
|
|
|
// inspired by https://github.com/zeit/email-prompt
|
|
|
|
|
|
|
|
// theirs
|
|
|
|
// Packages
|
|
|
|
const ansiEscapes = require('ansi-escapes') |
|
|
|
const ansiRegex = require('ansi-regex') |
|
|
|
const chalk = require('chalk') |
|
|
|
const stripAnsi = require('strip-ansi') |
|
|
|
|
|
|
|
// ours
|
|
|
|
// Utilities
|
|
|
|
const eraseLines = require('../output/erase-lines') |
|
|
|
|
|
|
|
const ESCAPES = { |
|
|
|
LEFT: '\u001B[D', |
|
|
|
RIGHT: '\u001B[C', |
|
|
|
CTRL_C: '\x03', |
|
|
|
CTRL_C: '\u0003', |
|
|
|
BACKSPACE: '\u0008', |
|
|
|
CTRL_H: '\u007F', |
|
|
|
CARRIAGE: '\r' |
|
|
|
} |
|
|
|
|
|
|
|
const textInput = ({ |
|
|
|
label = 'Enter some text: ', |
|
|
|
resolveChars = new Set([ESCAPES.CARRIAGE]), |
|
|
|
abortChars = new Set([ESCAPES.CTRL_C]), |
|
|
|
// if `true`, `eraseLines(1)` will be `stdout.write`d before
|
|
|
|
// `resolve`ing or `reject`ing
|
|
|
|
clearWhenDone = true |
|
|
|
}) => { |
|
|
|
const formatCC = data => { |
|
|
|
return data.replace(/\s/g, '').replace(/(.{4})/g, '$1 ').trim() |
|
|
|
} |
|
|
|
|
|
|
|
module.exports = function( |
|
|
|
{ |
|
|
|
label = '', |
|
|
|
initialValue = '', |
|
|
|
// If false, the `- label` will be printed as `✖ label` in red
|
|
|
|
// Until the first keypress
|
|
|
|
valid = true, |
|
|
|
// Can be:
|
|
|
|
// - `false`, which does nothing
|
|
|
|
// - `cc`, for credit cards
|
|
|
|
// - `date`, for dates in the mm / yyyy format
|
|
|
|
mask = false, |
|
|
|
placeholder = '', |
|
|
|
abortSequences = new Set(['\x03']), |
|
|
|
eraseSequences = new Set([ESCAPES.BACKSPACE, ESCAPES.CTRL_H]), |
|
|
|
resolveChars = new Set([ESCAPES.CARRIAGE]), |
|
|
|
stdin = process.stdin, |
|
|
|
stdout = process.stdout, |
|
|
|
// Char to print before resolving/rejecting the promise
|
|
|
|
// If `false`, nothing will be printed
|
|
|
|
trailing = ansiEscapes.eraseLines(1), |
|
|
|
// Gets called on each keypress;
|
|
|
|
// `data` contains the current keypress;
|
|
|
|
// `futureValue` contains the current value + the
|
|
|
|
// Keypress in the correct place
|
|
|
|
validateKeypress = (data, futureValue) => true, // eslint-disable-line no-unused-vars
|
|
|
|
// Get's called before the promise is resolved
|
|
|
|
// Returning `false` here will prevent the user from submiting the value
|
|
|
|
validateValue = data => true, // eslint-disable-line no-unused-vars
|
|
|
|
// Receives the value of the input and should return a string
|
|
|
|
// Or false if no autocomplion is available
|
|
|
|
autoComplete = value => false, // eslint-disable-line no-unused-vars
|
|
|
|
// Tab
|
|
|
|
// Right arrow
|
|
|
|
autoCompleteChars = new Set(['\t', '\x1b[C']), |
|
|
|
// If true, converts everything the user types to to lowercase
|
|
|
|
forceLowerCase = false |
|
|
|
} = {} |
|
|
|
) { |
|
|
|
return new Promise((resolve, reject) => { |
|
|
|
if (!process.stdin.setRawMode) { |
|
|
|
// Some environments (e.g., cygwin) don't provide a tty
|
|
|
|
const e = new Error('stdin lacks setRawMode support') |
|
|
|
e.userError = true |
|
|
|
reject(e) |
|
|
|
const isRaw = process.stdin.isRaw |
|
|
|
|
|
|
|
let value |
|
|
|
let caretOffset = 0 |
|
|
|
let regex |
|
|
|
let suggestion = '' |
|
|
|
|
|
|
|
if (valid) { |
|
|
|
stdout.write(label) |
|
|
|
} else { |
|
|
|
const _label = label.replace('-', '✖') |
|
|
|
stdout.write(chalk.red(_label)) |
|
|
|
} |
|
|
|
|
|
|
|
const isRaw = process.stdin.isRaw |
|
|
|
value = initialValue |
|
|
|
stdout.write(initialValue) |
|
|
|
|
|
|
|
process.stdin.setRawMode(true) |
|
|
|
process.stdin.resume() |
|
|
|
process.stdout.write(label) |
|
|
|
if (mask) { |
|
|
|
if (!value) { |
|
|
|
value = chalk.gray(placeholder) |
|
|
|
caretOffset = 0 - stripAnsi(value).length |
|
|
|
stdout.write(value) |
|
|
|
stdout.write(ansiEscapes.cursorBackward(Math.abs(caretOffset))) |
|
|
|
} |
|
|
|
|
|
|
|
let input = '' // Whatever the user types
|
|
|
|
let caretOffset = 0 // Left/right keys
|
|
|
|
regex = placeholder |
|
|
|
.split('') |
|
|
|
.reduce((prev, curr) => { |
|
|
|
if (curr !== ' ' && !prev.includes(curr)) { |
|
|
|
if (curr === '/') { |
|
|
|
prev.push(' / ') |
|
|
|
} else { |
|
|
|
prev.push(curr) |
|
|
|
} |
|
|
|
} |
|
|
|
return prev |
|
|
|
}, []) |
|
|
|
.join('|') |
|
|
|
regex = new RegExp(`(${regex})`, 'g') |
|
|
|
} |
|
|
|
|
|
|
|
stdin.setRawMode(true) |
|
|
|
stdin.resume() |
|
|
|
|
|
|
|
const onData = buffer => { |
|
|
|
function restore() { |
|
|
|
stdin.setRawMode(isRaw) |
|
|
|
stdin.pause() |
|
|
|
stdin.removeListener('data', onData) |
|
|
|
if (trailing) { |
|
|
|
stdout.write(trailing) |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
async function onData(buffer) { |
|
|
|
let data = buffer.toString() |
|
|
|
|
|
|
|
if (abortChars.has(data)) { |
|
|
|
const e = new Error('User abort') |
|
|
|
e.code = 'USER_ABORT' |
|
|
|
value = stripAnsi(value) |
|
|
|
|
|
|
|
if (abortSequences.has(data)) { |
|
|
|
restore() |
|
|
|
return reject(e) |
|
|
|
return reject(new Error('USER_ABORT')) |
|
|
|
} |
|
|
|
|
|
|
|
if (data === ESCAPES.LEFT) { |
|
|
|
if (input.length > Math.abs(caretOffset)) { |
|
|
|
if (forceLowerCase) { |
|
|
|
data = data.toLowerCase() |
|
|
|
} |
|
|
|
|
|
|
|
if (suggestion !== '' && !caretOffset && autoCompleteChars.has(data)) { |
|
|
|
value += stripAnsi(suggestion) |
|
|
|
suggestion = '' |
|
|
|
} else if (data === ESCAPES.LEFT) { |
|
|
|
if (value.length > Math.abs(caretOffset)) { |
|
|
|
caretOffset-- |
|
|
|
} |
|
|
|
} else if (data === ESCAPES.RIGHT) { |
|
|
|
if (caretOffset < 0) { |
|
|
|
caretOffset++ |
|
|
|
} |
|
|
|
} else if (data === '\x08' || data === '\x7f') { |
|
|
|
// Delete key needs splicing according to caret position
|
|
|
|
input = |
|
|
|
input.substr(0, input.length + caretOffset - 1) + |
|
|
|
input.substr(input.length + caretOffset) |
|
|
|
} else { |
|
|
|
if (resolveChars.has(data)) { |
|
|
|
} else if (eraseSequences.has(data)) { |
|
|
|
let char |
|
|
|
if (mask && value.length > Math.abs(caretOffset)) { |
|
|
|
if (value[value.length + caretOffset - 1] === ' ') { |
|
|
|
if (value[value.length + caretOffset - 2] === '/') { |
|
|
|
caretOffset -= 1 |
|
|
|
} |
|
|
|
char = placeholder[value.length + caretOffset] |
|
|
|
value = |
|
|
|
value.substr(0, value.length + caretOffset - 2) + |
|
|
|
char + |
|
|
|
value.substr(value.length + caretOffset - 1) |
|
|
|
caretOffset-- |
|
|
|
} else { |
|
|
|
char = placeholder[value.length + caretOffset - 1] |
|
|
|
value = |
|
|
|
value.substr(0, value.length + caretOffset - 1) + |
|
|
|
char + |
|
|
|
value.substr(value.length + caretOffset) |
|
|
|
} |
|
|
|
caretOffset-- |
|
|
|
} else { |
|
|
|
value = |
|
|
|
value.substr(0, value.length + caretOffset - 1) + |
|
|
|
value.substr(value.length + caretOffset) |
|
|
|
} |
|
|
|
suggestion = '' |
|
|
|
} else if (resolveChars.has(data)) { |
|
|
|
if (validateValue(value)) { |
|
|
|
restore() |
|
|
|
resolve(input) |
|
|
|
resolve(value) |
|
|
|
} else { |
|
|
|
if (mask === 'cc' || mask === 'ccv') { |
|
|
|
value = formatCC(value) |
|
|
|
value = value.replace(regex, chalk.gray('$1')) |
|
|
|
} else if (mask === 'expDate') { |
|
|
|
value = value.replace(regex, chalk.gray('$1')) |
|
|
|
} |
|
|
|
|
|
|
|
const l = chalk.red(label.replace('-', '✖')) |
|
|
|
eraseLines(1) |
|
|
|
stdout.write(l + value + ansiEscapes.beep) |
|
|
|
if (caretOffset) { |
|
|
|
process.stdout.write( |
|
|
|
ansiEscapes.cursorBackward(Math.abs(caretOffset)) |
|
|
|
) |
|
|
|
} |
|
|
|
} |
|
|
|
return |
|
|
|
} else if (!ansiRegex().test(data)) { |
|
|
|
let tmp = |
|
|
|
value.substr(0, value.length + caretOffset) + |
|
|
|
data + |
|
|
|
value.substr(value.length + caretOffset) |
|
|
|
|
|
|
|
if (mask) { |
|
|
|
if (/\d/.test(data) && caretOffset !== 0) { |
|
|
|
let formattedData = data |
|
|
|
|
|
|
|
if (mask === 'cc' || mask === 'ccv') { |
|
|
|
formattedData = formatCC(data) |
|
|
|
} |
|
|
|
|
|
|
|
if (value[value.length + caretOffset + 1] === ' ') { |
|
|
|
tmp = |
|
|
|
value.substr(0, value.length + caretOffset) + |
|
|
|
formattedData + |
|
|
|
value.substr(value.length + caretOffset + formattedData.length) |
|
|
|
|
|
|
|
if (stripAnsi(data).length !== data.length) { |
|
|
|
data = '' |
|
|
|
caretOffset += formattedData.length + 1 |
|
|
|
|
|
|
|
if (value[value.length + caretOffset] === '/') { |
|
|
|
caretOffset += formattedData.length + 1 |
|
|
|
} |
|
|
|
} else { |
|
|
|
tmp = |
|
|
|
value.substr(0, value.length + caretOffset) + |
|
|
|
formattedData + |
|
|
|
value.substr(value.length + caretOffset + formattedData.length) |
|
|
|
|
|
|
|
caretOffset += formattedData.length |
|
|
|
} |
|
|
|
} else if (/\s/.test(data) && caretOffset < 0) { |
|
|
|
caretOffset++ |
|
|
|
tmp = value |
|
|
|
} else { |
|
|
|
return stdout.write(ansiEscapes.beep) |
|
|
|
} |
|
|
|
value = tmp |
|
|
|
} else if (validateKeypress(data, value)) { |
|
|
|
value = tmp |
|
|
|
if (caretOffset === 0) { |
|
|
|
const completion = await autoComplete(value) |
|
|
|
if (completion) { |
|
|
|
suggestion = chalk.gray(completion) |
|
|
|
suggestion += ansiEscapes.cursorBackward(completion.length) |
|
|
|
} else { |
|
|
|
suggestion = '' |
|
|
|
} |
|
|
|
} |
|
|
|
} else { |
|
|
|
return stdout.write(ansiEscapes.beep) |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
input = |
|
|
|
input.substr(0, input.length + caretOffset) + |
|
|
|
stripAnsi(data) + |
|
|
|
input.substr(input.length + caretOffset) |
|
|
|
if (mask === 'cc' || mask === 'ccv') { |
|
|
|
value = formatCC(value) |
|
|
|
value = value.replace(regex, chalk.gray('$1')) |
|
|
|
} else if (mask === 'expDate') { |
|
|
|
value = value.replace(regex, chalk.gray('$1')) |
|
|
|
} |
|
|
|
|
|
|
|
process.stdout.write(eraseLines(1) + label + input) |
|
|
|
eraseLines(1) |
|
|
|
stdout.write(label + value + suggestion) |
|
|
|
if (caretOffset) { |
|
|
|
process.stdout.write(ansiEscapes.cursorBackward(Math.abs(caretOffset))) |
|
|
|
} |
|
|
|
} |
|
|
|
|
|
|
|
const restore = () => { |
|
|
|
if (clearWhenDone) { |
|
|
|
process.stdout.write(eraseLines(1)) |
|
|
|
} |
|
|
|
process.stdin.setRawMode(isRaw) |
|
|
|
process.stdin.pause() |
|
|
|
process.stdin.removeListener('data', onData) |
|
|
|
} |
|
|
|
|
|
|
|
process.stdin.on('data', onData) |
|
|
|
stdin.on('data', onData) |
|
|
|
}) |
|
|
|
} |
|
|
|
|
|
|
|
module.exports = textInput |
|
|
|
|
Leo Lamprecht
7 years ago
GitHub