Add support for generating short flags for options. Fixes #33 #36
Conversation
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
This adds a new `shortNameModifier` to the `Modifiers` record which is used to optionally generate a short flag for labeled fields This change also updates the documentation around how to use `Modifiers`
Closed
|
This looks really good. The documentation will be really helpful. The only constructive comment I have is that short options are a very common feature for option parsers. While I think the |
|
The main reason that this does not add short names out of the box is that there is a pretty high likelihood that they will conflict if two fields share the same first letter |
|
That makes sense, you would want to break the API for existing users. You might be able to add an option to explicitly turn it on. |
This picks the common default where you use the first letter of each option as the short name
|
I added a |
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.
This adds a new
shortNameModifierto theModifiersrecord which isused to optionally generate a short flag for labeled fields
This change also updates the documentation around how to use
Modifiers