@topcli/prompts 1.6.0 → 1.7.0

package/README.md

@@ -12,7 +12,8 @@ Node.js user prompt library for command-line interfaces.
 
 ## Getting Started
 
-> **Note** This package is ESM only.
+> [!CAUTION]
+> 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).
 
@@ -94,7 +95,7 @@ Use `ignoreValues` to skip result render & clear lines after a selected one.
 multiselect(message: string, options: MultiselectOptions): Promise<[string]>
 ```
 
-Scrollable multiselect depending `maxVisible` (default `8`).  
+Scrollable multiselect depending `maxVisible` (default `8`).<br>
 Use `preSelectedChoices` to pre-select choices.
 
 Use `validators` to handle user input.
@@ -110,6 +111,8 @@ const os = await multiselect('Choose OS', {
 
 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`
+
 ### `confirm()`
 
 ```ts
@@ -136,7 +139,7 @@ assert.equal(input, "John");
 > - When using `question()`, `validators` functions will not be executed.
 > - When using `select()`, the answer can be different from the available choices.
 > - When using `confirm()`, the answer can be any type other than boolean.
-> - etc  
+> - etc<br>
 > **Use with caution**
 
 ## Interfaces
@@ -180,6 +183,7 @@ export interface MultiselectOptions extends SharedOptions  {
   preSelectedChoices?: (Choice | string)[];
   validators?: Validator[];
   autocomplete?: boolean;
+  caseSensitive?: boolean;
 }
 
 export interface ConfirmOptions extends SharedOptions  {
@@ -196,7 +200,7 @@ export interface ConfirmOptions extends SharedOptions  {
   <tbody>
     <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/PierreDemailly"><img src="https://avatars.githubusercontent.com/u/39910767?v=4?s=100" width="100px;" alt="PierreDemailly"/><br /><sub><b>PierreDemailly</b></sub></a><br /><a href="https://github.com/TopCli/prompts/commits?author=PierreDemailly" title="Code">💻</a> <a href="https://github.com/TopCli/prompts/commits?author=PierreDemailly" title="Tests">⚠️</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/thomas-gentilhomme/"><img src="https://avatars.githubusercontent.com/u/4438263?v=4?s=100" width="100px;" alt="Gentilhomme"/><br /><sub><b>Gentilhomme</b></sub></a><br /><a href="https://github.com/TopCli/prompts/pulls?q=is%3Apr+reviewed-by%3Afraxken" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/thomas-gentilhomme/"><img src="https://avatars.githubusercontent.com/u/4438263?v=4?s=100" width="100px;" alt="Gentilhomme"/><br /><sub><b>Gentilhomme</b></sub></a><br /><a href="https://github.com/TopCli/prompts/pulls?q=is%3Apr+reviewed-by%3Afraxken" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/TopCli/prompts/commits?author=fraxken" title="Code">💻</a> <a href="https://github.com/TopCli/prompts/commits?author=fraxken" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://tonygo.dev"><img src="https://avatars0.githubusercontent.com/u/22824417?v=4?s=100" width="100px;" alt="Tony Gorez"/><br /><sub><b>Tony Gorez</b></sub></a><br /><a href="https://github.com/TopCli/prompts/pulls?q=is%3Apr+reviewed-by%3Atony-go" title="Reviewed Pull Requests">👀</a></td>
       <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>

package/index.d.ts

@@ -36,6 +36,7 @@ export interface MultiselectOptions extends SharedOptions  {
   preSelectedChoices?: (Choice | string)[];
   validators?: Validator[];
   autocomplete?: boolean;
+  caseSensitive?: boolean;
 }
 
 export interface ConfirmOptions extends SharedOptions  {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@topcli/prompts",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Node.js user input library for command-line interfaces.",
   "scripts": {
     "test": "node --no-warnings=ExperimentalWarning --loader=esmock --test test/",

package/src/prompts/multiselect.js

@@ -28,23 +28,35 @@ export class MultiselectPrompt extends AbstractPrompt {
   }
 
   get filteredChoices() {
-    return this.options.autocomplete && this.autocompleteValue.length > 0 ? this.choices.filter((choice) => {
-      if (typeof choice === "string") {
-        if (this.autocompleteValue.includes(" ")) {
-          return this.autocompleteValue.split(" ").every((word) => choice.includes(word)) ||
-          choice.includes(this.autocompleteValue);
-        }
+    if (!(this.options.autocomplete && this.autocompleteValue.length > 0)) {
+      return this.choices;
+    }
 
-        return choice.includes(this.autocompleteValue);
-      }
+    const isCaseSensitive = this.options.caseSensitive;
+    const autocompleteValue = isCaseSensitive ? this.autocompleteValue : this.autocompleteValue.toLowerCase();
 
-      if (this.autocompleteValue.includes(" ")) {
-        return this.autocompleteValue.split(" ").every((word) => choice.label.includes(word)) ||
-        choice.label.includes(this.autocompleteValue);
-      }
+    return this.choices.filter((choice) => this.#filterChoice(choice, autocompleteValue, isCaseSensitive));
+  }
+
+  #filterChoice(choice, autocompleteValue, isCaseSensitive) {
+    // eslint-disable-next-line no-nested-ternary
+    const choiceValue = typeof choice === "string" ?
+      (isCaseSensitive ? choice : choice.toLowerCase()) :
+      (isCaseSensitive ? choice.label : choice.label.toLowerCase());
 
-      return choice.label.includes(this.autocompleteValue);
-    }) : this.choices;
+    if (autocompleteValue.includes(" ")) {
+      return this.#filterMultipleWords(choiceValue, autocompleteValue, isCaseSensitive);
+    }
+
+    return choiceValue.includes(autocompleteValue);
+  }
+
+  #filterMultipleWords(choiceValue, autocompleteValue, isCaseSensitive) {
+    return autocompleteValue.split(" ").every((word) => {
+      const wordValue = isCaseSensitive ? word : word.toLowerCase();
+
+      return choiceValue.includes(wordValue) || choiceValue.includes(autocompleteValue);
+    });
   }
 
   get longestChoice() {
@@ -109,6 +121,7 @@ export class MultiselectPrompt extends AbstractPrompt {
       });
 
       if (choiceIndex === -1) {
+        this.destroy();
         throw new Error(`Invalid pre-selected choice: ${choice.value ?? choice}`);
       }