@clack/core

Minor Changes

• #595 227583e Thanks @dreyfus92! - Add an accessible option to the shared PromptOptions and a resolved accessible getter on the base Prompt, so any prompt can opt into accessible mode individually. Resolution order: per-prompt option > updateSettings({ accessible }) > the ACCESSIBLE environment variable.

• #592 caa32e8 Thanks @gameroman! - Export CANCEL_SYMBOL constant from @clack/core and @clack/prompts

• #594 37fca4e Thanks @dreyfus92! - Add tab-completion to the path prompt: pressing Tab fills the input with the focused suggestion, so you can quickly descend into deep directories (type / and Tab again). Powered by a new opt-in completeOnTab option on autocomplete, which also shows a Tab: complete hint in the instructions footer. Default autocomplete behavior is unchanged.

• #583 ae636dd Thanks @43081j! - Add async validation support to prompts, and validation state rendering to text prompts.

• #593 b20fa2b Thanks @dreyfus92! - Add isAccessible() and an accessible setting as the foundation for accessible mode. Resolution order: per-call option > updateSettings({ accessible }) > the ACCESSIBLE environment variable (any non-empty value enables it, except 0 and false).

Patch Changes

• #582 4b24953 Thanks @43081j! - Handle empty arrays in various prompts and utilities.

Patch Changes

• #561 2f2b52f Thanks @avallete! - Fix password prompt resolving to undefined on empty submit. It now normalizes an empty submission to "", matching the text prompt behavior and the documented Promise<string | symbol> return type.

• #569 e1b6ee7 Thanks @43081j! - fix: only submit multi-line prompt when double-return happens at end of input.

  Also fixes two minor things:

  • Initial value is used as initial user input for multi-line prompts
  • Cursor is placed at the end when there is initial input

Patch Changes

• #548 2356e97 Thanks @43081j! - Remove sourcemaps and enable pretty-ish build output.

Minor Changes

• #543 83428ac Thanks @florian-lefebvre! - Adds support for Standard Schema validation

  Prompts accept an optional validate() function to validate user input. While a function provides more flexibility and customization over your validation, it can be a bit verbose. To help solve this, there are libraries that provide schema-based validation to make shorthand and type-strict validation substantially easier.

  Libraries following the Standard Schema specification are now natively supported. For example, using Arktype:

  import { text } from '@clack/prompts';
  import { type } from 'arktype';
  
  const name = await text({
  	message: 'Enter your email',
  +	validate: type('string.email').describe('Invalid email'),
  });

Patch Changes

• #534 3dcb31a Thanks @MattStypa! - Fixed spaces and uppercase characters in multiline prompt

Patch Changes

• 54be8d7: Fix line wrapping and overflow computation in group multi-select and other list-like prompts.

Minor Changes

• 78fd3ae: Remove unused debug option key.
• ea5702e: fix: add engines field expressing node >=20.12 requirement
• 814ab9a: Add new multiline prompt for multi-line text input.

Minor Changes

• 9786226: Externalize fast-string-width and fast-wrap-ansi to avoid double dependencies
• 090902c: Adds date prompt with format support (YMD, MDY, DMY)

Patch Changes

• bdf89a5: Adds placeholder option to autocomplete. When the placeholder is set and the input is empty, pressing tab will set the value to placeholder.
• 417b451: Only apply autocomplete default filter if it has been explicitly set or if options is not a getter.

Minor Changes

• e3333fb: Replaces picocolors with Node.js built-in styleText.

Patch Changes

• 6404dc1: Disallows selection of disabled options in autocomplete.
• 2533180: Updates the documentation to mention userInputWithCursor when using the TextPrompt primitive.

Major Changes

• c713fd5: The package is now distributed as ESM-only. In v0 releases, the package was dual-published as CJS and ESM.

  For existing CJS projects using Node v20+, please see Node's guide on Loading ECMAScript modules using require().

Minor Changes

• 7bc3301: Prompts now have a userInput stored separately from their value.

• 2837845: Adds suggestion and path prompts

• 729bbb6: Add support for customizable spinner cancel and error messages. Users can now customize these messages either per spinner instance or globally via the updateSettings function to support multilingual CLIs.

  This update also improves the architecture by exposing the core settings to the prompts package, enabling more consistent default message handling across the codebase.

  // Per-instance customization
  const spinner = prompts.spinner({
    cancelMessage: "Operación cancelada", // "Operation cancelled" in Spanish
    errorMessage: "Se produjo un error", // "An error occurred" in Spanish
  });
  
  // Global customization via updateSettings
  prompts.updateSettings({
    messages: {
      cancel: "Operación cancelada", // "Operation cancelled" in Spanish
      error: "Se produjo un error", // "An error occurred" in Spanish
    },
  });
  
  // Settings can now be accessed directly
  console.log(prompts.settings.messages.cancel); // "Operación cancelada"
  
  // Direct options take priority over global settings
  const spinner = prompts.spinner({
    cancelMessage: "Cancelled", // This will be used instead of the global setting
  });
  

• 55645c2: Support wrapping autocomplete and select prompts.

• f2c2b89: Adds AutocompletePrompt to core with comprehensive tests and implement both autocomplete and autocomplete-multiselect components in prompts package.

• df4eea1: Remove suggestion prompt and change path prompt to be an autocomplete prompt.

• 1604f97: Add clearOnError option to password prompt to automatically clear input when validation fails

Patch Changes

