@topcli/prompts 0.0.1 → 0.0.2

package/README.md

@@ -45,17 +45,30 @@ const isAdult = await confirm('Are you over 18 ?', { initial: true })
 
 ## API
 
-### `prompt(message: string): Promise<string>`
+### `prompt()`
+
+```ts
+prompt(message: string): Promise<string>
+```
 
 Simple prompt, similar to `rl.question()` with an improved UI.
 
-### `select(message: string, options: { choices: (Choice | string)[], maxVisible?: number }): Promise<string>`
+### `select()`
+
+```ts
+select(message: string, options: { choices: (Choice | string)[], maxVisible?: number, ignoreValues?: (string | number | boolean)[] }): Promise<string>
+```
 
 Scrollable select depending `maxVisible` (default `8`).
+Use `ignoreValues` to skip result render & clear lines after a selected one.
+
+### `confirm()`
 
-### `confirm(message: string, options?: { initial: boolean }): Promise<string>`
+```ts
+confirm(message: string, options?: { initial: boolean }): Promise<string>
+```
 
-Boolean prompt.
+Boolean prompt, return `options.initial` if user input is different from "y"/"yes"/"n"/"no", (default `false`).
 
 ## Interfaces
 

package/index.d.ts

@@ -4,5 +4,5 @@ export interface Choice {
   description?: string,
 }
 export function prompt(message: string): Promise<string>;
-export function select(message: string, options: { choices: (Choice | string)[], maxVisble?: number }): Promise<string>;
+export function select(message: string, options: { choices: (Choice | string)[], maxVisble?: number, ignoreValues: (string | number | boolean)[] }): Promise<string>;
 export function confirm(message: string, options?: { initial: boolean }): Promise<string>;

package/index.js

@@ -1,5 +1,6 @@
-import { createInterface } from 'node:readline/promises'
-
+import { createInterface } from 'node:readline'
+import { promisify } from 'node:util'
+import { EOL } from 'node:os'
 import ansi from 'ansi-styles'
 
 const kQuestionMark = `${ansi.blue.open}?${ansi.blue.close}`
@@ -13,9 +14,9 @@ const kNext = '⭣'
 const kShowCursor = '\x1B[?25h'
 const kHideCursor = '\x1B[?25l'
 
