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

Add bash completion #1684

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add bash completion #1684

wants to merge 2 commits into from

Conversation

balki
Copy link
Contributor

@balki balki commented Oct 8, 2024

POC for bash completion support. It does two things as for now

  1. Following then, it completes a verb
  2. When tab is hit twice after completing a verb, it shows help for the verb

Demo

demo

Setup

❯ mlr completion     
Usage: mlr completion SHELL
Supported shells: bash

Add below to your bashrc to enable completion
source <(mlr completion bash)

❯ mlr completion bash
complete -o nospace -o nosort -C "mlr _complete_bash" mlr

Let me know if you like the approach. Can be enhanced further

  • zsh completion
  • complete global flags
  • complete verb flags
  • complete field names from input for some verbs like cut -f.. (extracted from first line of input in --from flag)

@balki
Copy link
Contributor Author

balki commented Oct 18, 2024

@johnkerl Are you ok with the approach for completion? Reading flags may require bit of refactor in command line parsing logic.

johnkerl
johnkerl reviewed Oct 19, 2024
View reviewed changes
pkg/auxents/completion.go Outdated Show resolved Hide resolved
@johnkerl
Copy link
Owner

@balki Hi and sorry for the delay!

This is AWESOME stuff!!! 😎

Agreed re all four checkboxes -- if you're up for it, these are all great! It's better to have some completion than none at all, so, I'm happy to take these as separate PRs.

I think bash is more popular than zsh but I really don't have data -- in any case ideally one would have support for both.

I'm happy to work with you on refactoring the command-line-parsing logic ...

johnkerl
johnkerl requested changes Oct 19, 2024
View reviewed changes
Copy link
Owner

@johnkerl johnkerl left a comment

Choose a reason for hiding this comment

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

Please see requested change

@balki @johnkerl
Update pkg/auxents/completion.go
1733e06 
Co-authored-by: John Kerl <kerl.john.r@gmail.com>
@balki
Copy link
Contributor Author

balki commented Nov 1, 2024

Thank you! Will try to work on this in next few weeks.

Yes bash is more popular and will start with bash as it is simpler. However zsh completion is more powerful and useful. E.g the flag completion has the help text which is very helpful. And mac os default shell is zsh.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johnkerl johnkerl johnkerl requested changes

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

Successfully merging this pull request may close these issues.
2 participants
@balki @johnkerl