• 0718b07: fix: export *Options types for prompts.
• bfe0dd3: Prevents placeholder from being used as input value in text prompts
• 6868c1c: Adds a new selectableGroups boolean to the group multi-select prompt. Using selectableGroups: false will disable the ability to select a top-level group, but still allow every child to be selected individually.
• 7df841d: Removed all trailing space in prompt output and fixed various padding rendering bugs.
• a4f5034: Fixes an edge case for placeholder values. Previously, when pressing enter on an empty prompt, placeholder values would be ignored. Now, placeholder values are treated as the prompt value.
• b103ad3: Allow disabled options in multi-select and select prompts.
• 71b5029: Add missing nullish checks around values.
• a36292b: Fix "TTY initialization failed: uv_tty_init returned EBADF (bad file descriptor)" error happening on Windows for non-tty terminals.
• 1a45f93: Switched from wrap-ansi to fast-wrap-ansi
• 4ba2d78: Support short terminal windows when re-rendering by accounting for off-screen lines
• 34f52fe: Validates initial values immediately when using text prompts with initialValue and validate props.
• 94fee2a: Changes placeholder to be a visual hint rather than a tabbable value.
• 4f6b3c2: Set initial values of auto complete prompt to first option when multiple is false.
• 8ead5d3: Avoid passing initial values to core when using auto complete prompt
• acc4c3a: Add a new withGuide option to all prompts to disable the default clack border
• 68dbf9b: select-key: Fixed wrapping and added new caseSensitive option
• 2310b43: Allow custom writables as output stream.
• d98e033: add invert selection for multiselect prompt

Patch Changes

• 8093f3c: Adds Error support to the validate function
• e5ba09a: Fixes a cursor display bug in terminals that do not support the "hidden" escape sequence. See Issue #127.
• 8cba8e3: Fixes a rendering bug with cursor positions for TextPrompt

Minor Changes

• a83d2f8: Adds a new updateSettings() function to support new global keybindings.

  updateSettings() accepts an aliases object that maps custom keys to an action (up | down | left | right | space | enter | cancel).

  import { updateSettings } from "@clack/core";
  
  // Support custom keybindings
  updateSettings({
    aliases: {
      w: "up",
      a: "left",
      s: "down",
      d: "right",
    },
  });
  

[!WARNING] In order to enforce consistent, user-friendly defaults across the ecosystem, updateSettings does not support disabling Clack's default keybindings.

• 801246b: Adds a new signal option to support programmatic prompt cancellation with an abort controller.

• a83d2f8: Updates default keybindings to support Vim motion shortcuts and map the escape key to cancel (ctrl+c).

  alias	action
  k	up
  l	right
  j	down
  h	left
  esc	cancel

Patch Changes

• 51e12bc: Improves types for events and interaction states.

Patch Changes

• 4845f4f: Fixes a bug which kept the terminal cursor hidden after a prompt is cancelled
• d7b2fb9: Adds missing LICENSE file. Since the package.json file has always included "license": "MIT", please consider this a licensing clarification rather than a licensing change.

Patch Changes

• a04e418: fix(@clack/core): keyboard input not working after await in spinner
• 4f6fcf5: feat(@clack/core): allow tab completion for placeholders

Patch Changes

• cd79076: fix: restore raw mode on unblock

Patch Changes

• c96eda5: Enable hard line-wrapping behavior for long words without spaces

Patch Changes

• 58a1df1: Fix line duplication bug by automatically wrapping prompts to process.stdout.columns

Minor Changes

• 8a4a12f: Add GroupMultiSelect prompt

Patch Changes

• 8a4a12f: add groupMultiselect prompt

Patch Changes

• ec812b6: fix readline hang on Windows

Minor Changes

• d74dd05: Adds a selectKey prompt type
• 54c1bc3: Breaking Change multiselect has renamed initialValue to initialValues

Patch Changes

• 1251132: Multiselect: return Value[] instead of Option[].
• 8994382: Add a password prompt to @clack/prompts

Patch Changes

• d96071c: Don't mutate initialValue in multiselect, fix parameter type for validate().

  Credits to @banjo for the bug report and initial PR!

Patch Changes

• 6d9e675: Add support for neovim cursor motion (hjkl)

  Thanks @esau-morais for the assist!

Patch Changes

• 7fb5375: Adds a new defaultValue option to the text prompt, removes automatic usage of the placeholder value.

Patch Changes

• de1314e: Support required option for multi-select

Patch Changes

• ca77da1: Fix multiselect initial value logic
• 8aed606: Fix MaxListenersExceededWarning by detaching stdin listeners on close

Patch Changes

• a99c458: Support initialValue option for text prompt

Patch Changes

• Allow isCancel to type guard any unknown value
• 7dcad8f: Allow placeholder to be passed to TextPrompt
• 2242f13: Fix multiselect returning undefined
• b1341d6: Improved placeholder handling

Patch Changes

• 4be7dbf: Ensure raw mode is unset on submit
• b480679: Preserve value if validation fails

Minor Changes

• 7015ec9: Create new prompt: multi-select

Patch Changes

• 9d371c3: Fix rendering bug when using y/n to confirm

Patch Changes

• 441d5b7: fix select return undefined
• d20ef2a: Update keywords, URLs
• fe13c2f: fix cursor missing after submit

Patch Changes

• a0cb382: Add main entrypoint

Patch Changes

• Fix node@16 issue (cannot read "createInterface" of undefined)

Patch Changes

• a4b5e13: Bug fixes, exposes block utility

Patch Changes

• Fix cursor bug

Patch Changes

• Fix error with character check

Patch Changes

• 491f9e0: update readme

Patch Changes

• 7372d5c: Fix bug with line deletion

Patch Changes

• 5605d28: Do not bundle dependencies (take II)

Patch Changes

• 2ee67cb: don't bundle deps

Patch Changes

• 306598e: Initial publish, still WIP