@inquirer/password

• Feat: Added a loading message while validating input. Customizable through a theme option.
• Fix: not always properly handling editor path on Windows.

• Feat (select): 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.

• Fix (checkbox): Element who're both checked and disabled are now always included in the returned array.
• Feat (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: Now supports default

• Pressing tab will now toggle between yes/no answers.

• Now includes a new number prompt.

• Introduces a new useMemo hook.

• Fix: breaking change wrongly removed the Separator export.

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

• [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.

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

• 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

Major rewrite of the core to rely on node's async hooks for better isolation of each prompts. Relying on this means each prompt context is fully isolated (previously it would rely on the module level context.)

We expect this update to be transparent to most. Though some custom event handlers within useEffect could stop working. If you find any issues there, first please let us know - there might be thing to improve internally to make it transparent. The manual fix will likely be to explicitly define events callback as an AsyncResource.

Let us know how this works for you!

Rewrite internals to support a clean promise API. Tried to maintain backward compatibility as best as possible, but there could be type issue surface. Legacy API marked as deprecated.

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

• Breaking: Paginator is deprecated in favour of the usePagination hook. This hook will always properly reflect the width of the output stream.

• Add support for short property on rawlist choices.

• Performance improvements
• Includes updates in @inquirer/core@2.2.0

• When setting a state (useState), it'll only re-renders if the value changed.
• When setting multiple states at once, we'll only trigger one re-renders if it happens inside a hook callback (previously each state change triggered one re-render.)

If you're setting multiple state in a callback from an async function (like setTimeout or a network call), those will not be merged in a single re-renders. For those case, you're better using a state object holding all values to reduce the amount of re-renders. Open to discuss this in #1251