@topcli/prompts 1.0.1 → 1.1.0

package/README.md

@@ -100,6 +100,7 @@ Boolean prompt, return `options.initial` if user input is different from "y"/"ye
 
 ```ts
 export interface PromptOptions {
+  defaultValue?: string;
   validators?: {
     validate: (input: string) => boolean;
     error: (input: string) => string;

package/index.d.ts

@@ -1,4 +1,5 @@
 export interface PromptOptions {
+  defaultValue?: string;
   validators?: Validator[];
 }
 

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@topcli/prompts",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Node.js user input library for command-line interfaces.",
   "scripts": {
-    "test": "node --loader=esmock --test ./test/**.test.js",
+    "test": "node --loader=esmock --test test/",
     "coverage": "c8 -r html npm run test",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix"
@@ -29,7 +29,8 @@
     "esmock": "^2.1.0"
   },
   "dependencies": {
-    "ansi-styles": "^6.2.1",
+    "is-unicode-supported": "^1.3.0",
+    "kleur": "^4.1.5",
     "strip-ansi": "^7.0.1"
   },
   "engines": {

package/src/confirm-prompt.js

@@ -2,7 +2,7 @@
 import { EOL } from "node:os";
 
 // Import Third-party Dependencies
-import ansi from "ansi-styles";
+import kleur from "kleur";
 
 // Import Internal Dependencies
 import { AbstractPrompt } from "./abstract-prompt.js";
@@ -17,9 +17,9 @@ export class ConfirmPrompt extends AbstractPrompt {
     } = options;
     super(message, stdin, stdout);
 
-    const Yes = `${ansi.bold.open}Yes${ansi.bold.close}`;
-    const No = `${ansi.bold.open}No${ansi.bold.close}`;
-    const tip = initial ? `${Yes}/no` : `yes/${No}`;
+    const Yes = kleur.bold("Yes");
+    const No = kleur.bold("No");
+    this.tip = kleur.gray(initial ? `(${Yes}/no)` : `(yes/${No})`);
 
     this.initial = initial;
   }
@@ -39,14 +39,14 @@ export class ConfirmPrompt extends AbstractPrompt {
   }
 
   #getQuestionQuery() {
-    const query = `${ansi.bold.open}${SYMBOLS.QuestionMark} ${this.message}${ansi.bold.close}`;
+    const query = kleur.bold(`${SYMBOLS.QuestionMark} ${this.message}`);
 
-    return `${query} ${ansi.grey.open}(${this.initial ? "Yes/no" : "yes/No"})${ansi.grey.close} `;
+    return `${query} ${this.tip} `;
   }
 
   #onQuestionAnswer() {
     this.clearLastLine();
-    this.write(`${this.answer ? SYMBOLS.Tick : SYMBOLS.Cross} ${this.message}${EOL}`);
+    this.write(`${this.answer ? SYMBOLS.Tick : SYMBOLS.Cross} ${kleur.bold(this.message)}${EOL}`);
   }
 
   #validateResult(result) {

package/src/constants.js

@@ -1,17 +1,31 @@
 // Import Third-party Dependencies
-import ansi from "ansi-styles";
+import kleur from "kleur";
+import isUnicodeSupported from "is-unicode-supported";
 
-const kPointer = `${ansi.gray.open}›${ansi.gray.close}`;
+const kMainSymbols = {
+  tick: "✔",
+  cross: "✖",
+  pointer: "›",
+  previous: "⭡",
+  next: "⭣"
+};
+const kFallbackSymbols = {
+  tick: "√",
+  cross: "×",
+  pointer: ">",
+  previous: "↑",
+  next: "↓"
+};
+const kSymbols = isUnicodeSupported() ? kMainSymbols : kFallbackSymbols;
+const kPointer = kleur.gray(kSymbols.pointer);
 
 export const SYMBOLS = {
-  QuestionMark: `${ansi.blue.open}?${ansi.blue.close}`,
-  Tick: `${ansi.green.open}✔${ansi.green.close}`,
-  Cross: `${ansi.red.open}✖${ansi.red.close}`,
+  QuestionMark: kleur.blue().bold("?"),
+  Tick: kleur.green().bold(kSymbols.tick),
+  Cross: kleur.red().bold(kSymbols.cross),
   Pointer: kPointer,
-  Active: `${ansi.reset.open}${kPointer}`,
-  Inactive: `${ansi.gray.open}`,
-  Previous: "⭡",
-  Next: "⭣",
+  Previous: kSymbols.previous,
+  Next: kSymbols.next,
   ShowCursor: "\x1B[?25h",
   HideCursor: "\x1B[?25l"
 };

package/src/question-prompt.js

@@ -2,8 +2,7 @@
 import { EOL } from "node:os";
 
 // Import Third-party Dependencies
-import ansi from "ansi-styles";
-import stripAnsi from "strip-ansi";
+import kleur from "kleur";
 
 // Import Internal Dependencies
 import { AbstractPrompt } from "./abstract-prompt.js";
@@ -13,12 +12,22 @@ export class QuestionPrompt extends AbstractPrompt {
   #validators;
 
   constructor(message, options = {}) {
-    const { stdin = process.stdin, stdout = process.stdout, validators = [] } = options;
+    const {
+      stdin = process.stdin,
+      stdout = process.stdout,
+      defaultValue,
+      validators = []
+    } = options;
+
     super(message, stdin, stdout);
 
+    if (defaultValue && typeof defaultValue !== "string") {
+      throw new TypeError("defaultValue must be a string");
+    }
+
+    this.defaultValue = defaultValue;
+    this.tip = this.defaultValue ? ` (${this.defaultValue})` : "";
     this.#validators = validators;
-    this.questionPrefix = `${ansi.bold.open}${SYMBOLS.QuestionMark} `;
-    this.questionSuffix = `${ansi.bold.close} `;
     this.questionSuffixError = "";
   }
 
@@ -35,19 +44,19 @@ export class QuestionPrompt extends AbstractPrompt {
   }
 
   #getQuestionQuery() {
-    return `${this.questionPrefix}${this.message}${this.questionSuffix}${this.questionSuffixError}`;
+    return `${kleur.bold(`${SYMBOLS.QuestionMark} ${this.message}${this.tip}`)} ${this.questionSuffixError}`;
   }
 
   #setQuestionSuffixError(error) {
-    const suffix = `${ansi.red.open}[${error}]${ansi.red.close} `;
+    const suffix = kleur.red(`[${error}] `);
     this.questionSuffixError = suffix;
   }
 
   #writeAnswer() {
-    const prefix = `${ansi.bold.open}${this.answer ? SYMBOLS.Tick : SYMBOLS.Cross}`;
-    const suffix = `${ansi.yellow.close}${ansi.bold.close}${EOL}`;
+    const prefix = this.answer ? SYMBOLS.Tick : SYMBOLS.Cross;
+    const answer = kleur.yellow(this.answer ?? "");
 
-    this.write(`${prefix} ${this.message} ${SYMBOLS.Pointer} ${ansi.yellow.open}${this.answer ?? ""}${suffix}`);
+    this.write(`${prefix} ${kleur.bold(this.message)} ${SYMBOLS.Pointer} ${answer}${EOL}`);
   }
 
   #onQuestionAnswer() {
@@ -69,6 +78,10 @@ export class QuestionPrompt extends AbstractPrompt {
   async question() {
     this.answer = await this.#question();
 
+    if (this.answer === "" && this.defaultValue) {
+      this.answer = this.defaultValue;
+    }
+
     this.#onQuestionAnswer();
 
     while (this.answer?.constructor.name === "Promise") {

package/src/select-prompt.js

@@ -2,7 +2,7 @@
 import { EOL } from "node:os";
 
 // Import Third-party Dependencies
-import ansi from "ansi-styles";
+import kleur from "kleur";
 
 // Import Internal Dependencies
 import { AbstractPrompt } from "./abstract-prompt.js";
@@ -82,6 +82,7 @@ export class SelectPrompt extends AbstractPrompt {
 
     for (let choiceIndex = startIndex; choiceIndex < endIndex; choiceIndex++) {
       const choice = this.#getFormattedChoice(choiceIndex);
+      const isChoiceSelected = choiceIndex === this.activeIndex;
       const showPreviousChoicesArrow = startIndex > 0 && choiceIndex === startIndex;
       const showNextChoicesArrow = endIndex < this.choices.length && choiceIndex === endIndex - 1;
 
@@ -93,20 +94,21 @@ export class SelectPrompt extends AbstractPrompt {
         prefixArrow = SYMBOLS.Next;
       }
 
-      const prefix = `${prefixArrow}${choiceIndex === this.activeIndex ? `${SYMBOLS.Active} ` : `${SYMBOLS.Inactive}  `}`;
+      const prefix = `${prefixArrow}${isChoiceSelected ? `${SYMBOLS.Pointer} ` : "  "}`;
       const formattedLabel = choice.label.padEnd(
         this.longestChoice < 10 ? this.longestChoice : 0
       );
       const formattedDescription = choice.description ? ` - ${choice.description}` : "";
-      const str = `${prefix}${formattedLabel}${formattedDescription}${ansi.reset.open}${EOL}`;
+      const color = isChoiceSelected ? kleur.white().bold : kleur.gray;
+      const str = color(`${prefix}${formattedLabel}${formattedDescription}${EOL}`);
 
       this.write(str);
     }
   }
 
   #showAnsweredQuestion(choice) {
-    const prefix = `${ansi.bold.open}${SYMBOLS.Tick} ${this.message} ${SYMBOLS.Pointer}`;
-    const formattedChoice = `${ansi.yellow.open}${choice.label ?? choice}${ansi.reset.open}`;
+    const prefix = `${SYMBOLS.Tick} ${kleur.bold(this.message)} ${SYMBOLS.Pointer}`;
+    const formattedChoice = kleur.yellow(choice.label ?? choice);
 
     this.write(`${prefix} ${formattedChoice}${EOL}`);
   }
@@ -175,6 +177,6 @@ export class SelectPrompt extends AbstractPrompt {
   }
 
   #showQuestion() {
-    this.write(`${ansi.bold.open}${SYMBOLS.QuestionMark} ${this.message}${ansi.bold.close}${EOL}`);
+    this.write(`${SYMBOLS.QuestionMark} ${kleur.bold(this.message)}${EOL}`);
   }
 }