@topcli/prompts 1.7.0 → 1.8.1

package/package.json

@@ -1,43 +1,55 @@
-{
-  "name": "@topcli/prompts",
-  "version": "1.7.0",
-  "description": "Node.js user input library for command-line interfaces.",
-  "scripts": {
-    "test": "node --no-warnings=ExperimentalWarning --loader=esmock --test test/",
-    "coverage": "c8 -r html npm run test",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
-  },
-  "main": "./index.js",
-  "keywords": [
-    "node.js",
-    "cli",
-    "prompt"
-  ],
-  "files": [
-    "index.js",
-    "index.d.ts",
-    "src"
-  ],
-  "author": "PierreDemailly <pierredemailly.pro@gmail.com>",
-  "license": "ISC",
-  "type": "module",
-  "devDependencies": {
-    "@nodesecure/eslint-config": "^1.8.0",
-    "@types/node": "^20.8.5",
-    "c8": "^8.0.1",
-    "eslint": "^8.51.0",
-    "esmock": "^2.5.2"
-  },
-  "dependencies": {
-    "@topcli/wcwidth": "^1.0.1",
-    "kleur": "^4.1.5"
-  },
-  "engines": {
-    "node": ">=14"
-  },
-  "bugs": {
-    "url": "https://github.com/TopCli/prompts/issues"
-  },
-  "homepage": "https://github.com/TopCli/prompts#readme"
-}
+{
+  "name": "@topcli/prompts",
+  "version": "1.8.1",
+  "description": "Node.js user input library for command-line interfaces.",
+  "scripts": {
+    "build": "tsup index.ts --format cjs,esm --dts --clean",
+    "prepublishOnly": "npm run build",
+    "test": "glob -c \"tsx --no-warnings=ExperimentalWarning --loader=esmock --test\" \"./test/**/*.test.ts\"",
+    "coverage": "c8 -r html npm run test",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "keywords": [
+    "node.js",
+    "cli",
+    "prompt"
+  ],
+  "files": [
+    "dist"
+  ],
+  "author": "PierreDemailly <pierredemailly.pro@gmail.com>",
+  "license": "ISC",
+  "type": "module",
+  "devDependencies": {
+    "@nodesecure/eslint-config": "^1.9.0",
+    "@types/node": "^20.11.6",
+    "c8": "^9.1.0",
+    "eslint": "^8.56.0",
+    "esmock": "^2.6.3",
+    "glob": "^10.3.10",
+    "tsup": "^8.0.1",
+    "tsx": "^4.7.0",
+    "typescript": "^5.3.3"
+  },
+  "dependencies": {
+    "@topcli/wcwidth": "^1.0.1",
+    "kleur": "^4.1.5"
+  },
+  "engines": {
+    "node": ">=14"
+  },
+  "bugs": {
+    "url": "https://github.com/TopCli/prompts/issues"
+  },
+  "homepage": "https://github.com/TopCli/prompts#readme"
+}

package/index.d.ts

@@ -1,77 +0,0 @@
-export interface SharedOptions {
-  stdin?: NodeJS.ReadStream & {
-    fd: 0;
-  };
-  stdout?: NodeJS.WriteStream & {
-    fd: 1;
-  };
-}
-
-export interface Validator {
-  validate: (input: string) => boolean;
-  error: (input?: string) => string;
-}
-
-export interface QuestionOptions extends SharedOptions {
-  defaultValue?: string;
-  validators?: Validator[];
-  secure?: boolean;
-}
-
-export interface Choice {
-  value: any;
-  label: string;
-  description?: string;
-}
-
-export interface SelectOptions extends SharedOptions  {
-  choices: (Choice | string)[];
-  maxVisible?: number;
-  ignoreValues?: (string | number | boolean)[];
-}
-
-export interface MultiselectOptions extends SharedOptions  {
-  choices: (Choice | string)[];
-  maxVisible?: number;
-  preSelectedChoices?: (Choice | string)[];
-  validators?: Validator[];
-  autocomplete?: boolean;
-  caseSensitive?: boolean;
-}
-
-export interface ConfirmOptions extends SharedOptions  {
-  initial?: boolean;
-}
-
-export function question(message: string, options?: QuestionOptions): Promise<string>;
-export function select(message: string, options: SelectOptions): Promise<string>;
-export function multiselect(message: string, options: MultiselectOptions): Promise<string[]>;
-export function confirm(message: string, options?: ConfirmOptions): Promise<boolean>;
-
-export function required(): Validator;
-
-export class PromptAgent {
-  /**
-   * The prompts answers queue.
-   * When not empty, any prompt will be answered by the first answer in this list.
-   */
-  nextAnswers: Array<string | boolean>;
-
-  static get agent(): PromptAgent;
-
-  /**
-   * Programmatically set the next answer for any prompt (`question()`, `confirm()`, `select()`)
-   *
-   * This is useful for testing.
-   *
-   * @example
-   * ```js
-   * const promptAgent = PromptAgent.agent();
-   * promptAgent.nextAnswer("toto");
-   *
-   * const input = await question("what is your name?");
-   * assert.equal(input, "toto");
-   * ```
-   */
-  nextAnswer(value: string | boolean | Array<string | boolean>): void
-}

package/index.js

@@ -1,30 +0,0 @@
-// Import Internal Dependencies
-import * as prompts from "./src/prompts/index.js";
-import { required } from "./src/validators.js";
-import { PromptAgent } from "./src/prompt-agent.js";
-
-export async function question(message, options = {}) {
-  const questionPrompt = new prompts.QuestionPrompt(message, options);
-
-  return questionPrompt.question();
-}
-
-export async function select(message, options) {
-  const selectPrompt = new prompts.SelectPrompt(message, options);
-
-  return selectPrompt.select();
-}
-
-export async function confirm(message, options) {
-  const confirmPrompt = new prompts.ConfirmPrompt(message, options);
-
-  return confirmPrompt.confirm();
-}
-
-export async function multiselect(message, options) {
-  const multiselectPrompt = new prompts.MultiselectPrompt(message, options);
-
-  return multiselectPrompt.multiselect();
-}
-
-export { required, PromptAgent };

package/src/constants.js

@@ -1,39 +0,0 @@
-// Import Third-party Dependencies
-import kleur from "kleur";
-
-// Import Internal Dependencies
-import { isUnicodeSupported } from "./utils.js";
-
-const kMainSymbols = {
-  tick: "✔",
-  cross: "✖",
-  pointer: "›",
-  previous: "⭡",
-  next: "⭣",
-  active: "●",
-  inactive: "○"
-};
-const kFallbackSymbols = {
-  tick: "√",
-  cross: "×",
-  pointer: ">",
-  previous: "↑",
-  next: "↓",
-  active: "(+)",
-  inactive: "(-)"
-};
-const kSymbols = isUnicodeSupported() || process.env.CI ? kMainSymbols : kFallbackSymbols;
-const kPointer = kleur.gray(kSymbols.pointer);
-
-export const SYMBOLS = {
-  QuestionMark: kleur.blue().bold("?"),
-  Tick: kleur.green().bold(kSymbols.tick),
-  Cross: kleur.red().bold(kSymbols.cross),
-  Pointer: kPointer,
-  Previous: kSymbols.previous,
-  Next: kSymbols.next,
-  ShowCursor: "\x1B[?25h",
-  HideCursor: "\x1B[?25l",
-  Active: kleur.cyan(kSymbols.active),
-  Inactive: kleur.gray(kSymbols.inactive)
-};

package/src/prompt-agent.js

@@ -1,56 +0,0 @@
-// CONSTANTS
-const kPrivateInstancier = Symbol("instancier");
-
-export class PromptAgent {
-  /**
-   * The prompts answers queue.
-   * When not empty, any prompt will be answered by the first answer in this list.
-   *
-   *  @type {string[]}
-   */
-  nextAnswers = [];
-
-  /**
-   * The shared PromptAgent.
-   *
-   * @type {PromptAgent}
-   */
-  static #this;
-
-  static agent() {
-    // eslint-disable-next-line no-return-assign
-    return this.#this ??= new PromptAgent(kPrivateInstancier);
-  }
-
-  constructor(instancier) {
-    if (instancier !== kPrivateInstancier) {
-      throw new Error("Cannot instanciate PromptAgent, use PromptAgent.agent() instead");
-    }
-  }
-
-  /**
-   * Programmatically set the next answer for any prompt (`question()`, `confirm()`, `select()`)
-   *
-   * This is useful for testing.
-   *
-   * @param {string | boolean | Array<string | boolean>} value
-   *
-   * @example
-   * ```js
-   * const promptAgent = PromptAgent.agent();
-   * promptAgent.nextAnswer("toto");
-   *
-   * const input = await question("what is your name?");
-   * assert.equal(input, "toto");
-   * ```
-   */
-  nextAnswer(value) {
-    if (Array.isArray(value)) {
-      this.nextAnswers.push(...value);
-
-      return;
-    }
-
-    this.nextAnswers.push(value);
-  }
-}

package/src/prompts/abstract.js

@@ -1,68 +0,0 @@
-// Import Node.js Dependencies
-import { EOL } from "node:os";
-import { createInterface } from "node:readline";
-import { Writable } from "node:stream";
-
-// Import Internal Dependencies
-import { stripAnsi } from "../utils.js";
-import { PromptAgent } from "../prompt-agent.js";
-
-export class AbstractPrompt {
-  constructor(message, input = process.stdin, output = process.stdout) {
-    if (this.constructor === AbstractPrompt) {
-      throw new Error("AbstractPrompt can't be instantiated.");
-    }
-
-    if (typeof message !== "string") {
-      throw new TypeError(`message must be string, ${typeof message} given.`);
-    }
-
-    this.stdin = input;
-    this.stdout = output;
-    this.message = message;
-    this.history = [];
-    this.agent = PromptAgent.agent();
-    this.mute = false;
-
-    if (this.stdout.isTTY) {
-      this.stdin.setRawMode(true);
-    }
-    this.rl = createInterface({
-      input,
-      output: new Writable({
-        write: (chunk, encoding, callback) => {
-          if (!this.mute) {
-            this.stdout.write(chunk, encoding);
-          }
-          callback();
-        }
-      }),
-      terminal: true
-    });
-  }
-
-  write(data) {
-    const formattedData = stripAnsi(data).replace(EOL, "");
-    if (formattedData) {
-      this.history.push(formattedData);
-    }
-
-    return this.stdout.write(data);
-  }
-
-  clearLastLine() {
-    const lastLine = this.history.pop();
-    if (!lastLine) {
-      return;
-    }
-
-    const lastLineRows = Math.ceil(stripAnsi(lastLine).length / this.stdout.columns);
-
-    this.stdout.moveCursor(-this.stdout.columns, -lastLineRows);
-    this.stdout.clearScreenDown();
-  }
-
-  destroy() {
-    this.rl.close();
-  }
-}

package/src/prompts/confirm.js

@@ -1,135 +0,0 @@
-// Import Node.js Dependencies
-import { EOL } from "node:os";
-
-// Import Third-party Dependencies
-import kleur from "kleur";
-import wcwidth from "@topcli/wcwidth";
-
-// Import Internal Dependencies
-import { AbstractPrompt } from "./abstract.js";
-import { stripAnsi } from "../utils.js";
-import { SYMBOLS } from "../constants.js";
-
-// CONSTANTS
-const kToggleKeys = new Set([
-  "left",
-  "right",
-  "tab",
-  "q",
-  "a",
-  "d",
-  "h",
-  "j",
-  "k",
-  "l",
-  "space"
-]);
-
-export class ConfirmPrompt extends AbstractPrompt {
-  #boundKeyPressEvent;
-  #boundExitEvent;
-
-  constructor(message, options = {}) {
-    const {
-      stdin = process.stdin,
-      stdout = process.stdout,
-      initial = false
-    } = options;
-    super(message, stdin, stdout);
-
-    this.initial = initial;
-    this.selectedValue = initial;
-  }
-
-  #getHint() {
-    const Yes = kleur.bold().underline().cyan("Yes");
-    const No = kleur.bold().underline().cyan("No");
-
-    return this.selectedValue ? `${Yes}/No` : `Yes/${No}`;
-  }
-
-  #render() {
-    this.write(this.#getQuestionQuery());
-  }
-
-  #question() {
-    return new Promise((resolve) => {
-      const questionQuery = this.#getQuestionQuery();
-
-      this.write(questionQuery);
-
-      this.#boundKeyPressEvent = this.#onKeypress.bind(this, resolve);
-      this.stdin.on("keypress", this.#boundKeyPressEvent);
-
-      this.#boundExitEvent = this.#onProcessExit.bind(this);
-      process.once("exit", this.#boundExitEvent);
-    });
-  }
-
-  #onKeypress(resolve, value, key) {
-    this.stdout.moveCursor(
-      -this.stdout.columns,
-      -Math.floor(wcwidth(stripAnsi(this.#getQuestionQuery())) / this.stdout.columns)
-    );
-    this.stdout.clearScreenDown();
-
-    if (key.name === "return") {
-      resolve(this.selectedValue);
-
-      return;
-    }
-
-    if (kToggleKeys.has(key.name)) {
-      this.selectedValue = !this.selectedValue;
-    }
-
-    this.#render();
-  }
-
-  #onProcessExit() {
-    this.stdin.off("keypress", this.#boundKeyPressEvent);
-  }
-
-  #getQuestionQuery() {
-    const query = kleur.bold(`${SYMBOLS.QuestionMark} ${this.message}`);
-
-    return `${query} ${this.#getHint()}`;
-  }
-
-  #onQuestionAnswer() {
-    this.stdout.moveCursor(
-      -this.stdout.columns,
-      -(Math.floor(wcwidth(stripAnsi(this.#getQuestionQuery())) / this.stdout.columns) || 1)
-    );
-    this.stdout.clearScreenDown();
-    this.write(`${this.selectedValue ? SYMBOLS.Tick : SYMBOLS.Cross} ${kleur.bold(this.message)}${EOL}`);
-  }
-
-  async confirm() {
-    if (this.agent.nextAnswers.length > 0) {
-      const answer = this.agent.nextAnswers.shift();
-      this.selectedValue = answer;
-      this.#onQuestionAnswer();
-      this.destroy();
-
-      return answer;
-    }
-
-    this.write(SYMBOLS.HideCursor);
-
-    try {
-      await this.#question();
-      this.#onQuestionAnswer();
-
-      return this.selectedValue;
-    }
-    finally {
-      this.write(SYMBOLS.ShowCursor);
-
-      this.#onProcessExit();
-      process.off("exit", this.#boundExitEvent);
-
-      this.destroy();
-    }
-  }
-}

package/src/prompts/index.js

@@ -1,12 +0,0 @@
-// Import Internal Dependencies
-import { QuestionPrompt } from "./question.js";
-import { ConfirmPrompt } from "./confirm.js";
-import { SelectPrompt } from "./select.js";
-import { MultiselectPrompt } from "./multiselect.js";
-
-export {
-  QuestionPrompt,
-  ConfirmPrompt,
-  SelectPrompt,
-  MultiselectPrompt
-};