BREAKING: Stop exporting core APIs from @inquirer/prompts #1384
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SBoudrias
force-pushed
the
breaking/prompts-without-core
branch
from
23ffe11
to
36c183b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Breaking change to
@inquirer/promptsto stop exporting the core APIs from it.This was proposed earlier by a PR, but it's been causing issue. Any breaking change to
@inquirer/corebecomes a breaking change to@inquirer/prompts, and for most users they'll only rely on prompts that receive UX upgrade.So, I'm feeling pretty strongly about keeping both packages separated going forward.
@inquirer/coreare more frequent (larger API surface.) So they'll just be exposed to prompt authors. (as a proof, we're at v7 of@inquirer/core, vs v2 of most prompts)@inquirer/promptsmeans there's been a non-backward compatible change to a prompt public interface. Those are rare, so most of the time it'll be patch/minor updates to the UX that users will be able to bump worry free.Leaving open a short while for review, but planning to release next week along #1381 (which introduce a breaking core change, but simple UX upgrade to all prompts.)