adding support for DidYouMean when long options are spelled incorrectly #150
+124
−13
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
|
|
Fryguy
reviewed
Apr 27, 2024
lib/optimist.rb
Outdated
| # instance_eval(&b) if b # can't take arguments | ||
| cloaker(&b).bind(self).call(*a) if b | ||
| #cloaker(&b).bind(self).call(*a) if b |
There was a problem hiding this comment.
Should this line just be deleted? I'm curious why you stopped using the cloaker.
There was a problem hiding this comment.
Yup, should be deleted, I just removed the call to it and the cloaker method.
AFAICT the cloaker was a super clever trick used before instance_exec was in ruby, since instance_eval didnt support passing a block, but i could be wrong about that...
In any event, instance_exec seems to work such that all tests pass and doesnt require weird trickery, so felt like the cloaker could be safely removed.
Fryguy
approved these changes
May 1, 2024
Fryguy
added a commit
that referenced
this pull request
Nov 11, 2024
Added: - Align the short and long forms into their own columns in the help output (#145 - thanks akhoury6) - Add support for DidYouMean when long options are spelled incorrectly (#150 - thanks nanobowers) - Using `permitted:` restricts the allowed values that a end-user inputs to a pre-defined list (#147 - thanks akhoury6) - Add exact_match to settings, defaulting to inexact matching (#154 - thanks nanobowers) - Add setting to disable implicit short options (#155 - thanks nanobowers) - Add alt longname and multiple char support (#151 - thanks nanobowers) - Permitted regexp/range support (#158, #159- thanks nanobowers) - Add some examples (#161 - thanks nanobowers) Changed: - Enable frozen_string_literal for future-ruby support (#149, #153 - thanks nanobowers) - Refactor constraints (#156 - thanks nanobowers) - Fix assert_raises to assert_raises_errmatch (#160 - thanks nanobowers)
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.
Enables "did_you_mean" style suggestions for long options.
This works similar to how it does when you misspell something in Ruby, but applied to long options in Optimist.
It uses the same string-distance algorithm as Ruby to see if any of the long options are within a reasonable distance. The
DidYouMeanfeature was added in ruby2.3, so this will not work with older rubies but I dont believe we support those anymore.There is a keyword option that can be passed in at the Optimist.options() level to disable suggestions, e.g.
Optimist.options(ARGV, suggestions: false)and get legacy behavior. Some tweaks to how options are merged was necessary for this.examples script and output provided in the
/examplesdirectory.@miq-bot add-label enhancement
@miq-bot add-reviewer @Fryguy