Compare Versions - @inquirer/prompts

npm / @inquirer/prompts / Compare Versions

View on npm

From: → To:

8.3.2

Fix broken 8.3.1 release process.

8.3.1

Bump dependencies

8.3.0

Fix: Keypresses happening before a prompt is rendered are now ignored.
Fix (checkbox): Element who're both checked and disabled are now always included in the returned array.
Feat (select/checkbox): Cursor will now hover disabled options of the list; but they still cannot be interacted with. This prevents the cursor jumping ahead in ways that can be confusing.
Feat: various new theme options to make all prompts content localizable.

Finally, see our new @inquirer/i18n package!

8.2.1

chore: Switch wrap-ansi with fast-wrap-ansi

8.2.0

feat(search): Add support for default.
feat(rawlist): Add support for description of choices. That information is displayed under the list when the choice is highlighted.
Bump dependencies

8.1.0

Feat: rawlist now supports default option.
Fix: select now infer return type properly when passing a choices array of string literals.

8.0.2

Fix Typescript not discovering types when moduleResolution is set to commonjs (you probably want to fix that in your project if it's still in your tsconfig)

8.0.0

Release Notes

🚨 Breaking Changes

This is a major release that modernizes the codebase for Node.js ≥ 20.

ESM Only - No More CommonJS Support

Impact: All packages are now ESM-only. CommonJS imports are no longer supported.

If you're on modern Node versions (≥ 20), this should be transparent and have no impact.

Node.js Version Requirement

Minimum Node.js version is now 20.x

Node.js versions below 20 are no longer supported. Please upgrade to Node.js 20 or later.

Node min versions: >=23.5.0 || ^22.13.0 || ^21.7.0 || ^20.12.0

Deprecated APIs Removed

The following deprecated APIs have been removed after being deprecated in previous releases:

`list` prompt alias removed (affects `inquirer` package only)

The list alias has been removed from the inquirer package. This only impacts users of the legacy inquirer package, not users of @inquirer/prompts or individual prompt packages.

// ❌ No longer available (inquirer package only)
import inquirer from 'inquirer';
const answer = await inquirer.prompt([
  { type: 'list', name: 'choice', message: 'Pick one:', choices: ['a', 'b'] }
]);

// ✅ Use 'select' instead
import inquirer from 'inquirer';
const answer = await inquirer.prompt([
  { type: 'select', name: 'choice', message: 'Pick one:', choices: ['a', 'b'] }
]);

`helpMode` theme property removed

// ❌ No longer available
const answer = await select({
  theme: { helpMode: 'never' }
});

// ✅ Use theme.style.keysHelpTip instead
const answer = await select({
  theme: {
    style: {
      keysHelpTip: () => undefined // or your custom styling function
    }
  }
});

This affects the following prompts:

@inquirer/checkbox
@inquirer/search
@inquirer/select

`instructions` config property removed

// ❌ No longer available
const answer = await checkbox({
  instructions: 'Custom instructions'
});

// ✅ Use theme.style.keysHelpTip instead
const answer = await checkbox({
  theme: {
    style: {
      keysHelpTip: (text) => 'Custom instructions'
    }
  }
});

This affects the following prompts:

@inquirer/checkbox
@inquirer/search
@inquirer/select

`cancel()` method removed

The cancel() method on prompt return custom Promise has been removed.

// ❌ No longer available
const answerPromise = input({ message: 'Name?' });
answerPromise.cancel();
const answer = await answerPromise;

// ✅ Use AbortSignal instead
const controller = new AbortController();
const answer = await input(
  { message: 'Name?' },
  { signal: controller.signal }
);
controller.abort();

Color Library Change: yoctocolors → Node.js `styleText`

Internal change: The project now uses Node.js built-in util.styleText() instead of the yoctocolors package for terminal colors. This makes Inquirer smaller and reduces risks of vulnerabilities coming from transitive dependencies.

7.10.1

[Node 18 compat] Downgraded to mute-stream@2 to maintain Node 18 compatibility.

7.10.0

feat @inquirer/input: Now support simple RegExp validation with pattern/patternError.
fix @inquirer/editor: Fix typo s/waitForUseInput/waitForUserInput
Bump dependencies

7.9.0

New design for the keys help tip. Themable/localizable with theme.style.keysHelpTip.
Re-introduce option to match up/down actions with vim or emacs keybindings. Enable with theme.keybindings

7.8.6

Reduce number of transitive dependencies

7.8.5

Fix #1834: (rawlist) Allows specifying numbers as explicit keys of option within the list.

7.8.4

fix: Remove "easter-egg" vim/emacs bindings conflicting with the type-to-search feature.

7.8.3

Fix Unix yes not properly being processed by the confirm prompt. (yes | node confirm-script.js)

7.8.2

Make @types/node an optional peer dependency.

7.8.1

Replace external-editor dependency with new @inquirer/external-editor. This remove the vulnerable tmp transitive dependency from the dependency tree.

7.8.0

Search prompt: New instructions config to allow localizing the help tips.

7.7.1

Fix #1786 select prompt with indexMode: number theme option didn't properly calculate the items indexes if separators where present in between choices.

7.7.0

Select prompt: When pressing a number key, we'll ignore separators in counting the index of the item to jump to.
Checkbox prompt: When pressing a number key, we'll ignore separators in counting the index of the item to select.

7.6.0

-input prompt: New prefill option to control if the default value is editable inline or only after pressing tab.

7.5.3

Fix #1743: pagination logic of the select, checkbox and search prompts was fully rewritten to handle edge cases around rendering multi-line choices and pointer positioning.

7.5.2

Chore: dependencies bump

7.5.0

Feat(@inquirer/select): Added an instructions option allowing to customize the messages in the help tips.
Feat(@inquirer/rawlist): Arrow keys will now cycle through the option, just like the @inquirer/select prompt. Also added a loop option to control the list loop behaviour when reaching the boundaries.

7.4.1

Fix number prompt (typescript): If prompt is required, only number can be returned. (previously was nullable)
README: Add new sponsor
Chore: dependency updates

7.3.3

Fix an issue where inquirer would throw if Node is ran with the new --frozen-intrinsics flag.

This fix is also released through patches of all specific prompts packages.

7.3.1

Mark @types/node as an optional peer dependency across all packages.

7.0.1

Hoist peer-dependencies to remove warning when using yarn

7.0.0

@types/node is now only a peerDependencies. This reduces the install size of inquirer dramatically for folks not using Typescript. It's unlikely to break your builds if you used TS already, if it does run npm install --dev @types/node/yarn add --dev @types/node.

6.0.0

No technical breaking changes; but we changed the style of the question prefix once the answer is provided. Once a question is answer, the prefix becomes a tick mark (previously it was the same ? as when the prompt is idle.)

This is theme-able, and so can be overwritten to with theme.prefix.

5.3.0

Now includes a search prompt. import { search } from @inquirer/prompts

5.1.0

Now includes a new number prompt.

5.0.7

Replace chalk with ~~picolors~~ (in 5.1.0 went to yoctocolors to stay with Sindre's packages and reduce amount of provenance.)
TS 5.5 (no impact expected on package users)

5.0.1

Fix: breaking change wrongly removed the Separator export.

5.0.0

[Breaking #1384] @inquirer/core isn't exported from @inquirer/prompts anymore. If you want to create custom prompts, import from the core package. This decision was made to disambiguate what breaks in each package - with prompts re-exporting core, any core breaking change (no matter how minor) caused a major version bump. Now only prompts interfaces breaking changes will be major on prompts. We're hoping this will simplify your usage of @inquirer/* packages.

4.3.3

On windows, we will now use unicode characters whenever possible

4.3.2

Performance improvements (less flickering mainly noticeable on select/checkbox)

4.3.0

Errors thrown from prompts are now custom errors.

4.2.1

Bugfix: When relying on asynchronous validation, the loader icon was broken.
Chore: Added tests covering the prior issue to prevent future regression of loaders.

4.0.0

All prompts are now themable. See each prompts documentation about the options available.
BREAKING: The message option of each prompt must now be a string. It could previously be an asynchronous function. See recipes for a migration option.
Node 18 required

3.1.1

Fix: There was an issue with ESM/CJS imports interoperability that should now be fixed. Ref #1297

3.1.0

Review how force exit events are handled to make sure we restore the cursor properly.
Various dependencies bump (including TS 5.2.2)

3.0.0

Breaking: Includes new major version of @inquirer/core.
Bug fix: on Select & Checkbox prompt where it could happen the choice list wasn't matching the terminal width.

2.3.1

Fix bug where Common.js Typescript types definition were broken (should have no impact on ESM users)

2.2.0

Performance improvements
Includes updates in @inquirer/core@2.2.0

Compare Versions - @inquirer/prompts

Release Notes

🚨 Breaking Changes

ESM Only - No More CommonJS Support

Node.js Version Requirement

Deprecated APIs Removed

list prompt alias removed (affects inquirer package only)

helpMode theme property removed

instructions config property removed

cancel() method removed

Color Library Change: yoctocolors → Node.js styleText

`list` prompt alias removed (affects `inquirer` package only)

`helpMode` theme property removed

`instructions` config property removed

`cancel()` method removed

Color Library Change: yoctocolors → Node.js `styleText`