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.

Sign up for GitHub

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

Jump to bottom

Support different bash completion options #1509

Merged
merged 1 commit into from
Dec 7, 2021
Merged

Support different bash completion options #1509

merged 1 commit into from
Dec 7, 2021

Conversation

marckhouzam
Copy link
Collaborator

@marckhouzam marckhouzam commented Oct 19, 2021 •
edited
Loading

Fixes #1508

Bash completion V2 adds descriptions to completions. However, with certain options, the description must be removed. For example the menu-complete/menu-complete-backward bash option will immediately insert on the command-line the first completion returned, therefore we must remove the description to avoid it being added on the command-line also.

Based on the documentation found here
https://www.gnu.org/software/bash/manual/html_node/Commands-For-Completion.html
we remove descriptions for the cases:

  • menu-complete
  • menu-complete-backward
  • insert-completions

This was referenced Oct 19, 2021
Closed
Closed
Closed
Luap99
Luap99 reviewed Oct 19, 2021
View reviewed changes
Copy link
Contributor

@Luap99 Luap99 left a comment

Choose a reason for hiding this comment

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

Thanks for the quick fix @marckhouzam

I think we should handle insert-completion like menu-complete,
insert-completion is documented to return all current completions.

One cool usecase I could think of is podman rm a[press key for insert-completions]. This would automatically insert all container names starting with an a.

@marckhouzam
Copy link
Collaborator Author

I think we should handle insert-completion like menu-complete, insert-completion is documented to return all current completions.

One cool usecase I could think of is podman rm a[press key for insert-completions]. This would automatically insert all container names starting with an a.

Brilliant!
I was confused because such a behaviour would break completion for commands; but I now realize different keys are bound to different completion types. So, on my Mac, TAB triggers normal completion, while ESC-* triggers the insert-completion type. I love it.

I will update the PR.

Thanks @Luap99!

@marckhouzam
Copy link
Collaborator Author

I think we should handle insert-completion like menu-complete

PR updated

Luap99
Luap99 approved these changes Oct 19, 2021
View reviewed changes
Copy link
Contributor

@Luap99 Luap99 left a comment

Choose a reason for hiding this comment

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

LGTM

@Luap99
Copy link
Contributor

Luap99 commented Oct 19, 2021

Do you think it is possible to add a test in your completion-testing repo?

@marckhouzam
Copy link
Collaborator Author

Do you think it is possible to add a test in your completion-testing repo?

Should be possible, and we should do it.
Feel free to do a PR if you have some time, if not, I'll eventually get to it 🤞

@marckhouzam
Support different bash completion options
258452a 
spf13#1508

Based on the documentation found here
https://www.gnu.org/software/bash/manual/html_node/Commands-For-Completion.html
we remove descriptions for the following completion types:
- menu-complete
- menu-complete-backward
- insert-completions

Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
marckhouzam added a commit to marckhouzam/cobra-completion-testing that referenced this pull request Oct 21, 2021
@marckhouzam
Add testing for different bash completion types
9226dbf 
These tests cover the issue: spf13/cobra#1508
and the corresponding fix: spf13/cobra#1509

Signed-off-by: Marc Khouzam <marc.khouzam@gmail.com>
@marckhouzam marckhouzam mentioned this pull request Oct 21, 2021
Merged
@marckhouzam
Copy link
Collaborator Author

Do you think it is possible to add a test in your completion-testing repo?

I've done a PR to add tests: marckhouzam/cobra-completion-testing#9

marckhouzam added a commit to marckhouzam/cobra-completion-testing that referenced this pull request Oct 21, 2021
@marckhouzam
Add testing for different bash completion types
32f0091 
These tests cover the issue: spf13/cobra#1508
and the corresponding fix: spf13/cobra#1509

Signed-off-by: Marc Khouzam <marc.khouzam@gmail.com>
@marckhouzam
Copy link
Collaborator Author

Looks like I confused GitHub 🙄

