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

Provide bash completion #230

Closed
mvitz opened this issue Nov 10, 2016 · 2 comments
Closed

Provide bash completion #230

mvitz opened this issue Nov 10, 2016 · 2 comments
Labels
enhancement An enhancement to the functionality of the software. help wanted Others are encouraged to work on this issue. question An issue that is lacking clarity on one or more points.

Comments

@mvitz
Copy link
Contributor

mvitz commented Nov 10, 2016

It would be nice to have bash completion.
@BurntSushi
Copy link
Owner

I agree, but I'm unlikely to do this myself. I would however maintain one. But it would have to be automatically generated somehow.

@BurntSushi BurntSushi added enhancement An enhancement to the functionality of the software. help wanted Others are encouraged to work on this issue. question An issue that is lacking clarity on one or more points. labels Nov 10, 2016
@kbknapp
Copy link
Contributor

kbknapp commented Nov 11, 2016

@BurntSushi Related to #136 clap now supports generating bash, zsh, fish, and powershell completion scripts 😉

@BurntSushi BurntSushi mentioned this issue Nov 13, 2016
Merged
BurntSushi added a commit that referenced this issue Nov 13, 2016
@BurntSushi
Switch from Docopt to Clap.
d9bd654 
There were two important reasons for the switch:

1. Performance. Docopt does poorly when the argv becomes large, which is
   a reasonable common use case for search tools. (e.g., use with xargs)
2. Better failure modes. Clap knows a lot more about how a particular
   argv might be invalid, and can therefore provide much clearer error
   messages.

While both were important, (1) made it urgent.

Note that since Clap requires at least Rust 1.11, this will in turn
increase the minimum Rust version supported by ripgrep from Rust 1.9 to
Rust 1.11. It is therefore a breaking change, so the soonest release of
ripgrep with Clap will have to be 0.3.

There is also at least one subtle breaking change in real usage.
Previous to this commit, this used to work:

    rg -e -foo

Where this would cause ripgrep to search for the string `-foo`. Clap
currently has problems supporting this use case
(see: clap-rs/clap#742),
but it can be worked around by using this instead:

    rg -e [-]foo

or even

    rg [-]foo

and this still works:

    rg -- -foo

This commit also adds Bash, Fish and PowerShell completion files to the
release, fixes a bug that prevented ripgrep from working on file
paths containing invalid UTF-8 and shows short descriptions in the
output of `-h` but longer descriptions in the output of `--help`.

Fixes #136, #189, #210, #230
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement An enhancement to the functionality of the software. help wanted Others are encouraged to work on this issue. question An issue that is lacking clarity on one or more points.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@BurntSushi @mvitz @kbknapp