Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(comp): Add support for fish completion #8664

Merged
merged 1 commit into from Sep 3, 2020

Conversation

marckhouzam
Copy link
Member

@marckhouzam marckhouzam commented Aug 27, 2020

Part of #8109
Replaces #8111

What this PR does / why we need it:

Provides support for Fish shell completion through Cobra

Special notes for your reviewer:

This PR replaces #8111 because the contributor has not come back to his PR, which needs a rebase, since July 7th, 2020.
I've reached out three times but no luck.

Also, a new flag --no-descriptions was added just for the command helm completion fish, to allow users to disable descriptions if they don't like to have them. Descriptions are a feature of fish completion (and native zsh completion) that looks like this:

$ bin/helm s<TAB>
search  (search for a keyword in charts)  
show    (show information of a chart)  
status  (display the status of the named release)

Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
@helm-bot helm-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 27, 2020
@mattfarina mattfarina self-requested a review September 3, 2020 14:47
Copy link
Collaborator

@mattfarina mattfarina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm.

Manually testing this out was fun. There are some things I like about fish that I forget about.

@marckhouzam
Copy link
Member Author

Thanks @mattfarina.
I also liked fish after trying out. The use of colors is nice, the scripting language is more intuitive, but the feature that I enjoy the most was the grayed-out command-line that recalls my previous similar command. I have installed a plugin in zsh to mimic that last feature, I can't live without it anymore.

@marckhouzam marckhouzam merged commit 36d9311 into helm:master Sep 3, 2020
@marckhouzam marckhouzam deleted the feat/fishCompWithCobra branch September 3, 2020 15:18
@thernstig
Copy link

@marckhouzam and @mattfarina - I just recently tested this, but assume it has not made it in to any release yet, and that it can be expected in Helm 3.4.0.

But I also noticed that this PR forgot to update the documentation, more specifically found here:
https://helm.sh/docs/helm/helm_completion/

Also note that there should be a documentation entry at this location: https://helm.sh/docs/helm/helm_completion_fish/

@marckhouzam
Copy link
Member Author

Thank you @thernstig for trying this out. You are right, it will be part of Helm 3.4.
From what I know, the docs you mention are automatically generated and should therefore be updated once 3.4 has been released.

If you notice anything unexpected in your usage of Fish completion, I encourage you to continue reporting it, it will help others.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants