Add Command.options to TypeScript #1827
Merged
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
Make options and commands readonly to discourage direct manipulation. Co-authored-by: Cynthia <cynthia@cynthia.dev> Co-authored-by: Marcelo Shima <marceloshima@gmail.com> Co-authored-by: Dmitry Maganov <vonagam@gmail.com>
shadowspawn
added
the
semver: major
This was referenced Sep 7, 2023
This was referenced Oct 13, 2023
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
People want to access
optionson the command object from TypeScript. See: #1784 #1825But we don't want people to muck with the options array...
I have been suggesting
Help.visibleOptions(), but it is really only a good match for cases where client wants the automatic options included or the hidden options removed. It is a bit indirect as a general access method.Solution
Add
options.Make both
optionsandcommandsreadonly to discourage direct modification, as suggested in #1184 by @vonagam and in #1784 by @mshima.All three authors of previous related PR added as co-authors on this PR. Thanks for your past contributions!
ChangeLog
optionsproperty ofCommandcommandsproperty ofCommandis now readonly