Inquirer.js

• On windows, we will now use unicode characters whenever possible

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

• Bugfix: Cursor position when no value/default value is rendered.
• Chore: Dependency bumps

• Errors thrown from prompts are now custom errors.

• Feat: Thrown errors from Inquirer are now all custom (so they can be filtered.) Those errors are exported from the package.

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

• Bugfix: usePrefix returned broken loader frames (bug introduced with the themability capabilities)
• Chore: Added tests covering the prior issue to prevent future regression.

• @inquirer/select now support search when typing letters (aiming to imitate how the HTML <select> search works)

• Allow customizing renderSelectedChoices with theme.

• 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

• Now exposes utilities to allow theming prompts (type Theme, makeTheme)
• message option isn't transformed by the core anymore - options are now passed through as-is to the prompt.
• Node 18 required

• Breaking: usePagination now requires pageSize to be passed in. The size of the pages should inform the help shown on the screen, and keeping this information in 2 areas leave a change the default value will mistmatch.

New features!

• New required prompt config. Makes sure at least one choice is selected.
• New validate prompt config. Provide a function that'll validate the user selection with any logic you want (like enforcing a min or max selection amount.) Please use this config with parsimony since complicated validation scheme can lead to sub-optimal UX!

• Now supports the loop: false option. (This feature was available on inquirer, but not ported to new prompts yet)

• Now supports the loop: false option. (This feature was available on inquirer, but not ported to new prompts yet)

• Introduces a new useMemo hook.

• Bugfix: infinite loop occurring when changing state from useEffect body. See #1307

• Breaking (low chance): The typing always defined a validate config; but it was rarely used. It's been removed and prompts relying on it are expected to handle it on their own (no default value.) The types were updated accordingly and will raise issue if you're using typescript.
• Deprecation warning (TS only): If your custom prompt extended AsyncPromptConfig, it's been deprecated in favour of PromptConfig

- import type { AsyncPromptConfig } from '@inquirer/core';
+ import type { PromptConfig } from '@inquirer/core';

- type Config = AsyncPromptConfig & { custom: 'value' };
+ type Config = PromptConfig<{ custom: 'value' }>;

Note: Old interface works for now, but is marked as deprecated.

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

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