Add a zsh completion script #4128
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 nix output completions in the form `completion\tdescription`. This can't be used by bash (afaik), but other shells like zsh or fish can display it along the completion choices
Based on @clhodapp's suggestion in nix-community/nix-zsh-completions#32 (comment) and adapted to use the description of the completions
edolstra
reviewed
Oct 9, 2020
| @@ -17,8 +17,19 @@ void Args::addFlag(Flag && flag_) | |||
| if (flag->shortName) shortFlags[flag->shortName] = flag; | |||
| } | |||
|
|
|||
| void Completions::add(std::string completion, std::string description) | |||
| { | |||
| insert(Completion{ | |||
There was a problem hiding this comment.
Maybe add an assert here to check that description doesn't contain a newline.
|
Could you add a local.mk file like: so it's picked up by zsh fpath? |
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.
Extends the completion mechanism to also output the descriptions, and add a zsh completion script taking advantage of this.
This is a breaking change for the existing bash completion script (which can cause some minor issues if one updates the Nix client but not the script), but afaik it hasn't made it to any release yet, so it shouldn't be a major issue.
The current implementation also has an issue if the word to complete has a tab in it, but that sounds unlikely-enough to happen in practice