Compare Versions - inquirer

npm / inquirer / Compare Versions

View on npm

From: → To:

13.3.2

Fix broken 1.3.1 release process.

13.3.1

Bump dependencies

13.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!

13.2.3

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

13.2.2

Typescript disallow type: 'list' unless there's a plugin installed under that name. (list was replaced by select and marked as deprecated for a few released, v13.0.0 removed the alias.)

13.2.1

Regression: previous answers weren't provided to the validate functions as the second arguments.

13.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

13.1.0

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

13.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)

13.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.

12.11.1

[Node 18 compat] Downgraded to mute-stream@2 to maintain Node 18 compatibility.
[Typescript] Allow passing a Partial<{ ... }> type as pre-filled answers.

12.11.0

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

12.10.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

12.9.6

Reduce number of transitive dependencies

12.9.5

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

12.9.4

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

12.9.3

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

12.9.2

Make @types/node an optional peer dependency.

12.9.1

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

12.9.0

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

12.8.2

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

12.8.1

Fixes: a transitive dependency (run-aysnc) loaded devDependencies unexpectedly. This is now fixed upstream. Rel #1791

12.8.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.

12.7.0

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

12.6.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.

12.6.2

Chore: dependencies bump

12.6.1

Fix #1741: Issue with SIGINT in some scenarios leaving promises unsettled on exit.
Fix: Remove monorepo related dependencies from all artifacts published to npm. This removes non-standard version specifiers like workspace:* from the public npm packages.

12.6.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.

12.5.2

README: Add new sponsor
Chore: dependency updates

12.5.0

Feat (select): Introduce theme.indexMode to control displaying an index prefix in front of each choice. (defaults to hidden)
Fix (select): Improve search when number keys are pressed

12.4.3

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

12.4.1

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

12.4.0

Added new shortcut config to the checkbox prompt. Allows to customize or disable shortcut keys for select all and invert selection.

12.3.3

Replace 3rd party dependency strip-ansi in favour of Node built-in stripVTControlCharacters util.

12.3.0

Checkbox prompt: re-added support for an array of default to be provided listing pre-checked checkboxes. This is a legacy interface brought back given this feature removal was an involuntary breaking change during the v12 release. The preferred interface is to provide the checked property to choices { value: 'bar', checked: true }.

12.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.

11.1.0

Now exports base utility Typescript types: import type { Question, DistinctQuestion, Answers } from 'inquirer';

You should use as follow to keep the inference working properly:

const questions = [
    { ... }
] as const satisfies Question[];
// If you're not using inquirer plugins, `Question` could alternatively be replaced by `DistinctQuestion` for stricter checks.

11.0.2

Fix #1555: when behaviour changed unexpectedly when returning a falsy value.

11.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.

10.2.2

Fix the filter option not working.
The signal: AbortSignal didn't work with class based prompts (OSS plugins.) Now it should work consistently with legacy style prompts.

10.2.1

Fix expand prompt being broken if a Separator was in the choices array.

10.2.0

Includes various fixes & new features to the different built-in prompts
Fix: Major rework of the Typescript types. Hoping to reduce the amount of finicky type errors (or wrong types) you might've ran into.

10.1.2

Fix broken backward compatibility issues with v9. Choice objects without value should default to use name as the value. Note: Please don't rely on this weird behaviour, but we fixed it since it was an unintended breaking change.

10.1.0

Adds the new { type: 'search' } prompt.

10.0.3

