@reliverse/rempts 1.7.27 → 1.7.29

package/README.md

@@ -6,7 +6,8 @@
 
 ## Features
 
-- 😘 drop-in alternative to `citty` + built-in prompts
+- 😘 drop-in to libraries like `unjs/citty` and `@clack/prompts`
+- 📝 includes comprehensive set of built-in cli prompts
 - 📂 file-based commands (app-router style by default)
 - 🫂 rempts keeps you from fighting with your CLI tool
 - 🏎️ prompt engine that *feels* modern — and actually is
@@ -60,7 +61,7 @@ import {
   // ...prompts
   defineCommand, runMain, defineArgs,
   inputPrompt, selectPrompt, multiselectPrompt, numberPrompt,
-  confirmPrompt, togglePrompt, spinnerTaskPrompt, progressTaskPrompt,
+  confirmPrompt, togglePrompt, taskSpinPrompt, taskProgressPrompt,
   startPrompt, endPrompt, resultPrompt, nextStepsPrompt,
   // ...hooks
   useSpinner,
@@ -79,25 +80,32 @@ import {
 
 | Prompt                    | Description                                               |
 |---------------------------|-----------------------------------------------------------|
+| `useSpinner`              | Start/stop spinner |
 | `inputPrompt`             | Single-line input (with mask support, e.g. for passwords) |
 | `selectPrompt`            | Single-choice radio menu                                  |
 | `multiselectPrompt`       | Multi-choice checkbox menu                                |
 | `numberPrompt`            | Type-safe number input                                    |
 | `confirmPrompt`           | Yes/No toggle                                             |
 | `togglePrompt`            | Custom on/off toggles                                     |
-| `progressTaskPrompt`      | Progress bar for async tasks                              |
+| `taskProgressPrompt`      | Progress bar for async tasks                              |
 | `resultPrompt`            | Show results in a styled box                              |
 | `nextStepsPrompt`         | Show next steps in a styled list                          |
 | `startPrompt`/`endPrompt` | Makes CLI start/end flows look nice                       |
-| `spinnerTaskPrompt`       | Async loader with spinner (possibly will be deprecated)   |
+| `taskSpinPrompt`       | Async loader with spinner (possibly will be deprecated)   |
 | `datePrompt`              | Date input with format validation                         |
 | `anykeyPrompt`            | Wait for any keypress                                     |
 
-### Hooks
+### Aliases
 
-| Hook         | Description        |
-|--------------|--------------------|
-| `useSpinner` | Start/stop spinner |
+To help you migrate from the different CLI frameworks, `@reliverse/rempts` has some aliases for the most popular prompts.
+
+| Prompt                | Aliases         |
+|-----------------------|-----------------|
+| `useSpinner`          | `spinner`       |
+| `selectPrompt`        | `select`        |
+| `multiselectPrompt`   | `multiselect`   |
+| `inputPrompt`         | `text`, `input` |
+| `@reliverse/relinka`  | `log`           |
 
 ### Notices
 
@@ -124,6 +132,23 @@ async function main() {
     defaultValue: "my-cool-project",
   });
 
+  const spinner = useSpinner({
+    text: "Loading...",
+    indicator: "timer", // or "dots"
+    frames: ["◒", "◐", "◓", "◑"], // custom frames
+    delay: 80, // custom delay
+    onCancel: () => {
+      console.log("Operation cancelled");
+    },
+    cancelMessage: "Operation cancelled by user",
+    errorMessage: "Operation failed",
+    signal: abortController.signal,
+  }).start();
+
+  // The spinner will show:
+  // ◒  Loading... [5s]
+  // With animated frames and timer
+
   const framework = await selectPrompt({
     title: "Pick your framework",
     options: [
@@ -140,6 +165,57 @@ async function main() {
 await main();
 ```
 
+**Available spinner options:**
+
+| Option | Description |
+|--------|-------------|
+| `cancelMessage` | The message to display when the spinner is cancelled |
+| `color` | The color of the spinner |
+| `delay` | The delay between frames |
+| `errorMessage` | The message to display when the spinner fails |
+| `failText` | The text to display when the spinner fails |
+| `frames` | The frames to use for the spinner |
+| `hideCursor` | Whether to hide the cursor |
+| `indicator` | The indicator to use for the spinner |
+| `onCancel` | The function to call when the spinner is cancelled |
+| `prefixText` | The text to display before the spinner |
+| `signal` | The signal to use for the spinner |
+| `silent` | Whether to hide the spinner |
+| `spinner` | The spinner to use for the spinner |
+| `successText` | The text to display when the spinner succeeds |
+| `text` | The text to display next to the spinner |
+
+**Available indicator options:**
+
+| Option | Description |
+|--------|-------------|
+| `timer` | The timer indicator |
+| `dots` | The dots indicator |
+
+**Available signal options:**
+
+| Option | Description |
+|--------|-------------|
+| `abortController.signal` | The signal to use for the spinner |
+
+**Available frames options:**
+
+| Option | Description |
+|--------|-------------|
+| `["◒", "◐", "◓", "◑"]` | The frames to use for the spinner |
+
+**Available delay options:**
+
+| Option | Description |
+|--------|-------------|
+| `80` | The delay between frames |
+
+**Available onCancel options:**
+
+| Option | Description |
+|--------|-------------|
+| `() => { console.log("Operation cancelled"); }` | The function to call when the spinner is cancelled |
+
 ## Launcher
 
 ### Terminology

package/bin/components/aliases/aliases-mod.d.ts

@@ -0,0 +1,11 @@
+import type { InputPromptOptions } from "../../types.js";
+export declare const password: (options: Omit<InputPromptOptions, "mode">) => any;
+export declare const multiselect: any;
+export declare const select: any;
+export declare const input: any;
+export declare const text: any;
+export declare const startPrompt: any;
+export declare const intro: any;
+export declare const endPrompt: any;
+export declare const outro: any;
+export declare const spinner: any;

package/bin/components/aliases/aliases-mod.js

@@ -0,0 +1,16 @@
+import { inputPrompt } from "../input/input-prompt.js";
+import { introPrompt } from "../intro/intro-start.js";
+import { outroPrompt } from "../outro/outro-end.js";
+import { multiselectPrompt } from "../select/multiselect-prompt.js";
+import { selectPrompt } from "../select/select-prompt.js";
+import { useSpinner } from "../spinner/spinner-mod.js";
+export const password = (options) => inputPrompt({ ...options, mode: "password" });
+export const multiselect = multiselectPrompt;
+export const select = selectPrompt;
+export const input = inputPrompt;
+export const text = inputPrompt;
+export const startPrompt = introPrompt;
+export const intro = introPrompt;
+export const endPrompt = outroPrompt;
+export const outro = outroPrompt;
+export const spinner = useSpinner;

package/bin/components/{visual/animate → animate}/animate.d.ts

@@ -1,5 +1,5 @@
 import { type Animation, type AnimationName } from "@figliolia/chalk-animation";
-import type { BorderColorName, ColorName, MsgType, TypographyName } from "../../../types.js";
+import type { BorderColorName, ColorName, MsgType, TypographyName } from "../../types.js";
 export declare const animationMap: Record<AnimationName, (text: string) => Animation>;
 export declare function animateText({ title, anim, delay, type, titleColor, titleTypography, border, borderColor, horizontalLineLength, }: {
     title: string;

package/bin/components/{visual/animate → animate}/animate.js

@@ -2,11 +2,11 @@ import {
   ChalkAnimation
 } from "@figliolia/chalk-animation";
 import { relinka } from "@reliverse/relinka";
-import { msg } from "../../msg-fmt/messages.js";
+import { msg } from "../msg-fmt/messages.js";
 import {
   deleteLastLine,
   getTerminalWidth
-} from "../../msg-fmt/terminal.js";
+} from "../msg-fmt/terminal.js";
 export const animationMap = {
   rainbow: ChalkAnimation.rainbow,
   pulse: ChalkAnimation.pulse,

package/bin/components/anykey/anykey-mod.d.ts

@@ -1,5 +1,5 @@
 import type { ColorName } from "../../types.js";
-type Options = {
+interface Options {
     ctrlC?: number | false | "reject";
     preserveLog?: boolean;
     hideMessage?: boolean;
@@ -7,6 +7,6 @@ type Options = {
     streamDelay?: number;
     color?: ColorName;
     placeholderColor?: ColorName;
-};
+}
 export declare function anykeyPrompt(message?: string, options?: Options): Promise<void>;
 export {};

package/bin/components/anykey/anykey-mod.js

@@ -1,7 +1,7 @@
 import logUpdate from "log-update";
 import { cursor } from "sisteransi";
 import { fmt } from "../msg-fmt/messages.js";
-import { endPrompt } from "../st-end/end.js";
+import { outroPrompt } from "../outro/outro-end.js";
 import { streamText } from "../../utils/stream-text.js";
 const DEFAULT_MESSAGE = "Press any key to continue...";
 const CTRL_C_CODE = 3;
@@ -82,7 +82,7 @@ export async function anykeyPrompt(message = DEFAULT_MESSAGE, options = {}) {
     };
     const handleCtrlC = () => {
       cleanup();
-      void endPrompt({
+      void outroPrompt({
         title: "\u270B User pressed Ctrl+C, exiting...",
         titleAnimation: "pulse",
         titleColor: "redBright",

package/bin/components/cancel/cancel.d.ts

@@ -0,0 +1,45 @@
+import type { Readable, Writable } from "node:stream";
+/**
+ * Special value that indicates a cancelled operation
+ */
+export declare const CANCEL: unique symbol;
+/**
+ * Type for the cancel value
+ */
+export type CancelValue = typeof CANCEL;
+export declare const isWindows: boolean;
+/**
+ * Sets raw mode on input stream
+ */
+export declare function setRawMode(input: Readable, value: boolean): void;
+/**
+ * Gets the number of columns in the terminal
+ */
+export declare function getColumns(output: Writable): number;
+interface BlockOptions {
+    input?: Readable;
+    output?: Writable;
+    overwrite?: boolean;
+    hideCursor?: boolean;
+}
+/**
+ * Creates a block for handling input with proper cursor and cleanup
+ */
+export declare function block({ input, output, overwrite, hideCursor, }?: BlockOptions): () => void;
+/**
+ * Checks if a value represents a cancelled operation
+ * @param value - The value to check
+ * @returns true if the value represents a cancelled operation
+ */
+export declare function isCancel(value: unknown): value is CancelValue;
+/**
+ * Handles cancellation of an operation
+ * @param message - Optional message to display before exiting
+ */
+export declare function cancel(message?: string): never;
+/**
+ * Creates a cancel value that can be returned from operations
+ * @returns The cancel value
+ */
+export declare function createCancel(): CancelValue;
+export {};

package/bin/components/cancel/cancel.js

@@ -0,0 +1,72 @@
+import { stdin, stdout } from "node:process";
+import * as readline from "node:readline";
+import { ReadStream, WriteStream } from "node:tty";
+import { cursor } from "sisteransi";
+export const CANCEL = Symbol("CANCEL");
+export const isWindows = globalThis.process.platform.startsWith("win");
+export function setRawMode(input, value) {
+  const i = input;
+  if (i.isTTY) i.setRawMode(value);
+}
+export function getColumns(output) {
+  if (output instanceof WriteStream && output.columns) {
+    return output.columns;
+  }
+  return 80;
+}
+export function block({
+  input = stdin,
+  output = stdout,
+  overwrite = true,
+  hideCursor = true
+} = {}) {
+  const rl = readline.createInterface({
+    input,
+    output,
+    prompt: "",
+    tabSize: 1
+  });
+  readline.emitKeypressEvents(input, rl);
+  if (input instanceof ReadStream && input.isTTY) {
+    input.setRawMode(true);
+  }
+  const clear = (data, { name, sequence }) => {
+    const str = String(data);
+    if (str === "" || name === "c" && sequence === "") {
+      if (hideCursor) output.write(cursor.show);
+      process.exit(0);
+      return;
+    }
+    if (!overwrite) return;
+    const dx = name === "return" ? 0 : -1;
+    const dy = name === "return" ? -1 : 0;
+    readline.moveCursor(output, dx, dy, () => {
+      readline.clearLine(output, 1, () => {
+        input.once("keypress", clear);
+      });
+    });
+  };
+  if (hideCursor) output.write(cursor.hide);
+  input.once("keypress", clear);
+  return () => {
+    input.off("keypress", clear);
+    if (hideCursor) output.write(cursor.show);
+    if (input instanceof ReadStream && input.isTTY && !isWindows) {
+      input.setRawMode(false);
+    }
+    rl.terminal = false;
+    rl.close();
+  };
+}
+export function isCancel(value) {
+  return value === CANCEL;
+}
+export function cancel(message) {
+  if (message) {
+    console.log(message);
+  }
+  process.exit(0);
+}
+export function createCancel() {
+  return CANCEL;
+}

package/bin/components/editor/editor-mod.d.ts

@@ -1,5 +1,5 @@
 import type { EditorExitResult } from "../../types.js";
-type EditorConfig = {
+interface EditorConfig {
     syntaxHighlighting?: boolean;
     theme?: "auto" | "light" | "dark";
     defaultAllowSaveAs?: boolean;
@@ -7,8 +7,8 @@ type EditorConfig = {
     defaultAutoCloseOnSave?: boolean;
     defaultReturnContentOnSave?: boolean;
     [key: string]: any;
-};
-type EditorOptions = {
+}
+interface EditorOptions {
     filename?: string | null;
     initialContent?: string | null;
     onSave?: (content: string, filename: string | null) => Promise<string | boolean | undefined> | string | boolean | undefined;
@@ -20,6 +20,6 @@ type EditorOptions = {
     returnContentOnSave?: boolean;
     mode?: string;
     cwd?: string;
-};
+}
 export declare function startEditor(options?: EditorOptions): Promise<EditorExitResult>;
 export {};

package/bin/components/{st-end/start.d.ts → intro/intro-start.d.ts}

@@ -1,3 +1,4 @@
+import type { Fonts } from "figlet";
 import type { PreventWrongTerminalSizeOptions, PromptOptions } from "../../types.js";
 type StartPromptOptions = PromptOptions & {
     clearConsole?: boolean;
@@ -12,6 +13,8 @@ type StartPromptOptions = PromptOptions & {
         wrongTerminalSize?: boolean;
         windowsHomeDirRoot?: boolean;
     };
+    variant?: "header" | "ascii-art";
+    asciiArtFont?: Fonts;
 };
-export declare function startPrompt({ title, titleColor, titleTypography, titleVariant, borderColor, clearConsole, horizontalLine, horizontalLineLength, packageName, packageVersion, terminalSizeOptions, isDev, prevent, }: StartPromptOptions): Promise<void>;
+export declare function introPrompt(optionsOrTitle: StartPromptOptions | string): Promise<void>;
 export {};

package/bin/components/{st-end/start.js → intro/intro-start.js}

@@ -1,5 +1,6 @@
 import { relinka } from "@reliverse/relinka";
 import { getCurrentTerminalName } from "@reliverse/runtime";
+import { createAsciiArt } from "../ascii-art/ascii-art.js";
 import { msg } from "../msg-fmt/messages.js";
 import {
   getExactTerminalWidth,
@@ -12,25 +13,30 @@ import {
   preventUnsupportedTTY
 } from "../../utils/prevent.js";
 import { pm, reliversePrompts } from "../../utils/system.js";
-export async function startPrompt({
-  title = "",
-  titleColor = "inverse",
-  titleTypography = "none",
-  titleVariant,
-  borderColor = "dim",
-  clearConsole = false,
-  horizontalLine = true,
-  horizontalLineLength = 0,
-  packageName = reliversePrompts.name,
-  packageVersion = reliversePrompts.version,
-  terminalSizeOptions = {},
-  isDev = false,
-  prevent = {
-    unsupportedTTY: true,
-    wrongTerminalSize: true,
-    windowsHomeDirRoot: true
-  }
-}) {
+export async function introPrompt(optionsOrTitle) {
+  const options = typeof optionsOrTitle === "string" ? { title: optionsOrTitle } : optionsOrTitle;
+  const {
+    title = "",
+    titleColor = "inverse",
+    titleTypography = "none",
+    titleVariant,
+    borderColor = "dim",
+    clearConsole = false,
+    horizontalLine = true,
+    horizontalLineLength: initialHorizontalLineLength = 0,
+    packageName = reliversePrompts.name,
+    packageVersion = reliversePrompts.version,
+    terminalSizeOptions = {},
+    isDev = false,
+    prevent = {
+      unsupportedTTY: true,
+      wrongTerminalSize: true,
+      windowsHomeDirRoot: true
+    },
+    variant = "header",
+    asciiArtFont
+  } = options;
+  let horizontalLineLength = initialHorizontalLineLength;
   if (prevent.windowsHomeDirRoot) {
     preventWindowsHomeDirRoot(process.cwd());
   }
@@ -44,6 +50,14 @@ export async function startPrompt({
   const exactTerminalWidth = getExactTerminalWidth();
   const terminalHeight = getTerminalHeight();
   const formattedTitle = title !== "" ? title : `${packageName} v${packageVersion} | ${pm.packageManager} v${pm.version} | ${getCurrentTerminalName()}${isDev && terminalWidth > 80 ? ` | isDev | w${terminalWidth} h${terminalHeight}` : ""}`;
+  if (variant === "ascii-art") {
+    await createAsciiArt({
+      message: formattedTitle,
+      font: asciiArtFont,
+      clearConsole
+    });
+    return;
+  }
   if (horizontalLineLength === 0) {
     const titleFullLength = titleColor === "inverse" ? `\u2800${formattedTitle}\u2800`.length + 5 : formattedTitle.length + 5;
     horizontalLineLength = Math.max(1, exactTerminalWidth - titleFullLength);

package/bin/components/launcher/launcher-types.d.ts

@@ -1,17 +1,17 @@
 export type EmptyArgs = Record<string, never>;
-export type BaseArgProps = {
+export interface BaseArgProps {
     description?: string;
     required?: boolean;
     allowed?: string[];
-};
-export type BaseArgDefinition = {
+}
+export interface BaseArgDefinition {
     type: string;
     description?: string;
     required?: boolean;
     default?: any;
     allowed?: any[];
     dependencies?: string[];
-};
+}
 export type PositionalArgDefinition = BaseArgDefinition & {
     type: "positional";
     default?: string;
@@ -40,13 +40,13 @@ export type ArrayArgDefinition = BaseArgDefinition & {
 };
 export type ArgDefinition = PositionalArgDefinition | BooleanArgDefinition | StringArgDefinition | NumberArgDefinition | ArrayArgDefinition;
 export type ArgDefinitions = Record<string, ArgDefinition>;
-export type CommandMeta = {
+export interface CommandMeta {
     name: string;
     version?: string;
     description?: string;
     hidden?: boolean;
     aliases?: string[];
-};
+}
 /**
  * A subcommand can be either:
  * 1) A string path to a module with a default export of type Command.
@@ -57,13 +57,13 @@ export type CommandSpec = string | (() => Promise<{
     default: Command<any>;
 } | Command<any>>);
 export type CommandsMap = Record<string, CommandSpec>;
-export type CommandContext<ARGS> = {
+export interface CommandContext<ARGS> {
     args: ARGS;
     raw: string[];
-};
+}
 export type CommandRun<ARGS> = (ctx: CommandContext<ARGS>) => void | Promise<void>;
 export type CommandHook<ARGS> = (ctx: CommandContext<ARGS>) => void | Promise<void>;
-export type DefineCommandOptions<A extends ArgDefinitions = EmptyArgs> = {
+export interface DefineCommandOptions<A extends ArgDefinitions = EmptyArgs> {
     meta?: CommandMeta;
     args?: A;
     run?: CommandRun<InferArgTypes<A>>;
@@ -99,8 +99,8 @@ export type DefineCommandOptions<A extends ArgDefinitions = EmptyArgs> = {
      * Called once per CLI process, after all command/run() logic is finished
      */
     onLauncherExit?: () => void | Promise<void>;
-};
-export type Command<A extends ArgDefinitions = EmptyArgs> = {
+}
+export interface Command<A extends ArgDefinitions = EmptyArgs> {
     meta?: CommandMeta;
     args: A;
     run?: CommandRun<InferArgTypes<A>>;
@@ -136,13 +136,13 @@ export type Command<A extends ArgDefinitions = EmptyArgs> = {
      * Called once per CLI process, after all command/run() logic is finished
      */
     onLauncherExit?: () => void | Promise<void>;
-};
+}
 export type InferArgTypes<A extends ArgDefinitions> = {
     [K in keyof A]: A[K] extends PositionalArgDefinition ? string : A[K] extends BooleanArgDefinition ? boolean : A[K] extends StringArgDefinition ? string : A[K] extends NumberArgDefinition ? number : A[K] extends {
         type: "array";
     } ? string[] : never;
 };
-export type FileBasedCmdsOptions = {
+export interface FileBasedCmdsOptions {
     enable: boolean;
     cmdsRootPath: string;
-};
+}

package/bin/components/log/log.d.ts

@@ -0,0 +1,2 @@
+import { relinka } from "@reliverse/relinka";
+export declare const log: typeof relinka;

package/bin/components/log/log.js

@@ -0,0 +1,2 @@
+import { relinka } from "@reliverse/relinka";
+export const log = relinka;

package/bin/components/next-steps/next-steps.d.ts

@@ -1,6 +1,6 @@
 import type { TypographyName, ColorName } from "../../types.js";
 import type { VariantName } from "../../types.js";
-type NextStepsPromptOptions = {
+interface NextStepsPromptOptions {
     title?: string;
     titleColor?: ColorName;
     titleVariant?: VariantName;
@@ -9,6 +9,6 @@ type NextStepsPromptOptions = {
     contentColor?: ColorName;
     contentVariant?: VariantName;
     contentTypography?: TypographyName;
-};
+}
 export declare function nextStepsPrompt(options: NextStepsPromptOptions): Promise<void>;
 export {};

package/bin/components/number/number-mod.d.ts

@@ -1,6 +1,6 @@
 import type { BorderColorName, ColorName, FmtMsgOptions, TypographyName } from "../../types.js";
 type VariantName = FmtMsgOptions["titleVariant"];
-type NumberPromptOptions = {
+interface NumberPromptOptions {
     title: string;
     hint?: string;
     hintPlaceholderColor?: ColorName;
@@ -23,6 +23,6 @@ type NumberPromptOptions = {
         userInput?: string;
         errorMessage?: string;
     };
-};
+}
 export declare function numberPrompt(opts: NumberPromptOptions): Promise<number>;
 export {};

package/bin/components/outro/outro-end.d.ts

@@ -0,0 +1,8 @@
+import type { Fonts } from "figlet";
+import type { PromptOptions } from "../../types.js";
+type EndPromptOptions = PromptOptions & {
+    variant?: "footer" | "ascii-art";
+    asciiArtFont?: Fonts;
+};
+export declare function outroPrompt(optionsOrTitle: EndPromptOptions | string): Promise<void>;
+export {};

package/bin/components/outro/outro-end.js

@@ -0,0 +1,55 @@
+import { animateText } from "../animate/animate.js";
+import { createAsciiArt } from "../ascii-art/ascii-art.js";
+import { msg } from "../msg-fmt/messages.js";
+import { getExactTerminalWidth } from "../msg-fmt/terminal.js";
+export async function outroPrompt(optionsOrTitle) {
+  const options = typeof optionsOrTitle === "string" ? { title: optionsOrTitle } : optionsOrTitle;
+  const {
+    title = "",
+    titleColor = "cyan",
+    titleTypography = "none",
+    titleVariant,
+    titleAnimation,
+    titleAnimationDelay,
+    border = true,
+    borderColor = "dim",
+    horizontalLineLength: initialHorizontalLineLength = 0,
+    variant = "footer",
+    asciiArtFont
+  } = options;
+  let horizontalLineLength = initialHorizontalLineLength;
+  if (variant === "ascii-art") {
+    await createAsciiArt({
+      message: title || " ",
+      font: asciiArtFont
+    });
+    return;
+  }
+  if (horizontalLineLength === 0) {
+    horizontalLineLength = getExactTerminalWidth() - 3;
+  }
+  if (titleAnimation) {
+    await animateText({
+      title: title ? title : " ",
+      anim: titleAnimation,
+      delay: titleAnimationDelay,
+      type: "M_END",
+      titleColor,
+      titleTypography,
+      border,
+      borderColor,
+      horizontalLineLength
+    });
+  } else {
+    msg({
+      type: "M_END",
+      title: title ? title : " ",
+      titleColor,
+      titleTypography,
+      titleVariant,
+      border,
+      borderColor,
+      horizontalLineLength
+    });
+  }
+}

package/bin/components/results/results.d.ts

@@ -1,6 +1,6 @@
-export type ResultsType = {
+export interface ResultsType {
     username: string;
-};
+}
 export declare function resultPrompt({ results, inline, }: {
     results: ResultsType;
     inline?: boolean;