@inquirer/editor

@inquirer/password@5.2.2

• feat: Add support for description of choices. That information is displayed under the list when the choice is highlighted.

@inquirer/password@5.2.0

What's new

• Added a toggleMask option to temporarily reveal the typed value with ctrl+t, with a themed, i18n-able help tip for discoverability. Defaults to true; set to false to disable both the shortcut and its help line.

Dependencies

• @inquirer/core bumped to ^12.0.1
• @inquirer/type bumped to ^4.1.0

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

• 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

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

@inquirer/number@4.2.1

Dependencies

• @inquirer/core bumped to ^12.0.1
• @inquirer/type bumped to ^4.1.0

No source changes.

• New prefill option to control if the default value is editable inline or only after pressing tab.

• Feat(@inquirer/select): Added an instructions option allowing to customize the messages in the help tips.

• New theme option validationFailureMode: 'keep' | 'clear' to control the behaviour when validation fails.

@inquirer/number@4.2.0

What's fixed

• Avoid floating-point step errors by scaling value/step/min to exact decimal integers before the remainder check (#2166)
• Accept explicit undefined as the default value (#2182)

Dependencies

• @inquirer/core bumped to ^12.0.0

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

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

• New theme option validationFailureMode: 'keep' | 'clear' to control the behaviour when validation fails.

• Expose a new file option covering all options supported by external-editor.

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

• feat: Add support for default.

@inquirer/type@4.1.0

What's new

• Prettify is now recursive, so makeTheme returns a fully flattened theme type (nested style intersections merged into one object) for better IDE display (#2239).

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.

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

• Drop support for Node < 4
• Allow failing async validation by rejecting the returned Promise
• Fix bug with bottom bar

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.

• 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