Fix: Re-added missing short on select and checkbox prompt.
Fix: Remove type requiring a close method on prompt class instances (it wasn't required.)

10.0.0

Re-implemented with Typescript.
Adding CJS support (now inquirer is publishes a dual-build CJS/ESM.)
All core prompts are now coming from @inquirer/prompt.
Custom prompts now should be implemented with @inquirer/core. Custom prompts built on inquirer@9.x.x will keep working, but should plan a migration.
inquirer.ui.BottomBar is deleted.

My expectation is that this release should be a drop-in replacement for people using inquirer.prompt() and built-ins 🤞🏻. Please open an issue on Github if you run into issues migrating; it's a large rewrite and there might be a few sharp edges to cut! Hope you'll like this new release.

9.3.5

Fix issue with plugins relying on internal inquirer packages file structure.

9.3.1

Fix risk of prototype injection.

9.3.0

Replace chalk with ~~picolors~~ (in 9.3.2 went to yoctocolors to stay with Sindre's packages and reduce amount of provenance.)
Drop many dependencies in favour of native functions when possible.

No impact expected, but it's a large changes in dependencies. Let us know if you run into any issues upgrading!

9.2.22

editor prompt: Fixed compatibility issue between default and waitUserInput options. #1405

9.2.18

On windows, we will now use unicode characters whenever possible

9.2.9

Modified lodash imports to help with tree-shaking
Replace unmaintained through dependency (only affect users of the old bottom bar)

9.1.4

Fix issue with the default value disappearing from prompt.

9.0.0

Inquirer is now a native Node ECMAScript module. This will require your Node runtime to support es modules, and your app to be an es module. Node documentation over here: https://nodejs.org/api/esm.html#modules-ecmascript-modules

If you cannot migrate, please remember you can keep using the v8.x release line until you're ready.

8.2.6

Bugfix: Fix a dependency who became ESM only

8.2.3

Fix line wrapping with using with terminal links
Fix number prompt not working with negative numbers

8.2.2

Fix bugs with the rawlist

8.2.1

Fix bug when using both arrow keys and number keys on the rawList prompt.
Dependencies bump

8.2.0

checkbox prompt: Update the help message to be more complete. And the help message is now shown until a selection is made.

8.1.5

Fix older Node version compatibility issue.

8.1.4

Fix an error being thrown inside the rawlist prompt

8.1.3

Bug Fixes

Fix password prompt appearing when doing async filtering/validation
User being prompted a question even though it was answered when using nested answer object format.
Fix extra space appearing when using custom prefix.

And bump of all dependencies.

8.1.2

Fix bug on rawList prompt
Bump dependencies

8.1.1

Fix: Number prompt default behavior.

8.1.0

New features

Now display a loading spinner while asynchronously filtering or validating data.
inquirer.prompt() now accept a shorthand object syntax instead of an array with named prompts:

const { foo, bar } = await inquirer.prompt({
  foo: {
    message: '...',
    default: '...',
  },
  bar: {
    default: '...',
  }
}):

8.0.1

Fixes

Fix issue with duplicate keys in expand prompt not being caught if casing didn't match
Fix rawlist prompt ignoring short option
Rollback dependencies migrated to ESM causing issue for some users

And lastly general dependency upgrade (to non-ESM versions)

8.0.0

Drop support for Node 10 (through dependencies)
Add postfix option to the editor prompt to allow easily turning on proper syntax highlighting

7.3.3

Fix to release the readline on errors
Security patch (lodash)

7.3.2

Fix the loop: false option in the checkbox prompt.

7.3.1

Fix the loop: false option in the list prompt.

7.3.0

New option loop (boolean) for list type prompts. This prevents the list from looping when reaching the top or bottom of the selection.
Bug fix: multi line list type prompts
Core: Bumped dependencies

7.2.0

Enhancement

039a55c7ec04d95887bdeb9b164cc634f26beb57 #923 Only import used lodash methods. (@merceyz)

Bug Fix

a1171d25cdb48c147b405e3173828a8de2dc735b #918 Fix @inquirer/confirm formatted output value. (@rbardini)
1bf6413b71e94b52a68ba9a4d331ea67453e3390 Fix engines field for Node.js 8. (@LitoMore)

7.0.5

Errors when running in non-TTY environment are now marked and catchable.

7.0.3

Revert broken fix done in 7.0.2

7.0.2

~~Work around bug affecting Windows user with Node 10 (#767)~~ (Reverted in v7.0.3)

7.0.0