-function clearLastLine () {
-  process.stdout.moveCursor(0, -1)
-  process.stdout.clearLine()
+function clearLastLine (stdout = process.stdout) {
+  stdout.moveCursor(0, -1)
+  stdout.clearLine()
 }
 
 export async function prompt (message) {
@@ -26,7 +27,7 @@ export async function prompt (message) {
   const { stdin: input, stdout: output } = process
   const rl = createInterface({ input, output })
 
-  const answer = await rl.question(`${ansi.bold.open} ${kPointer} ${message} ${ansi.bold.close}`)
+  const answer = await promisify(rl.question)(`${ansi.bold.open}${kQuestionMark} ${message}${ansi.bold.close} `)
 
   clearLastLine()
   console.log(`${ansi.bold.open}${answer ? kTick : kCross} ${message} ${kPointer} ${ansi.yellow.open}${answer}${ansi.yellow.close}${ansi.bold.close}`)
@@ -44,8 +45,7 @@ export async function select (message, options) {
   if (!options) {
     throw new TypeError('Missing required options')
   }
-
-  const { choices } = options
+  const { choices, ignoreValues, stdout = process.stdout, stdin = process.stdin } = options
 
   if (!choices?.length) {
     throw new TypeError('Missing required param: choices')
@@ -67,13 +67,12 @@ export async function select (message, options) {
     return choice.label.length
   }))
 
-  process.stdout.write(kHideCursor)
-  const { stdin: input, stdout: output } = process
-  const rl = createInterface({ input, output })
+  stdout.write(kHideCursor)
+  const rl = options.stdin && options.stdout ? null : createInterface({ input: stdin, output: stdout })
 
   let activeIndex = 0
 
-  console.log(`${ansi.bold.open}${kQuestionMark} ${message}${ansi.bold.close}`)
+  stdout.write(`${ansi.bold.open}${kQuestionMark} ${message}${ansi.bold.close}${EOL}`)
 
   let lastRender = null
   const render = (initialRender = false, { reset } = {}) => {
@@ -94,14 +93,14 @@ export async function select (message, options) {
 
     if (!initialRender) {
       const linesToClear = lastRender.endIndex - lastRender.startIndex
-      process.stdout.clearLine(1)
-      process.stdout.moveCursor(0, -linesToClear)
-      process.stdout.clearLine(1)
+      stdout.moveCursor(0, -linesToClear)
+      stdout.clearScreenDown()
     }
 
     if (reset) {
-      clearLastLine()
-      clearLastLine()
+      clearLastLine(stdout)
+      clearLastLine(stdout)
+
       return
     }
 
@@ -110,8 +109,8 @@ export async function select (message, options) {
     for (let i = startIndex; i < endIndex; i++) {
       const choice = typeof choices[i] === 'string' ? { value: choices[i], label: choices[i] } : choices[i]
       const prefix = `${startIndex > 0 && i === startIndex ? kPrevious : endIndex < choices.length && i === endIndex - 1 ? kNext : ' '}${i === activeIndex ? kActive : kInactive}`
-      const str = `${prefix}${choice.label.padEnd(longestChoice < 10 ? longestChoice : 0)}${choice.description ? ` - ${choice.description}` : ''}${ansi.reset.open}`
-      console.log(str)
+      const str = `${prefix}${choice.label.padEnd(longestChoice < 10 ? longestChoice : 0)}${choice.description ? ` - ${choice.description}` : ''}${ansi.reset.open}${EOL}`
+      stdout.write(str)
     }
   }
 
@@ -126,19 +125,23 @@ export async function select (message, options) {
         activeIndex = activeIndex === choices.length - 1 ? 0 : activeIndex + 1
         render()
       } else if (key.name === 'return') {
-        process.stdin.off('keypress', onKeypress)
+        stdin.off('keypress', onKeypress)
+
         render(false, { reset: true })
 
-        console.log(`${ansi.bold.open}${kTick} ${message} ${kPointer} ${ansi.yellow.open}${choices[activeIndex].value}${ansi.reset.open}`)
+        const value = choices[activeIndex].value ?? choices[activeIndex]
+        if (!ignoreValues?.includes(value)) {
+          stdout.write(`${ansi.bold.open}${kTick} ${message} ${kPointer} ${ansi.yellow.open}${choices[activeIndex].label ?? choices[activeIndex]}${ansi.reset.open}${EOL}`)
+        }
 
-        process.stderr.write(kShowCursor)
-        rl.close()
+        stdout.write(kShowCursor)
+        rl?.close()
 
-        resolve(choices[activeIndex].value)
+        resolve(value)
       }
     }
 
-    process.stdin.on('keypress', onKeypress)
+    stdin.on('keypress', onKeypress)
   })
 }
 
@@ -156,7 +159,7 @@ export async function confirm (message, options = kDefaultConfirmOptions) {
 
   const tip = initial ? `${ansi.bold.open}Yes${ansi.bold.close}/no` : `yes/${ansi.bold.open}No${ansi.bold.close}`
   const answer = await rl.question(`${kQuestionMark} ${message} ${ansi.grey.open}(${tip})${ansi.grey.close} ${kPointer} `)
-  const result = (!answer && initial) || ['y', 'yes'].includes(answer.toLocaleLowerCase())
+  const result = answer ? ['y', 'yes'].includes(answer.toLocaleLowerCase()) : initial
 
   clearLastLine()
   console.log(`${result ? kTick : kCross} ${message}`)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@topcli/prompts",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Node.js user input library for command-line interfaces.",
   "scripts": {
     "test": "node --test ./test/**.test.js",
@@ -21,7 +21,8 @@
   "type": "module",
   "devDependencies": {
     "snazzy": "^9.0.0",
-    "standard": "^17.0.0"
+    "standard": "^17.0.0",
+    "strip-ansi": "^7.0.1"
   },
   "dependencies": {
     "ansi-styles": "^6.2.1"
@@ -32,8 +33,5 @@
   "bugs": {
     "url": "https://github.com/TopCli/prompts/issues"
   },
-  "homepage": "https://github.com/TopCli/prompts#readme",
-  "publishConfig": {
-    "access": "public"
-  }
+  "homepage": "https://github.com/TopCli/prompts#readme"
 }