Update dependency inquirer to v13
This PR contains the following updates:
| Package | Change | Age | Confidence |
|---|---|---|---|
| inquirer (source) | ^8.2.5 -> ^13.0.1 |
Release Notes
SBoudrias/Inquirer.js (inquirer)
v13.0.1
v13.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.
v12.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.
v12.11.0
- feat
@inquirer/input: Now support simple RegExp validation withpattern/patternError. - fix
@inquirer/editor: Fix typos/waitForUseInput/waitForUserInput - Bump dependencies
v12.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
v12.9.6
- Reduce number of transitive dependencies
v12.9.5
- Fix #β1834: (rawlist) Allows specifying numbers as explicit keys of option within the list.
v12.9.4
- fix: Remove "easter-egg" vim/emacs bindings conflicting with the type-to-search feature.
v12.9.3
- Fix Unix
yesnot properly being processed by the confirm prompt. (yes | node confirm-script.js)
v12.9.2
- Make
@types/nodean optional peer dependency.
v12.9.1
- Replace
external-editordependency with new@inquirer/external-editor. This remove the vulnerabletmptransitive dependency from the dependency tree.
v12.9.0
- Search prompt: New
instructionsconfig to allow localizing the help tips.
v12.8.2
- Fix #β1786 select prompt with
indexMode: numbertheme option didn't properly calculate the items indexes if separators where present in between choices.
v12.8.1
- Fixes: a transitive dependency (
run-aysnc) loaded devDependencies unexpectedly. This is now fixed upstream. Rel #β1791
v12.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.
v12.7.0
-input prompt: New prefill option to control if the default value is editable inline or only after pressing tab.
v12.6.3
- Fix #β1743: pagination logic of the
select,checkboxandsearchprompts was fully rewritten to handle edge cases around rendering multi-line choices and pointer positioning.
v12.6.2
- Chore: dependencies bump
v12.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 likeworkspace:*from the public npm packages.
v12.6.0
- Feat(@βinquirer/select): Added an
instructionsoption allowing to customize the messages in the help tips. - Feat(@βinquirer/rawlist): Arrow keys will now cycle through the option, just like the
@inquirer/selectprompt. Also added aloopoption to control the list loop behaviour when reaching the boundaries.
v12.5.2
- README: Add new sponsor
- Chore: dependency updates
v12.5.1
v12.5.0
- Feat (
select): Introducetheme.indexModeto control displaying an index prefix in front of each choice. (defaults to hidden) - Fix (
select): Improve search when number keys are pressed
v12.4.3
- Fix an issue where inquirer would throw if Node is ran with the new
--frozen-intrinsicsflag.
v12.4.2
v12.4.1
- Mark
@types/nodeas an optional peer dependency across all packages.
v12.4.0
- Added new
shortcutconfig to thecheckboxprompt. Allows to customize or disable shortcut keys for select all and invert selection.
v12.3.3
- Replace 3rd party dependency
strip-ansiin favour of Node built-instripVTControlCharactersutil.
v12.3.2
v12.3.1
v12.3.0
- Checkbox prompt: re-added support for an array of
defaultto be provided listing pre-checked checkboxes. This is a legacy interface brought back given this feature removal was an involuntary breaking change during thev12release. The preferred interface is to provide thecheckedproperty to choices{ value: 'bar', checked: true }.
v12.2.0
v12.1.0
v12.0.1
v12.0.0
-
@types/nodeis now only apeerDependencies. 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 runnpm install --dev @​types/node/yarn add --dev @​types/node.
v11.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.
v11.0.2
- Fix #β1555:
whenbehaviour changed unexpectedly when returning a falsy value.
v11.0.1
v11.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.
v10.2.2
- Fix the
filteroption not working. - The
signal: AbortSignaldidn't work with class based prompts (OSS plugins.) Now it should work consistently with legacy style prompts.
v10.2.1
- Fix
expandprompt being broken if a Separator was in thechoicesarray.
v10.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.
v10.1.8
v10.1.7
v10.1.6
v10.1.5
v10.1.4
v10.1.3
v10.1.2
- Fix broken backward compatibility issues with v9.
Choiceobjects withoutvalueshould default to usenameas the value. Note: Please don't rely on this weird behaviour, but we fixed it since it was an unintended breaking change.
v10.1.1
v10.1.0
- Adds the new
{ type: 'search' }prompt.
v10.0.4
v10.0.3
- Fix: Re-added missing
shorton select and checkbox prompt. - Fix: Remove type requiring a
closemethod on prompt class instances (it wasn't required.)
v10.0.2
v10.0.1
v10.0.0
- Re-implemented with Typescript.
- Adding CJS support (now
inquireris 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[email protected]will keep working, but should plan a migration. -
inquirer.ui.BottomBaris 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.
v9.3.8
v9.3.7
v9.3.6
v9.3.5
- Fix issue with plugins relying on internal
inquirerpackages file structure.
v9.3.4
v9.3.3
v9.3.2
v9.3.1
- Fix risk of prototype injection.
v9.3.0
- Replace
chalkwith ~~picolors~~ (in 9.3.2 went toyoctocolorsto 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!
v9.2.23
v9.2.22
-
editorprompt: Fixed compatibility issue betweendefaultandwaitUserInputoptions. #β1405
v9.2.21
v9.2.20
v9.2.19
v9.2.18
- On windows, we will now use unicode characters whenever possible
v9.2.17
v9.2.16
v9.2.15
v9.2.14
v9.2.13
v9.2.12
v9.2.11
v9.2.10
v9.2.9
- Modified lodash imports to help with tree-shaking
- Replace unmaintained
throughdependency (only affect users of the old bottom bar)
v9.2.8
v9.2.7
v9.2.6
v9.2.5
v9.2.4
v9.2.3
v9.2.2
v9.2.1
v9.2.0
v9.1.5
v9.1.4
Fix issue with the default value disappearing from prompt.
v9.1.3
v9.1.2
v9.1.1
v9.1.0
v9.0.2
v9.0.1
v9.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.
v8.2.7
v8.2.6
- Bugfix: Fix a dependency who became ESM only
Configuration
π Schedule: Branch creation - "on friday" (UTC), Automerge - At any time (no schedule defined).
π¦ Automerge: Disabled by config. Please merge this manually once you are satisfied.
β» Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
π Ignore: Close this PR and you won't be reminded about this update again.
- [ ] If you want to rebase/retry this PR, check this box
This PR was generated by Mend Renovate. View the repository job log.