@inquirer/confirm

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

Breaking

• Update to Rx.js v6

New features

• New prompt type number.
• transformer option now receive { isFinal } as a flag to allow transforming the final answer differently.
• Use name as default message if message isn't provided.
• Hide default values for password prompt.

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

• Added a transformer option to the input prompt allowing you to modify the displayed user input. (Useful to modify colors as user type, etc)

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

• Fix bug with the editor prompt.

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

Breaking: Upgrade to RxJS v5 which updates a bunch of Reactive interface method names.

For people not using the Reactive interface directly, this new major release should just work out of the box.

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!

Breaking

The core codebase went through a major es5 to 6 refactor. As such, we're dropping support for Node 4.

This change will likely require changes to the community Plugins as es6 classes are enforcing more restriction (like constructor can only be invoked with new).

New features / Bug fixes

• list, expand and rawlist prompts now accepts the value as default (previously it would only accept the choice index).
• The pagination now properly handles multiline choices.
• Fix bug where invalid default choices would break the UI.

• 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

• Change to list prompts default handling:
  • If number, default is the choice index
  • Any other defined values, find the value in the choice array. (previously it'd only support strings)
• Bug: SIGINT was not properly exiting the process for some users
• Cleanup: bump dependencies