Confusion between `NumberPrompt` vs `Numeral`

When trying to integrate Enquirer prompts for the first time It took some digging in your code to figure out how to get number prompts to work.

In your code you export a Numeral type.

https://github.com/cenk1cenk2/listr2/blob/1fbfaf27c2e3325855de73154689defabd679b0d/src/utils/prompt.interface.ts#L119

But in the enquirer docs they have a Markdown heading for a Numeral type (which is maybe where you got your naming from?) but the actual thing they export is a NumberPrompt:

https://github.com/enquirer/enquirer#numeral-prompt

I don’t know why they have this confusion either.

Is it possible to help clear up the confusion to make this more discoverable? Or make Number an alias of Numeral? Perhaps also document here which types Listr2 works with?

https://listr2.kilic.dev/general-usage/user-input

Thanks!

[cenk1cenk2]

I hope to not overwrite the types as soon as the merge request on the upstream merges. I only tried to convert the types that I was using at the time and added the rest mostly from the documentation, so it may be a little bit buggy. Sorry for that. You can easily see how that was not intended to be a long time solution from the extends clauses instead of a proper map.

I might take a look this weekend if i have some extra time, but can not promise since currently bit swamped. a pull request is welcome if you have any extra time.

[cenk1cenk2]

🎉 This issue has been resolved in version 3.4.5 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