@topcli/prompts 1.8.1 → 1.10.0

package/README.md

@@ -1,11 +1,11 @@
-# prompts
+<div align="center">
+  <img src="./public/banner.png" alt="@topcli/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 prompt library for command-line interfaces.
+  ![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)
+</div>
 
 ## Requirements
 - [Node.js](https://nodejs.org/en/) v18 or higher
@@ -49,9 +49,13 @@ question(message: string, options?: PromptOptions): Promise<string>
 ```
 
 Simple prompt, similar to `rl.question()` with an improved UI.
+
 Use `options.secure` if you need to hide both input and answer.
+
 Use `options.validators` to handle user input.
 
+Use `options.signal` to set an `AbortSignal` (throws a [AbortError](#aborterror)).
+
 **Example**
 
 ```js
@@ -84,8 +88,17 @@ select(message: string, options: SelectOptions): Promise<string>
 ```
 
 Scrollable select depending `maxVisible` (default `8`).
+
 Use `ignoreValues` to skip result render & clear lines after a selected one.
 
+Use `validators` to handle user input.
+
+Use `autocomplete` to allow filtered choices. This can be useful for a large list of choices.
+
+Use `caseSensitive` to make autocomplete filters case sensitive. Default `false`
+
+Use `options.signal` to set an `AbortSignal` (throws a [AbortError](#aborterror)).
+
 ### `multiselect()`
 
 ```ts
@@ -97,18 +110,13 @@ Use `preSelectedChoices` to pre-select choices.
 
 Use `validators` to handle user input.
 
-**Example**
+Use `showHint: false` to disable hint (this option is truthy by default).
 
-```js
-const os = await multiselect('Choose OS', {
-  choices: ["linux", "mac", "windows"]
-  validators: [required()]
-});
-```
+Use `autocomplete` to allow filtered choices. This can be useful for a large list of choices.
 
-Use `autocomplete` to allow filtered choices. This can be usefull for a large list of choices.
+Use `caseSensitive` to make autocomplete filters case sensitive. Default `false`.
 
-Use `caseSensitive` to make autocomplete filters case sensitive. Default `false`
+Use `options.signal` to set an `AbortSignal` (throws a [AbortError](#aborterror)).
 
 ### `confirm()`
 
@@ -118,6 +126,8 @@ confirm(message: string, options?: ConfirmOptions): Promise<boolean>
 
 Boolean prompt, return `options.initial` if user input is different from `y`/`yes`/`n`/`no` (case insensitive), (default `false`).
 
+Use `options.signal` to set an `AbortSignal` (throws a [AbortError](#aborterror)).
+
 ### `PromptAgent`
 
 The `PromptAgent` class allows to programmatically set the next answers for any prompt function, this can be useful for testing.
@@ -139,16 +149,35 @@ assert.equal(input, "John");
 > - etc<br>
 > **Use with caution**
 
+## Errors
+
+### `AbortError`
+
+```ts
+export class AbortError extends Error {
+  constructor(message: string) {
+    super(message);
+    this.name = "AbortError";
+  }
+}
+```
+
 ## Interfaces
 
 ```ts
-export interface SharedOptions {
-  stdin?: NodeJS.ReadStream & {
-    fd: 0;
-  };
-  stdout?: NodeJS.WriteStream & {
-    fd: 1;
-  };
+type Stdin = NodeJS.ReadStream & {
+  fd: 0;
+};
+
+type Stdout = NodeJS.WriteStream & {
+  fd: 1;
+}
+
+export interface AbstractPromptOptions {
+  stdin?: Stdin;
+  stdout?: Stdout;
+  message: string;
+  sginal?: AbortSignal;
 }
 
 export interface PromptValidator<T = string | string[] | boolean> {
@@ -172,6 +201,9 @@ export interface SelectOptions extends SharedOptions  {
   choices: (Choice | string)[];
   maxVisible?: number;
   ignoreValues?: (string | number | boolean)[];
+  validators?: Validator[];
+  autocomplete?: boolean;
+  caseSensitive?: boolean;
 }
 
 export interface MultiselectOptions extends SharedOptions  {
@@ -181,6 +213,7 @@ export interface MultiselectOptions extends SharedOptions  {
   validators?: Validator[];
   autocomplete?: boolean;
   caseSensitive?: boolean;
+  showHint?: boolean;
 }
 
 export interface ConfirmOptions extends SharedOptions  {
@@ -202,6 +235,10 @@ export interface ConfirmOptions extends SharedOptions  {
       <td align="center" valign="top" width="14.28%"><a href="http://sofiand.github.io/portfolio-client/"><img src="https://avatars.githubusercontent.com/u/39944043?v=4?s=100" width="100px;" alt="Yefis"/><br /><sub><b>Yefis</b></sub></a><br /><a href="https://github.com/TopCli/prompts/commits?author=SofianD" title="Code">💻</a> <a href="https://github.com/TopCli/prompts/commits?author=SofianD" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://justie.dev"><img src="https://avatars.githubusercontent.com/u/7118300?v=4?s=100" width="100px;" alt="Ben"/><br /><sub><b>Ben</b></sub></a><br /><a href="https://github.com/TopCli/prompts/commits?author=JUSTIVE" title="Documentation">📖</a> <a href="#maintenance-JUSTIVE" title="Maintenance">🚧</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/ncukondo"><img src="https://avatars.githubusercontent.com/u/17022138?v=4?s=100" width="100px;" alt="Takeshi Kondo"/><br /><sub><b>Takeshi Kondo</b></sub></a><br /><a href="#maintenance-ncukondo" title="Maintenance">🚧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/FredGuiou"><img src="https://avatars.githubusercontent.com/u/99122562?v=4?s=100" width="100px;" alt="FredGuiou"/><br /><sub><b>FredGuiou</b></sub></a><br /><a href="https://github.com/TopCli/prompts/commits?author=FredGuiou" title="Code">💻</a> <a href="https://github.com/TopCli/prompts/commits?author=FredGuiou" title="Tests">⚠️</a> <a href="https://github.com/TopCli/prompts/commits?author=FredGuiou" title="Documentation">📖</a></td>
+    </tr>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/noxify"><img src="https://avatars.githubusercontent.com/u/521777?v=4?s=100" width="100px;" alt="Marcus Reinhardt"/><br /><sub><b>Marcus Reinhardt</b></sub></a><br /><a href="https://github.com/TopCli/prompts/commits?author=noxify" title="Code">💻</a> <a href="https://github.com/TopCli/prompts/commits?author=noxify" title="Tests">⚠️</a> <a href="https://github.com/TopCli/prompts/commits?author=noxify" title="Documentation">📖</a></td>
     </tr>
   </tbody>
 </table>