Reduce duplicated option completions #26
Closed
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
Previously we generated our own completions for available options and commands, in a similar way to how this was is done in the `click._bashcomplete` module. However, this module has had various improvements made to it since this was originally done. Rather than duplicate similar code here (and have to do this again in future), this commit changes our completion to delegate generating the available completions to Click. There is also additional handling around this to still display relevant help alongside the completions, where possible. The end result is that this commit should make click-repl's completion function as before, except with some additional completions shown where these are relevant, such as the completion of choices added in pallets/click#681. Any additional improvements to Click's completion will also become available to us.
Frequently a CLI has options with both short and long identifiers, e.g. `-o` and `--opt`. For an interactive CLI such as that generated by click-repl I think it is nicer to just show the long option(s) in these cases, to avoid cluttering the completions with the same option many times in different forms. This commit does this; note that short options are still shown if there is not a corresponding long option to show instead.
|
Ah, very cool. I agree that this is a good change 👍 |
|
@bobwhitelock I'd like to see this merged eventually, but for now I am closing it because #25 has been inactive as well |
|
@untitaker fair enough in both cases - needed these changes for a project I'm no longer working on, and no longer remember the details of what I was doing, but if I need to work with |
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.
Frequently a CLI has options with both short and long identifiers, e.g.
-oand--opt. For an interactive CLI such as that generated by click-repl I think it is nicer to just show the long option(s) in thesecases, to avoid cluttering the completions with the same option many times in different forms. This commit does this; note that short options are still shown if there is not a corresponding long option to show
instead.
Note that this PR is based on #25 as it builds on the completion changes made there.
Thanks!