@topcli/prompts 0.0.1

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Pierre Demailly
+
+Permission to use, copy, modify, and/or distribute this software for any purpose
+with or without fee is hereby granted, provided that the above copyright notice
+and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
+OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
+THIS SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# prompts
+
+![version](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&url=https://raw.githubusercontent.com/TopCli/prompts/main/package.json&query=$.version&label=Version)
+[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=for-the-badge)](https://github.com/TopCli/prompts/commit-activity)
+[![isc](https://img.shields.io/badge/License-ISC-blue.svg?style=for-the-badge)](https://github.com/TopCli/prompts/blob/main/LICENSE)
+![build](https://img.shields.io/github/actions/workflow/status/TopCli/prompts/node.js.yml?style=for-the-badge)
+
+Node.js user input library for command-line interfaces.
+
+## Requirements
+- [Node.js](https://nodejs.org/en/) v14 or higher
+
+## Getting Started
+
+> **Note** This package is ESM only.
+
+This package is available in the Node Package Repository and can be easily installed with [npm](https://docs.npmjs.com/getting-started/what-is-npm) or [yarn](https://yarnpkg.com).
+
+```bash
+$ npm i @topcli/prompts
+# or
+$ yarn add @topcli/prompts
+```
+
+## Usage exemple
+
+```js
+import { prompt, select, confirm } from '@topcli/prompts'
+
+const name = await prompt('What\'s your name ?')
+const gender = await select('What\'s your gender ?', {
+  choices: [
+    {
+      value: 'M',
+      label: 'Male'
+    },
+    {
+      value: 'F',
+      label: 'Female'
+    },
+  ]
+})
+const isAdult = await confirm('Are you over 18 ?', { initial: true })
+```
+
+## API
+
+### `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>`
+
+Scrollable select depending `maxVisible` (default `8`).
+
+### `confirm(message: string, options?: { initial: boolean }): Promise<string>`
+
+Boolean prompt.
+
+## Interfaces
+
+```ts
+export interface Choice {
+  value: any,
+  label: string,
+  description?: string,
+}
+```

package/index.d.ts

@@ -0,0 +1,8 @@
+export interface Choice {
+  value: any,
+  label: string,
+  description?: string,
+}
+export function prompt(message: string): Promise<string>;
+export function select(message: string, options: { choices: (Choice | string)[], maxVisble?: number }): Promise<string>;
+export function confirm(message: string, options?: { initial: boolean }): Promise<string>;

package/index.js

@@ -0,0 +1,167 @@
+import { createInterface } from 'node:readline/promises'
+
+import ansi from 'ansi-styles'
+
+const kQuestionMark = `${ansi.blue.open}?${ansi.blue.close}`
+const kTick = `${ansi.green.open}✔${ansi.green.close}`
+const kCross = `${ansi.red.open}✖${ansi.red.close}`
+const kPointer = `${ansi.gray.open}›${ansi.gray.close}`
+const kActive = `${ansi.reset.open}${kPointer} `
+const kInactive = `${ansi.gray.open}  `
+const kPrevious = '⭡'
+const kNext = '⭣'
+const kShowCursor = '\x1B[?25h'
+const kHideCursor = '\x1B[?25l'
+
+function clearLastLine () {
+  process.stdout.moveCursor(0, -1)
+  process.stdout.clearLine()
+}
+
+export async function prompt (message) {
+  if (typeof message !== 'string') {
+    throw new TypeError('message must be a string')
+  }
+
+  const { stdin: input, stdout: output } = process
+  const rl = createInterface({ input, output })
+
+  const answer = await rl.question(`${ansi.bold.open} ${kPointer} ${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}`)
+
+  rl.close()
+
+  return answer
+}
+
+export async function select (message, options) {
+  if (typeof message !== 'string') {
+    throw new TypeError('message must be a string')
+  }
+
+  if (!options) {
+    throw new TypeError('Missing required options')
+  }
+
+  const { choices } = options
+
+  if (!choices?.length) {
+    throw new TypeError('Missing required param: choices')
+  }
+
+  const longestChoice = Math.max(...choices.map(choice => {
+    if (typeof choice === 'string') {
+      return choice.length
+    }
+
+    const kRequiredChoiceProperties = ['label', 'value']
+
+    for (const prop of kRequiredChoiceProperties) {
+      if (!choice[prop]) {
+        throw new TypeError(`Missing ${prop} for choice ${JSON.stringify(choice)}`)
+      }
+    }
+
+    return choice.label.length
+  }))
+
+  process.stdout.write(kHideCursor)
+  const { stdin: input, stdout: output } = process
+  const rl = createInterface({ input, output })
+
+  let activeIndex = 0
+
+  console.log(`${ansi.bold.open}${kQuestionMark} ${message}${ansi.bold.close}`)
+
+  let lastRender = null
+  const render = (initialRender = false, { reset } = {}) => {
+    const getVisibleChoices = (currentIndex, total, maxVisible) => {
+      maxVisible = maxVisible || total
+
+      let startIndex = Math.min(total - maxVisible, currentIndex - Math.floor(maxVisible / 2))
+      if (startIndex < 0) {
+        startIndex = 0
+      }
+
+      const endIndex = Math.min(startIndex + maxVisible, total)
+
+      return { startIndex, endIndex }
+    }
+
+    const { startIndex, endIndex } = getVisibleChoices(activeIndex, choices.length, options.maxVisible || 8)
+
+    if (!initialRender) {
+      const linesToClear = lastRender.endIndex - lastRender.startIndex
+      process.stdout.clearLine(1)
+      process.stdout.moveCursor(0, -linesToClear)
+      process.stdout.clearLine(1)
+    }
+
+    if (reset) {
+      clearLastLine()
+      clearLastLine()
+      return
+    }
+
+    lastRender = { startIndex, endIndex }
+
+    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)
+    }
+  }
+
+  render(true)
+
+  return new Promise((resolve) => {
+    const onKeypress = (value, key) => {
+      if (key.name === 'up') {
+        activeIndex = activeIndex === 0 ? choices.length - 1 : activeIndex - 1
+        render()
+      } else if (key.name === 'down') {
+        activeIndex = activeIndex === choices.length - 1 ? 0 : activeIndex + 1
+        render()
+      } else if (key.name === 'return') {
+        process.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}`)
+
+        process.stderr.write(kShowCursor)
+        rl.close()
+
+        resolve(choices[activeIndex].value)
+      }
+    }
+
+    process.stdin.on('keypress', onKeypress)
+  })
+}
+
+const kDefaultConfirmOptions = { initial: false }
+
+export async function confirm (message, options = kDefaultConfirmOptions) {
+  if (typeof message !== 'string') {
+    throw new TypeError('message must be a string')
+  }
+
+  const { initial } = { kDefaultConfirmOptions, ...options }
+
+  const { stdin: input, stdout: output } = process
+  const rl = createInterface({ input, output })
+
+  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())
+
+  clearLastLine()
+  console.log(`${result ? kTick : kCross} ${message}`)
+
+  rl.close()
+
+  return result
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@topcli/prompts",
+  "version": "0.0.1",
+  "description": "Node.js user input library for command-line interfaces.",
+  "scripts": {
+    "test": "node --test ./test/**.test.js",
+    "lint": "standard --fix | snazzy"
+  },
+  "main": "./index.js",
+  "keywords": [
+    "node.js",
+    "cli",
+    "prompt"
+  ],
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "author": "PierreDemailly <pierredemailly.pro@gmail.com>",
+  "license": "ISC",
+  "type": "module",
+  "devDependencies": {
+    "snazzy": "^9.0.0",
+    "standard": "^17.0.0"
+  },
+  "dependencies": {
+    "ansi-styles": "^6.2.1"
+  },
+  "engines": {
+    "node": ">=14"
+  },
+  "bugs": {
+    "url": "https://github.com/TopCli/prompts/issues"
+  },
+  "homepage": "https://github.com/TopCli/prompts#readme",
+  "publishConfig": {
+    "access": "public"
+  }
+}