fix: accept explicit undefined as default in number, confirm, editor#2182
Open
greymoth-jp wants to merge 1 commit into
Open
fix: accept explicit undefined as default in number, confirm, editor#2182greymoth-jp wants to merge 1 commit into
greymoth-jp wants to merge 1 commit into
Conversation
Mirror of SBoudrias#2111 (input) for the remaining scalar-default prompts so the `default` option accepts an explicit `undefined` under exactOptionalPropertyTypes. Refs SBoudrias#2110.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2182 +/- ##
=======================================
Coverage ? 89.16%
=======================================
Files ? 48
Lines ? 2225
Branches ? 586
=======================================
Hits ? 1984
Misses ? 232
Partials ? 9 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
#2111 widened
InputConfig['default']tostring | undefinedso the option accepts an explicitly-undefined value underexactOptionalPropertyTypes: true(the inconsistency reported in #2110). The other prompts that expose a scalardefaultstill declare it as a bare optional, so they reject an explicitundefinedthe way@inquirer/inputdid before #2111:@inquirer/number:default?: number@inquirer/confirm:default?: boolean@inquirer/editor:default?: stringThis applies the same widening to those three, so
default: valuetype-checks whenvalueisT | undefined. Each gets a test mirroring the one added in #2111.The choice-based prompts (
select,rawlist,search,expand) have the same gap on theirdefaultoption. I kept this PR to the scalar-default prompts that match@inquirer/input, and am happy to follow up on the rest.Test plan
yarn tscyarn vitest --run packages/number packages/confirm packages/editoryarn oxlint/yarn eslint