@marckhouzam marckhouzam reopened this Oct 21, 2021
umarcor pushed a commit to umarcor/cobra that referenced this pull request Nov 5, 2021
@marckhouzam @umarcor
Support different bash completion options (spf13#1509)
c6e7365 
spf13#1508

Based on the documentation found here
https://www.gnu.org/software/bash/manual/html_node/Commands-For-Completion.html
we remove descriptions for the following completion types:
- menu-complete
- menu-complete-backward
- insert-completions

Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
umarcor pushed a commit to umarcor/cobra that referenced this pull request Nov 15, 2021
@marckhouzam @umarcor
Support different bash completion options (spf13#1509)
2b31c95 
spf13#1508

Based on the documentation found here
https://www.gnu.org/software/bash/manual/html_node/Commands-For-Completion.html
we remove descriptions for the following completion types:
- menu-complete
- menu-complete-backward
- insert-completions

Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
umarcor pushed a commit to umarcor/cobra that referenced this pull request Nov 16, 2021
@marckhouzam @umarcor
Support different bash completion options (spf13#1509)
8371a1a 
spf13#1508

Based on the documentation found here
https://www.gnu.org/software/bash/manual/html_node/Commands-For-Completion.html
we remove descriptions for the following completion types:
- menu-complete
- menu-complete-backward
- insert-completions

Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
umarcor pushed a commit to umarcor/cobra that referenced this pull request Nov 25, 2021
@marckhouzam @umarcor
Support different bash completion options (spf13#1509)
9d5e047 
spf13#1508

Based on the documentation found here
https://www.gnu.org/software/bash/manual/html_node/Commands-For-Completion.html
we remove descriptions for the following completion types:
- menu-complete
- menu-complete-backward
- insert-completions

Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
@marckhouzam marckhouzam mentioned this pull request Dec 6, 2021
Closed
jpmcb
jpmcb approved these changes Dec 7, 2021
View reviewed changes
Copy link
Collaborator

@jpmcb jpmcb left a comment

Choose a reason for hiding this comment

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

Seems good! @marckhouzam - I'm guessing in marckhouzam/cobra-completion-testing we need this merged before we test?

@jpmcb jpmcb merged commit 3fed3ef into spf13:master Dec 7, 2021
@jpmcb jpmcb added this to the 1.3.0 milestone Dec 7, 2021
umarcor pushed a commit to umarcor/cobra that referenced this pull request Dec 7, 2021
@marckhouzam @umarcor
Support different bash completion options (spf13#1509)
3e06118 
spf13#1508

Based on the documentation found here
https://www.gnu.org/software/bash/manual/html_node/Commands-For-Completion.html
we remove descriptions for the following completion types:
- menu-complete
- menu-complete-backward
- insert-completions

Signed-off-by: Marc Khouzam <marc.khouzam@montreal.ca>
@marckhouzam marckhouzam deleted the fix/bashV2CompType branch December 8, 2021 00:07
@marckhouzam
Copy link
Collaborator Author

Seems good! @marckhouzam - I'm guessing in marckhouzam/cobra-completion-testing we need this merged before we test?

Yes the cobra-completion-testing already had a test for this which was failing until this merge.

Thanks for merging @jpmcb !

@marckhouzam marckhouzam mentioned this pull request Dec 19, 2021
Closed
@marckhouzam marckhouzam mentioned this pull request Jan 6, 2022
Closed
This was referenced Jan 19, 2022
Closed
Closed
This was referenced Apr 4, 2022
Closed
Merged
@marckhouzam marckhouzam mentioned this pull request Nov 4, 2022
Merged
akinomyoga added a commit to akinomyoga/bash-completion that referenced this pull request Dec 17, 2022
@akinomyoga
fix(make): disable the display-only mode also for COMP_TYPE=42
04aa820 
scop#546 (comment)
spf13/cobra#1509
akinomyoga added a commit to akinomyoga/bash-completion that referenced this pull request Dec 19, 2022
@akinomyoga
fix(make): disable the display-only mode also for COMP_TYPE=42
e29b79b 
scop#546 (comment)
spf13/cobra#1509
@lincheney lincheney mentioned this pull request Nov 20, 2024
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Luap99 Luap99 Luap99 approved these changes

@jpmcb jpmcb jpmcb approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
1.3.0
Development

Successfully merging this pull request may close these issues.

Bash autocompletion adds command description to completed line
3 participants
@marckhouzam @Luap99 @jpmcb