Make OptionValueSource a string with well-known values for auto-complete #1983
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
This was referenced Jun 19, 2024
This was referenced Jul 5, 2024
This was referenced Sep 20, 2024
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.
Pull Request
Problem
Authors are allowed to use their own strings for
OptionValueSource, but the usual range will just be the values that Commander uses. The TypeScript typing only listed the Commander values to support the primary use, and get autocomplete in the editor.Solution
Use a well-known "trick" to specify a string with some known values. The known values are offered for auto-complete by VSCode, and TypeScript allows other values too.
This was prototyped in https://github.com/commander-js/extra-typings
References:
ChangeLog
OptionValueSourceto allow any string to match supported custom use